> ## Documentation Index > Fetch the complete documentation index at: https://docs.siderolabs.com/llms.txt > Use this file to discover all available pages before exploring further. # API > Talos gRPC API reference. export const VersionWarningBanner = () => { const latestVersion = "v1.13"; const [latestUrl, setLatestUrl] = useState(null); const [currentVersion, setCurrentVersion] = useState(null); const [isBeta, setIsBeta] = useState(false); const parseVersion = v => v.replace("v", "").split(".").map(Number); const isGreaterVersion = (a, b) => { const [aMajor, aMinor] = parseVersion(a); const [bMajor, bMinor] = parseVersion(b); if (aMajor > bMajor) return true; if (aMajor === bMajor && aMinor > bMinor) return true; return false; }; useEffect(() => { if (typeof window === "undefined") return; const {pathname, hash, search} = window.location; const match = pathname.match(/\/talos\/(v\d+\.\d+)\//); if (!match) return; const detectedVersion = match[1]; if (detectedVersion === latestVersion) return; setCurrentVersion(detectedVersion); if (isGreaterVersion(detectedVersion, latestVersion)) { setIsBeta(true); } const newPath = pathname.replace(`/talos/${detectedVersion}/`, `/talos/${latestVersion}/`); setLatestUrl(`${newPath}${search}${hash}`); }, []); if (!latestUrl || !currentVersion) return null; return
{isBeta ? <> ⚠️ You are viewing a beta version of Talos ({currentVersion}). This version may be unstable. View latest stable version {latestVersion} → : <> ⚠️ You are viewing an older version of Talos ({currentVersion}). View the latest version {latestVersion} → }
; }; ## Table of Contents * [common/common.proto](#common/common.proto) * [Data](#common.Data) * [DataResponse](#common.DataResponse) * [Empty](#common.Empty) * [EmptyResponse](#common.EmptyResponse) * [Error](#common.Error) * [Metadata](#common.Metadata) * [NetIP](#common.NetIP) * [NetIPPort](#common.NetIPPort) * [NetIPPrefix](#common.NetIPPrefix) * [PEMEncodedCertificate](#common.PEMEncodedCertificate) * [PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) * [PEMEncodedKey](#common.PEMEncodedKey) * [URL](#common.URL) * [Code](#common.Code) * [ContainerDriver](#common.ContainerDriver) * [ContainerdNamespace](#common.ContainerdNamespace) * [File-level Extensions](#common/common.proto-extensions) * [cluster/cluster.proto](#cluster/cluster.proto) * [ClusterInfo](#cluster.ClusterInfo) * [HealthCheckProgress](#cluster.HealthCheckProgress) * [HealthCheckRequest](#cluster.HealthCheckRequest) * [ClusterService](#cluster.ClusterService) * [inspect/inspect.proto](#inspect/inspect.proto) * [ControllerDependencyEdge](#inspect.ControllerDependencyEdge) * [ControllerRuntimeDependenciesResponse](#inspect.ControllerRuntimeDependenciesResponse) * [ControllerRuntimeDependency](#inspect.ControllerRuntimeDependency) * [DependencyEdgeType](#inspect.DependencyEdgeType) * [InspectService](#inspect.InspectService) * [machine/machine.proto](#machine/machine.proto) * [AddressEvent](#machine.AddressEvent) * [ApplyConfiguration](#machine.ApplyConfiguration) * [ApplyConfigurationRequest](#machine.ApplyConfigurationRequest) * [ApplyConfigurationResponse](#machine.ApplyConfigurationResponse) * [BPFInstruction](#machine.BPFInstruction) * [Bootstrap](#machine.Bootstrap) * [BootstrapRequest](#machine.BootstrapRequest) * [BootstrapResponse](#machine.BootstrapResponse) * [CNIConfig](#machine.CNIConfig) * [CPUFreqStats](#machine.CPUFreqStats) * [CPUFreqStatsResponse](#machine.CPUFreqStatsResponse) * [CPUInfo](#machine.CPUInfo) * [CPUInfoResponse](#machine.CPUInfoResponse) * [CPUStat](#machine.CPUStat) * [CPUsFreqStats](#machine.CPUsFreqStats) * [CPUsInfo](#machine.CPUsInfo) * [ClusterConfig](#machine.ClusterConfig) * [ClusterNetworkConfig](#machine.ClusterNetworkConfig) * [ConfigLoadErrorEvent](#machine.ConfigLoadErrorEvent) * [ConfigValidationErrorEvent](#machine.ConfigValidationErrorEvent) * [ConnectRecord](#machine.ConnectRecord) * [ConnectRecord.Process](#machine.ConnectRecord.Process) * [Container](#machine.Container) * [ContainerInfo](#machine.ContainerInfo) * [ContainersRequest](#machine.ContainersRequest) * [ContainersResponse](#machine.ContainersResponse) * [ControlPlaneConfig](#machine.ControlPlaneConfig) * [CopyRequest](#machine.CopyRequest) * [DHCPOptionsConfig](#machine.DHCPOptionsConfig) * [DiskStat](#machine.DiskStat) * [DiskStats](#machine.DiskStats) * [DiskStatsResponse](#machine.DiskStatsResponse) * [DiskUsageInfo](#machine.DiskUsageInfo) * [DiskUsageRequest](#machine.DiskUsageRequest) * [DmesgRequest](#machine.DmesgRequest) * [EtcdAlarm](#machine.EtcdAlarm) * [EtcdAlarmDisarm](#machine.EtcdAlarmDisarm) * [EtcdAlarmDisarmResponse](#machine.EtcdAlarmDisarmResponse) * [EtcdAlarmListResponse](#machine.EtcdAlarmListResponse) * [EtcdClusterDowngrade](#machine.EtcdClusterDowngrade) * [EtcdDefragment](#machine.EtcdDefragment) * [EtcdDefragmentResponse](#machine.EtcdDefragmentResponse) * [EtcdDowngradeCancel](#machine.EtcdDowngradeCancel) * [EtcdDowngradeCancelResponse](#machine.EtcdDowngradeCancelResponse) * [EtcdDowngradeEnable](#machine.EtcdDowngradeEnable) * [EtcdDowngradeEnableRequest](#machine.EtcdDowngradeEnableRequest) * [EtcdDowngradeEnableResponse](#machine.EtcdDowngradeEnableResponse) * [EtcdDowngradeValidate](#machine.EtcdDowngradeValidate) * [EtcdDowngradeValidateRequest](#machine.EtcdDowngradeValidateRequest) * [EtcdDowngradeValidateResponse](#machine.EtcdDowngradeValidateResponse) * [EtcdForfeitLeadership](#machine.EtcdForfeitLeadership) * [EtcdForfeitLeadershipRequest](#machine.EtcdForfeitLeadershipRequest) * [EtcdForfeitLeadershipResponse](#machine.EtcdForfeitLeadershipResponse) * [EtcdLeaveCluster](#machine.EtcdLeaveCluster) * [EtcdLeaveClusterRequest](#machine.EtcdLeaveClusterRequest) * [EtcdLeaveClusterResponse](#machine.EtcdLeaveClusterResponse) * [EtcdMember](#machine.EtcdMember) * [EtcdMemberAlarm](#machine.EtcdMemberAlarm) * [EtcdMemberListRequest](#machine.EtcdMemberListRequest) * [EtcdMemberListResponse](#machine.EtcdMemberListResponse) * [EtcdMemberStatus](#machine.EtcdMemberStatus) * [EtcdMembers](#machine.EtcdMembers) * [EtcdRecover](#machine.EtcdRecover) * [EtcdRecoverResponse](#machine.EtcdRecoverResponse) * [EtcdRemoveMember](#machine.EtcdRemoveMember) * [EtcdRemoveMemberByID](#machine.EtcdRemoveMemberByID) * [EtcdRemoveMemberByIDRequest](#machine.EtcdRemoveMemberByIDRequest) * [EtcdRemoveMemberByIDResponse](#machine.EtcdRemoveMemberByIDResponse) * [EtcdRemoveMemberRequest](#machine.EtcdRemoveMemberRequest) * [EtcdRemoveMemberResponse](#machine.EtcdRemoveMemberResponse) * [EtcdSnapshotRequest](#machine.EtcdSnapshotRequest) * [EtcdStatus](#machine.EtcdStatus) * [EtcdStatusResponse](#machine.EtcdStatusResponse) * [Event](#machine.Event) * [EventsRequest](#machine.EventsRequest) * [FeaturesInfo](#machine.FeaturesInfo) * [FileInfo](#machine.FileInfo) * [GenerateClientConfiguration](#machine.GenerateClientConfiguration) * [GenerateClientConfigurationRequest](#machine.GenerateClientConfigurationRequest) * [GenerateClientConfigurationResponse](#machine.GenerateClientConfigurationResponse) * [GenerateConfiguration](#machine.GenerateConfiguration) * [GenerateConfigurationRequest](#machine.GenerateConfigurationRequest) * [GenerateConfigurationResponse](#machine.GenerateConfigurationResponse) * [Hostname](#machine.Hostname) * [HostnameResponse](#machine.HostnameResponse) * [ImageListRequest](#machine.ImageListRequest) * [ImageListResponse](#machine.ImageListResponse) * [ImagePull](#machine.ImagePull) * [ImagePullRequest](#machine.ImagePullRequest) * [ImagePullResponse](#machine.ImagePullResponse) * [InstallConfig](#machine.InstallConfig) * [ListRequest](#machine.ListRequest) * [LoadAvg](#machine.LoadAvg) * [LoadAvgResponse](#machine.LoadAvgResponse) * [LogsContainer](#machine.LogsContainer) * [LogsContainersResponse](#machine.LogsContainersResponse) * [LogsRequest](#machine.LogsRequest) * [MachineConfig](#machine.MachineConfig) * [MachineStatusEvent](#machine.MachineStatusEvent) * [MachineStatusEvent.MachineStatus](#machine.MachineStatusEvent.MachineStatus) * [MachineStatusEvent.MachineStatus.UnmetCondition](#machine.MachineStatusEvent.MachineStatus.UnmetCondition) * [MemInfo](#machine.MemInfo) * [Memory](#machine.Memory) * [MemoryResponse](#machine.MemoryResponse) * [MetaDelete](#machine.MetaDelete) * [MetaDeleteRequest](#machine.MetaDeleteRequest) * [MetaDeleteResponse](#machine.MetaDeleteResponse) * [MetaWrite](#machine.MetaWrite) * [MetaWriteRequest](#machine.MetaWriteRequest) * [MetaWriteResponse](#machine.MetaWriteResponse) * [MountStat](#machine.MountStat) * [Mounts](#machine.Mounts) * [MountsResponse](#machine.MountsResponse) * [NetDev](#machine.NetDev) * [Netstat](#machine.Netstat) * [NetstatRequest](#machine.NetstatRequest) * [NetstatRequest.Feature](#machine.NetstatRequest.Feature) * [NetstatRequest.L4proto](#machine.NetstatRequest.L4proto) * [NetstatRequest.NetNS](#machine.NetstatRequest.NetNS) * [NetstatResponse](#machine.NetstatResponse) * [NetworkConfig](#machine.NetworkConfig) * [NetworkDeviceConfig](#machine.NetworkDeviceConfig) * [NetworkDeviceStats](#machine.NetworkDeviceStats) * [NetworkDeviceStatsResponse](#machine.NetworkDeviceStatsResponse) * [PacketCaptureRequest](#machine.PacketCaptureRequest) * [PhaseEvent](#machine.PhaseEvent) * [PlatformInfo](#machine.PlatformInfo) * [Process](#machine.Process) * [ProcessInfo](#machine.ProcessInfo) * [ProcessesResponse](#machine.ProcessesResponse) * [ReadRequest](#machine.ReadRequest) * [Reboot](#machine.Reboot) * [RebootRequest](#machine.RebootRequest) * [RebootResponse](#machine.RebootResponse) * [Reset](#machine.Reset) * [ResetPartitionSpec](#machine.ResetPartitionSpec) * [ResetRequest](#machine.ResetRequest) * [ResetResponse](#machine.ResetResponse) * [Restart](#machine.Restart) * [RestartEvent](#machine.RestartEvent) * [RestartRequest](#machine.RestartRequest) * [RestartResponse](#machine.RestartResponse) * [Rollback](#machine.Rollback) * [RollbackRequest](#machine.RollbackRequest) * [RollbackResponse](#machine.RollbackResponse) * [RouteConfig](#machine.RouteConfig) * [SequenceEvent](#machine.SequenceEvent) * [ServiceEvent](#machine.ServiceEvent) * [ServiceEvents](#machine.ServiceEvents) * [ServiceHealth](#machine.ServiceHealth) * [ServiceInfo](#machine.ServiceInfo) * [ServiceList](#machine.ServiceList) * [ServiceListResponse](#machine.ServiceListResponse) * [ServiceRestart](#machine.ServiceRestart) * [ServiceRestartRequest](#machine.ServiceRestartRequest) * [ServiceRestartResponse](#machine.ServiceRestartResponse) * [ServiceStart](#machine.ServiceStart) * [ServiceStartRequest](#machine.ServiceStartRequest) * [ServiceStartResponse](#machine.ServiceStartResponse) * [ServiceStateEvent](#machine.ServiceStateEvent) * [ServiceStop](#machine.ServiceStop) * [ServiceStopRequest](#machine.ServiceStopRequest) * [ServiceStopResponse](#machine.ServiceStopResponse) * [Shutdown](#machine.Shutdown) * [ShutdownRequest](#machine.ShutdownRequest) * [ShutdownResponse](#machine.ShutdownResponse) * [SoftIRQStat](#machine.SoftIRQStat) * [Stat](#machine.Stat) * [Stats](#machine.Stats) * [StatsRequest](#machine.StatsRequest) * [StatsResponse](#machine.StatsResponse) * [SystemStat](#machine.SystemStat) * [SystemStatResponse](#machine.SystemStatResponse) * [TaskEvent](#machine.TaskEvent) * [Upgrade](#machine.Upgrade) * [UpgradeRequest](#machine.UpgradeRequest) * [UpgradeResponse](#machine.UpgradeResponse) * [Version](#machine.Version) * [VersionInfo](#machine.VersionInfo) * [VersionResponse](#machine.VersionResponse) * [Xattr](#machine.Xattr) * [ApplyConfigurationRequest.Mode](#machine.ApplyConfigurationRequest.Mode) * [ConnectRecord.State](#machine.ConnectRecord.State) * [ConnectRecord.TimerActive](#machine.ConnectRecord.TimerActive) * [EtcdMemberAlarm.AlarmType](#machine.EtcdMemberAlarm.AlarmType) * [ListRequest.Type](#machine.ListRequest.Type) * [MachineConfig.MachineType](#machine.MachineConfig.MachineType) * [MachineStatusEvent.MachineStage](#machine.MachineStatusEvent.MachineStage) * [NetstatRequest.Filter](#machine.NetstatRequest.Filter) * [PhaseEvent.Action](#machine.PhaseEvent.Action) * [RebootRequest.Mode](#machine.RebootRequest.Mode) * [ResetRequest.WipeMode](#machine.ResetRequest.WipeMode) * [SequenceEvent.Action](#machine.SequenceEvent.Action) * [ServiceStateEvent.Action](#machine.ServiceStateEvent.Action) * [TaskEvent.Action](#machine.TaskEvent.Action) * [UpgradeRequest.RebootMode](#machine.UpgradeRequest.RebootMode) * [MachineService](#machine.MachineService) * [resource/config/config.proto](#resource/config/config.proto) * [MachineConfigSpec](#resource.config.MachineConfigSpec) * [MachineTypeSpec](#resource.config.MachineTypeSpec) * [MachineType](#resource.config.MachineType) * [resource/definitions/enums/enums.proto](#resource/definitions/enums/enums.proto) * [BlockEncryptionKeyType](#talos.resource.definitions.enums.BlockEncryptionKeyType) * [BlockEncryptionProviderType](#talos.resource.definitions.enums.BlockEncryptionProviderType) * [BlockFilesystemType](#talos.resource.definitions.enums.BlockFilesystemType) * [BlockVolumePhase](#talos.resource.definitions.enums.BlockVolumePhase) * [BlockVolumeType](#talos.resource.definitions.enums.BlockVolumeType) * [CriImageCacheCopyStatus](#talos.resource.definitions.enums.CriImageCacheCopyStatus) * [CriImageCacheStatus](#talos.resource.definitions.enums.CriImageCacheStatus) * [KubespanPeerState](#talos.resource.definitions.enums.KubespanPeerState) * [MachineType](#talos.resource.definitions.enums.MachineType) * [NethelpersADSelect](#talos.resource.definitions.enums.NethelpersADSelect) * [NethelpersARPAllTargets](#talos.resource.definitions.enums.NethelpersARPAllTargets) * [NethelpersARPValidate](#talos.resource.definitions.enums.NethelpersARPValidate) * [NethelpersAddressFlag](#talos.resource.definitions.enums.NethelpersAddressFlag) * [NethelpersAddressSortAlgorithm](#talos.resource.definitions.enums.NethelpersAddressSortAlgorithm) * [NethelpersAutoHostnameKind](#talos.resource.definitions.enums.NethelpersAutoHostnameKind) * [NethelpersBondMode](#talos.resource.definitions.enums.NethelpersBondMode) * [NethelpersBondXmitHashPolicy](#talos.resource.definitions.enums.NethelpersBondXmitHashPolicy) * [NethelpersConntrackState](#talos.resource.definitions.enums.NethelpersConntrackState) * [NethelpersDuplex](#talos.resource.definitions.enums.NethelpersDuplex) * [NethelpersFailOverMAC](#talos.resource.definitions.enums.NethelpersFailOverMAC) * [NethelpersFamily](#talos.resource.definitions.enums.NethelpersFamily) * [NethelpersICMPType](#talos.resource.definitions.enums.NethelpersICMPType) * [NethelpersLACPRate](#talos.resource.definitions.enums.NethelpersLACPRate) * [NethelpersLinkType](#talos.resource.definitions.enums.NethelpersLinkType) * [NethelpersMatchOperator](#talos.resource.definitions.enums.NethelpersMatchOperator) * [NethelpersNfTablesChainHook](#talos.resource.definitions.enums.NethelpersNfTablesChainHook) * [NethelpersNfTablesChainPriority](#talos.resource.definitions.enums.NethelpersNfTablesChainPriority) * [NethelpersNfTablesVerdict](#talos.resource.definitions.enums.NethelpersNfTablesVerdict) * [NethelpersOperationalState](#talos.resource.definitions.enums.NethelpersOperationalState) * [NethelpersPort](#talos.resource.definitions.enums.NethelpersPort) * [NethelpersPrimaryReselect](#talos.resource.definitions.enums.NethelpersPrimaryReselect) * [NethelpersProtocol](#talos.resource.definitions.enums.NethelpersProtocol) * [NethelpersRouteFlag](#talos.resource.definitions.enums.NethelpersRouteFlag) * [NethelpersRouteProtocol](#talos.resource.definitions.enums.NethelpersRouteProtocol) * [NethelpersRouteType](#talos.resource.definitions.enums.NethelpersRouteType) * [NethelpersRoutingTable](#talos.resource.definitions.enums.NethelpersRoutingTable) * [NethelpersScope](#talos.resource.definitions.enums.NethelpersScope) * [NethelpersVLANProtocol](#talos.resource.definitions.enums.NethelpersVLANProtocol) * [NethelpersWOLMode](#talos.resource.definitions.enums.NethelpersWOLMode) * [NetworkConfigLayer](#talos.resource.definitions.enums.NetworkConfigLayer) * [NetworkOperator](#talos.resource.definitions.enums.NetworkOperator) * [RuntimeFIPSState](#talos.resource.definitions.enums.RuntimeFIPSState) * [RuntimeMachineStage](#talos.resource.definitions.enums.RuntimeMachineStage) * [RuntimeSELinuxState](#talos.resource.definitions.enums.RuntimeSELinuxState) * [resource/definitions/block/block.proto](#resource/definitions/block/block.proto) * [DeviceSpec](#talos.resource.definitions.block.DeviceSpec) * [DiscoveredVolumeSpec](#talos.resource.definitions.block.DiscoveredVolumeSpec) * [DiscoveryRefreshRequestSpec](#talos.resource.definitions.block.DiscoveryRefreshRequestSpec) * [DiscoveryRefreshStatusSpec](#talos.resource.definitions.block.DiscoveryRefreshStatusSpec) * [DiskSelector](#talos.resource.definitions.block.DiskSelector) * [DiskSpec](#talos.resource.definitions.block.DiskSpec) * [EncryptionKey](#talos.resource.definitions.block.EncryptionKey) * [EncryptionSpec](#talos.resource.definitions.block.EncryptionSpec) * [FilesystemSpec](#talos.resource.definitions.block.FilesystemSpec) * [LocatorSpec](#talos.resource.definitions.block.LocatorSpec) * [MountRequestSpec](#talos.resource.definitions.block.MountRequestSpec) * [MountSpec](#talos.resource.definitions.block.MountSpec) * [MountStatusSpec](#talos.resource.definitions.block.MountStatusSpec) * [PartitionSpec](#talos.resource.definitions.block.PartitionSpec) * [ProvisioningSpec](#talos.resource.definitions.block.ProvisioningSpec) * [SwapStatusSpec](#talos.resource.definitions.block.SwapStatusSpec) * [SymlinkProvisioningSpec](#talos.resource.definitions.block.SymlinkProvisioningSpec) * [SymlinkSpec](#talos.resource.definitions.block.SymlinkSpec) * [SystemDiskSpec](#talos.resource.definitions.block.SystemDiskSpec) * [TPMEncryptionOptionsInfo](#talos.resource.definitions.block.TPMEncryptionOptionsInfo) * [UserDiskConfigStatusSpec](#talos.resource.definitions.block.UserDiskConfigStatusSpec) * [VolumeConfigSpec](#talos.resource.definitions.block.VolumeConfigSpec) * [VolumeMountRequestSpec](#talos.resource.definitions.block.VolumeMountRequestSpec) * [VolumeMountStatusSpec](#talos.resource.definitions.block.VolumeMountStatusSpec) * [VolumeStatusSpec](#talos.resource.definitions.block.VolumeStatusSpec) * [ZswapStatusSpec](#talos.resource.definitions.block.ZswapStatusSpec) * [resource/definitions/cluster/cluster.proto](#resource/definitions/cluster/cluster.proto) * [AffiliateSpec](#talos.resource.definitions.cluster.AffiliateSpec) * [ConfigSpec](#talos.resource.definitions.cluster.ConfigSpec) * [ControlPlane](#talos.resource.definitions.cluster.ControlPlane) * [IdentitySpec](#talos.resource.definitions.cluster.IdentitySpec) * [InfoSpec](#talos.resource.definitions.cluster.InfoSpec) * [KubeSpanAffiliateSpec](#talos.resource.definitions.cluster.KubeSpanAffiliateSpec) * [MemberSpec](#talos.resource.definitions.cluster.MemberSpec) * [resource/definitions/cri/cri.proto](#resource/definitions/cri/cri.proto) * [ImageCacheConfigSpec](#talos.resource.definitions.cri.ImageCacheConfigSpec) * [RegistriesConfigSpec](#talos.resource.definitions.cri.RegistriesConfigSpec) * [RegistriesConfigSpec.RegistryConfigEntry](#talos.resource.definitions.cri.RegistriesConfigSpec.RegistryConfigEntry) * [RegistriesConfigSpec.RegistryMirrorsEntry](#talos.resource.definitions.cri.RegistriesConfigSpec.RegistryMirrorsEntry) * [RegistryAuthConfig](#talos.resource.definitions.cri.RegistryAuthConfig) * [RegistryConfig](#talos.resource.definitions.cri.RegistryConfig) * [RegistryEndpointConfig](#talos.resource.definitions.cri.RegistryEndpointConfig) * [RegistryMirrorConfig](#talos.resource.definitions.cri.RegistryMirrorConfig) * [RegistryTLSConfig](#talos.resource.definitions.cri.RegistryTLSConfig) * [SeccompProfileSpec](#talos.resource.definitions.cri.SeccompProfileSpec) * [resource/definitions/etcd/etcd.proto](#resource/definitions/etcd/etcd.proto) * [ConfigSpec](#talos.resource.definitions.etcd.ConfigSpec) * [ConfigSpec.ExtraArgsEntry](#talos.resource.definitions.etcd.ConfigSpec.ExtraArgsEntry) * [MemberSpec](#talos.resource.definitions.etcd.MemberSpec) * [PKIStatusSpec](#talos.resource.definitions.etcd.PKIStatusSpec) * [SpecSpec](#talos.resource.definitions.etcd.SpecSpec) * [SpecSpec.ExtraArgsEntry](#talos.resource.definitions.etcd.SpecSpec.ExtraArgsEntry) * [resource/definitions/extensions/extensions.proto](#resource/definitions/extensions/extensions.proto) * [Compatibility](#talos.resource.definitions.extensions.Compatibility) * [Constraint](#talos.resource.definitions.extensions.Constraint) * [Layer](#talos.resource.definitions.extensions.Layer) * [Metadata](#talos.resource.definitions.extensions.Metadata) * [resource/definitions/files/files.proto](#resource/definitions/files/files.proto) * [EtcFileSpecSpec](#talos.resource.definitions.files.EtcFileSpecSpec) * [EtcFileStatusSpec](#talos.resource.definitions.files.EtcFileStatusSpec) * [resource/definitions/hardware/hardware.proto](#resource/definitions/hardware/hardware.proto) * [MemoryModuleSpec](#talos.resource.definitions.hardware.MemoryModuleSpec) * [PCIDeviceSpec](#talos.resource.definitions.hardware.PCIDeviceSpec) * [PCIDriverRebindConfigSpec](#talos.resource.definitions.hardware.PCIDriverRebindConfigSpec) * [PCIDriverRebindStatusSpec](#talos.resource.definitions.hardware.PCIDriverRebindStatusSpec) * [ProcessorSpec](#talos.resource.definitions.hardware.ProcessorSpec) * [SystemInformationSpec](#talos.resource.definitions.hardware.SystemInformationSpec) * [resource/definitions/proto/proto.proto](#resource/definitions/proto/proto.proto) * [LinuxIDMapping](#talos.resource.definitions.proto.LinuxIDMapping) * [Mount](#talos.resource.definitions.proto.Mount) * [resource/definitions/k8s/k8s.proto](#resource/definitions/k8s/k8s.proto) * [APIServerConfigSpec](#talos.resource.definitions.k8s.APIServerConfigSpec) * [APIServerConfigSpec.EnvironmentVariablesEntry](#talos.resource.definitions.k8s.APIServerConfigSpec.EnvironmentVariablesEntry) * [APIServerConfigSpec.ExtraArgsEntry](#talos.resource.definitions.k8s.APIServerConfigSpec.ExtraArgsEntry) * [AdmissionControlConfigSpec](#talos.resource.definitions.k8s.AdmissionControlConfigSpec) * [AdmissionPluginSpec](#talos.resource.definitions.k8s.AdmissionPluginSpec) * [AuditPolicyConfigSpec](#talos.resource.definitions.k8s.AuditPolicyConfigSpec) * [AuthorizationAuthorizersSpec](#talos.resource.definitions.k8s.AuthorizationAuthorizersSpec) * [AuthorizationConfigSpec](#talos.resource.definitions.k8s.AuthorizationConfigSpec) * [BootstrapManifestsConfigSpec](#talos.resource.definitions.k8s.BootstrapManifestsConfigSpec) * [ConfigStatusSpec](#talos.resource.definitions.k8s.ConfigStatusSpec) * [ControllerManagerConfigSpec](#talos.resource.definitions.k8s.ControllerManagerConfigSpec) * [ControllerManagerConfigSpec.EnvironmentVariablesEntry](#talos.resource.definitions.k8s.ControllerManagerConfigSpec.EnvironmentVariablesEntry) * [ControllerManagerConfigSpec.ExtraArgsEntry](#talos.resource.definitions.k8s.ControllerManagerConfigSpec.ExtraArgsEntry) * [EndpointSpec](#talos.resource.definitions.k8s.EndpointSpec) * [ExtraManifest](#talos.resource.definitions.k8s.ExtraManifest) * [ExtraManifest.ExtraHeadersEntry](#talos.resource.definitions.k8s.ExtraManifest.ExtraHeadersEntry) * [ExtraManifestsConfigSpec](#talos.resource.definitions.k8s.ExtraManifestsConfigSpec) * [ExtraVolume](#talos.resource.definitions.k8s.ExtraVolume) * [KubePrismConfigSpec](#talos.resource.definitions.k8s.KubePrismConfigSpec) * [KubePrismEndpoint](#talos.resource.definitions.k8s.KubePrismEndpoint) * [KubePrismEndpointsSpec](#talos.resource.definitions.k8s.KubePrismEndpointsSpec) * [KubePrismStatusesSpec](#talos.resource.definitions.k8s.KubePrismStatusesSpec) * [KubeletConfigSpec](#talos.resource.definitions.k8s.KubeletConfigSpec) * [KubeletConfigSpec.ExtraArgsEntry](#talos.resource.definitions.k8s.KubeletConfigSpec.ExtraArgsEntry) * [KubeletSpecSpec](#talos.resource.definitions.k8s.KubeletSpecSpec) * [ManifestSpec](#talos.resource.definitions.k8s.ManifestSpec) * [ManifestStatusSpec](#talos.resource.definitions.k8s.ManifestStatusSpec) * [NodeAnnotationSpecSpec](#talos.resource.definitions.k8s.NodeAnnotationSpecSpec) * [NodeIPConfigSpec](#talos.resource.definitions.k8s.NodeIPConfigSpec) * [NodeIPSpec](#talos.resource.definitions.k8s.NodeIPSpec) * [NodeLabelSpecSpec](#talos.resource.definitions.k8s.NodeLabelSpecSpec) * [NodeStatusSpec](#talos.resource.definitions.k8s.NodeStatusSpec) * [NodeStatusSpec.AnnotationsEntry](#talos.resource.definitions.k8s.NodeStatusSpec.AnnotationsEntry) * [NodeStatusSpec.LabelsEntry](#talos.resource.definitions.k8s.NodeStatusSpec.LabelsEntry) * [NodeTaintSpecSpec](#talos.resource.definitions.k8s.NodeTaintSpecSpec) * [NodenameSpec](#talos.resource.definitions.k8s.NodenameSpec) * [Resources](#talos.resource.definitions.k8s.Resources) * [Resources.LimitsEntry](#talos.resource.definitions.k8s.Resources.LimitsEntry) * [Resources.RequestsEntry](#talos.resource.definitions.k8s.Resources.RequestsEntry) * [SchedulerConfigSpec](#talos.resource.definitions.k8s.SchedulerConfigSpec) * [SchedulerConfigSpec.EnvironmentVariablesEntry](#talos.resource.definitions.k8s.SchedulerConfigSpec.EnvironmentVariablesEntry) * [SchedulerConfigSpec.ExtraArgsEntry](#talos.resource.definitions.k8s.SchedulerConfigSpec.ExtraArgsEntry) * [SecretsStatusSpec](#talos.resource.definitions.k8s.SecretsStatusSpec) * [SingleManifest](#talos.resource.definitions.k8s.SingleManifest) * [StaticPodServerStatusSpec](#talos.resource.definitions.k8s.StaticPodServerStatusSpec) * [StaticPodSpec](#talos.resource.definitions.k8s.StaticPodSpec) * [StaticPodStatusSpec](#talos.resource.definitions.k8s.StaticPodStatusSpec) * [resource/definitions/kubeaccess/kubeaccess.proto](#resource/definitions/kubeaccess/kubeaccess.proto) * [ConfigSpec](#talos.resource.definitions.kubeaccess.ConfigSpec) * [resource/definitions/kubespan/kubespan.proto](#resource/definitions/kubespan/kubespan.proto) * [ConfigSpec](#talos.resource.definitions.kubespan.ConfigSpec) * [EndpointSpec](#talos.resource.definitions.kubespan.EndpointSpec) * [IdentitySpec](#talos.resource.definitions.kubespan.IdentitySpec) * [PeerSpecSpec](#talos.resource.definitions.kubespan.PeerSpecSpec) * [PeerStatusSpec](#talos.resource.definitions.kubespan.PeerStatusSpec) * [resource/definitions/runtime/runtime.proto](#resource/definitions/runtime/runtime.proto) * [BootedEntrySpec](#talos.resource.definitions.runtime.BootedEntrySpec) * [DevicesStatusSpec](#talos.resource.definitions.runtime.DevicesStatusSpec) * [DiagnosticSpec](#talos.resource.definitions.runtime.DiagnosticSpec) * [EventSinkConfigSpec](#talos.resource.definitions.runtime.EventSinkConfigSpec) * [ExtensionServiceConfigFile](#talos.resource.definitions.runtime.ExtensionServiceConfigFile) * [ExtensionServiceConfigSpec](#talos.resource.definitions.runtime.ExtensionServiceConfigSpec) * [ExtensionServiceConfigStatusSpec](#talos.resource.definitions.runtime.ExtensionServiceConfigStatusSpec) * [KernelCmdlineSpec](#talos.resource.definitions.runtime.KernelCmdlineSpec) * [KernelModuleSpecSpec](#talos.resource.definitions.runtime.KernelModuleSpecSpec) * [KernelParamSpecSpec](#talos.resource.definitions.runtime.KernelParamSpecSpec) * [KernelParamStatusSpec](#talos.resource.definitions.runtime.KernelParamStatusSpec) * [KmsgLogConfigSpec](#talos.resource.definitions.runtime.KmsgLogConfigSpec) * [LoadedKernelModuleSpec](#talos.resource.definitions.runtime.LoadedKernelModuleSpec) * [MachineStatusSpec](#talos.resource.definitions.runtime.MachineStatusSpec) * [MachineStatusStatus](#talos.resource.definitions.runtime.MachineStatusStatus) * [MaintenanceServiceConfigSpec](#talos.resource.definitions.runtime.MaintenanceServiceConfigSpec) * [MetaKeySpec](#talos.resource.definitions.runtime.MetaKeySpec) * [MetaLoadedSpec](#talos.resource.definitions.runtime.MetaLoadedSpec) * [MountStatusSpec](#talos.resource.definitions.runtime.MountStatusSpec) * [PlatformMetadataSpec](#talos.resource.definitions.runtime.PlatformMetadataSpec) * [PlatformMetadataSpec.TagsEntry](#talos.resource.definitions.runtime.PlatformMetadataSpec.TagsEntry) * [SBOMItemSpec](#talos.resource.definitions.runtime.SBOMItemSpec) * [SecurityStateSpec](#talos.resource.definitions.runtime.SecurityStateSpec) * [UniqueMachineTokenSpec](#talos.resource.definitions.runtime.UniqueMachineTokenSpec) * [UnmetCondition](#talos.resource.definitions.runtime.UnmetCondition) * [WatchdogTimerConfigSpec](#talos.resource.definitions.runtime.WatchdogTimerConfigSpec) * [WatchdogTimerStatusSpec](#talos.resource.definitions.runtime.WatchdogTimerStatusSpec) * [resource/definitions/network/network.proto](#resource/definitions/network/network.proto) * [AddressSpecSpec](#talos.resource.definitions.network.AddressSpecSpec) * [AddressStatusSpec](#talos.resource.definitions.network.AddressStatusSpec) * [BondMasterSpec](#talos.resource.definitions.network.BondMasterSpec) * [BondSlave](#talos.resource.definitions.network.BondSlave) * [BridgeMasterSpec](#talos.resource.definitions.network.BridgeMasterSpec) * [BridgeSlave](#talos.resource.definitions.network.BridgeSlave) * [BridgeVLANSpec](#talos.resource.definitions.network.BridgeVLANSpec) * [DHCP4OperatorSpec](#talos.resource.definitions.network.DHCP4OperatorSpec) * [DHCP6OperatorSpec](#talos.resource.definitions.network.DHCP6OperatorSpec) * [DNSResolveCacheSpec](#talos.resource.definitions.network.DNSResolveCacheSpec) * [EthernetChannelsSpec](#talos.resource.definitions.network.EthernetChannelsSpec) * [EthernetChannelsStatus](#talos.resource.definitions.network.EthernetChannelsStatus) * [EthernetFeatureStatus](#talos.resource.definitions.network.EthernetFeatureStatus) * [EthernetRingsSpec](#talos.resource.definitions.network.EthernetRingsSpec) * [EthernetRingsStatus](#talos.resource.definitions.network.EthernetRingsStatus) * [EthernetSpecSpec](#talos.resource.definitions.network.EthernetSpecSpec) * [EthernetSpecSpec.FeaturesEntry](#talos.resource.definitions.network.EthernetSpecSpec.FeaturesEntry) * [EthernetStatusSpec](#talos.resource.definitions.network.EthernetStatusSpec) * [HardwareAddrSpec](#talos.resource.definitions.network.HardwareAddrSpec) * [HostDNSConfigSpec](#talos.resource.definitions.network.HostDNSConfigSpec) * [HostnameSpecSpec](#talos.resource.definitions.network.HostnameSpecSpec) * [HostnameStatusSpec](#talos.resource.definitions.network.HostnameStatusSpec) * [LinkAliasSpecSpec](#talos.resource.definitions.network.LinkAliasSpecSpec) * [LinkRefreshSpec](#talos.resource.definitions.network.LinkRefreshSpec) * [LinkSpecSpec](#talos.resource.definitions.network.LinkSpecSpec) * [LinkStatusSpec](#talos.resource.definitions.network.LinkStatusSpec) * [NfTablesAddressMatch](#talos.resource.definitions.network.NfTablesAddressMatch) * [NfTablesChainSpec](#talos.resource.definitions.network.NfTablesChainSpec) * [NfTablesClampMSS](#talos.resource.definitions.network.NfTablesClampMSS) * [NfTablesConntrackStateMatch](#talos.resource.definitions.network.NfTablesConntrackStateMatch) * [NfTablesICMPTypeMatch](#talos.resource.definitions.network.NfTablesICMPTypeMatch) * [NfTablesIfNameMatch](#talos.resource.definitions.network.NfTablesIfNameMatch) * [NfTablesLayer4Match](#talos.resource.definitions.network.NfTablesLayer4Match) * [NfTablesLimitMatch](#talos.resource.definitions.network.NfTablesLimitMatch) * [NfTablesMark](#talos.resource.definitions.network.NfTablesMark) * [NfTablesPortMatch](#talos.resource.definitions.network.NfTablesPortMatch) * [NfTablesRule](#talos.resource.definitions.network.NfTablesRule) * [NodeAddressFilterSpec](#talos.resource.definitions.network.NodeAddressFilterSpec) * [NodeAddressSortAlgorithmSpec](#talos.resource.definitions.network.NodeAddressSortAlgorithmSpec) * [NodeAddressSpec](#talos.resource.definitions.network.NodeAddressSpec) * [OperatorSpecSpec](#talos.resource.definitions.network.OperatorSpecSpec) * [PlatformConfigSpec](#talos.resource.definitions.network.PlatformConfigSpec) * [PortRange](#talos.resource.definitions.network.PortRange) * [ProbeSpecSpec](#talos.resource.definitions.network.ProbeSpecSpec) * [ProbeStatusSpec](#talos.resource.definitions.network.ProbeStatusSpec) * [ResolverSpecSpec](#talos.resource.definitions.network.ResolverSpecSpec) * [ResolverStatusSpec](#talos.resource.definitions.network.ResolverStatusSpec) * [RouteSpecSpec](#talos.resource.definitions.network.RouteSpecSpec) * [RouteStatusSpec](#talos.resource.definitions.network.RouteStatusSpec) * [STPSpec](#talos.resource.definitions.network.STPSpec) * [StatusSpec](#talos.resource.definitions.network.StatusSpec) * [TCPProbeSpec](#talos.resource.definitions.network.TCPProbeSpec) * [TimeServerSpecSpec](#talos.resource.definitions.network.TimeServerSpecSpec) * [TimeServerStatusSpec](#talos.resource.definitions.network.TimeServerStatusSpec) * [VIPEquinixMetalSpec](#talos.resource.definitions.network.VIPEquinixMetalSpec) * [VIPHCloudSpec](#talos.resource.definitions.network.VIPHCloudSpec) * [VIPOperatorSpec](#talos.resource.definitions.network.VIPOperatorSpec) * [VLANSpec](#talos.resource.definitions.network.VLANSpec) * [WireguardPeer](#talos.resource.definitions.network.WireguardPeer) * [WireguardSpec](#talos.resource.definitions.network.WireguardSpec) * [resource/definitions/perf/perf.proto](#resource/definitions/perf/perf.proto) * [CPUSpec](#talos.resource.definitions.perf.CPUSpec) * [CPUStat](#talos.resource.definitions.perf.CPUStat) * [MemorySpec](#talos.resource.definitions.perf.MemorySpec) * [resource/definitions/secrets/secrets.proto](#resource/definitions/secrets/secrets.proto) * [APICertsSpec](#talos.resource.definitions.secrets.APICertsSpec) * [CertSANSpec](#talos.resource.definitions.secrets.CertSANSpec) * [EncryptionSaltSpec](#talos.resource.definitions.secrets.EncryptionSaltSpec) * [EtcdCertsSpec](#talos.resource.definitions.secrets.EtcdCertsSpec) * [EtcdRootSpec](#talos.resource.definitions.secrets.EtcdRootSpec) * [KubeletSpec](#talos.resource.definitions.secrets.KubeletSpec) * [KubernetesCertsSpec](#talos.resource.definitions.secrets.KubernetesCertsSpec) * [KubernetesDynamicCertsSpec](#talos.resource.definitions.secrets.KubernetesDynamicCertsSpec) * [KubernetesRootSpec](#talos.resource.definitions.secrets.KubernetesRootSpec) * [MaintenanceRootSpec](#talos.resource.definitions.secrets.MaintenanceRootSpec) * [MaintenanceServiceCertsSpec](#talos.resource.definitions.secrets.MaintenanceServiceCertsSpec) * [OSRootSpec](#talos.resource.definitions.secrets.OSRootSpec) * [TrustdCertsSpec](#talos.resource.definitions.secrets.TrustdCertsSpec) * [resource/definitions/siderolink/siderolink.proto](#resource/definitions/siderolink/siderolink.proto) * [ConfigSpec](#talos.resource.definitions.siderolink.ConfigSpec) * [StatusSpec](#talos.resource.definitions.siderolink.StatusSpec) * [TunnelSpec](#talos.resource.definitions.siderolink.TunnelSpec) * [resource/definitions/time/time.proto](#resource/definitions/time/time.proto) * [AdjtimeStatusSpec](#talos.resource.definitions.time.AdjtimeStatusSpec) * [StatusSpec](#talos.resource.definitions.time.StatusSpec) * [resource/definitions/v1alpha1/v1alpha1.proto](#resource/definitions/v1alpha1/v1alpha1.proto) * [ServiceSpec](#talos.resource.definitions.v1alpha1.ServiceSpec) * [resource/network/device\_config.proto](#resource/network/device_config.proto) * [DeviceConfigSpecSpec](#resource.network.DeviceConfigSpecSpec) * [security/security.proto](#security/security.proto) * [CertificateRequest](#securityapi.CertificateRequest) * [CertificateResponse](#securityapi.CertificateResponse) * [SecurityService](#securityapi.SecurityService) * [storage/storage.proto](#storage/storage.proto) * [BlockDeviceWipe](#storage.BlockDeviceWipe) * [BlockDeviceWipeDescriptor](#storage.BlockDeviceWipeDescriptor) * [BlockDeviceWipeRequest](#storage.BlockDeviceWipeRequest) * [BlockDeviceWipeResponse](#storage.BlockDeviceWipeResponse) * [Disk](#storage.Disk) * [Disks](#storage.Disks) * [DisksResponse](#storage.DisksResponse) * [BlockDeviceWipeDescriptor.Method](#storage.BlockDeviceWipeDescriptor.Method) * [Disk.DiskType](#storage.Disk.DiskType) * [StorageService](#storage.StorageService) * [time/time.proto](#time/time.proto) * [Time](#time.Time) * [TimeRequest](#time.TimeRequest) * [TimeResponse](#time.TimeResponse) * [TimeService](#time.TimeService) * [Scalar Value Types](#scalar-value-types)

Top

## common/common.proto ### Data | Field | Type | Label | Description | | -------- | ---------------------------- | ----- | ----------- | | metadata | [Metadata](#common.Metadata) | | | | bytes | [bytes](#bytes) | | | ### DataResponse | Field | Type | Label | Description | | -------- | -------------------- | -------- | ----------- | | messages | [Data](#common.Data) | repeated | | ### Empty | Field | Type | Label | Description | | -------- | ---------------------------- | ----- | ----------- | | metadata | [Metadata](#common.Metadata) | | | ### EmptyResponse | Field | Type | Label | Description | | -------- | ---------------------- | -------- | ----------- | | messages | [Empty](#common.Empty) | repeated | | ### Error | Field | Type | Label | Description | | ------- | ------------------------------------------- | -------- | ----------- | | code | [Code](#common.Code) | | | | message | [string](#string) | | | | details | [google.protobuf.Any](#google.protobuf.Any) | repeated | | ### Metadata Common metadata message nested in all reply message types | Field | Type | Label | Description | | -------- | --------------------------------------- | ----- | ------------------------------------------------------------------------------ | | hostname | [string](#string) | | hostname of the server response comes from (injected by proxy) | | error | [string](#string) | | error is set if request failed to the upstream (rest of response is undefined) | | status | [google.rpc.Status](#google.rpc.Status) | | error as gRPC Status | ### NetIP | Field | Type | Label | Description | | ----- | --------------- | ----- | ----------- | | ip | [bytes](#bytes) | | | ### NetIPPort | Field | Type | Label | Description | | ----- | --------------- | ----- | ----------- | | ip | [bytes](#bytes) | | | | port | [int32](#int32) | | | ### NetIPPrefix | Field | Type | Label | Description | | -------------- | --------------- | ----- | ----------- | | ip | [bytes](#bytes) | | | | prefix\_length | [int32](#int32) | | | ### PEMEncodedCertificate | Field | Type | Label | Description | | ----- | --------------- | ----- | ----------- | | crt | [bytes](#bytes) | | | ### PEMEncodedCertificateAndKey | Field | Type | Label | Description | | ----- | --------------- | ----- | ----------- | | crt | [bytes](#bytes) | | | | key | [bytes](#bytes) | | | ### PEMEncodedKey | Field | Type | Label | Description | | ----- | --------------- | ----- | ----------- | | key | [bytes](#bytes) | | | ### URL | Field | Type | Label | Description | | ---------- | ----------------- | ----- | ----------- | | full\_path | [string](#string) | | | ### Code | Name | Number | Description | | -------- | ------ | ----------- | | FATAL | 0 | | | LOCKED | 1 | | | CANCELED | 2 | | ### ContainerDriver | Name | Number | Description | | ---------- | ------ | ----------- | | CONTAINERD | 0 | | | CRI | 1 | | ### ContainerdNamespace | Name | Number | Description | | ----------- | ------ | ----------- | | NS\_UNKNOWN | 0 | | | NS\_SYSTEM | 1 | | | NS\_CRI | 2 | | ### File-level Extensions | Extension | Type | Base | Number | Description | | ------------------------------- | ------ | --------------------------------- | ------ | ------------------------------------------------------------------------------------- | | remove\_deprecated\_enum | string | .google.protobuf.EnumOptions | 93117 | Indicates the Talos version when this deprecated enum will be removed from API. | | remove\_deprecated\_enum\_value | string | .google.protobuf.EnumValueOptions | 93117 | Indicates the Talos version when this deprecated enum value will be removed from API. | | remove\_deprecated\_field | string | .google.protobuf.FieldOptions | 93117 | Indicates the Talos version when this deprecated filed will be removed from API. | | remove\_deprecated\_message | string | .google.protobuf.MessageOptions | 93117 | Indicates the Talos version when this deprecated message will be removed from API. | | remove\_deprecated\_method | string | .google.protobuf.MethodOptions | 93117 | Indicates the Talos version when this deprecated method will be removed from API. | | remove\_deprecated\_service | string | .google.protobuf.ServiceOptions | 93117 | Indicates the Talos version when this deprecated service will be removed from API. |

Top

## cluster/cluster.proto ### ClusterInfo | Field | Type | Label | Description | | --------------------- | ----------------- | -------- | ----------- | | control\_plane\_nodes | [string](#string) | repeated | | | worker\_nodes | [string](#string) | repeated | | | force\_endpoint | [string](#string) | | | ### HealthCheckProgress | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | message | [string](#string) | | | ### HealthCheckRequest | Field | Type | Label | Description | | ------------- | ----------------------------------------------------- | ----- | ----------- | | wait\_timeout | [google.protobuf.Duration](#google.protobuf.Duration) | | | | cluster\_info | [ClusterInfo](#cluster.ClusterInfo) | | | ### ClusterService The cluster service definition. | Method Name | Request Type | Response Type | Description | | ----------- | ------------------------------------------------- | ---------------------------------------------------------- | ----------- | | HealthCheck | [HealthCheckRequest](#cluster.HealthCheckRequest) | [HealthCheckProgress](#cluster.HealthCheckProgress) stream | |

Top

## inspect/inspect.proto ### ControllerDependencyEdge | Field | Type | Label | Description | | ------------------- | ------------------------------------------------- | ----- | ----------- | | controller\_name | [string](#string) | | | | edge\_type | [DependencyEdgeType](#inspect.DependencyEdgeType) | | | | resource\_namespace | [string](#string) | | | | resource\_type | [string](#string) | | | | resource\_id | [string](#string) | | | ### ControllerRuntimeDependenciesResponse | Field | Type | Label | Description | | -------- | ------------------------------------------------------------------- | -------- | ----------- | | messages | [ControllerRuntimeDependency](#inspect.ControllerRuntimeDependency) | repeated | | ### ControllerRuntimeDependency The ControllerRuntimeDependency message contains the graph of controller-resource dependencies. | Field | Type | Label | Description | | -------- | ------------------------------------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | edges | [ControllerDependencyEdge](#inspect.ControllerDependencyEdge) | repeated | | ### DependencyEdgeType | Name | Number | Description | | --------------------- | ------ | ----------- | | OUTPUT\_EXCLUSIVE | 0 | | | OUTPUT\_SHARED | 3 | | | INPUT\_STRONG | 1 | | | INPUT\_WEAK | 2 | | | INPUT\_DESTROY\_READY | 4 | | ### InspectService The inspect service definition. InspectService provides auxiliary API to inspect OS internals. | Method Name | Request Type | Response Type | Description | | ----------------------------- | ------------------------------------------------ | --------------------------------------------------------------------------------------- | ----------- | | ControllerRuntimeDependencies | [.google.protobuf.Empty](#google.protobuf.Empty) | [ControllerRuntimeDependenciesResponse](#inspect.ControllerRuntimeDependenciesResponse) | |

Top

## machine/machine.proto ### AddressEvent AddressEvent reports node endpoints aggregated from k8s.Endpoints and network.Hostname. | Field | Type | Label | Description | | --------- | ----------------- | -------- | ----------- | | hostname | [string](#string) | | | | addresses | [string](#string) | repeated | | ### ApplyConfiguration ApplyConfigurationResponse describes the response to a configuration request. | Field | Type | Label | Description | | ------------- | ------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------- | | metadata | [common.Metadata](#common.Metadata) | | | | warnings | [string](#string) | repeated | Configuration validation warnings. | | mode | [ApplyConfigurationRequest.Mode](#machine.ApplyConfigurationRequest.Mode) | | States which mode was actually chosen. | | mode\_details | [string](#string) | | Human-readable message explaining the result of the apply configuration call. | ### ApplyConfigurationRequest rpc applyConfiguration ApplyConfiguration describes a request to assert a new configuration upon a node. | Field | Type | Label | Description | | ------------------ | ------------------------------------------------------------------------- | ----- | ----------- | | data | [bytes](#bytes) | | | | mode | [ApplyConfigurationRequest.Mode](#machine.ApplyConfigurationRequest.Mode) | | | | dry\_run | [bool](#bool) | | | | try\_mode\_timeout | [google.protobuf.Duration](#google.protobuf.Duration) | | | ### ApplyConfigurationResponse | Field | Type | Label | Description | | -------- | ------------------------------------------------- | -------- | ----------- | | messages | [ApplyConfiguration](#machine.ApplyConfiguration) | repeated | | ### BPFInstruction | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | op | [uint32](#uint32) | | | | jt | [uint32](#uint32) | | | | jf | [uint32](#uint32) | | | | k | [uint32](#uint32) | | | ### Bootstrap The bootstrap message containing the bootstrap status. | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | ### BootstrapRequest rpc Bootstrap | Field | Type | Label | Description | | -------------------------- | ------------- | ----- | --------------------------------------------------------------------------------------------------------------------- | | recover\_etcd | [bool](#bool) | | Enable etcd recovery from the snapshot. Snapshot should be uploaded before this call via EtcdRecover RPC. | | recover\_skip\_hash\_check | [bool](#bool) | | Skip hash check on the snapshot (etcd). Enable this when recovering from data directory copy to skip integrity check. | ### BootstrapResponse | Field | Type | Label | Description | | -------- | ------------------------------- | -------- | ----------- | | messages | [Bootstrap](#machine.Bootstrap) | repeated | | ### CNIConfig | Field | Type | Label | Description | | ----- | ----------------- | -------- | ----------- | | name | [string](#string) | | | | urls | [string](#string) | repeated | | ### CPUFreqStats | Field | Type | Label | Description | | ------------------ | ----------------- | ----- | ----------- | | current\_frequency | [uint64](#uint64) | | | | minimum\_frequency | [uint64](#uint64) | | | | maximum\_frequency | [uint64](#uint64) | | | | governor | [string](#string) | | | ### CPUFreqStatsResponse | Field | Type | Label | Description | | -------- | --------------------------------------- | -------- | ----------- | | messages | [CPUsFreqStats](#machine.CPUsFreqStats) | repeated | | ### CPUInfo | Field | Type | Label | Description | | ----------------- | ----------------- | -------- | ----------- | | processor | [uint32](#uint32) | | | | vendor\_id | [string](#string) | | | | cpu\_family | [string](#string) | | | | model | [string](#string) | | | | model\_name | [string](#string) | | | | stepping | [string](#string) | | | | microcode | [string](#string) | | | | cpu\_mhz | [double](#double) | | | | cache\_size | [string](#string) | | | | physical\_id | [string](#string) | | | | siblings | [uint32](#uint32) | | | | core\_id | [string](#string) | | | | cpu\_cores | [uint32](#uint32) | | | | apic\_id | [string](#string) | | | | initial\_apic\_id | [string](#string) | | | | fpu | [string](#string) | | | | fpu\_exception | [string](#string) | | | | cpu\_id\_level | [uint32](#uint32) | | | | wp | [string](#string) | | | | flags | [string](#string) | repeated | | | bugs | [string](#string) | repeated | | | bogo\_mips | [double](#double) | | | | cl\_flush\_size | [uint32](#uint32) | | | | cache\_alignment | [uint32](#uint32) | | | | address\_sizes | [string](#string) | | | | power\_management | [string](#string) | | | ### CPUInfoResponse | Field | Type | Label | Description | | -------- | ----------------------------- | -------- | ----------- | | messages | [CPUsInfo](#machine.CPUsInfo) | repeated | | ### CPUStat | Field | Type | Label | Description | | ----------- | ----------------- | ----- | ----------- | | user | [double](#double) | | | | nice | [double](#double) | | | | system | [double](#double) | | | | idle | [double](#double) | | | | iowait | [double](#double) | | | | irq | [double](#double) | | | | soft\_irq | [double](#double) | | | | steal | [double](#double) | | | | guest | [double](#double) | | | | guest\_nice | [double](#double) | | | ### CPUsFreqStats | Field | Type | Label | Description | | ---------------- | ------------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | cpu\_freq\_stats | [CPUFreqStats](#machine.CPUFreqStats) | repeated | | ### CPUsInfo | Field | Type | Label | Description | | --------- | ----------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | cpu\_info | [CPUInfo](#machine.CPUInfo) | repeated | | ### ClusterConfig | Field | Type | Label | Description | | -------------------------------------- | ----------------------------------------------------- | ----- | ----------- | | name | [string](#string) | | | | control\_plane | [ControlPlaneConfig](#machine.ControlPlaneConfig) | | | | cluster\_network | [ClusterNetworkConfig](#machine.ClusterNetworkConfig) | | | | allow\_scheduling\_on\_control\_planes | [bool](#bool) | | | ### ClusterNetworkConfig | Field | Type | Label | Description | | ----------- | ------------------------------- | ----- | ----------- | | dns\_domain | [string](#string) | | | | cni\_config | [CNIConfig](#machine.CNIConfig) | | | ### ConfigLoadErrorEvent ConfigLoadErrorEvent is reported when the config loading has failed. | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | error | [string](#string) | | | ### ConfigValidationErrorEvent ConfigValidationErrorEvent is reported when config validation has failed. | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | error | [string](#string) | | | ### ConnectRecord | Field | Type | Label | Description | | ---------- | --------------------------------------------------------------- | ----- | ----------- | | l4proto | [string](#string) | | | | localip | [string](#string) | | | | localport | [uint32](#uint32) | | | | remoteip | [string](#string) | | | | remoteport | [uint32](#uint32) | | | | state | [ConnectRecord.State](#machine.ConnectRecord.State) | | | | txqueue | [uint64](#uint64) | | | | rxqueue | [uint64](#uint64) | | | | tr | [ConnectRecord.TimerActive](#machine.ConnectRecord.TimerActive) | | | | timerwhen | [uint64](#uint64) | | | | retrnsmt | [uint64](#uint64) | | | | uid | [uint32](#uint32) | | | | timeout | [uint64](#uint64) | | | | inode | [uint64](#uint64) | | | | ref | [uint64](#uint64) | | | | pointer | [uint64](#uint64) | | | | process | [ConnectRecord.Process](#machine.ConnectRecord.Process) | | | | netns | [string](#string) | | | ### ConnectRecord.Process | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | pid | [uint32](#uint32) | | | | name | [string](#string) | | | ### Container The messages message containing the requested containers. | Field | Type | Label | Description | | ---------- | --------------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | containers | [ContainerInfo](#machine.ContainerInfo) | repeated | | ### ContainerInfo The messages message containing the requested containers. | Field | Type | Label | Description | | ------------------ | ----------------- | ----- | ----------- | | namespace | [string](#string) | | | | id | [string](#string) | | | | uid | [string](#string) | | | | internal\_id | [string](#string) | | | | image | [string](#string) | | | | pid | [uint32](#uint32) | | | | status | [string](#string) | | | | pod\_id | [string](#string) | | | | name | [string](#string) | | | | network\_namespace | [string](#string) | | | ### ContainersRequest | Field | Type | Label | Description | | --------- | ------------------------------------------------- | ----- | --------------------------------------------- | | namespace | [string](#string) | | | | driver | [common.ContainerDriver](#common.ContainerDriver) | | driver might be default "containerd" or "cri" | ### ContainersResponse | Field | Type | Label | Description | | -------- | ------------------------------- | -------- | ----------- | | messages | [Container](#machine.Container) | repeated | | ### ControlPlaneConfig | Field | Type | Label | Description | | -------- | ----------------- | ----- | ----------- | | endpoint | [string](#string) | | | ### CopyRequest CopyRequest describes a request to copy data out of Talos node Copy produces .tar.gz archive which is streamed back to the caller | Field | Type | Label | Description | | ---------- | ----------------- | ----- | --------------------------------------------------------------------------- | | root\_path | [string](#string) | | Root path to start copying data out, it might be either a file or directory | ### DHCPOptionsConfig | Field | Type | Label | Description | | ------------- | ----------------- | ----- | ----------- | | route\_metric | [uint32](#uint32) | | | ### DiskStat | Field | Type | Label | Description | | ---------------------- | ----------------- | ----- | ----------- | | name | [string](#string) | | | | read\_completed | [uint64](#uint64) | | | | read\_merged | [uint64](#uint64) | | | | read\_sectors | [uint64](#uint64) | | | | read\_time\_ms | [uint64](#uint64) | | | | write\_completed | [uint64](#uint64) | | | | write\_merged | [uint64](#uint64) | | | | write\_sectors | [uint64](#uint64) | | | | write\_time\_ms | [uint64](#uint64) | | | | io\_in\_progress | [uint64](#uint64) | | | | io\_time\_ms | [uint64](#uint64) | | | | io\_time\_weighted\_ms | [uint64](#uint64) | | | | discard\_completed | [uint64](#uint64) | | | | discard\_merged | [uint64](#uint64) | | | | discard\_sectors | [uint64](#uint64) | | | | discard\_time\_ms | [uint64](#uint64) | | | ### DiskStats | Field | Type | Label | Description | | -------- | ----------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | total | [DiskStat](#machine.DiskStat) | | | | devices | [DiskStat](#machine.DiskStat) | repeated | | ### DiskStatsResponse | Field | Type | Label | Description | | -------- | ------------------------------- | -------- | ----------- | | messages | [DiskStats](#machine.DiskStats) | repeated | | ### DiskUsageInfo DiskUsageInfo describes a file or directory's information for du command | Field | Type | Label | Description | | -------------- | ----------------------------------- | ----- | -------------------------------------------------------------------------------- | | metadata | [common.Metadata](#common.Metadata) | | | | name | [string](#string) | | Name is the name (including prefixed path) of the file or directory | | size | [int64](#int64) | | Size indicates the number of bytes contained within the file | | error | [string](#string) | | Error describes any error encountered while trying to read the file information. | | relative\_name | [string](#string) | | RelativeName is the name of the file or directory relative to the RootPath | ### DiskUsageRequest DiskUsageRequest describes a request to list disk usage of directories and regular files | Field | Type | Label | Description | | ---------------- | ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | recursion\_depth | [int32](#int32) | | RecursionDepth indicates how many levels of subdirectories should be recursed. The default (0) indicates that no limit should be enforced. | | all | [bool](#bool) | | All write sizes for all files, not just directories. | | threshold | [int64](#int64) | | Threshold exclude entries smaller than SIZE if positive, or entries greater than SIZE if negative. | | paths | [string](#string) | repeated | DiskUsagePaths is the list of directories to calculate disk usage for. | ### DmesgRequest dmesg | Field | Type | Label | Description | | ------ | ------------- | ----- | ----------- | | follow | [bool](#bool) | | | | tail | [bool](#bool) | | | ### EtcdAlarm | Field | Type | Label | Description | | -------------- | ------------------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | member\_alarms | [EtcdMemberAlarm](#machine.EtcdMemberAlarm) | repeated | | ### EtcdAlarmDisarm | Field | Type | Label | Description | | -------------- | ------------------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | member\_alarms | [EtcdMemberAlarm](#machine.EtcdMemberAlarm) | repeated | | ### EtcdAlarmDisarmResponse | Field | Type | Label | Description | | -------- | ------------------------------------------- | -------- | ----------- | | messages | [EtcdAlarmDisarm](#machine.EtcdAlarmDisarm) | repeated | | ### EtcdAlarmListResponse | Field | Type | Label | Description | | -------- | ------------------------------- | -------- | ----------- | | messages | [EtcdAlarm](#machine.EtcdAlarm) | repeated | | ### EtcdClusterDowngrade | Field | Type | Label | Description | | ---------------- | ----------------- | ----- | ----------- | | cluster\_version | [string](#string) | | | ### EtcdDefragment | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | ### EtcdDefragmentResponse | Field | Type | Label | Description | | -------- | ----------------------------------------- | -------- | ----------- | | messages | [EtcdDefragment](#machine.EtcdDefragment) | repeated | | ### EtcdDowngradeCancel | Field | Type | Label | Description | | ------------------ | ----------------------------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | cluster\_downgrade | [EtcdClusterDowngrade](#machine.EtcdClusterDowngrade) | | | ### EtcdDowngradeCancelResponse | Field | Type | Label | Description | | -------- | --------------------------------------------------- | -------- | ----------- | | messages | [EtcdDowngradeCancel](#machine.EtcdDowngradeCancel) | repeated | | ### EtcdDowngradeEnable | Field | Type | Label | Description | | ------------------ | ----------------------------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | cluster\_downgrade | [EtcdClusterDowngrade](#machine.EtcdClusterDowngrade) | | | ### EtcdDowngradeEnableRequest | Field | Type | Label | Description | | ------- | ----------------- | ----- | ----------- | | version | [string](#string) | | | ### EtcdDowngradeEnableResponse | Field | Type | Label | Description | | -------- | --------------------------------------------------- | -------- | ----------- | | messages | [EtcdDowngradeEnable](#machine.EtcdDowngradeEnable) | repeated | | ### EtcdDowngradeValidate | Field | Type | Label | Description | | ------------------ | ----------------------------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | cluster\_downgrade | [EtcdClusterDowngrade](#machine.EtcdClusterDowngrade) | | | ### EtcdDowngradeValidateRequest | Field | Type | Label | Description | | ------- | ----------------- | ----- | ----------- | | version | [string](#string) | | | ### EtcdDowngradeValidateResponse | Field | Type | Label | Description | | -------- | ------------------------------------------------------- | -------- | ----------- | | messages | [EtcdDowngradeValidate](#machine.EtcdDowngradeValidate) | repeated | | ### EtcdForfeitLeadership | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | member | [string](#string) | | | ### EtcdForfeitLeadershipRequest ### EtcdForfeitLeadershipResponse | Field | Type | Label | Description | | -------- | ------------------------------------------------------- | -------- | ----------- | | messages | [EtcdForfeitLeadership](#machine.EtcdForfeitLeadership) | repeated | | ### EtcdLeaveCluster | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | ### EtcdLeaveClusterRequest ### EtcdLeaveClusterResponse | Field | Type | Label | Description | | -------- | --------------------------------------------- | -------- | ----------- | | messages | [EtcdLeaveCluster](#machine.EtcdLeaveCluster) | repeated | | ### EtcdMember EtcdMember describes a single etcd member. | Field | Type | Label | Description | | ------------ | ----------------- | -------- | --------------------------------------------------------------------- | | id | [uint64](#uint64) | | member ID. | | hostname | [string](#string) | | human-readable name of the member. | | peer\_urls | [string](#string) | repeated | the list of URLs the member exposes to clients for communication. | | client\_urls | [string](#string) | repeated | the list of URLs the member exposes to the cluster for communication. | | is\_learner | [bool](#bool) | | learner flag | ### EtcdMemberAlarm | Field | Type | Label | Description | | ---------- | --------------------------------------------------------------- | ----- | ----------- | | member\_id | [uint64](#uint64) | | | | alarm | [EtcdMemberAlarm.AlarmType](#machine.EtcdMemberAlarm.AlarmType) | | | ### EtcdMemberListRequest | Field | Type | Label | Description | | ------------ | ------------- | ----- | ----------- | | query\_local | [bool](#bool) | | | ### EtcdMemberListResponse | Field | Type | Label | Description | | -------- | ----------------------------------- | -------- | ----------- | | messages | [EtcdMembers](#machine.EtcdMembers) | repeated | | ### EtcdMemberStatus | Field | Type | Label | Description | | -------------------- | ----------------- | -------- | ----------- | | storage\_version | [string](#string) | | | | member\_id | [uint64](#uint64) | | | | protocol\_version | [string](#string) | | | | db\_size | [int64](#int64) | | | | db\_size\_in\_use | [int64](#int64) | | | | leader | [uint64](#uint64) | | | | raft\_index | [uint64](#uint64) | | | | raft\_term | [uint64](#uint64) | | | | raft\_applied\_index | [uint64](#uint64) | | | | errors | [string](#string) | repeated | | | is\_learner | [bool](#bool) | | | ### EtcdMembers EtcdMembers contains the list of members registered on the host. | Field | Type | Label | Description | | --------------- | ----------------------------------- | -------- | ------------------------------------------------ | | metadata | [common.Metadata](#common.Metadata) | | | | legacy\_members | [string](#string) | repeated | list of member hostnames. | | members | [EtcdMember](#machine.EtcdMember) | repeated | the list of etcd members registered on the node. | ### EtcdRecover | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | ### EtcdRecoverResponse | Field | Type | Label | Description | | -------- | ----------------------------------- | -------- | ----------- | | messages | [EtcdRecover](#machine.EtcdRecover) | repeated | | ### EtcdRemoveMember | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | ### EtcdRemoveMemberByID | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | ### EtcdRemoveMemberByIDRequest | Field | Type | Label | Description | | ---------- | ----------------- | ----- | ----------- | | member\_id | [uint64](#uint64) | | | ### EtcdRemoveMemberByIDResponse | Field | Type | Label | Description | | -------- | ----------------------------------------------------- | -------- | ----------- | | messages | [EtcdRemoveMemberByID](#machine.EtcdRemoveMemberByID) | repeated | | ### EtcdRemoveMemberRequest | Field | Type | Label | Description | | ------ | ----------------- | ----- | ----------- | | member | [string](#string) | | | ### EtcdRemoveMemberResponse | Field | Type | Label | Description | | -------- | --------------------------------------------- | -------- | ----------- | | messages | [EtcdRemoveMember](#machine.EtcdRemoveMember) | repeated | | ### EtcdSnapshotRequest ### EtcdStatus | Field | Type | Label | Description | | -------------- | --------------------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | member\_status | [EtcdMemberStatus](#machine.EtcdMemberStatus) | | | ### EtcdStatusResponse | Field | Type | Label | Description | | -------- | --------------------------------- | -------- | ----------- | | messages | [EtcdStatus](#machine.EtcdStatus) | repeated | | ### Event | Field | Type | Label | Description | | --------- | ------------------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | data | [google.protobuf.Any](#google.protobuf.Any) | | | | id | [string](#string) | | | | actor\_id | [string](#string) | | | ### EventsRequest | Field | Type | Label | Description | | --------------- | ----------------- | ----- | ----------- | | tail\_events | [int32](#int32) | | | | tail\_id | [string](#string) | | | | tail\_seconds | [int32](#int32) | | | | with\_actor\_id | [string](#string) | | | ### FeaturesInfo FeaturesInfo describes individual Talos features that can be switched on or off. | Field | Type | Label | Description | | ----- | ------------- | ----- | ----------------------------------------------------- | | rbac | [bool](#bool) | | RBAC is true if role-based access control is enabled. | ### FileInfo FileInfo describes a file or directory's information | Field | Type | Label | Description | | -------------- | ----------------------------------- | -------- | -------------------------------------------------------------------------------- | | metadata | [common.Metadata](#common.Metadata) | | | | name | [string](#string) | | Name is the name (including prefixed path) of the file or directory | | size | [int64](#int64) | | Size indicates the number of bytes contained within the file | | mode | [uint32](#uint32) | | Mode is the bitmap of UNIX mode/permission flags of the file | | modified | [int64](#int64) | | Modified indicates the UNIX timestamp at which the file was last modified | | is\_dir | [bool](#bool) | | IsDir indicates that the file is a directory | | error | [string](#string) | | Error describes any error encountered while trying to read the file information. | | link | [string](#string) | | Link is filled with symlink target | | relative\_name | [string](#string) | | RelativeName is the name of the file or directory relative to the RootPath | | uid | [uint32](#uint32) | | Owner uid | | gid | [uint32](#uint32) | | Owner gid | | xattrs | [Xattr](#machine.Xattr) | repeated | Extended attributes (if present and requested) | ### GenerateClientConfiguration | Field | Type | Label | Description | | ----------- | ----------------------------------- | ----- | ------------------------------------------------ | | metadata | [common.Metadata](#common.Metadata) | | | | ca | [bytes](#bytes) | | PEM-encoded CA certificate. | | crt | [bytes](#bytes) | | PEM-encoded generated client certificate. | | key | [bytes](#bytes) | | PEM-encoded generated client key. | | talosconfig | [bytes](#bytes) | | Client configuration (talosconfig) file content. | ### GenerateClientConfigurationRequest | Field | Type | Label | Description | | -------- | ----------------------------------------------------- | -------- | ------------------------------------------ | | roles | [string](#string) | repeated | Roles in the generated client certificate. | | crt\_ttl | [google.protobuf.Duration](#google.protobuf.Duration) | | Client certificate TTL. | ### GenerateClientConfigurationResponse | Field | Type | Label | Description | | -------- | ------------------------------------------------------------------- | -------- | ----------- | | messages | [GenerateClientConfiguration](#machine.GenerateClientConfiguration) | repeated | | ### GenerateConfiguration GenerateConfiguration describes the response to a generate configuration request. | Field | Type | Label | Description | | ----------- | ----------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | data | [bytes](#bytes) | repeated | | | talosconfig | [bytes](#bytes) | | | ### GenerateConfigurationRequest GenerateConfigurationRequest describes a request to generate a new configuration on a node. | Field | Type | Label | Description | | --------------- | ------------------------------------------------------- | ----- | ----------- | | config\_version | [string](#string) | | | | cluster\_config | [ClusterConfig](#machine.ClusterConfig) | | | | machine\_config | [MachineConfig](#machine.MachineConfig) | | | | override\_time | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | | ### GenerateConfigurationResponse | Field | Type | Label | Description | | -------- | ------------------------------------------------------- | -------- | ----------- | | messages | [GenerateConfiguration](#machine.GenerateConfiguration) | repeated | | ### Hostname | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | hostname | [string](#string) | | | ### HostnameResponse | Field | Type | Label | Description | | -------- | ----------------------------- | -------- | ----------- | | messages | [Hostname](#machine.Hostname) | repeated | | ### ImageListRequest | Field | Type | Label | Description | | --------- | --------------------------------------------------------- | ----- | ---------------------------- | | namespace | [common.ContainerdNamespace](#common.ContainerdNamespace) | | Containerd namespace to use. | ### ImageListResponse | Field | Type | Label | Description | | ----------- | ------------------------------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | name | [string](#string) | | | | digest | [string](#string) | | | | size | [int64](#int64) | | | | created\_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | | ### ImagePull | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | ### ImagePullRequest | Field | Type | Label | Description | | --------- | --------------------------------------------------------- | ----- | ---------------------------- | | namespace | [common.ContainerdNamespace](#common.ContainerdNamespace) | | Containerd namespace to use. | | reference | [string](#string) | | Image reference to pull. | ### ImagePullResponse | Field | Type | Label | Description | | -------- | ------------------------------- | -------- | ----------- | | messages | [ImagePull](#machine.ImagePull) | repeated | | ### InstallConfig | Field | Type | Label | Description | | -------------- | ----------------- | ----- | ----------- | | install\_disk | [string](#string) | | | | install\_image | [string](#string) | | | ### ListRequest ListRequest describes a request to list the contents of a directory. | Field | Type | Label | Description | | ---------------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | root | [string](#string) | | Root indicates the root directory for the list. If not indicated, '/' is presumed. | | recurse | [bool](#bool) | | Recurse indicates that subdirectories should be recursed. | | recursion\_depth | [int32](#int32) | | RecursionDepth indicates how many levels of subdirectories should be recursed. The default (0) indicates that no limit should be enforced. | | types | [ListRequest.Type](#machine.ListRequest.Type) | repeated | Types indicates what file type should be returned. If not indicated, all files will be returned. | | report\_xattrs | [bool](#bool) | | Report xattrs | ### LoadAvg | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | load1 | [double](#double) | | | | load5 | [double](#double) | | | | load15 | [double](#double) | | | ### LoadAvgResponse | Field | Type | Label | Description | | -------- | --------------------------- | -------- | ----------- | | messages | [LoadAvg](#machine.LoadAvg) | repeated | | ### LogsContainer LogsContainer desribes all avalaible registered log containers. | Field | Type | Label | Description | | -------- | ----------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | ids | [string](#string) | repeated | | ### LogsContainersResponse | Field | Type | Label | Description | | -------- | --------------------------------------- | -------- | ----------- | | messages | [LogsContainer](#machine.LogsContainer) | repeated | | ### LogsRequest rpc logs The request message containing the process name. | Field | Type | Label | Description | | ----------- | ------------------------------------------------- | ----- | --------------------------------------------- | | namespace | [string](#string) | | | | id | [string](#string) | | | | driver | [common.ContainerDriver](#common.ContainerDriver) | | driver might be default "containerd" or "cri" | | follow | [bool](#bool) | | | | tail\_lines | [int32](#int32) | | | ### MachineConfig | Field | Type | Label | Description | | ------------------- | --------------------------------------------------------------- | ----- | ----------- | | type | [MachineConfig.MachineType](#machine.MachineConfig.MachineType) | | | | install\_config | [InstallConfig](#machine.InstallConfig) | | | | network\_config | [NetworkConfig](#machine.NetworkConfig) | | | | kubernetes\_version | [string](#string) | | | ### MachineStatusEvent MachineStatusEvent reports changes to the MachineStatus resource. | Field | Type | Label | Description | | ------ | ----------------------------------------------------------------------------- | ----- | ----------- | | stage | [MachineStatusEvent.MachineStage](#machine.MachineStatusEvent.MachineStage) | | | | status | [MachineStatusEvent.MachineStatus](#machine.MachineStatusEvent.MachineStatus) | | | ### MachineStatusEvent.MachineStatus | Field | Type | Label | Description | | ----------------- | ----------------------------------------------------------------------------------------------------------- | -------- | ----------- | | ready | [bool](#bool) | | | | unmet\_conditions | [MachineStatusEvent.MachineStatus.UnmetCondition](#machine.MachineStatusEvent.MachineStatus.UnmetCondition) | repeated | | ### MachineStatusEvent.MachineStatus.UnmetCondition | Field | Type | Label | Description | | ------ | ----------------- | ----- | ----------- | | name | [string](#string) | | | | reason | [string](#string) | | | ### MemInfo | Field | Type | Label | Description | | ----------------- | ----------------- | ----- | ----------- | | memtotal | [uint64](#uint64) | | | | memfree | [uint64](#uint64) | | | | memavailable | [uint64](#uint64) | | | | buffers | [uint64](#uint64) | | | | cached | [uint64](#uint64) | | | | swapcached | [uint64](#uint64) | | | | active | [uint64](#uint64) | | | | inactive | [uint64](#uint64) | | | | activeanon | [uint64](#uint64) | | | | inactiveanon | [uint64](#uint64) | | | | activefile | [uint64](#uint64) | | | | inactivefile | [uint64](#uint64) | | | | unevictable | [uint64](#uint64) | | | | mlocked | [uint64](#uint64) | | | | swaptotal | [uint64](#uint64) | | | | swapfree | [uint64](#uint64) | | | | dirty | [uint64](#uint64) | | | | writeback | [uint64](#uint64) | | | | anonpages | [uint64](#uint64) | | | | mapped | [uint64](#uint64) | | | | shmem | [uint64](#uint64) | | | | slab | [uint64](#uint64) | | | | sreclaimable | [uint64](#uint64) | | | | sunreclaim | [uint64](#uint64) | | | | kernelstack | [uint64](#uint64) | | | | pagetables | [uint64](#uint64) | | | | nfsunstable | [uint64](#uint64) | | | | bounce | [uint64](#uint64) | | | | writebacktmp | [uint64](#uint64) | | | | commitlimit | [uint64](#uint64) | | | | committedas | [uint64](#uint64) | | | | vmalloctotal | [uint64](#uint64) | | | | vmallocused | [uint64](#uint64) | | | | vmallocchunk | [uint64](#uint64) | | | | hardwarecorrupted | [uint64](#uint64) | | | | anonhugepages | [uint64](#uint64) | | | | shmemhugepages | [uint64](#uint64) | | | | shmempmdmapped | [uint64](#uint64) | | | | cmatotal | [uint64](#uint64) | | | | cmafree | [uint64](#uint64) | | | | hugepagestotal | [uint64](#uint64) | | | | hugepagesfree | [uint64](#uint64) | | | | hugepagesrsvd | [uint64](#uint64) | | | | hugepagessurp | [uint64](#uint64) | | | | hugepagesize | [uint64](#uint64) | | | | directmap4k | [uint64](#uint64) | | | | directmap2m | [uint64](#uint64) | | | | directmap1g | [uint64](#uint64) | | | ### Memory | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | meminfo | [MemInfo](#machine.MemInfo) | | | ### MemoryResponse | Field | Type | Label | Description | | -------- | ------------------------- | -------- | ----------- | | messages | [Memory](#machine.Memory) | repeated | | ### MetaDelete | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | ### MetaDeleteRequest | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [uint32](#uint32) | | | ### MetaDeleteResponse | Field | Type | Label | Description | | -------- | --------------------------------- | -------- | ----------- | | messages | [MetaDelete](#machine.MetaDelete) | repeated | | ### MetaWrite | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | ### MetaWriteRequest | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [uint32](#uint32) | | | | value | [bytes](#bytes) | | | ### MetaWriteResponse | Field | Type | Label | Description | | -------- | ------------------------------- | -------- | ----------- | | messages | [MetaWrite](#machine.MetaWrite) | repeated | | ### MountStat The messages message containing the requested processes. | Field | Type | Label | Description | | ----------- | ----------------- | ----- | ----------- | | filesystem | [string](#string) | | | | size | [uint64](#uint64) | | | | available | [uint64](#uint64) | | | | mounted\_on | [string](#string) | | | ### Mounts The messages message containing the requested df stats. | Field | Type | Label | Description | | -------- | ----------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | stats | [MountStat](#machine.MountStat) | repeated | | ### MountsResponse | Field | Type | Label | Description | | -------- | ------------------------- | -------- | ----------- | | messages | [Mounts](#machine.Mounts) | repeated | | ### NetDev | Field | Type | Label | Description | | -------------- | ----------------- | ----- | ----------- | | name | [string](#string) | | | | rx\_bytes | [uint64](#uint64) | | | | rx\_packets | [uint64](#uint64) | | | | rx\_errors | [uint64](#uint64) | | | | rx\_dropped | [uint64](#uint64) | | | | rx\_fifo | [uint64](#uint64) | | | | rx\_frame | [uint64](#uint64) | | | | rx\_compressed | [uint64](#uint64) | | | | rx\_multicast | [uint64](#uint64) | | | | tx\_bytes | [uint64](#uint64) | | | | tx\_packets | [uint64](#uint64) | | | | tx\_errors | [uint64](#uint64) | | | | tx\_dropped | [uint64](#uint64) | | | | tx\_fifo | [uint64](#uint64) | | | | tx\_collisions | [uint64](#uint64) | | | | tx\_carrier | [uint64](#uint64) | | | | tx\_compressed | [uint64](#uint64) | | | ### Netstat | Field | Type | Label | Description | | ------------- | --------------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | connectrecord | [ConnectRecord](#machine.ConnectRecord) | repeated | | ### NetstatRequest | Field | Type | Label | Description | | ------- | --------------------------------------------------------- | ----- | ----------- | | filter | [NetstatRequest.Filter](#machine.NetstatRequest.Filter) | | | | feature | [NetstatRequest.Feature](#machine.NetstatRequest.Feature) | | | | l4proto | [NetstatRequest.L4proto](#machine.NetstatRequest.L4proto) | | | | netns | [NetstatRequest.NetNS](#machine.NetstatRequest.NetNS) | | | ### NetstatRequest.Feature | Field | Type | Label | Description | | ----- | ------------- | ----- | ----------- | | pid | [bool](#bool) | | | ### NetstatRequest.L4proto | Field | Type | Label | Description | | -------- | ------------- | ----- | ----------- | | tcp | [bool](#bool) | | | | tcp6 | [bool](#bool) | | | | udp | [bool](#bool) | | | | udp6 | [bool](#bool) | | | | udplite | [bool](#bool) | | | | udplite6 | [bool](#bool) | | | | raw | [bool](#bool) | | | | raw6 | [bool](#bool) | | | ### NetstatRequest.NetNS | Field | Type | Label | Description | | ----------- | ----------------- | -------- | ----------- | | hostnetwork | [bool](#bool) | | | | netns | [string](#string) | repeated | | | allnetns | [bool](#bool) | | | ### NetstatResponse | Field | Type | Label | Description | | -------- | --------------------------- | -------- | ----------- | | messages | [Netstat](#machine.Netstat) | repeated | | ### NetworkConfig | Field | Type | Label | Description | | ---------- | --------------------------------------------------- | -------- | ----------- | | hostname | [string](#string) | | | | interfaces | [NetworkDeviceConfig](#machine.NetworkDeviceConfig) | repeated | | ### NetworkDeviceConfig | Field | Type | Label | Description | | ------------- | ----------------------------------------------- | -------- | ----------- | | interface | [string](#string) | | | | cidr | [string](#string) | | | | mtu | [int32](#int32) | | | | dhcp | [bool](#bool) | | | | ignore | [bool](#bool) | | | | dhcp\_options | [DHCPOptionsConfig](#machine.DHCPOptionsConfig) | | | | routes | [RouteConfig](#machine.RouteConfig) | repeated | | ### NetworkDeviceStats | Field | Type | Label | Description | | -------- | ----------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | total | [NetDev](#machine.NetDev) | | | | devices | [NetDev](#machine.NetDev) | repeated | | ### NetworkDeviceStatsResponse | Field | Type | Label | Description | | -------- | ------------------------------------------------- | -------- | ----------- | | messages | [NetworkDeviceStats](#machine.NetworkDeviceStats) | repeated | | ### PacketCaptureRequest | Field | Type | Label | Description | | ----------- | ----------------------------------------- | -------- | -------------------------------------------- | | interface | [string](#string) | | Interface name to perform packet capture on. | | promiscuous | [bool](#bool) | | Enable promiscuous mode. | | snap\_len | [uint32](#uint32) | | Snap length in bytes. | | bpf\_filter | [BPFInstruction](#machine.BPFInstruction) | repeated | BPF filter. | ### PhaseEvent | Field | Type | Label | Description | | ------ | ----------------------------------------------- | ----- | ----------- | | phase | [string](#string) | | | | action | [PhaseEvent.Action](#machine.PhaseEvent.Action) | | | ### PlatformInfo | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | name | [string](#string) | | | | mode | [string](#string) | | | ### Process | Field | Type | Label | Description | | --------- | ----------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | processes | [ProcessInfo](#machine.ProcessInfo) | repeated | | ### ProcessInfo | Field | Type | Label | Description | | ---------------- | ----------------- | ----- | ----------- | | pid | [int32](#int32) | | | | ppid | [int32](#int32) | | | | state | [string](#string) | | | | threads | [int32](#int32) | | | | cpu\_time | [double](#double) | | | | virtual\_memory | [uint64](#uint64) | | | | resident\_memory | [uint64](#uint64) | | | | command | [string](#string) | | | | executable | [string](#string) | | | | args | [string](#string) | | | | label | [string](#string) | | | ### ProcessesResponse rpc processes | Field | Type | Label | Description | | -------- | --------------------------- | -------- | ----------- | | messages | [Process](#machine.Process) | repeated | | ### ReadRequest | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | path | [string](#string) | | | ### Reboot The reboot message containing the reboot status. | Field | Type | Label | Description | | --------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | actor\_id | [string](#string) | | | ### RebootRequest rpc reboot | Field | Type | Label | Description | | ----- | ------------------------------------------------- | ----- | ----------- | | mode | [RebootRequest.Mode](#machine.RebootRequest.Mode) | | | ### RebootResponse | Field | Type | Label | Description | | -------- | ------------------------- | -------- | ----------- | | messages | [Reboot](#machine.Reboot) | repeated | | ### Reset The reset message containing the restart status. | Field | Type | Label | Description | | --------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | actor\_id | [string](#string) | | | ### ResetPartitionSpec rpc reset | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | label | [string](#string) | | | | wipe | [bool](#bool) | | | ### ResetRequest | Field | Type | Label | Description | | ---------------------------- | ------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | graceful | [bool](#bool) | | Graceful indicates whether node should leave etcd before the upgrade, it also enforces etcd checks before leaving. | | reboot | [bool](#bool) | | Reboot indicates whether node should reboot or halt after resetting. | | system\_partitions\_to\_wipe | [ResetPartitionSpec](#machine.ResetPartitionSpec) | repeated | System\_partitions\_to\_wipe lists specific system disk partitions to be reset (wiped). If system\_partitions\_to\_wipe is empty, all the partitions are erased. | | user\_disks\_to\_wipe | [string](#string) | repeated | UserDisksToWipe lists specific connected block devices to be reset (wiped). | | mode | [ResetRequest.WipeMode](#machine.ResetRequest.WipeMode) | | WipeMode defines which devices should be wiped. | ### ResetResponse | Field | Type | Label | Description | | -------- | ----------------------- | -------- | ----------- | | messages | [Reset](#machine.Reset) | repeated | | ### Restart | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | ### RestartEvent | Field | Type | Label | Description | | ----- | --------------- | ----- | ----------- | | cmd | [int64](#int64) | | | ### RestartRequest rpc restart The request message containing the process to restart. | Field | Type | Label | Description | | --------- | ------------------------------------------------- | ----- | --------------------------------------------- | | namespace | [string](#string) | | | | id | [string](#string) | | | | driver | [common.ContainerDriver](#common.ContainerDriver) | | driver might be default "containerd" or "cri" | ### RestartResponse The messages message containing the restart status. | Field | Type | Label | Description | | -------- | --------------------------- | -------- | ----------- | | messages | [Restart](#machine.Restart) | repeated | | ### Rollback | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | ### RollbackRequest rpc rollback ### RollbackResponse | Field | Type | Label | Description | | -------- | ----------------------------- | -------- | ----------- | | messages | [Rollback](#machine.Rollback) | repeated | | ### RouteConfig | Field | Type | Label | Description | | ------- | ----------------- | ----- | ----------- | | network | [string](#string) | | | | gateway | [string](#string) | | | | metric | [uint32](#uint32) | | | ### SequenceEvent rpc events | Field | Type | Label | Description | | -------- | ----------------------------------------------------- | ----- | ----------- | | sequence | [string](#string) | | | | action | [SequenceEvent.Action](#machine.SequenceEvent.Action) | | | | error | [common.Error](#common.Error) | | | ### ServiceEvent | Field | Type | Label | Description | | ----- | ------------------------------------------------------- | ----- | ----------- | | msg | [string](#string) | | | | state | [string](#string) | | | | ts | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | | ### ServiceEvents | Field | Type | Label | Description | | ------ | ------------------------------------- | -------- | ----------- | | events | [ServiceEvent](#machine.ServiceEvent) | repeated | | ### ServiceHealth | Field | Type | Label | Description | | ------------- | ------------------------------------------------------- | ----- | ----------- | | unknown | [bool](#bool) | | | | healthy | [bool](#bool) | | | | last\_message | [string](#string) | | | | last\_change | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | | ### ServiceInfo | Field | Type | Label | Description | | ------ | --------------------------------------- | ----- | ----------- | | id | [string](#string) | | | | state | [string](#string) | | | | events | [ServiceEvents](#machine.ServiceEvents) | | | | health | [ServiceHealth](#machine.ServiceHealth) | | | ### ServiceList rpc servicelist | Field | Type | Label | Description | | -------- | ----------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | services | [ServiceInfo](#machine.ServiceInfo) | repeated | | ### ServiceListResponse | Field | Type | Label | Description | | -------- | ----------------------------------- | -------- | ----------- | | messages | [ServiceList](#machine.ServiceList) | repeated | | ### ServiceRestart | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | resp | [string](#string) | | | ### ServiceRestartRequest | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | id | [string](#string) | | | ### ServiceRestartResponse | Field | Type | Label | Description | | -------- | ----------------------------------------- | -------- | ----------- | | messages | [ServiceRestart](#machine.ServiceRestart) | repeated | | ### ServiceStart | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | resp | [string](#string) | | | ### ServiceStartRequest rpc servicestart | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | id | [string](#string) | | | ### ServiceStartResponse | Field | Type | Label | Description | | -------- | ------------------------------------- | -------- | ----------- | | messages | [ServiceStart](#machine.ServiceStart) | repeated | | ### ServiceStateEvent | Field | Type | Label | Description | | ------- | ------------------------------------------------------------- | ----- | ----------- | | service | [string](#string) | | | | action | [ServiceStateEvent.Action](#machine.ServiceStateEvent.Action) | | | | message | [string](#string) | | | | health | [ServiceHealth](#machine.ServiceHealth) | | | ### ServiceStop | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | resp | [string](#string) | | | ### ServiceStopRequest | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | id | [string](#string) | | | ### ServiceStopResponse | Field | Type | Label | Description | | -------- | ----------------------------------- | -------- | ----------- | | messages | [ServiceStop](#machine.ServiceStop) | repeated | | ### Shutdown rpc shutdown The messages message containing the shutdown status. | Field | Type | Label | Description | | --------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | actor\_id | [string](#string) | | | ### ShutdownRequest | Field | Type | Label | Description | | ----- | ------------- | ----- | --------------------------------------------------------------------------------- | | force | [bool](#bool) | | Force indicates whether node should shutdown without first cordening and draining | ### ShutdownResponse | Field | Type | Label | Description | | -------- | ----------------------------- | -------- | ----------- | | messages | [Shutdown](#machine.Shutdown) | repeated | | ### SoftIRQStat | Field | Type | Label | Description | | --------------- | ----------------- | ----- | ----------- | | hi | [uint64](#uint64) | | | | timer | [uint64](#uint64) | | | | net\_tx | [uint64](#uint64) | | | | net\_rx | [uint64](#uint64) | | | | block | [uint64](#uint64) | | | | block\_io\_poll | [uint64](#uint64) | | | | tasklet | [uint64](#uint64) | | | | sched | [uint64](#uint64) | | | | hrtimer | [uint64](#uint64) | | | | rcu | [uint64](#uint64) | | | ### Stat The messages message containing the requested stat. | Field | Type | Label | Description | | ------------- | ----------------- | ----- | ----------- | | namespace | [string](#string) | | | | id | [string](#string) | | | | memory\_usage | [uint64](#uint64) | | | | cpu\_usage | [uint64](#uint64) | | | | pod\_id | [string](#string) | | | | name | [string](#string) | | | ### Stats The messages message containing the requested stats. | Field | Type | Label | Description | | -------- | ----------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | stats | [Stat](#machine.Stat) | repeated | | ### StatsRequest The request message containing the containerd namespace. | Field | Type | Label | Description | | --------- | ------------------------------------------------- | ----- | --------------------------------------------- | | namespace | [string](#string) | | | | driver | [common.ContainerDriver](#common.ContainerDriver) | | driver might be default "containerd" or "cri" | ### StatsResponse | Field | Type | Label | Description | | -------- | ----------------------- | -------- | ----------- | | messages | [Stats](#machine.Stats) | repeated | | ### SystemStat | Field | Type | Label | Description | | ----------------- | ----------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | boot\_time | [uint64](#uint64) | | | | cpu\_total | [CPUStat](#machine.CPUStat) | | | | cpu | [CPUStat](#machine.CPUStat) | repeated | | | irq\_total | [uint64](#uint64) | | | | irq | [uint64](#uint64) | repeated | | | context\_switches | [uint64](#uint64) | | | | process\_created | [uint64](#uint64) | | | | process\_running | [uint64](#uint64) | | | | process\_blocked | [uint64](#uint64) | | | | soft\_irq\_total | [uint64](#uint64) | | | | soft\_irq | [SoftIRQStat](#machine.SoftIRQStat) | | | ### SystemStatResponse | Field | Type | Label | Description | | -------- | --------------------------------- | -------- | ----------- | | messages | [SystemStat](#machine.SystemStat) | repeated | | ### TaskEvent | Field | Type | Label | Description | | ------ | --------------------------------------------- | ----- | ----------- | | task | [string](#string) | | | | action | [TaskEvent.Action](#machine.TaskEvent.Action) | | | ### Upgrade | Field | Type | Label | Description | | --------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | ack | [string](#string) | | | | actor\_id | [string](#string) | | | ### UpgradeRequest rpc upgrade | Field | Type | Label | Description | | ------------ | --------------------------------------------------------------- | ----- | ----------- | | image | [string](#string) | | | | preserve | [bool](#bool) | | | | stage | [bool](#bool) | | | | force | [bool](#bool) | | | | reboot\_mode | [UpgradeRequest.RebootMode](#machine.UpgradeRequest.RebootMode) | | | ### UpgradeResponse | Field | Type | Label | Description | | -------- | --------------------------- | -------- | ----------- | | messages | [Upgrade](#machine.Upgrade) | repeated | | ### Version | Field | Type | Label | Description | | -------- | ------------------------------------- | ----- | --------------------------------------------------------------------------- | | metadata | [common.Metadata](#common.Metadata) | | | | version | [VersionInfo](#machine.VersionInfo) | | | | platform | [PlatformInfo](#machine.PlatformInfo) | | | | features | [FeaturesInfo](#machine.FeaturesInfo) | | Features describe individual Talos features that can be switched on or off. | ### VersionInfo | Field | Type | Label | Description | | ----------- | ----------------- | ----- | ----------- | | tag | [string](#string) | | | | sha | [string](#string) | | | | built | [string](#string) | | | | go\_version | [string](#string) | | | | os | [string](#string) | | | | arch | [string](#string) | | | ### VersionResponse | Field | Type | Label | Description | | -------- | --------------------------- | -------- | ----------- | | messages | [Version](#machine.Version) | repeated | | ### Xattr | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | name | [string](#string) | | | | data | [bytes](#bytes) | | | ### ApplyConfigurationRequest.Mode | Name | Number | Description | | ---------- | ------ | ----------- | | REBOOT | 0 | | | AUTO | 1 | | | NO\_REBOOT | 2 | | | STAGED | 3 | | | TRY | 4 | | ### ConnectRecord.State | Name | Number | Description | | ----------- | ------ | ----------- | | RESERVED | 0 | | | ESTABLISHED | 1 | | | SYN\_SENT | 2 | | | SYN\_RECV | 3 | | | FIN\_WAIT1 | 4 | | | FIN\_WAIT2 | 5 | | | TIME\_WAIT | 6 | | | CLOSE | 7 | | | CLOSEWAIT | 8 | | | LASTACK | 9 | | | LISTEN | 10 | | | CLOSING | 11 | | ### ConnectRecord.TimerActive | Name | Number | Description | | --------- | ------ | ----------- | | OFF | 0 | | | ON | 1 | | | KEEPALIVE | 2 | | | TIMEWAIT | 3 | | | PROBE | 4 | | ### EtcdMemberAlarm.AlarmType | Name | Number | Description | | ------- | ------ | ----------- | | NONE | 0 | | | NOSPACE | 1 | | | CORRUPT | 2 | | ### ListRequest.Type File type. | Name | Number | Description | | --------- | ------ | ------------------------------------------- | | REGULAR | 0 | Regular file (not directory, symlink, etc). | | DIRECTORY | 1 | Directory. | | SYMLINK | 2 | Symbolic link. | ### MachineConfig.MachineType | Name | Number | Description | | -------------------- | ------ | ----------- | | TYPE\_UNKNOWN | 0 | | | TYPE\_INIT | 1 | | | TYPE\_CONTROL\_PLANE | 2 | | | TYPE\_WORKER | 3 | | ### MachineStatusEvent.MachineStage | Name | Number | Description | | -------------- | ------ | ----------- | | UNKNOWN | 0 | | | BOOTING | 1 | | | INSTALLING | 2 | | | MAINTENANCE | 3 | | | RUNNING | 4 | | | REBOOTING | 5 | | | SHUTTING\_DOWN | 6 | | | RESETTING | 7 | | | UPGRADING | 8 | | ### NetstatRequest.Filter | Name | Number | Description | | --------- | ------ | ----------- | | ALL | 0 | | | CONNECTED | 1 | | | LISTENING | 2 | | ### PhaseEvent.Action | Name | Number | Description | | ----- | ------ | ----------- | | START | 0 | | | STOP | 1 | | ### RebootRequest.Mode | Name | Number | Description | | ---------- | ------ | ----------- | | DEFAULT | 0 | | | POWERCYCLE | 1 | | ### ResetRequest.WipeMode | Name | Number | Description | | ------------ | ------ | ----------- | | ALL | 0 | | | SYSTEM\_DISK | 1 | | | USER\_DISKS | 2 | | ### SequenceEvent.Action | Name | Number | Description | | ----- | ------ | ----------- | | NOOP | 0 | | | START | 1 | | | STOP | 2 | | ### ServiceStateEvent.Action | Name | Number | Description | | ----------- | ------ | ----------- | | INITIALIZED | 0 | | | PREPARING | 1 | | | WAITING | 2 | | | RUNNING | 3 | | | STOPPING | 4 | | | FINISHED | 5 | | | FAILED | 6 | | | SKIPPED | 7 | | | STARTING | 8 | | ### TaskEvent.Action | Name | Number | Description | | ----- | ------ | ----------- | | START | 0 | | | STOP | 1 | | ### UpgradeRequest.RebootMode | Name | Number | Description | | ---------- | ------ | ----------- | | DEFAULT | 0 | | | POWERCYCLE | 1 | | ### MachineService The machine service definition. | Method Name | Request Type | Response Type | Description | | --------------------------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ApplyConfiguration | [ApplyConfigurationRequest](#machine.ApplyConfigurationRequest) | [ApplyConfigurationResponse](#machine.ApplyConfigurationResponse) | | | Bootstrap | [BootstrapRequest](#machine.BootstrapRequest) | [BootstrapResponse](#machine.BootstrapResponse) | Bootstrap method makes control plane node enter etcd bootstrap mode. Node aborts etcd join sequence and creates single-node etcd cluster. If recover\_etcd argument is specified, etcd is recovered from a snapshot uploaded with EtcdRecover. | | Containers | [ContainersRequest](#machine.ContainersRequest) | [ContainersResponse](#machine.ContainersResponse) | | | Copy | [CopyRequest](#machine.CopyRequest) | [.common.Data](#common.Data) stream | | | CPUFreqStats | [.google.protobuf.Empty](#google.protobuf.Empty) | [CPUFreqStatsResponse](#machine.CPUFreqStatsResponse) | | | CPUInfo | [.google.protobuf.Empty](#google.protobuf.Empty) | [CPUInfoResponse](#machine.CPUInfoResponse) | | | DiskStats | [.google.protobuf.Empty](#google.protobuf.Empty) | [DiskStatsResponse](#machine.DiskStatsResponse) | | | Dmesg | [DmesgRequest](#machine.DmesgRequest) | [.common.Data](#common.Data) stream | | | Events | [EventsRequest](#machine.EventsRequest) | [Event](#machine.Event) stream | | | EtcdMemberList | [EtcdMemberListRequest](#machine.EtcdMemberListRequest) | [EtcdMemberListResponse](#machine.EtcdMemberListResponse) | | | EtcdRemoveMemberByID | [EtcdRemoveMemberByIDRequest](#machine.EtcdRemoveMemberByIDRequest) | [EtcdRemoveMemberByIDResponse](#machine.EtcdRemoveMemberByIDResponse) | EtcdRemoveMemberByID removes a member from the etcd cluster identified by member ID. This API should be used to remove members which don't have an associated Talos node anymore. To remove a member with a running Talos node, use EtcdLeaveCluster API on the node to be removed. | | EtcdLeaveCluster | [EtcdLeaveClusterRequest](#machine.EtcdLeaveClusterRequest) | [EtcdLeaveClusterResponse](#machine.EtcdLeaveClusterResponse) | | | EtcdForfeitLeadership | [EtcdForfeitLeadershipRequest](#machine.EtcdForfeitLeadershipRequest) | [EtcdForfeitLeadershipResponse](#machine.EtcdForfeitLeadershipResponse) | | | EtcdRecover | [.common.Data](#common.Data) stream | [EtcdRecoverResponse](#machine.EtcdRecoverResponse) | EtcdRecover method uploads etcd data snapshot created with EtcdSnapshot to the node. Snapshot can be later used to recover the cluster via Bootstrap method. | | EtcdSnapshot | [EtcdSnapshotRequest](#machine.EtcdSnapshotRequest) | [.common.Data](#common.Data) stream | EtcdSnapshot method creates etcd data snapshot (backup) from the local etcd instance and streams it back to the client. This method is available only on control plane nodes (which run etcd). | | EtcdAlarmList | [.google.protobuf.Empty](#google.protobuf.Empty) | [EtcdAlarmListResponse](#machine.EtcdAlarmListResponse) | EtcdAlarmList lists etcd alarms for the current node. This method is available only on control plane nodes (which run etcd). | | EtcdAlarmDisarm | [.google.protobuf.Empty](#google.protobuf.Empty) | [EtcdAlarmDisarmResponse](#machine.EtcdAlarmDisarmResponse) | EtcdAlarmDisarm disarms etcd alarms for the current node. This method is available only on control plane nodes (which run etcd). | | EtcdDefragment | [.google.protobuf.Empty](#google.protobuf.Empty) | [EtcdDefragmentResponse](#machine.EtcdDefragmentResponse) | EtcdDefragment defragments etcd data directory for the current node. Defragmentation is a resource-heavy operation, so it should only run on a specific node. This method is available only on control plane nodes (which run etcd). | | EtcdStatus | [.google.protobuf.Empty](#google.protobuf.Empty) | [EtcdStatusResponse](#machine.EtcdStatusResponse) | EtcdStatus returns etcd status for the current member. This method is available only on control plane nodes (which run etcd). | | EtcdDowngradeValidate | [EtcdDowngradeValidateRequest](#machine.EtcdDowngradeValidateRequest) | [EtcdDowngradeValidateResponse](#machine.EtcdDowngradeValidateResponse) | EtcdDowngradeValidate validates etcd cluster for downgrade to a specific version. This method is available only on control plane nodes (which run etcd). | | EtcdDowngradeEnable | [EtcdDowngradeEnableRequest](#machine.EtcdDowngradeEnableRequest) | [EtcdDowngradeEnableResponse](#machine.EtcdDowngradeEnableResponse) | EtcdDowngradeEnable enables etcd cluster downgrade to a specific version. This method is available only on control plane nodes (which run etcd). | | EtcdDowngradeCancel | [.google.protobuf.Empty](#google.protobuf.Empty) | [EtcdDowngradeCancelResponse](#machine.EtcdDowngradeCancelResponse) | EtcdDowngradeCancel cancels etcd cluster downgrade that is in progress. This method is available only on control plane nodes (which run etcd). | | GenerateConfiguration | [GenerateConfigurationRequest](#machine.GenerateConfigurationRequest) | [GenerateConfigurationResponse](#machine.GenerateConfigurationResponse) | | | Hostname | [.google.protobuf.Empty](#google.protobuf.Empty) | [HostnameResponse](#machine.HostnameResponse) | | | Kubeconfig | [.google.protobuf.Empty](#google.protobuf.Empty) | [.common.Data](#common.Data) stream | | | List | [ListRequest](#machine.ListRequest) | [FileInfo](#machine.FileInfo) stream | | | DiskUsage | [DiskUsageRequest](#machine.DiskUsageRequest) | [DiskUsageInfo](#machine.DiskUsageInfo) stream | | | LoadAvg | [.google.protobuf.Empty](#google.protobuf.Empty) | [LoadAvgResponse](#machine.LoadAvgResponse) | | | Logs | [LogsRequest](#machine.LogsRequest) | [.common.Data](#common.Data) stream | | | LogsContainers | [.google.protobuf.Empty](#google.protobuf.Empty) | [LogsContainersResponse](#machine.LogsContainersResponse) | | | Memory | [.google.protobuf.Empty](#google.protobuf.Empty) | [MemoryResponse](#machine.MemoryResponse) | | | Mounts | [.google.protobuf.Empty](#google.protobuf.Empty) | [MountsResponse](#machine.MountsResponse) | | | NetworkDeviceStats | [.google.protobuf.Empty](#google.protobuf.Empty) | [NetworkDeviceStatsResponse](#machine.NetworkDeviceStatsResponse) | | | Processes | [.google.protobuf.Empty](#google.protobuf.Empty) | [ProcessesResponse](#machine.ProcessesResponse) | | | Read | [ReadRequest](#machine.ReadRequest) | [.common.Data](#common.Data) stream | | | Reboot | [RebootRequest](#machine.RebootRequest) | [RebootResponse](#machine.RebootResponse) | | | Restart | [RestartRequest](#machine.RestartRequest) | [RestartResponse](#machine.RestartResponse) | | | Rollback | [RollbackRequest](#machine.RollbackRequest) | [RollbackResponse](#machine.RollbackResponse) | | | Reset | [ResetRequest](#machine.ResetRequest) | [ResetResponse](#machine.ResetResponse) | | | ServiceList | [.google.protobuf.Empty](#google.protobuf.Empty) | [ServiceListResponse](#machine.ServiceListResponse) | | | ServiceRestart | [ServiceRestartRequest](#machine.ServiceRestartRequest) | [ServiceRestartResponse](#machine.ServiceRestartResponse) | | | ServiceStart | [ServiceStartRequest](#machine.ServiceStartRequest) | [ServiceStartResponse](#machine.ServiceStartResponse) | | | ServiceStop | [ServiceStopRequest](#machine.ServiceStopRequest) | [ServiceStopResponse](#machine.ServiceStopResponse) | | | Shutdown | [ShutdownRequest](#machine.ShutdownRequest) | [ShutdownResponse](#machine.ShutdownResponse) | | | Stats | [StatsRequest](#machine.StatsRequest) | [StatsResponse](#machine.StatsResponse) | | | SystemStat | [.google.protobuf.Empty](#google.protobuf.Empty) | [SystemStatResponse](#machine.SystemStatResponse) | | | Upgrade | [UpgradeRequest](#machine.UpgradeRequest) | [UpgradeResponse](#machine.UpgradeResponse) | | | Version | [.google.protobuf.Empty](#google.protobuf.Empty) | [VersionResponse](#machine.VersionResponse) | | | GenerateClientConfiguration | [GenerateClientConfigurationRequest](#machine.GenerateClientConfigurationRequest) | [GenerateClientConfigurationResponse](#machine.GenerateClientConfigurationResponse) | GenerateClientConfiguration generates talosctl client configuration (talosconfig). | | PacketCapture | [PacketCaptureRequest](#machine.PacketCaptureRequest) | [.common.Data](#common.Data) stream | PacketCapture performs packet capture and streams back pcap file. | | Netstat | [NetstatRequest](#machine.NetstatRequest) | [NetstatResponse](#machine.NetstatResponse) | Netstat provides information about network connections. | | MetaWrite | [MetaWriteRequest](#machine.MetaWriteRequest) | [MetaWriteResponse](#machine.MetaWriteResponse) | MetaWrite writes a META key-value pair. | | MetaDelete | [MetaDeleteRequest](#machine.MetaDeleteRequest) | [MetaDeleteResponse](#machine.MetaDeleteResponse) | MetaDelete deletes a META key. | | ImageList | [ImageListRequest](#machine.ImageListRequest) | [ImageListResponse](#machine.ImageListResponse) stream | ImageList lists images in the CRI. | | ImagePull | [ImagePullRequest](#machine.ImagePullRequest) | [ImagePullResponse](#machine.ImagePullResponse) | ImagePull pulls an image into the CRI. |

Top

## resource/config/config.proto ### MachineConfigSpec MessageConfigSpec is the spec for the config.MachineConfig resource. | Field | Type | Label | Description | | ---------------- | --------------- | ----- | ----------------------------------------------- | | yaml\_marshalled | [bytes](#bytes) | | Contains YAML marshalled machine configuration. | Byte representation is preserved as the machine configuration was submitted to the node. | ### MachineTypeSpec MachineTypeSpec is the spec for the config.MachineType resource. | Field | Type | Label | Description | | ------------- | ------------------------------------------- | ----- | ----------- | | machine\_type | [MachineType](#resource.config.MachineType) | | | ### MachineType MachineType matches machine.Type constants. | Name | Number | Description | | -------------- | ------ | ----------- | | UNKNOWN | 0 | | | INIT | 1 | | | CONTROL\_PLANE | 2 | | | WORKER | 3 | |

Top

## resource/definitions/enums/enums.proto ### BlockEncryptionKeyType BlockEncryptionKeyType describes encryption key type. | Name | Number | Description | | ------------------------- | ------ | ----------- | | ENCRYPTION\_KEY\_STATIC | 0 | | | ENCRYPTION\_KEY\_NODE\_ID | 1 | | | ENCRYPTION\_KEY\_KMS | 2 | | | ENCRYPTION\_KEY\_TPM | 3 | | ### BlockEncryptionProviderType BlockEncryptionProviderType describes encryption provider type. | Name | Number | Description | | --------------------------- | ------ | ----------- | | ENCRYPTION\_PROVIDER\_NONE | 0 | | | ENCRYPTION\_PROVIDER\_LUKS2 | 1 | | ### BlockFilesystemType BlockFilesystemType describes filesystem type. | Name | Number | Description | | ------------------------- | ------ | ----------- | | FILESYSTEM\_TYPE\_NONE | 0 | | | FILESYSTEM\_TYPE\_XFS | 1 | | | FILESYSTEM\_TYPE\_VFAT | 2 | | | FILESYSTEM\_TYPE\_EXT4 | 3 | | | FILESYSTEM\_TYPE\_ISO9660 | 4 | | | FILESYSTEM\_TYPE\_SWAP | 5 | | ### BlockVolumePhase BlockVolumePhase describes volume phase. | Name | Number | Description | | -------------------------- | ------ | ----------- | | VOLUME\_PHASE\_WAITING | 0 | | | VOLUME\_PHASE\_FAILED | 1 | | | VOLUME\_PHASE\_MISSING | 2 | | | VOLUME\_PHASE\_LOCATED | 3 | | | VOLUME\_PHASE\_PROVISIONED | 4 | | | VOLUME\_PHASE\_PREPARED | 5 | | | VOLUME\_PHASE\_READY | 6 | | | VOLUME\_PHASE\_CLOSED | 7 | | ### BlockVolumeType BlockVolumeType describes volume type. | Name | Number | Description | | ----------------------- | ------ | ----------- | | VOLUME\_TYPE\_PARTITION | 0 | | | VOLUME\_TYPE\_DISK | 1 | | | VOLUME\_TYPE\_TMPFS | 2 | | | VOLUME\_TYPE\_DIRECTORY | 3 | | | VOLUME\_TYPE\_SYMLINK | 4 | | | VOLUME\_TYPE\_OVERLAY | 5 | | ### CriImageCacheCopyStatus CriImageCacheCopyStatus describes image cache copy status type. | Name | Number | Description | | ----------------------------------- | ------ | ----------- | | IMAGE\_CACHE\_COPY\_STATUS\_UNKNOWN | 0 | | | IMAGE\_CACHE\_COPY\_STATUS\_SKIPPED | 1 | | | IMAGE\_CACHE\_COPY\_STATUS\_PENDING | 2 | | | IMAGE\_CACHE\_COPY\_STATUS\_READY | 3 | | ### CriImageCacheStatus CriImageCacheStatus describes image cache status type. | Name | Number | Description | | ------------------------------- | ------ | ----------- | | IMAGE\_CACHE\_STATUS\_UNKNOWN | 0 | | | IMAGE\_CACHE\_STATUS\_DISABLED | 1 | | | IMAGE\_CACHE\_STATUS\_PREPARING | 2 | | | IMAGE\_CACHE\_STATUS\_READY | 3 | | ### KubespanPeerState KubespanPeerState is KubeSpan peer current state. | Name | Number | Description | | -------------------- | ------ | ----------- | | PEER\_STATE\_UNKNOWN | 0 | | | PEER\_STATE\_UP | 1 | | | PEER\_STATE\_DOWN | 2 | | ### MachineType MachineType represents a machine type. | Name | Number | Description | | -------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | TYPE\_UNKNOWN | 0 | TypeUnknown represents undefined node type, when there is no machine configuration yet. | | TYPE\_INIT | 1 | TypeInit type designates the first control plane node to come up. You can think of it like a bootstrap node. This node will perform the initial steps to bootstrap the cluster -- generation of TLS assets, starting of the control plane, etc. | | TYPE\_CONTROL\_PLANE | 2 | TypeControlPlane designates the node as a control plane member. This means it will host etcd along with the Kubernetes controlplane components such as API Server, Controller Manager, Scheduler. | | TYPE\_WORKER | 3 | TypeWorker designates the node as a worker node. This means it will be an available compute node for scheduling workloads. | ### NethelpersADSelect NethelpersADSelect is ADSelect. | Name | Number | Description | | --------------------- | ------ | ----------- | | AD\_SELECT\_STABLE | 0 | | | AD\_SELECT\_BANDWIDTH | 1 | | | AD\_SELECT\_COUNT | 2 | | ### NethelpersARPAllTargets NethelpersARPAllTargets is an ARP targets mode. | Name | Number | Description | | ---------------------- | ------ | ----------- | | ARP\_ALL\_TARGETS\_ANY | 0 | | | ARP\_ALL\_TARGETS\_ALL | 1 | | ### NethelpersARPValidate NethelpersARPValidate is an ARP Validation mode. | Name | Number | Description | | --------------------- | ------ | ----------- | | ARP\_VALIDATE\_NONE | 0 | | | ARP\_VALIDATE\_ACTIVE | 1 | | | ARP\_VALIDATE\_BACKUP | 2 | | | ARP\_VALIDATE\_ALL | 3 | | ### NethelpersAddressFlag NethelpersAddressFlag wraps IFF\_\* constants. | Name | Number | Description | | ------------------------------------ | ------ | ----------- | | NETHELPERS\_ADDRESSFLAG\_UNSPECIFIED | 0 | | | ADDRESS\_TEMPORARY | 1 | | | ADDRESS\_NO\_DAD | 2 | | | ADDRESS\_OPTIMISTIC | 4 | | | ADDRESS\_DAD\_FAILED | 8 | | | ADDRESS\_HOME | 16 | | | ADDRESS\_DEPRECATED | 32 | | | ADDRESS\_TENTATIVE | 64 | | | ADDRESS\_PERMANENT | 128 | | | ADDRESS\_MANAGEMENT\_TEMP | 256 | | | ADDRESS\_NO\_PREFIX\_ROUTE | 512 | | | ADDRESS\_MC\_AUTO\_JOIN | 1024 | | | ADDRESS\_STABLE\_PRIVACY | 2048 | | ### NethelpersAddressSortAlgorithm NethelpersAddressSortAlgorithm is an internal address sorting algorithm. | Name | Number | Description | | ---------------------------- | ------ | ----------- | | ADDRESS\_SORT\_ALGORITHM\_V1 | 0 | | | ADDRESS\_SORT\_ALGORITHM\_V2 | 1 | | ### NethelpersAutoHostnameKind NethelpersAutoHostnameKind is a kind of automatically generated hostname. | Name | Number | Description | | ---------------------------- | ------ | ----------- | | AUTO\_HOSTNAME\_KIND\_OFF | 0 | | | AUTO\_HOSTNAME\_KIND\_ADDR | 1 | | | AUTO\_HOSTNAME\_KIND\_STABLE | 2 | | ### NethelpersBondMode NethelpersBondMode is a bond mode. | Name | Number | Description | | -------------------------- | ------ | ----------- | | BOND\_MODE\_ROUNDROBIN | 0 | | | BOND\_MODE\_ACTIVE\_BACKUP | 1 | | | BOND\_MODE\_XOR | 2 | | | BOND\_MODE\_BROADCAST | 3 | | | BOND\_MODE8023\_AD | 4 | | | BOND\_MODE\_TLB | 5 | | | BOND\_MODE\_ALB | 6 | | ### NethelpersBondXmitHashPolicy NethelpersBondXmitHashPolicy is a bond hash policy. | Name | Number | Description | | --------------------------- | ------ | ----------- | | BOND\_XMIT\_POLICY\_LAYER2 | 0 | | | BOND\_XMIT\_POLICY\_LAYER34 | 1 | | | BOND\_XMIT\_POLICY\_LAYER23 | 2 | | | BOND\_XMIT\_POLICY\_ENCAP23 | 3 | | | BOND\_XMIT\_POLICY\_ENCAP34 | 4 | | ### NethelpersConntrackState NethelpersConntrackState is a conntrack state. | Name | Number | Description | | --------------------------------------- | ------ | ----------- | | NETHELPERS\_CONNTRACKSTATE\_UNSPECIFIED | 0 | | | CONNTRACK\_STATE\_NEW | 8 | | | CONNTRACK\_STATE\_RELATED | 4 | | | CONNTRACK\_STATE\_ESTABLISHED | 2 | | | CONNTRACK\_STATE\_INVALID | 1 | | ### NethelpersDuplex NethelpersDuplex wraps ethtool.Duplex for YAML marshaling. | Name | Number | Description | | ------- | ------ | ----------- | | HALF | 0 | | | FULL | 1 | | | UNKNOWN | 255 | | ### NethelpersFailOverMAC NethelpersFailOverMAC is a MAC failover mode. | Name | Number | Description | | ----------------------- | ------ | ----------- | | FAIL\_OVER\_MAC\_NONE | 0 | | | FAIL\_OVER\_MAC\_ACTIVE | 1 | | | FAIL\_OVER\_MAC\_FOLLOW | 2 | | ### NethelpersFamily NethelpersFamily is a network family. | Name | Number | Description | | ------------------------------- | ------ | ----------- | | NETHELPERS\_FAMILY\_UNSPECIFIED | 0 | | | FAMILY\_INET4 | 2 | | | FAMILY\_INET6 | 10 | | ### NethelpersICMPType NethelpersICMPType is a ICMP packet type. | Name | Number | Description | | ---------------------------------- | ------ | ----------- | | NETHELPERS\_ICMPTYPE\_UNSPECIFIED | 0 | | | ICMP\_TYPE\_TIMESTAMP\_REQUEST | 13 | | | ICMP\_TYPE\_TIMESTAMP\_REPLY | 14 | | | ICMP\_TYPE\_ADDRESS\_MASK\_REQUEST | 17 | | | ICMP\_TYPE\_ADDRESS\_MASK\_REPLY | 18 | | ### NethelpersLACPRate NethelpersLACPRate is a LACP rate. | Name | Number | Description | | ---------------- | ------ | ----------- | | LACP\_RATE\_SLOW | 0 | | | LACP\_RATE\_FAST | 1 | | ### NethelpersLinkType NethelpersLinkType is a link type. | Name | Number | Description | | ------------------------ | ------ | ----------- | | LINK\_NETROM | 0 | | | LINK\_ETHER | 1 | | | LINK\_EETHER | 2 | | | LINK\_AX25 | 3 | | | LINK\_PRONET | 4 | | | LINK\_CHAOS | 5 | | | LINK\_IEE802 | 6 | | | LINK\_ARCNET | 7 | | | LINK\_ATALK | 8 | | | LINK\_DLCI | 15 | | | LINK\_ATM | 19 | | | LINK\_METRICOM | 23 | | | LINK\_IEEE1394 | 24 | | | LINK\_EUI64 | 27 | | | LINK\_INFINIBAND | 32 | | | LINK\_SLIP | 256 | | | LINK\_CSLIP | 257 | | | LINK\_SLIP6 | 258 | | | LINK\_CSLIP6 | 259 | | | LINK\_RSRVD | 260 | | | LINK\_ADAPT | 264 | | | LINK\_ROSE | 270 | | | LINK\_X25 | 271 | | | LINK\_HWX25 | 272 | | | LINK\_CAN | 280 | | | LINK\_PPP | 512 | | | LINK\_CISCO | 513 | | | LINK\_HDLC | 513 | | | LINK\_LAPB | 516 | | | LINK\_DDCMP | 517 | | | LINK\_RAWHDLC | 518 | | | LINK\_TUNNEL | 768 | | | LINK\_TUNNEL6 | 769 | | | LINK\_FRAD | 770 | | | LINK\_SKIP | 771 | | | LINK\_LOOPBCK | 772 | | | LINK\_LOCALTLK | 773 | | | LINK\_FDDI | 774 | | | LINK\_BIF | 775 | | | LINK\_SIT | 776 | | | LINK\_IPDDP | 777 | | | LINK\_IPGRE | 778 | | | LINK\_PIMREG | 779 | | | LINK\_HIPPI | 780 | | | LINK\_ASH | 781 | | | LINK\_ECONET | 782 | | | LINK\_IRDA | 783 | | | LINK\_FCPP | 784 | | | LINK\_FCAL | 785 | | | LINK\_FCPL | 786 | | | LINK\_FCFABRIC | 787 | | | LINK\_FCFABRIC1 | 788 | | | LINK\_FCFABRIC2 | 789 | | | LINK\_FCFABRIC3 | 790 | | | LINK\_FCFABRIC4 | 791 | | | LINK\_FCFABRIC5 | 792 | | | LINK\_FCFABRIC6 | 793 | | | LINK\_FCFABRIC7 | 794 | | | LINK\_FCFABRIC8 | 795 | | | LINK\_FCFABRIC9 | 796 | | | LINK\_FCFABRIC10 | 797 | | | LINK\_FCFABRIC11 | 798 | | | LINK\_FCFABRIC12 | 799 | | | LINK\_IEE802TR | 800 | | | LINK\_IEE80211 | 801 | | | LINK\_IEE80211PRISM | 802 | | | LINK\_IEE80211\_RADIOTAP | 803 | | | LINK\_IEE8021154 | 804 | | | LINK\_IEE8021154MONITOR | 805 | | | LINK\_PHONET | 820 | | | LINK\_PHONETPIPE | 821 | | | LINK\_CAIF | 822 | | | LINK\_IP6GRE | 823 | | | LINK\_NETLINK | 824 | | | LINK6\_LOWPAN | 825 | | | LINK\_VOID | 65535 | | | LINK\_NONE | 65534 | | ### NethelpersMatchOperator NethelpersMatchOperator is a netfilter match operator. | Name | Number | Description | | -------------------- | ------ | ----------- | | OPERATOR\_EQUAL | 0 | | | OPERATOR\_NOT\_EQUAL | 1 | | ### NethelpersNfTablesChainHook NethelpersNfTablesChainHook wraps nftables.ChainHook for YAML marshaling. | Name | Number | Description | | ------------------------ | ------ | ----------- | | CHAIN\_HOOK\_PREROUTING | 0 | | | CHAIN\_HOOK\_INPUT | 1 | | | CHAIN\_HOOK\_FORWARD | 2 | | | CHAIN\_HOOK\_OUTPUT | 3 | | | CHAIN\_HOOK\_POSTROUTING | 4 | | ### NethelpersNfTablesChainPriority NethelpersNfTablesChainPriority wraps nftables.ChainPriority for YAML marshaling. | Name | Number | Description | | ---------------------------------------------- | ----------- | ----------- | | NETHELPERS\_NFTABLESCHAINPRIORITY\_UNSPECIFIED | 0 | | | CHAIN\_PRIORITY\_FIRST | -2147483648 | | | CHAIN\_PRIORITY\_CONNTRACK\_DEFRAG | -400 | | | CHAIN\_PRIORITY\_RAW | -300 | | | CHAIN\_PRIORITY\_SE\_LINUX\_FIRST | -225 | | | CHAIN\_PRIORITY\_CONNTRACK | -200 | | | CHAIN\_PRIORITY\_MANGLE | -150 | | | CHAIN\_PRIORITY\_NAT\_DEST | -100 | | | CHAIN\_PRIORITY\_FILTER | 0 | | | CHAIN\_PRIORITY\_SECURITY | 50 | | | CHAIN\_PRIORITY\_NAT\_SOURCE | 100 | | | CHAIN\_PRIORITY\_SE\_LINUX\_LAST | 225 | | | CHAIN\_PRIORITY\_CONNTRACK\_HELPER | 300 | | | CHAIN\_PRIORITY\_LAST | 2147483647 | | ### NethelpersNfTablesVerdict NethelpersNfTablesVerdict wraps nftables.Verdict for YAML marshaling. | Name | Number | Description | | --------------- | ------ | ----------- | | VERDICT\_DROP | 0 | | | VERDICT\_ACCEPT | 1 | | ### NethelpersOperationalState NethelpersOperationalState wraps rtnetlink.OperationalState for YAML marshaling. | Name | Number | Description | | ------------------------------- | ------ | ----------- | | OPER\_STATE\_UNKNOWN | 0 | | | OPER\_STATE\_NOT\_PRESENT | 1 | | | OPER\_STATE\_DOWN | 2 | | | OPER\_STATE\_LOWER\_LAYER\_DOWN | 3 | | | OPER\_STATE\_TESTING | 4 | | | OPER\_STATE\_DORMANT | 5 | | | OPER\_STATE\_UP | 6 | | ### NethelpersPort NethelpersPort wraps ethtool.Port for YAML marshaling. | Name | Number | Description | | -------------- | ------ | ----------- | | TWISTED\_PAIR | 0 | | | AUI | 1 | | | MII | 2 | | | FIBRE | 3 | | | BNC | 4 | | | DIRECT\_ATTACH | 5 | | | NONE | 239 | | | OTHER | 255 | | ### NethelpersPrimaryReselect NethelpersPrimaryReselect is an ARP targets mode. | Name | Number | Description | | -------------------------- | ------ | ----------- | | PRIMARY\_RESELECT\_ALWAYS | 0 | | | PRIMARY\_RESELECT\_BETTER | 1 | | | PRIMARY\_RESELECT\_FAILURE | 2 | | ### NethelpersProtocol NethelpersProtocol is a inet protocol. | Name | Number | Description | | --------------------------------- | ------ | ----------- | | NETHELPERS\_PROTOCOL\_UNSPECIFIED | 0 | | | PROTOCOL\_ICMP | 1 | | | PROTOCOL\_TCP | 6 | | | PROTOCOL\_UDP | 17 | | | PROTOCOL\_ICM\_PV6 | 58 | | ### NethelpersRouteFlag NethelpersRouteFlag wraps RTM\_F\_\* constants. | Name | Number | Description | | ---------------------------------- | ------ | ----------- | | NETHELPERS\_ROUTEFLAG\_UNSPECIFIED | 0 | | | ROUTE\_NOTIFY | 256 | | | ROUTE\_CLONED | 512 | | | ROUTE\_EQUALIZE | 1024 | | | ROUTE\_PREFIX | 2048 | | | ROUTE\_LOOKUP\_TABLE | 4096 | | | ROUTE\_FIB\_MATCH | 8192 | | | ROUTE\_OFFLOAD | 16384 | | | ROUTE\_TRAP | 32768 | | ### NethelpersRouteProtocol NethelpersRouteProtocol is a routing protocol. | Name | Number | Description | | -------------------- | ------ | ----------- | | PROTOCOL\_UNSPEC | 0 | | | PROTOCOL\_REDIRECT | 1 | | | PROTOCOL\_KERNEL | 2 | | | PROTOCOL\_BOOT | 3 | | | PROTOCOL\_STATIC | 4 | | | PROTOCOL\_RA | 9 | | | PROTOCOL\_MRT | 10 | | | PROTOCOL\_ZEBRA | 11 | | | PROTOCOL\_BIRD | 12 | | | PROTOCOL\_DNROUTED | 13 | | | PROTOCOL\_XORP | 14 | | | PROTOCOL\_NTK | 15 | | | PROTOCOL\_DHCP | 16 | | | PROTOCOL\_MRTD | 17 | | | PROTOCOL\_KEEPALIVED | 18 | | | PROTOCOL\_BABEL | 42 | | | PROTOCOL\_OPENR | 99 | | | PROTOCOL\_BGP | 186 | | | PROTOCOL\_ISIS | 187 | | | PROTOCOL\_OSPF | 188 | | | PROTOCOL\_RIP | 189 | | | PROTOCOL\_EIGRP | 192 | | ### NethelpersRouteType NethelpersRouteType is a route type. | Name | Number | Description | | ----------------- | ------ | ----------- | | TYPE\_UNSPEC | 0 | | | TYPE\_UNICAST | 1 | | | TYPE\_LOCAL | 2 | | | TYPE\_BROADCAST | 3 | | | TYPE\_ANYCAST | 4 | | | TYPE\_MULTICAST | 5 | | | TYPE\_BLACKHOLE | 6 | | | TYPE\_UNREACHABLE | 7 | | | TYPE\_PROHIBIT | 8 | | | TYPE\_THROW | 9 | | | TYPE\_NAT | 10 | | | TYPE\_X\_RESOLVE | 11 | | ### NethelpersRoutingTable NethelpersRoutingTable is a routing table ID. | Name | Number | Description | | -------------- | ------ | ----------- | | TABLE\_UNSPEC | 0 | | | TABLE1 | 1 | | | TABLE2 | 2 | | | TABLE3 | 3 | | | TABLE4 | 4 | | | TABLE5 | 5 | | | TABLE6 | 6 | | | TABLE7 | 7 | | | TABLE8 | 8 | | | TABLE9 | 9 | | | TABLE10 | 10 | | | TABLE11 | 11 | | | TABLE12 | 12 | | | TABLE13 | 13 | | | TABLE14 | 14 | | | TABLE15 | 15 | | | TABLE16 | 16 | | | TABLE17 | 17 | | | TABLE18 | 18 | | | TABLE19 | 19 | | | TABLE20 | 20 | | | TABLE21 | 21 | | | TABLE22 | 22 | | | TABLE23 | 23 | | | TABLE24 | 24 | | | TABLE25 | 25 | | | TABLE26 | 26 | | | TABLE27 | 27 | | | TABLE28 | 28 | | | TABLE29 | 29 | | | TABLE30 | 30 | | | TABLE31 | 31 | | | TABLE32 | 32 | | | TABLE33 | 33 | | | TABLE34 | 34 | | | TABLE35 | 35 | | | TABLE36 | 36 | | | TABLE37 | 37 | | | TABLE38 | 38 | | | TABLE39 | 39 | | | TABLE40 | 40 | | | TABLE41 | 41 | | | TABLE42 | 42 | | | TABLE43 | 43 | | | TABLE44 | 44 | | | TABLE45 | 45 | | | TABLE46 | 46 | | | TABLE47 | 47 | | | TABLE48 | 48 | | | TABLE49 | 49 | | | TABLE50 | 50 | | | TABLE51 | 51 | | | TABLE52 | 52 | | | TABLE53 | 53 | | | TABLE54 | 54 | | | TABLE55 | 55 | | | TABLE56 | 56 | | | TABLE57 | 57 | | | TABLE58 | 58 | | | TABLE59 | 59 | | | TABLE60 | 60 | | | TABLE61 | 61 | | | TABLE62 | 62 | | | TABLE63 | 63 | | | TABLE64 | 64 | | | TABLE65 | 65 | | | TABLE66 | 66 | | | TABLE67 | 67 | | | TABLE68 | 68 | | | TABLE69 | 69 | | | TABLE70 | 70 | | | TABLE71 | 71 | | | TABLE72 | 72 | | | TABLE73 | 73 | | | TABLE74 | 74 | | | TABLE75 | 75 | | | TABLE76 | 76 | | | TABLE77 | 77 | | | TABLE78 | 78 | | | TABLE79 | 79 | | | TABLE80 | 80 | | | TABLE81 | 81 | | | TABLE82 | 82 | | | TABLE83 | 83 | | | TABLE84 | 84 | | | TABLE85 | 85 | | | TABLE86 | 86 | | | TABLE87 | 87 | | | TABLE88 | 88 | | | TABLE89 | 89 | | | TABLE90 | 90 | | | TABLE91 | 91 | | | TABLE92 | 92 | | | TABLE93 | 93 | | | TABLE94 | 94 | | | TABLE95 | 95 | | | TABLE96 | 96 | | | TABLE97 | 97 | | | TABLE98 | 98 | | | TABLE99 | 99 | | | TABLE100 | 100 | | | TABLE101 | 101 | | | TABLE102 | 102 | | | TABLE103 | 103 | | | TABLE104 | 104 | | | TABLE105 | 105 | | | TABLE106 | 106 | | | TABLE107 | 107 | | | TABLE108 | 108 | | | TABLE109 | 109 | | | TABLE110 | 110 | | | TABLE111 | 111 | | | TABLE112 | 112 | | | TABLE113 | 113 | | | TABLE114 | 114 | | | TABLE115 | 115 | | | TABLE116 | 116 | | | TABLE117 | 117 | | | TABLE118 | 118 | | | TABLE119 | 119 | | | TABLE120 | 120 | | | TABLE121 | 121 | | | TABLE122 | 122 | | | TABLE123 | 123 | | | TABLE124 | 124 | | | TABLE125 | 125 | | | TABLE126 | 126 | | | TABLE127 | 127 | | | TABLE128 | 128 | | | TABLE129 | 129 | | | TABLE130 | 130 | | | TABLE131 | 131 | | | TABLE132 | 132 | | | TABLE133 | 133 | | | TABLE134 | 134 | | | TABLE135 | 135 | | | TABLE136 | 136 | | | TABLE137 | 137 | | | TABLE138 | 138 | | | TABLE139 | 139 | | | TABLE140 | 140 | | | TABLE141 | 141 | | | TABLE142 | 142 | | | TABLE143 | 143 | | | TABLE144 | 144 | | | TABLE145 | 145 | | | TABLE146 | 146 | | | TABLE147 | 147 | | | TABLE148 | 148 | | | TABLE149 | 149 | | | TABLE150 | 150 | | | TABLE151 | 151 | | | TABLE152 | 152 | | | TABLE153 | 153 | | | TABLE154 | 154 | | | TABLE155 | 155 | | | TABLE156 | 156 | | | TABLE157 | 157 | | | TABLE158 | 158 | | | TABLE159 | 159 | | | TABLE160 | 160 | | | TABLE161 | 161 | | | TABLE162 | 162 | | | TABLE163 | 163 | | | TABLE164 | 164 | | | TABLE165 | 165 | | | TABLE166 | 166 | | | TABLE167 | 167 | | | TABLE168 | 168 | | | TABLE169 | 169 | | | TABLE170 | 170 | | | TABLE171 | 171 | | | TABLE172 | 172 | | | TABLE173 | 173 | | | TABLE174 | 174 | | | TABLE175 | 175 | | | TABLE176 | 176 | | | TABLE177 | 177 | | | TABLE178 | 178 | | | TABLE179 | 179 | | | TABLE180 | 180 | | | TABLE181 | 181 | | | TABLE182 | 182 | | | TABLE183 | 183 | | | TABLE184 | 184 | | | TABLE185 | 185 | | | TABLE186 | 186 | | | TABLE187 | 187 | | | TABLE188 | 188 | | | TABLE189 | 189 | | | TABLE190 | 190 | | | TABLE191 | 191 | | | TABLE192 | 192 | | | TABLE193 | 193 | | | TABLE194 | 194 | | | TABLE195 | 195 | | | TABLE196 | 196 | | | TABLE197 | 197 | | | TABLE198 | 198 | | | TABLE199 | 199 | | | TABLE200 | 200 | | | TABLE201 | 201 | | | TABLE202 | 202 | | | TABLE203 | 203 | | | TABLE204 | 204 | | | TABLE205 | 205 | | | TABLE206 | 206 | | | TABLE207 | 207 | | | TABLE208 | 208 | | | TABLE209 | 209 | | | TABLE210 | 210 | | | TABLE211 | 211 | | | TABLE212 | 212 | | | TABLE213 | 213 | | | TABLE214 | 214 | | | TABLE215 | 215 | | | TABLE216 | 216 | | | TABLE217 | 217 | | | TABLE218 | 218 | | | TABLE219 | 219 | | | TABLE220 | 220 | | | TABLE221 | 221 | | | TABLE222 | 222 | | | TABLE223 | 223 | | | TABLE224 | 224 | | | TABLE225 | 225 | | | TABLE226 | 226 | | | TABLE227 | 227 | | | TABLE228 | 228 | | | TABLE229 | 229 | | | TABLE230 | 230 | | | TABLE231 | 231 | | | TABLE232 | 232 | | | TABLE233 | 233 | | | TABLE234 | 234 | | | TABLE235 | 235 | | | TABLE236 | 236 | | | TABLE237 | 237 | | | TABLE238 | 238 | | | TABLE239 | 239 | | | TABLE240 | 240 | | | TABLE241 | 241 | | | TABLE242 | 242 | | | TABLE243 | 243 | | | TABLE244 | 244 | | | TABLE245 | 245 | | | TABLE246 | 246 | | | TABLE247 | 247 | | | TABLE248 | 248 | | | TABLE249 | 249 | | | TABLE250 | 250 | | | TABLE251 | 251 | | | TABLE252 | 252 | | | TABLE\_DEFAULT | 253 | | | TABLE\_MAIN | 254 | | | TABLE\_LOCAL | 255 | | ### NethelpersScope NethelpersScope is an address scope. | Name | Number | Description | | -------------- | ------ | ----------- | | SCOPE\_GLOBAL | 0 | | | SCOPE\_SITE | 200 | | | SCOPE\_LINK | 253 | | | SCOPE\_HOST | 254 | | | SCOPE\_NOWHERE | 255 | | ### NethelpersVLANProtocol NethelpersVLANProtocol is a VLAN protocol. | Name | Number | Description | | ------------------------------------- | ------ | ----------- | | NETHELPERS\_VLANPROTOCOL\_UNSPECIFIED | 0 | | | VLAN\_PROTOCOL8021\_Q | 33024 | | | VLAN\_PROTOCOL8021\_AD | 34984 | | ### NethelpersWOLMode NethelpersWOLMode wraps ethtool.WOLMode for YAML marshaling. | Name | Number | Description | | -------------------------------- | ------ | ----------- | | NETHELPERS\_WOLMODE\_UNSPECIFIED | 0 | | | WOL\_MODE\_PHY | 1 | | | WOL\_MODE\_UNICAST | 2 | | | WOL\_MODE\_MULTICAST | 4 | | | WOL\_MODE\_BROADCAST | 8 | | | WOL\_MODE\_MAGIC | 32 | | | WOL\_MODE\_MAGIC\_SECURE | 64 | | | WOL\_MODE\_FILTER | 128 | | ### NetworkConfigLayer NetworkConfigLayer describes network configuration layers, with lowest priority first. | Name | Number | Description | | ------------------------------ | ------ | ----------- | | CONFIG\_DEFAULT | 0 | | | CONFIG\_CMDLINE | 1 | | | CONFIG\_PLATFORM | 2 | | | CONFIG\_OPERATOR | 3 | | | CONFIG\_MACHINE\_CONFIGURATION | 4 | | ### NetworkOperator NetworkOperator enumerates Talos network operators. | Name | Number | Description | | --------------- | ------ | ----------- | | OPERATOR\_DHCP4 | 0 | | | OPERATOR\_DHCP6 | 1 | | | OPERATOR\_VIP | 2 | | ### RuntimeFIPSState RuntimeFIPSState describes the current FIPS status. | Name | Number | Description | | --------------------- | ------ | ----------- | | FIPS\_STATE\_DISABLED | 0 | | | FIPS\_STATE\_ENABLED | 1 | | | FIPS\_STATE\_STRICT | 2 | | ### RuntimeMachineStage RuntimeMachineStage describes the stage of the machine boot/run process. | Name | Number | Description | | ------------------------------ | ------ | ----------- | | MACHINE\_STAGE\_UNKNOWN | 0 | | | MACHINE\_STAGE\_BOOTING | 1 | | | MACHINE\_STAGE\_INSTALLING | 2 | | | MACHINE\_STAGE\_MAINTENANCE | 3 | | | MACHINE\_STAGE\_RUNNING | 4 | | | MACHINE\_STAGE\_REBOOTING | 5 | | | MACHINE\_STAGE\_SHUTTING\_DOWN | 6 | | | MACHINE\_STAGE\_RESETTING | 7 | | | MACHINE\_STAGE\_UPGRADING | 8 | | ### RuntimeSELinuxState RuntimeSELinuxState describes the current SELinux status. | Name | Number | Description | | ---------------------------- | ------ | ----------- | | SE\_LINUX\_STATE\_DISABLED | 0 | | | SE\_LINUX\_STATE\_PERMISSIVE | 1 | | | SE\_LINUX\_STATE\_ENFORCING | 2 | |

Top

## resource/definitions/block/block.proto ### DeviceSpec DeviceSpec is the spec for devices status. | Field | Type | Label | Description | | ----------------- | ----------------- | -------- | ----------- | | type | [string](#string) | | | | major | [int64](#int64) | | | | minor | [int64](#int64) | | | | partition\_name | [string](#string) | | | | partition\_number | [int64](#int64) | | | | generation | [int64](#int64) | | | | device\_path | [string](#string) | | | | parent | [string](#string) | | | | secondaries | [string](#string) | repeated | | ### DiscoveredVolumeSpec DiscoveredVolumeSpec is the spec for DiscoveredVolumes resource. | Field | Type | Label | Description | | ----------------------- | ----------------- | ----- | ----------- | | size | [uint64](#uint64) | | | | sector\_size | [uint64](#uint64) | | | | io\_size | [uint64](#uint64) | | | | name | [string](#string) | | | | uuid | [string](#string) | | | | label | [string](#string) | | | | block\_size | [uint32](#uint32) | | | | filesystem\_block\_size | [uint32](#uint32) | | | | probed\_size | [uint64](#uint64) | | | | partition\_uuid | [string](#string) | | | | partition\_type | [string](#string) | | | | partition\_label | [string](#string) | | | | partition\_index | [uint64](#uint64) | | | | type | [string](#string) | | | | device\_path | [string](#string) | | | | parent | [string](#string) | | | | dev\_path | [string](#string) | | | | parent\_dev\_path | [string](#string) | | | | pretty\_size | [string](#string) | | | ### DiscoveryRefreshRequestSpec DiscoveryRefreshRequestSpec is the spec for DiscoveryRefreshRequest. | Field | Type | Label | Description | | ------- | --------------- | ----- | ----------- | | request | [int64](#int64) | | | ### DiscoveryRefreshStatusSpec DiscoveryRefreshStatusSpec is the spec for DiscoveryRefreshStatus status. | Field | Type | Label | Description | | ------- | --------------- | ----- | ----------- | | request | [int64](#int64) | | | ### DiskSelector DiskSelector selects a disk for the volume. | Field | Type | Label | Description | | ----- | ----------------------------------------------------------------------------- | ----- | ----------- | | match | [google.api.expr.v1alpha1.CheckedExpr](#google.api.expr.v1alpha1.CheckedExpr) | | | ### DiskSpec DiskSpec is the spec for Disks status. | Field | Type | Label | Description | | ---------------- | ----------------- | -------- | ----------- | | size | [uint64](#uint64) | | | | io\_size | [uint64](#uint64) | | | | sector\_size | [uint64](#uint64) | | | | readonly | [bool](#bool) | | | | model | [string](#string) | | | | serial | [string](#string) | | | | modalias | [string](#string) | | | | wwid | [string](#string) | | | | bus\_path | [string](#string) | | | | sub\_system | [string](#string) | | | | transport | [string](#string) | | | | rotational | [bool](#bool) | | | | cdrom | [bool](#bool) | | | | dev\_path | [string](#string) | | | | pretty\_size | [string](#string) | | | | secondary\_disks | [string](#string) | repeated | | | uuid | [string](#string) | | | | symlinks | [string](#string) | repeated | | ### EncryptionKey EncryptionKey is the spec for volume encryption key. | Field | Type | Label | Description | | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------- | -------- | ----------- | | slot | [int64](#int64) | | | | type | [talos.resource.definitions.enums.BlockEncryptionKeyType](#talos.resource.definitions.enums.BlockEncryptionKeyType) | | | | static\_passphrase | [bytes](#bytes) | | | | kms\_endpoint | [string](#string) | | | | tpm\_check\_secureboot\_status\_on\_enroll | [bool](#bool) | | | | lock\_to\_state | [bool](#bool) | | | | tpmpc\_rs | [int64](#int64) | repeated | | | tpm\_pub\_key\_pc\_rs | [int64](#int64) | repeated | | ### EncryptionSpec EncryptionSpec is the spec for volume encryption. | Field | Type | Label | Description | | ------------- | ----------------------------------------------------------------------------------------------------------------------------- | -------- | ----------- | | provider | [talos.resource.definitions.enums.BlockEncryptionProviderType](#talos.resource.definitions.enums.BlockEncryptionProviderType) | | | | keys | [EncryptionKey](#talos.resource.definitions.block.EncryptionKey) | repeated | | | cipher | [string](#string) | | | | key\_size | [uint64](#uint64) | | | | block\_size | [uint64](#uint64) | | | | perf\_options | [string](#string) | repeated | | ### FilesystemSpec FilesystemSpec is the spec for volume filesystem. | Field | Type | Label | Description | | ----- | ------------------------------------------------------------------------------------------------------------- | ----- | ----------- | | type | [talos.resource.definitions.enums.BlockFilesystemType](#talos.resource.definitions.enums.BlockFilesystemType) | | | | label | [string](#string) | | | ### LocatorSpec LocatorSpec is the spec for volume locator. | Field | Type | Label | Description | | ----- | ----------------------------------------------------------------------------- | ----- | ----------- | | match | [google.api.expr.v1alpha1.CheckedExpr](#google.api.expr.v1alpha1.CheckedExpr) | | | ### MountRequestSpec MountRequestSpec is the spec for MountRequest. | Field | Type | Label | Description | | ----------------- | ----------------- | -------- | ----------- | | volume\_id | [string](#string) | | | | parent\_mount\_id | [string](#string) | | | | requesters | [string](#string) | repeated | | | requester\_i\_ds | [string](#string) | repeated | | | read\_only | [bool](#bool) | | | | detached | [bool](#bool) | | | ### MountSpec MountSpec is the spec for volume mount. | Field | Type | Label | Description | | ----------------------- | ----------------- | ----- | ----------- | | target\_path | [string](#string) | | | | selinux\_label | [string](#string) | | | | project\_quota\_support | [bool](#bool) | | | | parent\_id | [string](#string) | | | | file\_mode | [uint32](#uint32) | | | | uid | [int64](#int64) | | | | gid | [int64](#int64) | | | | recursive\_relabel | [bool](#bool) | | | ### MountStatusSpec MountStatusSpec is the spec for MountStatus. | Field | Type | Label | Description | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----- | ----------- | | spec | [MountRequestSpec](#talos.resource.definitions.block.MountRequestSpec) | | | | target | [string](#string) | | | | source | [string](#string) | | | | filesystem | [talos.resource.definitions.enums.BlockFilesystemType](#talos.resource.definitions.enums.BlockFilesystemType) | | | | read\_only | [bool](#bool) | | | | project\_quota\_support | [bool](#bool) | | | | encryption\_provider | [talos.resource.definitions.enums.BlockEncryptionProviderType](#talos.resource.definitions.enums.BlockEncryptionProviderType) | | | | detached | [bool](#bool) | | | ### PartitionSpec PartitionSpec is the spec for volume partitioning. | Field | Type | Label | Description | | ---------- | ----------------- | ----- | ----------- | | min\_size | [uint64](#uint64) | | | | max\_size | [uint64](#uint64) | | | | grow | [bool](#bool) | | | | label | [string](#string) | | | | type\_uuid | [string](#string) | | | ### ProvisioningSpec ProvisioningSpec is the spec for volume provisioning. | Field | Type | Label | Description | | ---------------- | ------------------------------------------------------------------ | ----- | ----------- | | disk\_selector | [DiskSelector](#talos.resource.definitions.block.DiskSelector) | | | | partition\_spec | [PartitionSpec](#talos.resource.definitions.block.PartitionSpec) | | | | wave | [int64](#int64) | | | | filesystem\_spec | [FilesystemSpec](#talos.resource.definitions.block.FilesystemSpec) | | | ### SwapStatusSpec SwapStatusSpec is the spec for SwapStatuss resource. | Field | Type | Label | Description | | ----------- | ----------------- | ----- | ----------- | | device | [string](#string) | | | | size\_bytes | [uint64](#uint64) | | | | size\_human | [string](#string) | | | | used\_bytes | [uint64](#uint64) | | | | used\_human | [string](#string) | | | | priority | [int32](#int32) | | | | type | [string](#string) | | | ### SymlinkProvisioningSpec SymlinkProvisioningSpec is the spec for volume symlink. | Field | Type | Label | Description | | --------------------- | ----------------- | ----- | ----------- | | symlink\_target\_path | [string](#string) | | | | force | [bool](#bool) | | | ### SymlinkSpec SymlinkSpec is the spec for Symlinks resource. | Field | Type | Label | Description | | ----- | ----------------- | -------- | ----------- | | paths | [string](#string) | repeated | | ### SystemDiskSpec SystemDiskSpec is the spec for SystemDisks resource. | Field | Type | Label | Description | | --------- | ----------------- | ----- | ----------- | | disk\_id | [string](#string) | | | | dev\_path | [string](#string) | | | ### TPMEncryptionOptionsInfo TPMEncryptionOptionsInfo is the options for TPM-based encryption. | Field | Type | Label | Description | | ---------------- | --------------- | -------- | ----------- | | pc\_rs | [int64](#int64) | repeated | | | pub\_key\_pc\_rs | [int64](#int64) | repeated | | ### UserDiskConfigStatusSpec UserDiskConfigStatusSpec is the spec for UserDiskConfigStatus resource. | Field | Type | Label | Description | | ---------- | ------------- | ----- | ----------- | | ready | [bool](#bool) | | | | torn\_down | [bool](#bool) | | | ### VolumeConfigSpec VolumeConfigSpec is the spec for VolumeConfig resource. | Field | Type | Label | Description | | ------------ | ----------------------------------------------------------------------------------------------------- | ----- | ----------- | | parent\_id | [string](#string) | | | | type | [talos.resource.definitions.enums.BlockVolumeType](#talos.resource.definitions.enums.BlockVolumeType) | | | | provisioning | [ProvisioningSpec](#talos.resource.definitions.block.ProvisioningSpec) | | | | locator | [LocatorSpec](#talos.resource.definitions.block.LocatorSpec) | | | | mount | [MountSpec](#talos.resource.definitions.block.MountSpec) | | | | encryption | [EncryptionSpec](#talos.resource.definitions.block.EncryptionSpec) | | | | symlink | [SymlinkProvisioningSpec](#talos.resource.definitions.block.SymlinkProvisioningSpec) | | | ### VolumeMountRequestSpec VolumeMountRequestSpec is the spec for VolumeMountRequest. | Field | Type | Label | Description | | ---------- | ----------------- | ----- | ----------- | | volume\_id | [string](#string) | | | | requester | [string](#string) | | | | read\_only | [bool](#bool) | | | | detached | [bool](#bool) | | | ### VolumeMountStatusSpec VolumeMountStatusSpec is the spec for VolumeMountStatus. | Field | Type | Label | Description | | ---------- | ----------------- | ----- | ----------- | | volume\_id | [string](#string) | | | | requester | [string](#string) | | | | target | [string](#string) | | | | read\_only | [bool](#bool) | | | | detached | [bool](#bool) | | | ### VolumeStatusSpec VolumeStatusSpec is the spec for VolumeStatus resource. | Field | Type | Label | Description | | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -------- | ----------- | | phase | [talos.resource.definitions.enums.BlockVolumePhase](#talos.resource.definitions.enums.BlockVolumePhase) | | | | location | [string](#string) | | | | error\_message | [string](#string) | | | | uuid | [string](#string) | | | | partition\_uuid | [string](#string) | | | | pre\_fail\_phase | [talos.resource.definitions.enums.BlockVolumePhase](#talos.resource.definitions.enums.BlockVolumePhase) | | | | parent\_location | [string](#string) | | | | partition\_index | [int64](#int64) | | | | size | [uint64](#uint64) | | | | filesystem | [talos.resource.definitions.enums.BlockFilesystemType](#talos.resource.definitions.enums.BlockFilesystemType) | | | | mount\_location | [string](#string) | | | | encryption\_provider | [talos.resource.definitions.enums.BlockEncryptionProviderType](#talos.resource.definitions.enums.BlockEncryptionProviderType) | | | | pretty\_size | [string](#string) | | | | encryption\_failed\_syncs | [string](#string) | repeated | | | mount\_spec | [MountSpec](#talos.resource.definitions.block.MountSpec) | | | | type | [talos.resource.definitions.enums.BlockVolumeType](#talos.resource.definitions.enums.BlockVolumeType) | | | | configured\_encryption\_keys | [string](#string) | repeated | | | symlink\_spec | [SymlinkProvisioningSpec](#talos.resource.definitions.block.SymlinkProvisioningSpec) | | | | parent\_id | [string](#string) | | | | encryption\_locked\_to\_state | [bool](#bool) | | | | encryption\_slot | [int64](#int64) | | | | tpm\_encryption\_options | [TPMEncryptionOptionsInfo](#talos.resource.definitions.block.TPMEncryptionOptionsInfo) | | | ### ZswapStatusSpec ZswapStatusSpec is the spec for ZswapStatus resource. | Field | Type | Label | Description | | ----------------------- | ----------------- | ----- | ----------- | | total\_size\_bytes | [uint64](#uint64) | | | | total\_size\_human | [string](#string) | | | | stored\_pages | [uint64](#uint64) | | | | pool\_limit\_hit | [uint64](#uint64) | | | | reject\_reclaim\_fail | [uint64](#uint64) | | | | reject\_alloc\_fail | [uint64](#uint64) | | | | reject\_kmemcache\_fail | [uint64](#uint64) | | | | reject\_compress\_fail | [uint64](#uint64) | | | | reject\_compress\_poor | [uint64](#uint64) | | | | written\_back\_pages | [uint64](#uint64) | | |

Top

## resource/definitions/cluster/cluster.proto ### AffiliateSpec AffiliateSpec describes Affiliate state. | Field | Type | Label | Description | | ----------------- | --------------------------------------------------------------------------------------------- | -------- | ----------- | | node\_id | [string](#string) | | | | addresses | [common.NetIP](#common.NetIP) | repeated | | | hostname | [string](#string) | | | | nodename | [string](#string) | | | | operating\_system | [string](#string) | | | | machine\_type | [talos.resource.definitions.enums.MachineType](#talos.resource.definitions.enums.MachineType) | | | | kube\_span | [KubeSpanAffiliateSpec](#talos.resource.definitions.cluster.KubeSpanAffiliateSpec) | | | | control\_plane | [ControlPlane](#talos.resource.definitions.cluster.ControlPlane) | | | ### ConfigSpec ConfigSpec describes KubeSpan configuration. | Field | Type | Label | Description | | ----------------------------- | ----------------- | ----- | ----------- | | discovery\_enabled | [bool](#bool) | | | | registry\_kubernetes\_enabled | [bool](#bool) | | | | registry\_service\_enabled | [bool](#bool) | | | | service\_endpoint | [string](#string) | | | | service\_endpoint\_insecure | [bool](#bool) | | | | service\_encryption\_key | [bytes](#bytes) | | | | service\_cluster\_id | [string](#string) | | | ### ControlPlane ControlPlane describes ControlPlane data if any. | Field | Type | Label | Description | | ----------------- | --------------- | ----- | ----------- | | api\_server\_port | [int64](#int64) | | | ### IdentitySpec IdentitySpec describes status of rendered secrets. Note: IdentitySpec is persisted on disk in the STATE partition, so YAML serialization should be kept backwards compatible. | Field | Type | Label | Description | | -------- | ----------------- | ----- | ----------- | | node\_id | [string](#string) | | | ### InfoSpec InfoSpec describes cluster information. | Field | Type | Label | Description | | ------------- | ----------------- | ----- | ----------- | | cluster\_id | [string](#string) | | | | cluster\_name | [string](#string) | | | ### KubeSpanAffiliateSpec KubeSpanAffiliateSpec describes additional information specific for the KubeSpan. | Field | Type | Label | Description | | --------------------- | ----------------------------------------- | -------- | ----------- | | public\_key | [string](#string) | | | | address | [common.NetIP](#common.NetIP) | | | | additional\_addresses | [common.NetIPPrefix](#common.NetIPPrefix) | repeated | | | endpoints | [common.NetIPPort](#common.NetIPPort) | repeated | | ### MemberSpec MemberSpec describes Member state. | Field | Type | Label | Description | | ----------------- | --------------------------------------------------------------------------------------------- | -------- | ----------- | | node\_id | [string](#string) | | | | addresses | [common.NetIP](#common.NetIP) | repeated | | | hostname | [string](#string) | | | | machine\_type | [talos.resource.definitions.enums.MachineType](#talos.resource.definitions.enums.MachineType) | | | | operating\_system | [string](#string) | | | | control\_plane | [ControlPlane](#talos.resource.definitions.cluster.ControlPlane) | | |

Top

## resource/definitions/cri/cri.proto ### ImageCacheConfigSpec ImageCacheConfigSpec represents the ImageCacheConfig. | Field | Type | Label | Description | | ------------ | --------------------------------------------------------------------------------------------------------------------- | -------- | ----------- | | status | [talos.resource.definitions.enums.CriImageCacheStatus](#talos.resource.definitions.enums.CriImageCacheStatus) | | | | roots | [string](#string) | repeated | | | copy\_status | [talos.resource.definitions.enums.CriImageCacheCopyStatus](#talos.resource.definitions.enums.CriImageCacheCopyStatus) | | | ### RegistriesConfigSpec RegistriesConfigSpec describes status of rendered secrets. | Field | Type | Label | Description | | ----------------- | ---------------------------------------------------------------------------------------------------------------------- | -------- | ----------- | | registry\_mirrors | [RegistriesConfigSpec.RegistryMirrorsEntry](#talos.resource.definitions.cri.RegistriesConfigSpec.RegistryMirrorsEntry) | repeated | | | registry\_config | [RegistriesConfigSpec.RegistryConfigEntry](#talos.resource.definitions.cri.RegistriesConfigSpec.RegistryConfigEntry) | repeated | | ### RegistriesConfigSpec.RegistryConfigEntry | Field | Type | Label | Description | | ----- | ---------------------------------------------------------------- | ----- | ----------- | | key | [string](#string) | | | | value | [RegistryConfig](#talos.resource.definitions.cri.RegistryConfig) | | | ### RegistriesConfigSpec.RegistryMirrorsEntry | Field | Type | Label | Description | | ----- | ---------------------------------------------------------------------------- | ----- | ----------- | | key | [string](#string) | | | | value | [RegistryMirrorConfig](#talos.resource.definitions.cri.RegistryMirrorConfig) | | | ### RegistryAuthConfig RegistryAuthConfig specifies authentication configuration for a registry. | Field | Type | Label | Description | | ------------------------- | ----------------- | ----- | ----------- | | registry\_username | [string](#string) | | | | registry\_password | [string](#string) | | | | registry\_auth | [string](#string) | | | | registry\_identity\_token | [string](#string) | | | ### RegistryConfig RegistryConfig specifies auth & TLS config per registry. | Field | Type | Label | Description | | -------------- | ------------------------------------------------------------------------ | ----- | ----------- | | registry\_tls | [RegistryTLSConfig](#talos.resource.definitions.cri.RegistryTLSConfig) | | | | registry\_auth | [RegistryAuthConfig](#talos.resource.definitions.cri.RegistryAuthConfig) | | | ### RegistryEndpointConfig RegistryEndpointConfig represents a single registry endpoint. | Field | Type | Label | Description | | ------------------------ | ----------------- | ----- | ----------- | | endpoint\_endpoint | [string](#string) | | | | endpoint\_override\_path | [bool](#bool) | | | ### RegistryMirrorConfig RegistryMirrorConfig represents mirror configuration for a registry. | Field | Type | Label | Description | | ---------------------- | -------------------------------------------------------------------------------- | -------- | ----------- | | mirror\_endpoints | [RegistryEndpointConfig](#talos.resource.definitions.cri.RegistryEndpointConfig) | repeated | | | mirror\_skip\_fallback | [bool](#bool) | | | ### RegistryTLSConfig RegistryTLSConfig specifies TLS config for HTTPS registries. | Field | Type | Label | Description | | --------------------------- | ------------------------------------------------------------------------- | ----- | ----------- | | tls\_client\_identity | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | | tlsca | [bytes](#bytes) | | | | tls\_insecure\_skip\_verify | [bool](#bool) | | | ### SeccompProfileSpec SeccompProfileSpec represents the SeccompProfile. | Field | Type | Label | Description | | ----- | ------------------------------------------------- | ----- | ----------- | | name | [string](#string) | | | | value | [google.protobuf.Struct](#google.protobuf.Struct) | | |

Top

## resource/definitions/etcd/etcd.proto ### ConfigSpec ConfigSpec describes (some) configuration settings of etcd. | Field | Type | Label | Description | | --------------------------- | --------------------------------------------------------------------------------------- | -------- | ----------- | | advertise\_valid\_subnets | [string](#string) | repeated | | | advertise\_exclude\_subnets | [string](#string) | repeated | | | image | [string](#string) | | | | extra\_args | [ConfigSpec.ExtraArgsEntry](#talos.resource.definitions.etcd.ConfigSpec.ExtraArgsEntry) | repeated | | | listen\_valid\_subnets | [string](#string) | repeated | | | listen\_exclude\_subnets | [string](#string) | repeated | | ### ConfigSpec.ExtraArgsEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### MemberSpec MemberSpec holds information about an etcd member. | Field | Type | Label | Description | | ---------- | ----------------- | ----- | ----------- | | member\_id | [string](#string) | | | ### PKIStatusSpec PKIStatusSpec describes status of rendered secrets. | Field | Type | Label | Description | | ------- | ----------------- | ----- | ----------- | | ready | [bool](#bool) | | | | version | [string](#string) | | | ### SpecSpec SpecSpec describes (some) Specuration settings of etcd. | Field | Type | Label | Description | | ------------------------- | ----------------------------------------------------------------------------------- | -------- | ----------- | | name | [string](#string) | | | | advertised\_addresses | [common.NetIP](#common.NetIP) | repeated | | | image | [string](#string) | | | | extra\_args | [SpecSpec.ExtraArgsEntry](#talos.resource.definitions.etcd.SpecSpec.ExtraArgsEntry) | repeated | | | listen\_peer\_addresses | [common.NetIP](#common.NetIP) | repeated | | | listen\_client\_addresses | [common.NetIP](#common.NetIP) | repeated | | ### SpecSpec.ExtraArgsEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | |

Top

## resource/definitions/extensions/extensions.proto ### Compatibility Compatibility describes extension compatibility. | Field | Type | Label | Description | | ----- | --------------------------------------------------------------- | ----- | ----------- | | talos | [Constraint](#talos.resource.definitions.extensions.Constraint) | | | ### Constraint Constraint describes compatibility constraint. | Field | Type | Label | Description | | ------- | ----------------- | ----- | ----------- | | version | [string](#string) | | | ### Layer Layer defines overlay mount layer. | Field | Type | Label | Description | | -------- | ----------------------------------------------------------- | ----- | ----------- | | image | [string](#string) | | | | metadata | [Metadata](#talos.resource.definitions.extensions.Metadata) | | | ### Metadata Metadata describes base extension metadata. | Field | Type | Label | Description | | ------------- | --------------------------------------------------------------------- | ----- | ----------- | | name | [string](#string) | | | | version | [string](#string) | | | | author | [string](#string) | | | | description | [string](#string) | | | | compatibility | [Compatibility](#talos.resource.definitions.extensions.Compatibility) | | | | extra\_info | [string](#string) | | |

Top

## resource/definitions/files/files.proto ### EtcFileSpecSpec EtcFileSpecSpec describes status of rendered secrets. | Field | Type | Label | Description | | -------------- | ----------------- | ----- | ----------- | | contents | [bytes](#bytes) | | | | mode | [uint32](#uint32) | | | | selinux\_label | [string](#string) | | | ### EtcFileStatusSpec EtcFileStatusSpec describes status of rendered secrets. | Field | Type | Label | Description | | ------------- | ----------------- | ----- | ----------- | | spec\_version | [string](#string) | | |

Top

## resource/definitions/hardware/hardware.proto ### MemoryModuleSpec MemoryModuleSpec represents a single Memory. | Field | Type | Label | Description | | --------------- | ----------------- | ----- | ----------- | | size | [uint32](#uint32) | | | | device\_locator | [string](#string) | | | | bank\_locator | [string](#string) | | | | speed | [uint32](#uint32) | | | | manufacturer | [string](#string) | | | | serial\_number | [string](#string) | | | | asset\_tag | [string](#string) | | | | product\_name | [string](#string) | | | ### PCIDeviceSpec PCIDeviceSpec represents a single processor. | Field | Type | Label | Description | | ------------ | ----------------- | ----- | ----------- | | class | [string](#string) | | | | subclass | [string](#string) | | | | vendor | [string](#string) | | | | product | [string](#string) | | | | class\_id | [string](#string) | | | | subclass\_id | [string](#string) | | | | vendor\_id | [string](#string) | | | | product\_id | [string](#string) | | | | driver | [string](#string) | | | ### PCIDriverRebindConfigSpec PCIDriverRebindConfigSpec describes PCI rebind configuration. | Field | Type | Label | Description | | -------------- | ----------------- | ----- | ----------- | | pciid | [string](#string) | | | | target\_driver | [string](#string) | | | ### PCIDriverRebindStatusSpec PCIDriverRebindStatusSpec describes status of rebinded drivers. | Field | Type | Label | Description | | -------------- | ----------------- | ----- | ----------- | | pciid | [string](#string) | | | | target\_driver | [string](#string) | | | ### ProcessorSpec ProcessorSpec represents a single processor. | Field | Type | Label | Description | | -------------- | ----------------- | ----- | ----------- | | socket | [string](#string) | | | | manufacturer | [string](#string) | | | | product\_name | [string](#string) | | | | max\_speed | [uint32](#uint32) | | | | boot\_speed | [uint32](#uint32) | | | | status | [uint32](#uint32) | | | | serial\_number | [string](#string) | | | | asset\_tag | [string](#string) | | | | part\_number | [string](#string) | | | | core\_count | [uint32](#uint32) | | | | core\_enabled | [uint32](#uint32) | | | | thread\_count | [uint32](#uint32) | | | ### SystemInformationSpec SystemInformationSpec represents the system information obtained from smbios. | Field | Type | Label | Description | | -------------- | ----------------- | ----- | ----------- | | manufacturer | [string](#string) | | | | product\_name | [string](#string) | | | | version | [string](#string) | | | | serial\_number | [string](#string) | | | | uuid | [string](#string) | | | | wake\_up\_type | [string](#string) | | | | sku\_number | [string](#string) | | |

Top

## resource/definitions/proto/proto.proto ### LinuxIDMapping LinuxIDMapping specifies UID/GID mappings. | Field | Type | Label | Description | | ------------- | ----------------- | ----- | ----------- | | container\_id | [uint32](#uint32) | | | | host\_id | [uint32](#uint32) | | | | size | [uint32](#uint32) | | | ### Mount Mount specifies a mount for a container. | Field | Type | Label | Description | | ------------- | ------------------------------------------------------------------ | -------- | ----------- | | destination | [string](#string) | | | | type | [string](#string) | | | | source | [string](#string) | | | | options | [string](#string) | repeated | | | uid\_mappings | [LinuxIDMapping](#talos.resource.definitions.proto.LinuxIDMapping) | repeated | | | gid\_mappings | [LinuxIDMapping](#talos.resource.definitions.proto.LinuxIDMapping) | repeated | |

Top

## resource/definitions/k8s/k8s.proto ### APIServerConfigSpec APIServerConfigSpec is configuration for kube-apiserver. | Field | Type | Label | Description | | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -------- | ----------- | | image | [string](#string) | | | | cloud\_provider | [string](#string) | | | | control\_plane\_endpoint | [string](#string) | | | | etcd\_servers | [string](#string) | repeated | | | local\_port | [int64](#int64) | | | | service\_cid\_rs | [string](#string) | repeated | | | extra\_args | [APIServerConfigSpec.ExtraArgsEntry](#talos.resource.definitions.k8s.APIServerConfigSpec.ExtraArgsEntry) | repeated | | | extra\_volumes | [ExtraVolume](#talos.resource.definitions.k8s.ExtraVolume) | repeated | | | environment\_variables | [APIServerConfigSpec.EnvironmentVariablesEntry](#talos.resource.definitions.k8s.APIServerConfigSpec.EnvironmentVariablesEntry) | repeated | | | advertised\_address | [string](#string) | | | | resources | [Resources](#talos.resource.definitions.k8s.Resources) | | | ### APIServerConfigSpec.EnvironmentVariablesEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### APIServerConfigSpec.ExtraArgsEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### AdmissionControlConfigSpec AdmissionControlConfigSpec is configuration for kube-apiserver. | Field | Type | Label | Description | | ------ | -------------------------------------------------------------------------- | -------- | ----------- | | config | [AdmissionPluginSpec](#talos.resource.definitions.k8s.AdmissionPluginSpec) | repeated | | ### AdmissionPluginSpec AdmissionPluginSpec is a single admission plugin configuration Admission Control plugins. | Field | Type | Label | Description | | ------------- | ------------------------------------------------- | ----- | ----------- | | name | [string](#string) | | | | configuration | [google.protobuf.Struct](#google.protobuf.Struct) | | | ### AuditPolicyConfigSpec AuditPolicyConfigSpec is audit policy configuration for kube-apiserver. | Field | Type | Label | Description | | ------ | ------------------------------------------------- | ----- | ----------- | | config | [google.protobuf.Struct](#google.protobuf.Struct) | | | ### AuthorizationAuthorizersSpec AuthorizationAuthorizersSpec is a configuration of authorization authorizers. | Field | Type | Label | Description | | ------- | ------------------------------------------------- | ----- | ----------- | | type | [string](#string) | | | | name | [string](#string) | | | | webhook | [google.protobuf.Struct](#google.protobuf.Struct) | | | ### AuthorizationConfigSpec AuthorizationConfigSpec is authorization configuration for kube-apiserver. | Field | Type | Label | Description | | ------ | -------------------------------------------------------------------------------------------- | -------- | ----------- | | image | [string](#string) | | | | config | [AuthorizationAuthorizersSpec](#talos.resource.definitions.k8s.AuthorizationAuthorizersSpec) | repeated | | ### BootstrapManifestsConfigSpec BootstrapManifestsConfigSpec is configuration for bootstrap manifests. | Field | Type | Label | Description | | ------------------------------ | ----------------- | -------- | ----------- | | server | [string](#string) | | | | cluster\_domain | [string](#string) | | | | pod\_cid\_rs | [string](#string) | repeated | | | proxy\_enabled | [bool](#bool) | | | | proxy\_image | [string](#string) | | | | proxy\_args | [string](#string) | repeated | | | core\_dns\_enabled | [bool](#bool) | | | | core\_dns\_image | [string](#string) | | | | dns\_service\_ip | [string](#string) | | | | dns\_service\_i\_pv6 | [string](#string) | | | | flannel\_enabled | [bool](#bool) | | | | flannel\_image | [string](#string) | | | | pod\_security\_policy\_enabled | [bool](#bool) | | | | talos\_api\_service\_enabled | [bool](#bool) | | | | flannel\_extra\_args | [string](#string) | repeated | | | flannel\_kube\_service\_host | [string](#string) | | | | flannel\_kube\_service\_port | [string](#string) | | | ### ConfigStatusSpec ConfigStatusSpec describes status of rendered secrets. | Field | Type | Label | Description | | ------- | ----------------- | ----- | ----------- | | ready | [bool](#bool) | | | | version | [string](#string) | | | ### ControllerManagerConfigSpec ControllerManagerConfigSpec is configuration for kube-controller-manager. | Field | Type | Label | Description | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------- | | enabled | [bool](#bool) | | | | image | [string](#string) | | | | cloud\_provider | [string](#string) | | | | pod\_cid\_rs | [string](#string) | repeated | | | service\_cid\_rs | [string](#string) | repeated | | | extra\_args | [ControllerManagerConfigSpec.ExtraArgsEntry](#talos.resource.definitions.k8s.ControllerManagerConfigSpec.ExtraArgsEntry) | repeated | | | extra\_volumes | [ExtraVolume](#talos.resource.definitions.k8s.ExtraVolume) | repeated | | | environment\_variables | [ControllerManagerConfigSpec.EnvironmentVariablesEntry](#talos.resource.definitions.k8s.ControllerManagerConfigSpec.EnvironmentVariablesEntry) | repeated | | | resources | [Resources](#talos.resource.definitions.k8s.Resources) | | | ### ControllerManagerConfigSpec.EnvironmentVariablesEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### ControllerManagerConfigSpec.ExtraArgsEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### EndpointSpec EndpointSpec describes status of rendered secrets. | Field | Type | Label | Description | | --------- | ----------------------------- | -------- | ----------- | | addresses | [common.NetIP](#common.NetIP) | repeated | | ### ExtraManifest ExtraManifest defines a single extra manifest to download. | Field | Type | Label | Description | | ---------------- | -------------------------------------------------------------------------------------------------- | -------- | ----------- | | name | [string](#string) | | | | url | [string](#string) | | | | priority | [string](#string) | | | | extra\_headers | [ExtraManifest.ExtraHeadersEntry](#talos.resource.definitions.k8s.ExtraManifest.ExtraHeadersEntry) | repeated | | | inline\_manifest | [string](#string) | | | ### ExtraManifest.ExtraHeadersEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### ExtraManifestsConfigSpec ExtraManifestsConfigSpec is configuration for extra bootstrap manifests. | Field | Type | Label | Description | | ---------------- | -------------------------------------------------------------- | -------- | ----------- | | extra\_manifests | [ExtraManifest](#talos.resource.definitions.k8s.ExtraManifest) | repeated | | ### ExtraVolume ExtraVolume is a configuration of extra volume. | Field | Type | Label | Description | | ----------- | ----------------- | ----- | ----------- | | name | [string](#string) | | | | host\_path | [string](#string) | | | | mount\_path | [string](#string) | | | | read\_only | [bool](#bool) | | | ### KubePrismConfigSpec KubePrismConfigSpec describes KubePrismConfig data. | Field | Type | Label | Description | | --------- | ---------------------------------------------------------------------- | -------- | ----------- | | host | [string](#string) | | | | port | [int64](#int64) | | | | endpoints | [KubePrismEndpoint](#talos.resource.definitions.k8s.KubePrismEndpoint) | repeated | | ### KubePrismEndpoint KubePrismEndpoint holds data for control plane endpoint. | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | host | [string](#string) | | | | port | [uint32](#uint32) | | | ### KubePrismEndpointsSpec KubePrismEndpointsSpec describes KubePrismEndpoints configuration. | Field | Type | Label | Description | | --------- | ---------------------------------------------------------------------- | -------- | ----------- | | endpoints | [KubePrismEndpoint](#talos.resource.definitions.k8s.KubePrismEndpoint) | repeated | | ### KubePrismStatusesSpec KubePrismStatusesSpec describes KubePrismStatuses data. | Field | Type | Label | Description | | ------- | ----------------- | ----- | ----------- | | host | [string](#string) | | | | healthy | [bool](#bool) | | | ### KubeletConfigSpec KubeletConfigSpec holds the source of kubelet configuration. | Field | Type | Label | Description | | ------------------------------------- | ---------------------------------------------------------------------------------------------------- | -------- | ----------- | | image | [string](#string) | | | | cluster\_dns | [string](#string) | repeated | | | cluster\_domain | [string](#string) | | | | extra\_args | [KubeletConfigSpec.ExtraArgsEntry](#talos.resource.definitions.k8s.KubeletConfigSpec.ExtraArgsEntry) | repeated | | | extra\_mounts | [talos.resource.definitions.proto.Mount](#talos.resource.definitions.proto.Mount) | repeated | | | extra\_config | [google.protobuf.Struct](#google.protobuf.Struct) | | | | cloud\_provider\_external | [bool](#bool) | | | | default\_runtime\_seccomp\_enabled | [bool](#bool) | | | | skip\_node\_registration | [bool](#bool) | | | | static\_pod\_list\_url | [string](#string) | | | | disable\_manifests\_directory | [bool](#bool) | | | | enable\_fs\_quota\_monitoring | [bool](#bool) | | | | credential\_provider\_config | [google.protobuf.Struct](#google.protobuf.Struct) | | | | allow\_scheduling\_on\_control\_plane | [bool](#bool) | | | ### KubeletConfigSpec.ExtraArgsEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### KubeletSpecSpec KubeletSpecSpec holds the source of kubelet configuration. | Field | Type | Label | Description | | ---------------------------- | --------------------------------------------------------------------------------- | -------- | ----------- | | image | [string](#string) | | | | args | [string](#string) | repeated | | | extra\_mounts | [talos.resource.definitions.proto.Mount](#talos.resource.definitions.proto.Mount) | repeated | | | expected\_nodename | [string](#string) | | | | config | [google.protobuf.Struct](#google.protobuf.Struct) | | | | credential\_provider\_config | [google.protobuf.Struct](#google.protobuf.Struct) | | | ### ManifestSpec ManifestSpec holds the Kubernetes resources spec. | Field | Type | Label | Description | | ----- | ---------------------------------------------------------------- | -------- | ----------- | | items | [SingleManifest](#talos.resource.definitions.k8s.SingleManifest) | repeated | | ### ManifestStatusSpec ManifestStatusSpec describes manifest application status. | Field | Type | Label | Description | | ------------------ | ----------------- | -------- | ----------- | | manifests\_applied | [string](#string) | repeated | | ### NodeAnnotationSpecSpec NodeAnnotationSpecSpec represents an annoation that's attached to a Talos node. | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### NodeIPConfigSpec NodeIPConfigSpec holds the Node IP specification. | Field | Type | Label | Description | | ---------------- | ----------------- | -------- | ----------- | | valid\_subnets | [string](#string) | repeated | | | exclude\_subnets | [string](#string) | repeated | | ### NodeIPSpec NodeIPSpec holds the Node IP specification. | Field | Type | Label | Description | | --------- | ----------------------------- | -------- | ----------- | | addresses | [common.NetIP](#common.NetIP) | repeated | | ### NodeLabelSpecSpec NodeLabelSpecSpec represents a label that's attached to a Talos node. | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### NodeStatusSpec NodeStatusSpec describes Kubernetes NodeStatus. | Field | Type | Label | Description | | ------------- | -------------------------------------------------------------------------------------------------- | -------- | ----------- | | nodename | [string](#string) | | | | node\_ready | [bool](#bool) | | | | unschedulable | [bool](#bool) | | | | labels | [NodeStatusSpec.LabelsEntry](#talos.resource.definitions.k8s.NodeStatusSpec.LabelsEntry) | repeated | | | annotations | [NodeStatusSpec.AnnotationsEntry](#talos.resource.definitions.k8s.NodeStatusSpec.AnnotationsEntry) | repeated | | ### NodeStatusSpec.AnnotationsEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### NodeStatusSpec.LabelsEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### NodeTaintSpecSpec NodeTaintSpecSpec represents a label that's attached to a Talos node. | Field | Type | Label | Description | | ------ | ----------------- | ----- | ----------- | | key | [string](#string) | | | | effect | [string](#string) | | | | value | [string](#string) | | | ### NodenameSpec NodenameSpec describes Kubernetes nodename. | Field | Type | Label | Description | | ------------------------ | ----------------- | ----- | ----------- | | nodename | [string](#string) | | | | hostname\_version | [string](#string) | | | | skip\_node\_registration | [bool](#bool) | | | ### Resources Resources is a configuration of cpu and memory resources. | Field | Type | Label | Description | | -------- | ---------------------------------------------------------------------------------- | -------- | ----------- | | requests | [Resources.RequestsEntry](#talos.resource.definitions.k8s.Resources.RequestsEntry) | repeated | | | limits | [Resources.LimitsEntry](#talos.resource.definitions.k8s.Resources.LimitsEntry) | repeated | | ### Resources.LimitsEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### Resources.RequestsEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### SchedulerConfigSpec SchedulerConfigSpec is configuration for kube-scheduler. | Field | Type | Label | Description | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------- | ----------- | | enabled | [bool](#bool) | | | | image | [string](#string) | | | | extra\_args | [SchedulerConfigSpec.ExtraArgsEntry](#talos.resource.definitions.k8s.SchedulerConfigSpec.ExtraArgsEntry) | repeated | | | extra\_volumes | [ExtraVolume](#talos.resource.definitions.k8s.ExtraVolume) | repeated | | | environment\_variables | [SchedulerConfigSpec.EnvironmentVariablesEntry](#talos.resource.definitions.k8s.SchedulerConfigSpec.EnvironmentVariablesEntry) | repeated | | | resources | [Resources](#talos.resource.definitions.k8s.Resources) | | | | config | [google.protobuf.Struct](#google.protobuf.Struct) | | | ### SchedulerConfigSpec.EnvironmentVariablesEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### SchedulerConfigSpec.ExtraArgsEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### SecretsStatusSpec SecretsStatusSpec describes status of rendered secrets. | Field | Type | Label | Description | | ------- | ----------------- | ----- | ----------- | | ready | [bool](#bool) | | | | version | [string](#string) | | | ### SingleManifest SingleManifest is a single manifest. | Field | Type | Label | Description | | ------ | ------------------------------------------------- | ----- | ----------- | | object | [google.protobuf.Struct](#google.protobuf.Struct) | | | ### StaticPodServerStatusSpec StaticPodServerStatusSpec describes static pod spec, it contains marshaled \*v1.Pod spec. | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | url | [string](#string) | | | ### StaticPodSpec StaticPodSpec describes static pod spec, it contains marshaled \*v1.Pod spec. | Field | Type | Label | Description | | ----- | ------------------------------------------------- | ----- | ----------- | | pod | [google.protobuf.Struct](#google.protobuf.Struct) | | | ### StaticPodStatusSpec StaticPodStatusSpec describes kubelet static pod status. | Field | Type | Label | Description | | ----------- | ------------------------------------------------- | ----- | ----------- | | pod\_status | [google.protobuf.Struct](#google.protobuf.Struct) | | |

Top

## resource/definitions/kubeaccess/kubeaccess.proto ### ConfigSpec ConfigSpec describes KubeSpan configuration. | Field | Type | Label | Description | | ------------------------------- | ----------------- | -------- | ----------- | | enabled | [bool](#bool) | | | | allowed\_api\_roles | [string](#string) | repeated | | | allowed\_kubernetes\_namespaces | [string](#string) | repeated | |

Top

## resource/definitions/kubespan/kubespan.proto ### ConfigSpec ConfigSpec describes KubeSpan configuration. | Field | Type | Label | Description | | ------------------------------- | ------------------------------------- | -------- | ----------- | | enabled | [bool](#bool) | | | | cluster\_id | [string](#string) | | | | shared\_secret | [string](#string) | | | | force\_routing | [bool](#bool) | | | | advertise\_kubernetes\_networks | [bool](#bool) | | | | mtu | [uint32](#uint32) | | | | endpoint\_filters | [string](#string) | repeated | | | harvest\_extra\_endpoints | [bool](#bool) | | | | extra\_endpoints | [common.NetIPPort](#common.NetIPPort) | repeated | | ### EndpointSpec EndpointSpec describes Endpoint state. | Field | Type | Label | Description | | ------------- | ------------------------------------- | ----- | ----------- | | affiliate\_id | [string](#string) | | | | endpoint | [common.NetIPPort](#common.NetIPPort) | | | ### IdentitySpec IdentitySpec describes KubeSpan keys and address. Note: IdentitySpec is persisted on disk in the STATE partition, so YAML serialization should be kept backwards compatible. | Field | Type | Label | Description | | ------------ | ----------------------------------------- | ----- | ----------- | | address | [common.NetIPPrefix](#common.NetIPPrefix) | | | | subnet | [common.NetIPPrefix](#common.NetIPPrefix) | | | | private\_key | [string](#string) | | | | public\_key | [string](#string) | | | ### PeerSpecSpec PeerSpecSpec describes PeerSpec state. | Field | Type | Label | Description | | ------------ | ----------------------------------------- | -------- | ----------- | | address | [common.NetIP](#common.NetIP) | | | | allowed\_ips | [common.NetIPPrefix](#common.NetIPPrefix) | repeated | | | endpoints | [common.NetIPPort](#common.NetIPPort) | repeated | | | label | [string](#string) | | | ### PeerStatusSpec PeerStatusSpec describes PeerStatus state. | Field | Type | Label | Description | | ---------------------- | --------------------------------------------------------------------------------------------------------- | ----- | ----------- | | endpoint | [common.NetIPPort](#common.NetIPPort) | | | | label | [string](#string) | | | | state | [talos.resource.definitions.enums.KubespanPeerState](#talos.resource.definitions.enums.KubespanPeerState) | | | | receive\_bytes | [int64](#int64) | | | | transmit\_bytes | [int64](#int64) | | | | last\_handshake\_time | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | | | last\_used\_endpoint | [common.NetIPPort](#common.NetIPPort) | | | | last\_endpoint\_change | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | |

Top

## resource/definitions/runtime/runtime.proto ### BootedEntrySpec BootedEntrySpec describes the booted entry resource properties. | Field | Type | Label | Description | | ------------- | ----------------- | ----- | ----------- | | booted\_entry | [string](#string) | | | ### DevicesStatusSpec DevicesStatusSpec is the spec for devices status. | Field | Type | Label | Description | | ----- | ------------- | ----- | ----------- | | ready | [bool](#bool) | | | ### DiagnosticSpec DiagnosticSpec is the spec for devices status. | Field | Type | Label | Description | | ------- | ----------------- | -------- | ----------- | | message | [string](#string) | | | | details | [string](#string) | repeated | | ### EventSinkConfigSpec EventSinkConfigSpec describes configuration of Talos event log streaming. | Field | Type | Label | Description | | -------- | ----------------- | ----- | ----------- | | endpoint | [string](#string) | | | ### ExtensionServiceConfigFile ExtensionServiceConfigFile describes extensions service config files. | Field | Type | Label | Description | | ----------- | ----------------- | ----- | ----------- | | content | [string](#string) | | | | mount\_path | [string](#string) | | | ### ExtensionServiceConfigSpec ExtensionServiceConfigSpec describes status of rendered extensions service config files. | Field | Type | Label | Description | | ----------- | -------------------------------------------------------------------------------------------- | -------- | ----------- | | files | [ExtensionServiceConfigFile](#talos.resource.definitions.runtime.ExtensionServiceConfigFile) | repeated | | | environment | [string](#string) | repeated | | ### ExtensionServiceConfigStatusSpec ExtensionServiceConfigStatusSpec describes status of rendered extensions service config files. | Field | Type | Label | Description | | ------------- | ----------------- | ----- | ----------- | | spec\_version | [string](#string) | | | ### KernelCmdlineSpec KernelCmdlineSpec presents kernel command line (contents of /proc/cmdline). | Field | Type | Label | Description | | ------- | ----------------- | ----- | ----------- | | cmdline | [string](#string) | | | ### KernelModuleSpecSpec KernelModuleSpecSpec describes Linux kernel module to load. | Field | Type | Label | Description | | ---------- | ----------------- | -------- | ----------- | | name | [string](#string) | | | | parameters | [string](#string) | repeated | | ### KernelParamSpecSpec KernelParamSpecSpec describes status of the defined sysctls. | Field | Type | Label | Description | | -------------- | ----------------- | ----- | ----------- | | value | [string](#string) | | | | ignore\_errors | [bool](#bool) | | | ### KernelParamStatusSpec KernelParamStatusSpec describes status of the defined sysctls. | Field | Type | Label | Description | | ----------- | ----------------- | ----- | ----------- | | current | [string](#string) | | | | default | [string](#string) | | | | unsupported | [bool](#bool) | | | ### KmsgLogConfigSpec KmsgLogConfigSpec describes configuration for kmsg log streaming. | Field | Type | Label | Description | | ------------ | ------------------------- | -------- | ----------- | | destinations | [common.URL](#common.URL) | repeated | | ### LoadedKernelModuleSpec LoadedKernelModuleSpec describes Linux kernel module to load. | Field | Type | Label | Description | | ---------------- | ----------------- | -------- | ----------- | | size | [int64](#int64) | | | | reference\_count | [int64](#int64) | | | | dependencies | [string](#string) | repeated | | | state | [string](#string) | | | | address | [string](#string) | | | ### MachineStatusSpec MachineStatusSpec describes status of the defined sysctls. | Field | Type | Label | Description | | ------ | ------------------------------------------------------------------------------------------------------------- | ----- | ----------- | | stage | [talos.resource.definitions.enums.RuntimeMachineStage](#talos.resource.definitions.enums.RuntimeMachineStage) | | | | status | [MachineStatusStatus](#talos.resource.definitions.runtime.MachineStatusStatus) | | | ### MachineStatusStatus MachineStatusStatus describes machine current status at the stage. | Field | Type | Label | Description | | ----------------- | -------------------------------------------------------------------- | -------- | ----------- | | ready | [bool](#bool) | | | | unmet\_conditions | [UnmetCondition](#talos.resource.definitions.runtime.UnmetCondition) | repeated | | ### MaintenanceServiceConfigSpec MaintenanceServiceConfigSpec describes configuration for maintenance service API. | Field | Type | Label | Description | | -------------------- | ----------------------------- | -------- | ----------- | | listen\_address | [string](#string) | | | | reachable\_addresses | [common.NetIP](#common.NetIP) | repeated | | ### MetaKeySpec MetaKeySpec describes status of the defined sysctls. | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | value | [string](#string) | | | ### MetaLoadedSpec MetaLoadedSpec is the spec for meta loaded. The Done field is always true when resource exists. | Field | Type | Label | Description | | ----- | ------------- | ----- | ----------- | | done | [bool](#bool) | | | ### MountStatusSpec MountStatusSpec describes status of the defined sysctls. | Field | Type | Label | Description | | --------------------- | ----------------- | -------- | ----------- | | source | [string](#string) | | | | target | [string](#string) | | | | filesystem\_type | [string](#string) | | | | options | [string](#string) | repeated | | | encrypted | [bool](#bool) | | | | encryption\_providers | [string](#string) | repeated | | ### PlatformMetadataSpec PlatformMetadataSpec describes platform metadata properties. | Field | Type | Label | Description | | -------------- | ---------------------------------------------------------------------------------------------------- | -------- | ----------- | | platform | [string](#string) | | | | hostname | [string](#string) | | | | region | [string](#string) | | | | zone | [string](#string) | | | | instance\_type | [string](#string) | | | | instance\_id | [string](#string) | | | | provider\_id | [string](#string) | | | | spot | [bool](#bool) | | | | internal\_dns | [string](#string) | | | | external\_dns | [string](#string) | | | | tags | [PlatformMetadataSpec.TagsEntry](#talos.resource.definitions.runtime.PlatformMetadataSpec.TagsEntry) | repeated | | ### PlatformMetadataSpec.TagsEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [string](#string) | | | ### SBOMItemSpec SBOMItemSpec describes the SBOM item resource properties. | Field | Type | Label | Description | | --------- | ----------------- | -------- | ----------- | | name | [string](#string) | | | | version | [string](#string) | | | | license | [string](#string) | | | | cp\_es | [string](#string) | repeated | | | pur\_ls | [string](#string) | repeated | | | extension | [bool](#bool) | | | ### SecurityStateSpec SecurityStateSpec describes the security state resource properties. | Field | Type | Label | Description | | ------------------------------ | ------------------------------------------------------------------------------------------------------------- | ----- | ----------- | | secure\_boot | [bool](#bool) | | | | uki\_signing\_key\_fingerprint | [string](#string) | | | | pcr\_signing\_key\_fingerprint | [string](#string) | | | | se\_linux\_state | [talos.resource.definitions.enums.RuntimeSELinuxState](#talos.resource.definitions.enums.RuntimeSELinuxState) | | | | booted\_with\_uki | [bool](#bool) | | | | fips\_state | [talos.resource.definitions.enums.RuntimeFIPSState](#talos.resource.definitions.enums.RuntimeFIPSState) | | | ### UniqueMachineTokenSpec UniqueMachineTokenSpec is the spec for the machine unique token. Token can be empty if machine wasn't assigned any. | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | token | [string](#string) | | | ### UnmetCondition UnmetCondition is a failure which prevents machine from being ready at the stage. | Field | Type | Label | Description | | ------ | ----------------- | ----- | ----------- | | name | [string](#string) | | | | reason | [string](#string) | | | ### WatchdogTimerConfigSpec WatchdogTimerConfigSpec describes configuration of watchdog timer. | Field | Type | Label | Description | | ------- | ----------------------------------------------------- | ----- | ----------- | | device | [string](#string) | | | | timeout | [google.protobuf.Duration](#google.protobuf.Duration) | | | ### WatchdogTimerStatusSpec WatchdogTimerStatusSpec describes configuration of watchdog timer. | Field | Type | Label | Description | | -------------- | ----------------------------------------------------- | ----- | ----------- | | device | [string](#string) | | | | timeout | [google.protobuf.Duration](#google.protobuf.Duration) | | | | feed\_interval | [google.protobuf.Duration](#google.protobuf.Duration) | | |

Top

## resource/definitions/network/network.proto ### AddressSpecSpec AddressSpecSpec describes status of rendered secrets. | Field | Type | Label | Description | | ------------------- | ----------------------------------------------------------------------------------------------------------- | ----- | ----------- | | address | [common.NetIPPrefix](#common.NetIPPrefix) | | | | link\_name | [string](#string) | | | | family | [talos.resource.definitions.enums.NethelpersFamily](#talos.resource.definitions.enums.NethelpersFamily) | | | | scope | [talos.resource.definitions.enums.NethelpersScope](#talos.resource.definitions.enums.NethelpersScope) | | | | flags | [uint32](#uint32) | | | | announce\_with\_arp | [bool](#bool) | | | | config\_layer | [talos.resource.definitions.enums.NetworkConfigLayer](#talos.resource.definitions.enums.NetworkConfigLayer) | | | | priority | [uint32](#uint32) | | | ### AddressStatusSpec AddressStatusSpec describes status of rendered secrets. | Field | Type | Label | Description | | ----------- | ------------------------------------------------------------------------------------------------------- | ----- | ----------- | | address | [common.NetIPPrefix](#common.NetIPPrefix) | | | | local | [common.NetIP](#common.NetIP) | | | | broadcast | [common.NetIP](#common.NetIP) | | | | anycast | [common.NetIP](#common.NetIP) | | | | multicast | [common.NetIP](#common.NetIP) | | | | link\_index | [uint32](#uint32) | | | | link\_name | [string](#string) | | | | family | [talos.resource.definitions.enums.NethelpersFamily](#talos.resource.definitions.enums.NethelpersFamily) | | | | scope | [talos.resource.definitions.enums.NethelpersScope](#talos.resource.definitions.enums.NethelpersScope) | | | | flags | [uint32](#uint32) | | | | priority | [uint32](#uint32) | | | ### BondMasterSpec BondMasterSpec describes bond settings if Kind == "bond". | Field | Type | Label | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ----- | ----------- | | mode | [talos.resource.definitions.enums.NethelpersBondMode](#talos.resource.definitions.enums.NethelpersBondMode) | | | | hash\_policy | [talos.resource.definitions.enums.NethelpersBondXmitHashPolicy](#talos.resource.definitions.enums.NethelpersBondXmitHashPolicy) | | | | lacp\_rate | [talos.resource.definitions.enums.NethelpersLACPRate](#talos.resource.definitions.enums.NethelpersLACPRate) | | | | arp\_validate | [talos.resource.definitions.enums.NethelpersARPValidate](#talos.resource.definitions.enums.NethelpersARPValidate) | | | | arp\_all\_targets | [talos.resource.definitions.enums.NethelpersARPAllTargets](#talos.resource.definitions.enums.NethelpersARPAllTargets) | | | | primary\_index | [uint32](#uint32) | | | | primary\_reselect | [talos.resource.definitions.enums.NethelpersPrimaryReselect](#talos.resource.definitions.enums.NethelpersPrimaryReselect) | | | | fail\_over\_mac | [talos.resource.definitions.enums.NethelpersFailOverMAC](#talos.resource.definitions.enums.NethelpersFailOverMAC) | | | | ad\_select | [talos.resource.definitions.enums.NethelpersADSelect](#talos.resource.definitions.enums.NethelpersADSelect) | | | | mii\_mon | [uint32](#uint32) | | | | up\_delay | [uint32](#uint32) | | | | down\_delay | [uint32](#uint32) | | | | arp\_interval | [uint32](#uint32) | | | | resend\_igmp | [uint32](#uint32) | | | | min\_links | [uint32](#uint32) | | | | lp\_interval | [uint32](#uint32) | | | | packets\_per\_slave | [uint32](#uint32) | | | | num\_peer\_notif | [uint32](#uint32) | | | | tlb\_dynamic\_lb | [uint32](#uint32) | | | | all\_slaves\_active | [uint32](#uint32) | | | | use\_carrier | [bool](#bool) | | | | ad\_actor\_sys\_prio | [uint32](#uint32) | | | | ad\_user\_port\_key | [uint32](#uint32) | | | | peer\_notify\_delay | [uint32](#uint32) | | | ### BondSlave BondSlave contains a bond's master name and slave index. | Field | Type | Label | Description | | ------------ | ----------------- | ----- | ----------- | | master\_name | [string](#string) | | | | slave\_index | [int64](#int64) | | | ### BridgeMasterSpec BridgeMasterSpec describes bridge settings if Kind == "bridge". | Field | Type | Label | Description | | ----- | -------------------------------------------------------------------- | ----- | ----------- | | stp | [STPSpec](#talos.resource.definitions.network.STPSpec) | | | | vlan | [BridgeVLANSpec](#talos.resource.definitions.network.BridgeVLANSpec) | | | ### BridgeSlave BridgeSlave contains the name of the master bridge of a bridged interface | Field | Type | Label | Description | | ------------ | ----------------- | ----- | ----------- | | master\_name | [string](#string) | | | ### BridgeVLANSpec BridgeVLANSpec describes VLAN settings of a bridge. | Field | Type | Label | Description | | ------------------ | ------------- | ----- | ----------- | | filtering\_enabled | [bool](#bool) | | | ### DHCP4OperatorSpec DHCP4OperatorSpec describes DHCP4 operator options. | Field | Type | Label | Description | | ----------------------- | ----------------- | ----- | ----------- | | route\_metric | [uint32](#uint32) | | | | skip\_hostname\_request | [bool](#bool) | | | ### DHCP6OperatorSpec DHCP6OperatorSpec describes DHCP6 operator options. | Field | Type | Label | Description | | ----------------------- | ----------------- | ----- | ----------- | | duid | [string](#string) | | | | route\_metric | [uint32](#uint32) | | | | skip\_hostname\_request | [bool](#bool) | | | ### DNSResolveCacheSpec DNSResolveCacheSpec describes DNS servers status. | Field | Type | Label | Description | | ------ | ----------------- | ----- | ----------- | | status | [string](#string) | | | ### EthernetChannelsSpec EthernetChannelsSpec describes config of Ethernet channels. | Field | Type | Label | Description | | -------- | ----------------- | ----- | ----------- | | rx | [uint32](#uint32) | | | | tx | [uint32](#uint32) | | | | other | [uint32](#uint32) | | | | combined | [uint32](#uint32) | | | ### EthernetChannelsStatus EthernetChannelsStatus describes status of Ethernet channels. | Field | Type | Label | Description | | ------------- | ----------------- | ----- | ----------- | | rx\_max | [uint32](#uint32) | | | | tx\_max | [uint32](#uint32) | | | | other\_max | [uint32](#uint32) | | | | combined\_max | [uint32](#uint32) | | | | rx | [uint32](#uint32) | | | | tx | [uint32](#uint32) | | | | other | [uint32](#uint32) | | | | combined | [uint32](#uint32) | | | ### EthernetFeatureStatus EthernetFeatureStatus describes status of Ethernet features. | Field | Type | Label | Description | | ------ | ----------------- | ----- | ----------- | | name | [string](#string) | | | | status | [string](#string) | | | ### EthernetRingsSpec EthernetRingsSpec describes config of Ethernet rings. | Field | Type | Label | Description | | ------------------ | ----------------- | ----- | ----------- | | rx | [uint32](#uint32) | | | | rx\_mini | [uint32](#uint32) | | | | rx\_jumbo | [uint32](#uint32) | | | | tx | [uint32](#uint32) | | | | rx\_buf\_len | [uint32](#uint32) | | | | cqe\_size | [uint32](#uint32) | | | | tx\_push | [bool](#bool) | | | | rx\_push | [bool](#bool) | | | | tx\_push\_buf\_len | [uint32](#uint32) | | | | tcp\_data\_split | [bool](#bool) | | | ### EthernetRingsStatus EthernetRingsStatus describes status of Ethernet rings. | Field | Type | Label | Description | | ----------------------- | ----------------- | ----- | ----------- | | rx\_max | [uint32](#uint32) | | | | rx\_mini\_max | [uint32](#uint32) | | | | rx\_jumbo\_max | [uint32](#uint32) | | | | tx\_max | [uint32](#uint32) | | | | tx\_push\_buf\_len\_max | [uint32](#uint32) | | | | rx | [uint32](#uint32) | | | | rx\_mini | [uint32](#uint32) | | | | rx\_jumbo | [uint32](#uint32) | | | | tx | [uint32](#uint32) | | | | rx\_buf\_len | [uint32](#uint32) | | | | cqe\_size | [uint32](#uint32) | | | | tx\_push | [bool](#bool) | | | | rx\_push | [bool](#bool) | | | | tx\_push\_buf\_len | [uint32](#uint32) | | | | tcp\_data\_split | [bool](#bool) | | | ### EthernetSpecSpec EthernetSpecSpec describes config of Ethernet link. | Field | Type | Label | Description | | ------------- | --------------------------------------------------------------------------------------------------------- | -------- | ----------- | | rings | [EthernetRingsSpec](#talos.resource.definitions.network.EthernetRingsSpec) | | | | features | [EthernetSpecSpec.FeaturesEntry](#talos.resource.definitions.network.EthernetSpecSpec.FeaturesEntry) | repeated | | | channels | [EthernetChannelsSpec](#talos.resource.definitions.network.EthernetChannelsSpec) | | | | wake\_on\_lan | [talos.resource.definitions.enums.NethelpersWOLMode](#talos.resource.definitions.enums.NethelpersWOLMode) | repeated | | ### EthernetSpecSpec.FeaturesEntry | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | key | [string](#string) | | | | value | [bool](#bool) | | | ### EthernetStatusSpec EthernetStatusSpec describes status of rendered secrets. | Field | Type | Label | Description | | --------------- | --------------------------------------------------------------------------------------------------------- | -------- | ----------- | | link\_state | [bool](#bool) | | | | speed\_megabits | [int64](#int64) | | | | port | [talos.resource.definitions.enums.NethelpersPort](#talos.resource.definitions.enums.NethelpersPort) | | | | duplex | [talos.resource.definitions.enums.NethelpersDuplex](#talos.resource.definitions.enums.NethelpersDuplex) | | | | our\_modes | [string](#string) | repeated | | | peer\_modes | [string](#string) | repeated | | | rings | [EthernetRingsStatus](#talos.resource.definitions.network.EthernetRingsStatus) | | | | features | [EthernetFeatureStatus](#talos.resource.definitions.network.EthernetFeatureStatus) | repeated | | | channels | [EthernetChannelsStatus](#talos.resource.definitions.network.EthernetChannelsStatus) | | | | wake\_on\_lan | [talos.resource.definitions.enums.NethelpersWOLMode](#talos.resource.definitions.enums.NethelpersWOLMode) | repeated | | ### HardwareAddrSpec HardwareAddrSpec describes spec for the link. | Field | Type | Label | Description | | -------------- | ----------------- | ----- | ----------- | | name | [string](#string) | | | | hardware\_addr | [bytes](#bytes) | | | ### HostDNSConfigSpec HostDNSConfigSpec describes host DNS config. | Field | Type | Label | Description | | --------------------------- | ------------------------------------- | -------- | ----------- | | enabled | [bool](#bool) | | | | listen\_addresses | [common.NetIPPort](#common.NetIPPort) | repeated | | | service\_host\_dns\_address | [common.NetIP](#common.NetIP) | | | | resolve\_member\_names | [bool](#bool) | | | ### HostnameSpecSpec HostnameSpecSpec describes node hostname. | Field | Type | Label | Description | | ------------- | ----------------------------------------------------------------------------------------------------------- | ----- | ----------- | | hostname | [string](#string) | | | | domainname | [string](#string) | | | | config\_layer | [talos.resource.definitions.enums.NetworkConfigLayer](#talos.resource.definitions.enums.NetworkConfigLayer) | | | ### HostnameStatusSpec HostnameStatusSpec describes node hostname. | Field | Type | Label | Description | | ---------- | ----------------- | ----- | ----------- | | hostname | [string](#string) | | | | domainname | [string](#string) | | | ### LinkAliasSpecSpec LinkAliasSpecSpec describes status of rendered secrets. | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | alias | [string](#string) | | | ### LinkRefreshSpec LinkRefreshSpec describes status of rendered secrets. | Field | Type | Label | Description | | ---------- | --------------- | ----- | ----------- | | generation | [int64](#int64) | | | ### LinkSpecSpec LinkSpecSpec describes spec for the link. | Field | Type | Label | Description | | ----------------- | ----------------------------------------------------------------------------------------------------------- | ----- | ----------- | | name | [string](#string) | | | | logical | [bool](#bool) | | | | up | [bool](#bool) | | | | mtu | [uint32](#uint32) | | | | kind | [string](#string) | | | | type | [talos.resource.definitions.enums.NethelpersLinkType](#talos.resource.definitions.enums.NethelpersLinkType) | | | | parent\_name | [string](#string) | | | | bond\_slave | [BondSlave](#talos.resource.definitions.network.BondSlave) | | | | bridge\_slave | [BridgeSlave](#talos.resource.definitions.network.BridgeSlave) | | | | vlan | [VLANSpec](#talos.resource.definitions.network.VLANSpec) | | | | bond\_master | [BondMasterSpec](#talos.resource.definitions.network.BondMasterSpec) | | | | bridge\_master | [BridgeMasterSpec](#talos.resource.definitions.network.BridgeMasterSpec) | | | | wireguard | [WireguardSpec](#talos.resource.definitions.network.WireguardSpec) | | | | config\_layer | [talos.resource.definitions.enums.NetworkConfigLayer](#talos.resource.definitions.enums.NetworkConfigLayer) | | | | hardware\_address | [bytes](#bytes) | | | ### LinkStatusSpec LinkStatusSpec describes status of rendered secrets. | Field | Type | Label | Description | | ------------------ | --------------------------------------------------------------------------------------------------------------------------- | -------- | ----------- | | index | [uint32](#uint32) | | | | type | [talos.resource.definitions.enums.NethelpersLinkType](#talos.resource.definitions.enums.NethelpersLinkType) | | | | link\_index | [uint32](#uint32) | | | | flags | [uint32](#uint32) | | | | hardware\_addr | [bytes](#bytes) | | | | broadcast\_addr | [bytes](#bytes) | | | | mtu | [uint32](#uint32) | | | | queue\_disc | [string](#string) | | | | master\_index | [uint32](#uint32) | | | | operational\_state | [talos.resource.definitions.enums.NethelpersOperationalState](#talos.resource.definitions.enums.NethelpersOperationalState) | | | | kind | [string](#string) | | | | slave\_kind | [string](#string) | | | | bus\_path | [string](#string) | | | | pciid | [string](#string) | | | | driver | [string](#string) | | | | driver\_version | [string](#string) | | | | firmware\_version | [string](#string) | | | | product\_id | [string](#string) | | | | vendor\_id | [string](#string) | | | | product | [string](#string) | | | | vendor | [string](#string) | | | | link\_state | [bool](#bool) | | | | speed\_megabits | [int64](#int64) | | | | port | [talos.resource.definitions.enums.NethelpersPort](#talos.resource.definitions.enums.NethelpersPort) | | | | duplex | [talos.resource.definitions.enums.NethelpersDuplex](#talos.resource.definitions.enums.NethelpersDuplex) | | | | vlan | [VLANSpec](#talos.resource.definitions.network.VLANSpec) | | | | bridge\_master | [BridgeMasterSpec](#talos.resource.definitions.network.BridgeMasterSpec) | | | | bond\_master | [BondMasterSpec](#talos.resource.definitions.network.BondMasterSpec) | | | | wireguard | [WireguardSpec](#talos.resource.definitions.network.WireguardSpec) | | | | permanent\_addr | [bytes](#bytes) | | | | alias | [string](#string) | | | | alt\_names | [string](#string) | repeated | | ### NfTablesAddressMatch NfTablesAddressMatch describes the match on the IP address. | Field | Type | Label | Description | | ---------------- | ----------------------------------------- | -------- | ----------- | | include\_subnets | [common.NetIPPrefix](#common.NetIPPrefix) | repeated | | | exclude\_subnets | [common.NetIPPrefix](#common.NetIPPrefix) | repeated | | | invert | [bool](#bool) | | | ### NfTablesChainSpec NfTablesChainSpec describes status of rendered secrets. | Field | Type | Label | Description | | -------- | ------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------- | | type | [string](#string) | | | | hook | [talos.resource.definitions.enums.NethelpersNfTablesChainHook](#talos.resource.definitions.enums.NethelpersNfTablesChainHook) | | | | priority | [talos.resource.definitions.enums.NethelpersNfTablesChainPriority](#talos.resource.definitions.enums.NethelpersNfTablesChainPriority) | | | | rules | [NfTablesRule](#talos.resource.definitions.network.NfTablesRule) | repeated | | | policy | [talos.resource.definitions.enums.NethelpersNfTablesVerdict](#talos.resource.definitions.enums.NethelpersNfTablesVerdict) | | | ### NfTablesClampMSS NfTablesClampMSS describes the TCP MSS clamping operation. MSS is limited by the `MaxMTU` so that: * IPv4: MSS = MaxMTU - 40 * IPv6: MSS = MaxMTU - 60. | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | mtu | [uint32](#uint32) | | | ### NfTablesConntrackStateMatch NfTablesConntrackStateMatch describes the match on the connection tracking state. | Field | Type | Label | Description | | ------ | ----------------------------------------------------------------------------------------------------------------------- | -------- | ----------- | | states | [talos.resource.definitions.enums.NethelpersConntrackState](#talos.resource.definitions.enums.NethelpersConntrackState) | repeated | | ### NfTablesICMPTypeMatch NfTablesICMPTypeMatch describes the match on the ICMP type. | Field | Type | Label | Description | | ----- | ----------------------------------------------------------------------------------------------------------- | -------- | ----------- | | types | [talos.resource.definitions.enums.NethelpersICMPType](#talos.resource.definitions.enums.NethelpersICMPType) | repeated | | ### NfTablesIfNameMatch NfTablesIfNameMatch describes the match on the interface name. | Field | Type | Label | Description | | ---------------- | --------------------------------------------------------------------------------------------------------------------- | -------- | ----------- | | operator | [talos.resource.definitions.enums.NethelpersMatchOperator](#talos.resource.definitions.enums.NethelpersMatchOperator) | | | | interface\_names | [string](#string) | repeated | | ### NfTablesLayer4Match NfTablesLayer4Match describes the match on the transport layer protocol. | Field | Type | Label | Description | | ------------------------ | ----------------------------------------------------------------------------------------------------------- | ----- | ----------- | | protocol | [talos.resource.definitions.enums.NethelpersProtocol](#talos.resource.definitions.enums.NethelpersProtocol) | | | | match\_source\_port | [NfTablesPortMatch](#talos.resource.definitions.network.NfTablesPortMatch) | | | | match\_destination\_port | [NfTablesPortMatch](#talos.resource.definitions.network.NfTablesPortMatch) | | | | match\_icmp\_type | [NfTablesICMPTypeMatch](#talos.resource.definitions.network.NfTablesICMPTypeMatch) | | | ### NfTablesLimitMatch NfTablesLimitMatch describes the match on the packet rate. | Field | Type | Label | Description | | ------------------------- | ----------------- | ----- | ----------- | | packet\_rate\_per\_second | [uint64](#uint64) | | | ### NfTablesMark NfTablesMark encodes packet mark match/update operation. When used as a match computes the following condition: (mark & mask) ^ xor == value When used as an update computes the following operation: mark = (mark & mask) ^ xor. | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | mask | [uint32](#uint32) | | | | xor | [uint32](#uint32) | | | | value | [uint32](#uint32) | | | ### NfTablesPortMatch NfTablesPortMatch describes the match on the transport layer port. | Field | Type | Label | Description | | ------ | ---------------------------------------------------------- | -------- | ----------- | | ranges | [PortRange](#talos.resource.definitions.network.PortRange) | repeated | | ### NfTablesRule NfTablesRule describes a single rule in the nftables chain. | Field | Type | Label | Description | | --------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ----- | ----------- | | match\_o\_if\_name | [NfTablesIfNameMatch](#talos.resource.definitions.network.NfTablesIfNameMatch) | | | | verdict | [talos.resource.definitions.enums.NethelpersNfTablesVerdict](#talos.resource.definitions.enums.NethelpersNfTablesVerdict) | | | | match\_mark | [NfTablesMark](#talos.resource.definitions.network.NfTablesMark) | | | | set\_mark | [NfTablesMark](#talos.resource.definitions.network.NfTablesMark) | | | | match\_source\_address | [NfTablesAddressMatch](#talos.resource.definitions.network.NfTablesAddressMatch) | | | | match\_destination\_address | [NfTablesAddressMatch](#talos.resource.definitions.network.NfTablesAddressMatch) | | | | match\_layer4 | [NfTablesLayer4Match](#talos.resource.definitions.network.NfTablesLayer4Match) | | | | match\_i\_if\_name | [NfTablesIfNameMatch](#talos.resource.definitions.network.NfTablesIfNameMatch) | | | | clamp\_mss | [NfTablesClampMSS](#talos.resource.definitions.network.NfTablesClampMSS) | | | | match\_limit | [NfTablesLimitMatch](#talos.resource.definitions.network.NfTablesLimitMatch) | | | | match\_conntrack\_state | [NfTablesConntrackStateMatch](#talos.resource.definitions.network.NfTablesConntrackStateMatch) | | | | anon\_counter | [bool](#bool) | | | ### NodeAddressFilterSpec NodeAddressFilterSpec describes a filter for NodeAddresses. | Field | Type | Label | Description | | ---------------- | ----------------------------------------- | -------- | ----------- | | include\_subnets | [common.NetIPPrefix](#common.NetIPPrefix) | repeated | | | exclude\_subnets | [common.NetIPPrefix](#common.NetIPPrefix) | repeated | | ### NodeAddressSortAlgorithmSpec NodeAddressSortAlgorithmSpec describes a filter for NodeAddresses. | Field | Type | Label | Description | | --------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----- | ----------- | | algorithm | [talos.resource.definitions.enums.NethelpersAddressSortAlgorithm](#talos.resource.definitions.enums.NethelpersAddressSortAlgorithm) | | | ### NodeAddressSpec NodeAddressSpec describes a set of node addresses. | Field | Type | Label | Description | | --------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------- | | addresses | [common.NetIPPrefix](#common.NetIPPrefix) | repeated | | | sort\_algorithm | [talos.resource.definitions.enums.NethelpersAddressSortAlgorithm](#talos.resource.definitions.enums.NethelpersAddressSortAlgorithm) | | | ### OperatorSpecSpec OperatorSpecSpec describes DNS resolvers. | Field | Type | Label | Description | | ------------- | ----------------------------------------------------------------------------------------------------------- | ----- | ----------- | | operator | [talos.resource.definitions.enums.NetworkOperator](#talos.resource.definitions.enums.NetworkOperator) | | | | link\_name | [string](#string) | | | | require\_up | [bool](#bool) | | | | dhcp4 | [DHCP4OperatorSpec](#talos.resource.definitions.network.DHCP4OperatorSpec) | | | | dhcp6 | [DHCP6OperatorSpec](#talos.resource.definitions.network.DHCP6OperatorSpec) | | | | vip | [VIPOperatorSpec](#talos.resource.definitions.network.VIPOperatorSpec) | | | | config\_layer | [talos.resource.definitions.enums.NetworkConfigLayer](#talos.resource.definitions.enums.NetworkConfigLayer) | | | ### PlatformConfigSpec PlatformConfigSpec describes platform network configuration. This structure is marshaled to STATE partition to persist cached network configuration across reboots. | Field | Type | Label | Description | | ------------- | ------------------------------------------------------------------------------------------------------------------- | -------- | ----------- | | addresses | [AddressSpecSpec](#talos.resource.definitions.network.AddressSpecSpec) | repeated | | | links | [LinkSpecSpec](#talos.resource.definitions.network.LinkSpecSpec) | repeated | | | routes | [RouteSpecSpec](#talos.resource.definitions.network.RouteSpecSpec) | repeated | | | hostnames | [HostnameSpecSpec](#talos.resource.definitions.network.HostnameSpecSpec) | repeated | | | resolvers | [ResolverSpecSpec](#talos.resource.definitions.network.ResolverSpecSpec) | repeated | | | time\_servers | [TimeServerSpecSpec](#talos.resource.definitions.network.TimeServerSpecSpec) | repeated | | | operators | [OperatorSpecSpec](#talos.resource.definitions.network.OperatorSpecSpec) | repeated | | | external\_ips | [common.NetIP](#common.NetIP) | repeated | | | probes | [ProbeSpecSpec](#talos.resource.definitions.network.ProbeSpecSpec) | repeated | | | metadata | [talos.resource.definitions.runtime.PlatformMetadataSpec](#talos.resource.definitions.runtime.PlatformMetadataSpec) | | | ### PortRange PortRange describes a range of ports. Range is \[lo, hi]. | Field | Type | Label | Description | | ----- | ----------------- | ----- | ----------- | | lo | [uint32](#uint32) | | | | hi | [uint32](#uint32) | | | ### ProbeSpecSpec ProbeSpecSpec describes the Probe. | Field | Type | Label | Description | | ------------------ | ----------------------------------------------------------------------------------------------------------- | ----- | ----------- | | interval | [google.protobuf.Duration](#google.protobuf.Duration) | | | | failure\_threshold | [int64](#int64) | | | | tcp | [TCPProbeSpec](#talos.resource.definitions.network.TCPProbeSpec) | | | | config\_layer | [talos.resource.definitions.enums.NetworkConfigLayer](#talos.resource.definitions.enums.NetworkConfigLayer) | | | ### ProbeStatusSpec ProbeStatusSpec describes the Probe. | Field | Type | Label | Description | | ----------- | ----------------- | ----- | ----------- | | success | [bool](#bool) | | | | last\_error | [string](#string) | | | ### ResolverSpecSpec ResolverSpecSpec describes DNS resolvers. | Field | Type | Label | Description | | --------------- | ----------------------------------------------------------------------------------------------------------- | -------- | ----------- | | dns\_servers | [common.NetIP](#common.NetIP) | repeated | | | config\_layer | [talos.resource.definitions.enums.NetworkConfigLayer](#talos.resource.definitions.enums.NetworkConfigLayer) | | | | search\_domains | [string](#string) | repeated | | ### ResolverStatusSpec ResolverStatusSpec describes DNS resolvers. | Field | Type | Label | Description | | --------------- | ----------------------------- | -------- | ----------- | | dns\_servers | [common.NetIP](#common.NetIP) | repeated | | | search\_domains | [string](#string) | repeated | | ### RouteSpecSpec RouteSpecSpec describes the route. | Field | Type | Label | Description | | --------------- | --------------------------------------------------------------------------------------------------------------------- | ----- | ----------- | | family | [talos.resource.definitions.enums.NethelpersFamily](#talos.resource.definitions.enums.NethelpersFamily) | | | | destination | [common.NetIPPrefix](#common.NetIPPrefix) | | | | source | [common.NetIP](#common.NetIP) | | | | gateway | [common.NetIP](#common.NetIP) | | | | out\_link\_name | [string](#string) | | | | table | [talos.resource.definitions.enums.NethelpersRoutingTable](#talos.resource.definitions.enums.NethelpersRoutingTable) | | | | priority | [uint32](#uint32) | | | | scope | [talos.resource.definitions.enums.NethelpersScope](#talos.resource.definitions.enums.NethelpersScope) | | | | type | [talos.resource.definitions.enums.NethelpersRouteType](#talos.resource.definitions.enums.NethelpersRouteType) | | | | flags | [uint32](#uint32) | | | | protocol | [talos.resource.definitions.enums.NethelpersRouteProtocol](#talos.resource.definitions.enums.NethelpersRouteProtocol) | | | | config\_layer | [talos.resource.definitions.enums.NetworkConfigLayer](#talos.resource.definitions.enums.NetworkConfigLayer) | | | | mtu | [uint32](#uint32) | | | ### RouteStatusSpec RouteStatusSpec describes status of rendered secrets. | Field | Type | Label | Description | | ---------------- | --------------------------------------------------------------------------------------------------------------------- | ----- | ----------- | | family | [talos.resource.definitions.enums.NethelpersFamily](#talos.resource.definitions.enums.NethelpersFamily) | | | | destination | [common.NetIPPrefix](#common.NetIPPrefix) | | | | source | [common.NetIP](#common.NetIP) | | | | gateway | [common.NetIP](#common.NetIP) | | | | out\_link\_index | [uint32](#uint32) | | | | out\_link\_name | [string](#string) | | | | table | [talos.resource.definitions.enums.NethelpersRoutingTable](#talos.resource.definitions.enums.NethelpersRoutingTable) | | | | priority | [uint32](#uint32) | | | | scope | [talos.resource.definitions.enums.NethelpersScope](#talos.resource.definitions.enums.NethelpersScope) | | | | type | [talos.resource.definitions.enums.NethelpersRouteType](#talos.resource.definitions.enums.NethelpersRouteType) | | | | flags | [uint32](#uint32) | | | | protocol | [talos.resource.definitions.enums.NethelpersRouteProtocol](#talos.resource.definitions.enums.NethelpersRouteProtocol) | | | | mtu | [uint32](#uint32) | | | ### STPSpec STPSpec describes Spanning Tree Protocol (STP) settings of a bridge. | Field | Type | Label | Description | | ------- | ------------- | ----- | ----------- | | enabled | [bool](#bool) | | | ### StatusSpec StatusSpec describes network state. | Field | Type | Label | Description | | ------------------- | ------------- | ----- | ----------- | | address\_ready | [bool](#bool) | | | | connectivity\_ready | [bool](#bool) | | | | hostname\_ready | [bool](#bool) | | | | etc\_files\_ready | [bool](#bool) | | | ### TCPProbeSpec TCPProbeSpec describes the TCP Probe. | Field | Type | Label | Description | | -------- | ----------------------------------------------------- | ----- | ----------- | | endpoint | [string](#string) | | | | timeout | [google.protobuf.Duration](#google.protobuf.Duration) | | | ### TimeServerSpecSpec TimeServerSpecSpec describes NTP servers. | Field | Type | Label | Description | | ------------- | ----------------------------------------------------------------------------------------------------------- | -------- | ----------- | | ntp\_servers | [string](#string) | repeated | | | config\_layer | [talos.resource.definitions.enums.NetworkConfigLayer](#talos.resource.definitions.enums.NetworkConfigLayer) | | | ### TimeServerStatusSpec TimeServerStatusSpec describes NTP servers. | Field | Type | Label | Description | | ------------ | ----------------- | -------- | ----------- | | ntp\_servers | [string](#string) | repeated | | ### VIPEquinixMetalSpec VIPEquinixMetalSpec describes virtual (elastic) IP settings for Equinix Metal. | Field | Type | Label | Description | | ----------- | ----------------- | ----- | ----------- | | project\_id | [string](#string) | | | | device\_id | [string](#string) | | | | api\_token | [string](#string) | | | ### VIPHCloudSpec VIPHCloudSpec describes virtual (elastic) IP settings for Hetzner Cloud. | Field | Type | Label | Description | | ----------- | ----------------- | ----- | ----------- | | device\_id | [int64](#int64) | | | | network\_id | [int64](#int64) | | | | api\_token | [string](#string) | | | ### VIPOperatorSpec VIPOperatorSpec describes virtual IP operator options. | Field | Type | Label | Description | | --------------- | ------------------------------------------------------------------------------ | ----- | ----------- | | ip | [common.NetIP](#common.NetIP) | | | | gratuitous\_arp | [bool](#bool) | | | | equinix\_metal | [VIPEquinixMetalSpec](#talos.resource.definitions.network.VIPEquinixMetalSpec) | | | | h\_cloud | [VIPHCloudSpec](#talos.resource.definitions.network.VIPHCloudSpec) | | | ### VLANSpec VLANSpec describes VLAN settings if Kind == "vlan". | Field | Type | Label | Description | | -------- | ------------------------------------------------------------------------------------------------------------------- | ----- | ----------- | | vid | [uint32](#uint32) | | | | protocol | [talos.resource.definitions.enums.NethelpersVLANProtocol](#talos.resource.definitions.enums.NethelpersVLANProtocol) | | | ### WireguardPeer WireguardPeer describes a single peer. | Field | Type | Label | Description | | ------------------------------- | ----------------------------------------------------- | -------- | ----------- | | public\_key | [string](#string) | | | | preshared\_key | [string](#string) | | | | endpoint | [string](#string) | | | | persistent\_keepalive\_interval | [google.protobuf.Duration](#google.protobuf.Duration) | | | | allowed\_ips | [common.NetIPPrefix](#common.NetIPPrefix) | repeated | | ### WireguardSpec WireguardSpec describes Wireguard settings if Kind == "wireguard". | Field | Type | Label | Description | | -------------- | ------------------------------------------------------------------ | -------- | ----------- | | private\_key | [string](#string) | | | | public\_key | [string](#string) | | | | listen\_port | [int64](#int64) | | | | firewall\_mark | [int64](#int64) | | | | peers | [WireguardPeer](#talos.resource.definitions.network.WireguardPeer) | repeated | |

Top

## resource/definitions/perf/perf.proto ### CPUSpec CPUSpec represents the last CPU stats snapshot. | Field | Type | Label | Description | | ----------------- | --------------------------------------------------- | -------- | ----------- | | cpu | [CPUStat](#talos.resource.definitions.perf.CPUStat) | repeated | | | cpu\_total | [CPUStat](#talos.resource.definitions.perf.CPUStat) | | | | irq\_total | [uint64](#uint64) | | | | context\_switches | [uint64](#uint64) | | | | process\_created | [uint64](#uint64) | | | | process\_running | [uint64](#uint64) | | | | process\_blocked | [uint64](#uint64) | | | | soft\_irq\_total | [uint64](#uint64) | | | ### CPUStat CPUStat represents a single cpu stat. | Field | Type | Label | Description | | ----------- | ----------------- | ----- | ----------- | | user | [double](#double) | | | | nice | [double](#double) | | | | system | [double](#double) | | | | idle | [double](#double) | | | | iowait | [double](#double) | | | | irq | [double](#double) | | | | soft\_irq | [double](#double) | | | | steal | [double](#double) | | | | guest | [double](#double) | | | | guest\_nice | [double](#double) | | | ### MemorySpec MemorySpec represents the last Memory stats snapshot. | Field | Type | Label | Description | | ------------------- | ----------------- | ----- | ----------- | | mem\_total | [uint64](#uint64) | | | | mem\_used | [uint64](#uint64) | | | | mem\_available | [uint64](#uint64) | | | | buffers | [uint64](#uint64) | | | | cached | [uint64](#uint64) | | | | swap\_cached | [uint64](#uint64) | | | | active | [uint64](#uint64) | | | | inactive | [uint64](#uint64) | | | | active\_anon | [uint64](#uint64) | | | | inactive\_anon | [uint64](#uint64) | | | | active\_file | [uint64](#uint64) | | | | inactive\_file | [uint64](#uint64) | | | | unevictable | [uint64](#uint64) | | | | mlocked | [uint64](#uint64) | | | | swap\_total | [uint64](#uint64) | | | | swap\_free | [uint64](#uint64) | | | | dirty | [uint64](#uint64) | | | | writeback | [uint64](#uint64) | | | | anon\_pages | [uint64](#uint64) | | | | mapped | [uint64](#uint64) | | | | shmem | [uint64](#uint64) | | | | slab | [uint64](#uint64) | | | | s\_reclaimable | [uint64](#uint64) | | | | s\_unreclaim | [uint64](#uint64) | | | | kernel\_stack | [uint64](#uint64) | | | | page\_tables | [uint64](#uint64) | | | | nf\_sunstable | [uint64](#uint64) | | | | bounce | [uint64](#uint64) | | | | writeback\_tmp | [uint64](#uint64) | | | | commit\_limit | [uint64](#uint64) | | | | committed\_as | [uint64](#uint64) | | | | vmalloc\_total | [uint64](#uint64) | | | | vmalloc\_used | [uint64](#uint64) | | | | vmalloc\_chunk | [uint64](#uint64) | | | | hardware\_corrupted | [uint64](#uint64) | | | | anon\_huge\_pages | [uint64](#uint64) | | | | shmem\_huge\_pages | [uint64](#uint64) | | | | shmem\_pmd\_mapped | [uint64](#uint64) | | | | cma\_total | [uint64](#uint64) | | | | cma\_free | [uint64](#uint64) | | | | huge\_pages\_total | [uint64](#uint64) | | | | huge\_pages\_free | [uint64](#uint64) | | | | huge\_pages\_rsvd | [uint64](#uint64) | | | | huge\_pages\_surp | [uint64](#uint64) | | | | hugepagesize | [uint64](#uint64) | | | | direct\_map4k | [uint64](#uint64) | | | | direct\_map2m | [uint64](#uint64) | | | | direct\_map1g | [uint64](#uint64) | | |

Top

## resource/definitions/secrets/secrets.proto ### APICertsSpec APICertsSpec describes etcd certs secrets. | Field | Type | Label | Description | | --------------- | ------------------------------------------------------------------------- | -------- | ----------- | | client | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | | server | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | | accepted\_c\_as | [common.PEMEncodedCertificate](#common.PEMEncodedCertificate) | repeated | | ### CertSANSpec CertSANSpec describes fields of the cert SANs. | Field | Type | Label | Description | | ---------- | ----------------------------- | -------- | ----------- | | i\_ps | [common.NetIP](#common.NetIP) | repeated | | | dns\_names | [string](#string) | repeated | | | fqdn | [string](#string) | | | ### EncryptionSaltSpec EncryptionSaltSpec describes the salt. | Field | Type | Label | Description | | ---------- | --------------- | ----- | ----------- | | disk\_salt | [bytes](#bytes) | | | ### EtcdCertsSpec EtcdCertsSpec describes etcd certs secrets. | Field | Type | Label | Description | | ----------------- | ------------------------------------------------------------------------- | ----- | ----------- | | etcd | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | | etcd\_peer | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | | etcd\_admin | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | | etcd\_api\_server | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | ### EtcdRootSpec EtcdRootSpec describes etcd CA secrets. | Field | Type | Label | Description | | -------- | ------------------------------------------------------------------------- | ----- | ----------- | | etcd\_ca | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | ### KubeletSpec KubeletSpec describes root Kubernetes secrets. | Field | Type | Label | Description | | ------------------------ | ------------------------------------------------------------- | -------- | ----------- | | endpoint | [common.URL](#common.URL) | | | | bootstrap\_token\_id | [string](#string) | | | | bootstrap\_token\_secret | [string](#string) | | | | accepted\_c\_as | [common.PEMEncodedCertificate](#common.PEMEncodedCertificate) | repeated | | ### KubernetesCertsSpec KubernetesCertsSpec describes generated Kubernetes certificates. | Field | Type | Label | Description | | ------------------------------- | ----------------- | ----- | ----------- | | scheduler\_kubeconfig | [string](#string) | | | | controller\_manager\_kubeconfig | [string](#string) | | | | localhost\_admin\_kubeconfig | [string](#string) | | | | admin\_kubeconfig | [string](#string) | | | ### KubernetesDynamicCertsSpec KubernetesDynamicCertsSpec describes generated KubernetesCerts certificates. | Field | Type | Label | Description | | ---------------------------- | ------------------------------------------------------------------------- | ----- | ----------- | | api\_server | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | | api\_server\_kubelet\_client | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | | front\_proxy | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | ### KubernetesRootSpec KubernetesRootSpec describes root Kubernetes secrets. | Field | Type | Label | Description | | ----------------------------- | ------------------------------------------------------------------------- | -------- | ----------- | | name | [string](#string) | | | | endpoint | [common.URL](#common.URL) | | | | local\_endpoint | [common.URL](#common.URL) | | | | cert\_sa\_ns | [string](#string) | repeated | | | dns\_domain | [string](#string) | | | | issuing\_ca | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | | service\_account | [common.PEMEncodedKey](#common.PEMEncodedKey) | | | | aggregator\_ca | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | | aescbc\_encryption\_secret | [string](#string) | | | | bootstrap\_token\_id | [string](#string) | | | | bootstrap\_token\_secret | [string](#string) | | | | secretbox\_encryption\_secret | [string](#string) | | | | api\_server\_ips | [common.NetIP](#common.NetIP) | repeated | | | accepted\_c\_as | [common.PEMEncodedCertificate](#common.PEMEncodedCertificate) | repeated | | ### MaintenanceRootSpec MaintenanceRootSpec describes maintenance service CA. | Field | Type | Label | Description | | ----- | ------------------------------------------------------------------------- | ----- | ----------- | | ca | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | ### MaintenanceServiceCertsSpec MaintenanceServiceCertsSpec describes maintenance service certs secrets. | Field | Type | Label | Description | | ------ | ------------------------------------------------------------------------- | ----- | ----------- | | ca | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | | server | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | ### OSRootSpec OSRootSpec describes operating system CA. | Field | Type | Label | Description | | ------------------- | ------------------------------------------------------------------------- | -------- | ----------- | | issuing\_ca | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | | cert\_sani\_ps | [common.NetIP](#common.NetIP) | repeated | | | cert\_sandns\_names | [string](#string) | repeated | | | token | [string](#string) | | | | accepted\_c\_as | [common.PEMEncodedCertificate](#common.PEMEncodedCertificate) | repeated | | ### TrustdCertsSpec TrustdCertsSpec describes etcd certs secrets. | Field | Type | Label | Description | | --------------- | ------------------------------------------------------------------------- | -------- | ----------- | | server | [common.PEMEncodedCertificateAndKey](#common.PEMEncodedCertificateAndKey) | | | | accepted\_c\_as | [common.PEMEncodedCertificate](#common.PEMEncodedCertificate) | repeated | |

Top

## resource/definitions/siderolink/siderolink.proto ### ConfigSpec ConfigSpec describes Siderolink configuration. | Field | Type | Label | Description | | ------------- | ----------------- | ----- | ----------- | | api\_endpoint | [string](#string) | | | | host | [string](#string) | | | | join\_token | [string](#string) | | | | insecure | [bool](#bool) | | | | tunnel | [bool](#bool) | | | ### StatusSpec StatusSpec describes Siderolink status. | Field | Type | Label | Description | | ------------ | ----------------- | ----- | ----------- | | host | [string](#string) | | | | connected | [bool](#bool) | | | | link\_name | [string](#string) | | | | grpc\_tunnel | [bool](#bool) | | | ### TunnelSpec TunnelSpec describes Siderolink GRPC Tunnel configuration. | Field | Type | Label | Description | | ------------- | ------------------------------------- | ----- | ----------- | | api\_endpoint | [string](#string) | | | | link\_name | [string](#string) | | | | mtu | [int64](#int64) | | | | node\_address | [common.NetIPPort](#common.NetIPPort) | | |

Top

## resource/definitions/time/time.proto ### AdjtimeStatusSpec AdjtimeStatusSpec describes Linux internal adjtime state. | Field | Type | Label | Description | | ---------------------------- | ----------------------------------------------------- | ----- | ----------- | | offset | [google.protobuf.Duration](#google.protobuf.Duration) | | | | frequency\_adjustment\_ratio | [double](#double) | | | | max\_error | [google.protobuf.Duration](#google.protobuf.Duration) | | | | est\_error | [google.protobuf.Duration](#google.protobuf.Duration) | | | | status | [string](#string) | | | | constant | [int64](#int64) | | | | sync\_status | [bool](#bool) | | | | state | [string](#string) | | | ### StatusSpec StatusSpec describes time sync state. | Field | Type | Label | Description | | -------------- | --------------- | ----- | ----------- | | synced | [bool](#bool) | | | | epoch | [int64](#int64) | | | | sync\_disabled | [bool](#bool) | | |

Top

## resource/definitions/v1alpha1/v1alpha1.proto ### ServiceSpec ServiceSpec describe service state. | Field | Type | Label | Description | | ------- | ------------- | ----- | ----------- | | running | [bool](#bool) | | | | healthy | [bool](#bool) | | | | unknown | [bool](#bool) | | |

Top

## resource/network/device\_config.proto ### DeviceConfigSpecSpec DeviceConfigSpecSpec is the spec for the network.DeviceConfigSpec resource. | Field | Type | Label | Description | | ---------------- | --------------- | ----- | ----------------------------------------------------------------------- | | yaml\_marshalled | [bytes](#bytes) | | Contains YAML marshalled device config (as part of the machine config). |

Top

## security/security.proto ### CertificateRequest The request message containing the certificate signing request. | Field | Type | Label | Description | | ----- | --------------- | ----- | ------------------------------------------ | | csr | [bytes](#bytes) | | Certificate Signing Request in PEM format. | ### CertificateResponse The response message containing signed certificate. | Field | Type | Label | Description | | ----- | --------------- | ----- | -------------------------------------------------------------------------- | | ca | [bytes](#bytes) | | Certificate of the CA that signed the requested certificate in PEM format. | | crt | [bytes](#bytes) | | Signed X.509 requested certificate in PEM format. | ### SecurityService The security service definition. | Method Name | Request Type | Response Type | Description | | ----------- | ----------------------------------------------------- | ------------------------------------------------------- | ----------- | | Certificate | [CertificateRequest](#securityapi.CertificateRequest) | [CertificateResponse](#securityapi.CertificateResponse) | |

Top

## storage/storage.proto ### BlockDeviceWipe | Field | Type | Label | Description | | -------- | ----------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | ### BlockDeviceWipeDescriptor BlockDeviceWipeDescriptor represents a single block device to be wiped. The device can be either a full disk (e.g. vda) or a partition (vda5). The device should not be used in any of active volumes. The device should not be used as a secondary (e.g. part of LVM). | Field | Type | Label | Description | | ------ | ----------------- | ----- | --------------------------------------- | | device | [string](#string) | | Device name to wipe (e.g. sda or sda5). | The name should be submitted without `/dev/` prefix. | \| method | [BlockDeviceWipeDescriptor.Method](#storage.BlockDeviceWipeDescriptor.Method) | | Wipe method to use. | \| skip\_volume\_check | [bool](#bool) | | Skip the volume in use check. | \| skip\_secondary\_check | [bool](#bool) | | Skip the secondary disk check (e.g. underlying disk for RAID or LVM). | \| drop\_partition | [bool](#bool) | | Drop the partition (only applies if the device is a partition). | ### BlockDeviceWipeRequest | Field | Type | Label | Description | | ------- | --------------------------------------------------------------- | -------- | ----------- | | devices | [BlockDeviceWipeDescriptor](#storage.BlockDeviceWipeDescriptor) | repeated | | ### BlockDeviceWipeResponse | Field | Type | Label | Description | | -------- | ------------------------------------------- | -------- | ----------- | | messages | [BlockDeviceWipe](#storage.BlockDeviceWipe) | repeated | | ### Disk Disk represents a disk. | Field | Type | Label | Description | | ------------ | --------------------------------------- | ----- | ------------------------------------------------------------------ | | size | [uint64](#uint64) | | Size indicates the disk size in bytes. | | model | [string](#string) | | Model idicates the disk model. | | device\_name | [string](#string) | | DeviceName indicates the disk name (e.g. `sda`). | | name | [string](#string) | | Name as in `/sys/block//device/name`. | | serial | [string](#string) | | Serial as in `/sys/block//device/serial`. | | modalias | [string](#string) | | Modalias as in `/sys/block//device/modalias`. | | uuid | [string](#string) | | Uuid as in `/sys/block//device/uuid`. | | wwid | [string](#string) | | Wwid as in `/sys/block//device/wwid`. | | type | [Disk.DiskType](#storage.Disk.DiskType) | | Type is a type of the disk: nvme, ssd, hdd, sd card. | | bus\_path | [string](#string) | | BusPath is the bus path of the disk. | | system\_disk | [bool](#bool) | | SystemDisk indicates that the disk is used as Talos system disk. | | subsystem | [string](#string) | | Subsystem is the symlink path in the `/sys/block//subsystem`. | | readonly | [bool](#bool) | | Readonly specifies if the disk is read only. | ### Disks DisksResponse represents the response of the `Disks` RPC. | Field | Type | Label | Description | | -------- | ----------------------------------- | -------- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | disks | [Disk](#storage.Disk) | repeated | | ### DisksResponse | Field | Type | Label | Description | | -------- | ----------------------- | -------- | ----------- | | messages | [Disks](#storage.Disks) | repeated | | ### BlockDeviceWipeDescriptor.Method | Name | Number | Description | | ------ | ------ | ------------------------------------------------------------------------------------------------------------------------- | | FAST | 0 | Fast wipe - wipe only filesystem signatures. | | ZEROES | 1 | Zeroes wipe - wipe by overwriting with zeroes (might be slow depending on the disk size and available hardware features). | ### Disk.DiskType | Name | Number | Description | | ------- | ------ | ----------- | | UNKNOWN | 0 | | | SSD | 1 | | | HDD | 2 | | | NVME | 3 | | | SD | 4 | | | CD | 5 | | ### StorageService StorageService represents the storage service. | Method Name | Request Type | Response Type | Description | | --------------- | --------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------- | | Disks | [.google.protobuf.Empty](#google.protobuf.Empty) | [DisksResponse](#storage.DisksResponse) | | | BlockDeviceWipe | [BlockDeviceWipeRequest](#storage.BlockDeviceWipeRequest) | [BlockDeviceWipeResponse](#storage.BlockDeviceWipeResponse) | BlockDeviceWipe performs a wipe of the blockdevice (partition or disk). | The method doesn't require a reboot, and it can only wipe blockdevices which are not being used as volumes at the moment. Wiping of volumes requires a different API. |

Top

## time/time.proto ### Time | Field | Type | Label | Description | | ---------- | ------------------------------------------------------- | ----- | ----------- | | metadata | [common.Metadata](#common.Metadata) | | | | server | [string](#string) | | | | localtime | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | | | remotetime | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | | ### TimeRequest The response message containing the ntp server | Field | Type | Label | Description | | ------ | ----------------- | ----- | ----------- | | server | [string](#string) | | | ### TimeResponse The response message containing the ntp server, time, and offset | Field | Type | Label | Description | | -------- | ------------------ | -------- | ----------- | | messages | [Time](#time.Time) | repeated | | ### TimeService The time service definition. | Method Name | Request Type | Response Type | Description | | ----------- | ------------------------------------------------ | ---------------------------------- | ----------- | | Time | [.google.protobuf.Empty](#google.protobuf.Empty) | [TimeResponse](#time.TimeResponse) | | | TimeCheck | [TimeRequest](#time.TimeRequest) | [TimeResponse](#time.TimeResponse) | | ## Scalar Value Types | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ---------- | ----------- | ------- | ---------- | -------------- | ------------------------------ | | double | | double | double | float | float64 | double | float | Float | | float | | float | float | float | float32 | float | float | Float | | int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | | uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | | uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | | sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | | fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | | fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | | sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | | bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | | string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | | bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | \[]byte | ByteString | string | String (ASCII-8BIT) |