api

package

Go to main page

Versions in this module

v6

v6.8.0

Dec 13, 2024

Changes in this version

type InstanceConsolePost

+ Force bool

v6.7.0

Nov 15, 2024

Changes in this version

type InstanceSource

+ RefreshExcludeOlder bool

type StorageVolumeSource

+ RefreshExcludeOlder bool

v6.6.0

Oct 3, 2024

Changes in this version

type InstanceState

+ OSInfo *InstanceStateOSInfo

+ type InstanceStateOSInfo struct

+ FQDN string

+ Hostname string

+ KernelVersion string

+ OS string

+ OSVersion string

+ type NetworkLoadBalancerState struct

+ BackendHealth map[string]NetworkLoadBalancerStateBackendHealth

+ type NetworkLoadBalancerStateBackendHealth struct

+ Address string

+ Ports []NetworkLoadBalancerStateBackendHealthPort

+ type NetworkLoadBalancerStateBackendHealthPort struct

+ Port int

+ Protocol string

+ Status string

v6.5.0

Sep 6, 2024

v6.4.0

Aug 9, 2024

Changes in this version

type ClusterGroupPut

+ Config map[string]string

v6.3.0

Jul 12, 2024

v6.2.0

May 31, 2024

v6.1.0

May 4, 2024

v6.0.2

Sep 16, 2024

Changes in this version

+ const EventLifecycleClusterMemberEvacuated

+ const EventLifecycleClusterMemberHealed

+ const EventLifecycleClusterMemberRestored

+ const EventLifecycleInstanceMigrated

+ type StorageVolumeBackup struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ Name string

+ OptimizedStorage bool

+ VolumeOnly bool

+ type StorageVolumeBackupPost struct

+ Name string

+ type StorageVolumeBackupsPost struct

+ CompressionAlgorithm string

+ ExpiresAt time.Time

+ Name string

+ OptimizedStorage bool

+ VolumeOnly bool

v6.0.1

Jun 28, 2024

Changes in this version

+ const AuthenticationMethodOIDC

+ const AuthenticationMethodTLS

+ const CertificateTypeClient

+ const CertificateTypeMetrics

+ const CertificateTypeServer

+ const CertificateTypeUnknown

+ const EventLifecycleCertificateCreated

+ const EventLifecycleCertificateDeleted

+ const EventLifecycleCertificateUpdated

+ const EventLifecycleClusterCertificateUpdated

+ const EventLifecycleClusterDisabled

+ const EventLifecycleClusterEnabled

+ const EventLifecycleClusterGroupCreated

+ const EventLifecycleClusterGroupDeleted

+ const EventLifecycleClusterGroupRenamed

+ const EventLifecycleClusterGroupUpdated

+ const EventLifecycleClusterMemberAdded

+ const EventLifecycleClusterMemberRemoved

+ const EventLifecycleClusterMemberRenamed

+ const EventLifecycleClusterMemberUpdated

+ const EventLifecycleClusterTokenCreated

+ const EventLifecycleConfigUpdated

+ const EventLifecycleImageAliasCreated

+ const EventLifecycleImageAliasDeleted

+ const EventLifecycleImageAliasRenamed

+ const EventLifecycleImageAliasUpdated

+ const EventLifecycleImageCreated

+ const EventLifecycleImageDeleted

+ const EventLifecycleImageRefreshed

+ const EventLifecycleImageRetrieved

+ const EventLifecycleImageSecretCreated

+ const EventLifecycleImageUpdated

+ const EventLifecycleInstanceBackupCreated

+ const EventLifecycleInstanceBackupDeleted

+ const EventLifecycleInstanceBackupRenamed

+ const EventLifecycleInstanceBackupRetrieved

+ const EventLifecycleInstanceConsole

+ const EventLifecycleInstanceConsoleReset

+ const EventLifecycleInstanceConsoleRetrieved

+ const EventLifecycleInstanceCreated

+ const EventLifecycleInstanceDeleted

+ const EventLifecycleInstanceExec

+ const EventLifecycleInstanceFileDeleted

+ const EventLifecycleInstanceFilePushed

+ const EventLifecycleInstanceFileRetrieved

+ const EventLifecycleInstanceLogDeleted

+ const EventLifecycleInstanceLogRetrieved

+ const EventLifecycleInstanceMetadataRetrieved

+ const EventLifecycleInstanceMetadataTemplateCreated

+ const EventLifecycleInstanceMetadataTemplateDeleted

+ const EventLifecycleInstanceMetadataTemplateRetrieved

+ const EventLifecycleInstanceMetadataUpdated

+ const EventLifecycleInstancePaused

+ const EventLifecycleInstanceReady

+ const EventLifecycleInstanceRenamed

+ const EventLifecycleInstanceRestarted

+ const EventLifecycleInstanceRestored

+ const EventLifecycleInstanceResumed

+ const EventLifecycleInstanceShutdown

+ const EventLifecycleInstanceSnapshotCreated

+ const EventLifecycleInstanceSnapshotDeleted

+ const EventLifecycleInstanceSnapshotRenamed

+ const EventLifecycleInstanceSnapshotUpdated

+ const EventLifecycleInstanceStarted

+ const EventLifecycleInstanceStopped

+ const EventLifecycleInstanceUpdated

+ const EventLifecycleNetworkACLCreated

+ const EventLifecycleNetworkACLDeleted

+ const EventLifecycleNetworkACLRenamed

+ const EventLifecycleNetworkACLUpdated

+ const EventLifecycleNetworkCreated

+ const EventLifecycleNetworkDeleted

+ const EventLifecycleNetworkForwardCreated

+ const EventLifecycleNetworkForwardDeleted

+ const EventLifecycleNetworkForwardUpdated

+ const EventLifecycleNetworkIntegrationCreated

+ const EventLifecycleNetworkIntegrationDeleted

+ const EventLifecycleNetworkIntegrationRenamed

+ const EventLifecycleNetworkIntegrationUpdated

+ const EventLifecycleNetworkLoadBalancerCreated

+ const EventLifecycleNetworkLoadBalancerDeleted

+ const EventLifecycleNetworkLoadBalancerUpdated

+ const EventLifecycleNetworkPeerCreated

+ const EventLifecycleNetworkPeerDeleted

+ const EventLifecycleNetworkPeerUpdated

+ const EventLifecycleNetworkRenamed

+ const EventLifecycleNetworkUpdated

+ const EventLifecycleNetworkZoneCreated

+ const EventLifecycleNetworkZoneDeleted

+ const EventLifecycleNetworkZoneRecordCreated

+ const EventLifecycleNetworkZoneRecordDeleted

+ const EventLifecycleNetworkZoneRecordUpdated

+ const EventLifecycleNetworkZoneUpdated

+ const EventLifecycleOperationCancelled

+ const EventLifecycleProfileCreated

+ const EventLifecycleProfileDeleted

+ const EventLifecycleProfileRenamed

+ const EventLifecycleProfileUpdated

+ const EventLifecycleProjectCreated

+ const EventLifecycleProjectDeleted

+ const EventLifecycleProjectRenamed

+ const EventLifecycleProjectUpdated

+ const EventLifecycleStorageBucketBackupCreated

+ const EventLifecycleStorageBucketBackupDeleted

+ const EventLifecycleStorageBucketBackupRenamed

+ const EventLifecycleStorageBucketBackupRetrieved

+ const EventLifecycleStorageBucketCreated

+ const EventLifecycleStorageBucketDeleted

+ const EventLifecycleStorageBucketKeyCreated

+ const EventLifecycleStorageBucketKeyDeleted

+ const EventLifecycleStorageBucketKeyUpdated

+ const EventLifecycleStorageBucketUpdated

+ const EventLifecycleStoragePoolCreated

+ const EventLifecycleStoragePoolDeleted

+ const EventLifecycleStoragePoolUpdated

+ const EventLifecycleStorageVolumeBackupCreated

+ const EventLifecycleStorageVolumeBackupDeleted

+ const EventLifecycleStorageVolumeBackupRenamed

+ const EventLifecycleStorageVolumeBackupRetrieved

+ const EventLifecycleStorageVolumeCreated

+ const EventLifecycleStorageVolumeDeleted

+ const EventLifecycleStorageVolumeRenamed

+ const EventLifecycleStorageVolumeRestored

+ const EventLifecycleStorageVolumeSnapshotCreated

+ const EventLifecycleStorageVolumeSnapshotDeleted

+ const EventLifecycleStorageVolumeSnapshotRenamed

+ const EventLifecycleStorageVolumeSnapshotUpdated

+ const EventLifecycleStorageVolumeUpdated

+ const EventLifecycleWarningAcknowledged

+ const EventLifecycleWarningDeleted

+ const EventLifecycleWarningReset

+ const EventTypeLifecycle

+ const EventTypeLogging

+ const EventTypeNetworkACL

+ const EventTypeOperation

+ const InstanceTypeAny

+ const InstanceTypeContainer

+ const InstanceTypeVM

+ const NetworkStatusCreated

+ const NetworkStatusErrored

+ const NetworkStatusPending

+ const NetworkStatusUnavailable

+ const NetworkStatusUnknown

+ const OperationClassTask

+ const OperationClassToken

+ const OperationClassWebsocket

+ const ProjectDefaultName

+ const SecretNameControl

+ const SecretNameFilesystem

+ const SecretNameState

+ const StoragePoolStatusCreated

+ const StoragePoolStatusErrored

+ const StoragePoolStatusPending

+ const StoragePoolStatusUnknown

+ const StoragePoolStatusUnvailable

+ var StatusCodeNames = map[StatusCode]string

+ func GetParentAndSnapshotName(name string) (string, string, bool)

+ func ParseFileHeaders(headers http.Header) (int64, int64, int, string, string)

+ func StatusErrorCheck(err error, matchStatusCodes ...int) bool

+ func StatusErrorMatch(err error, matchStatusCodes ...int) (int, bool)

+ type Access []AccessEntry

+ type AccessEntry struct

+ Identifier string

+ Provider string

+ Role string

+ type Certificate struct

+ Fingerprint string

+ func (c *Certificate) URL(apiVersion string) *URL

+ func (cert *Certificate) Writable() CertificatePut

+ type CertificateAddToken struct

+ Addresses []string

+ ClientName string

+ ExpiresAt time.Time

+ Fingerprint string

+ Secret string

+ func (t *CertificateAddToken) String() string

+ type CertificatePut struct

+ Certificate string

+ Description string

+ Name string

+ Projects []string

+ Restricted bool

+ Type string

+ type CertificatesPost struct

+ Token bool

+ TrustToken string

+ type Cluster struct

+ Enabled bool

+ MemberConfig []ClusterMemberConfigKey

+ ServerName string

+ type ClusterCertificatePut struct

+ ClusterCertificate string

+ ClusterCertificateKey string

+ type ClusterGroup struct

+ func (c *ClusterGroup) Writable() ClusterGroupPut

+ type ClusterGroupPost struct

+ Name string

+ type ClusterGroupPut struct

+ Description string

+ Members []string

+ type ClusterGroupsPost struct

+ Name string

+ type ClusterMember struct

+ Architecture string

+ Database bool

+ Message string

+ ServerName string

+ Status string

+ URL string

+ func (member *ClusterMember) Writable() ClusterMemberPut

+ type ClusterMemberConfigKey struct

+ Description string

+ Entity string

+ Key string

+ Name string

+ Value string

+ type ClusterMemberJoinToken struct

+ Addresses []string

+ ExpiresAt time.Time

+ Fingerprint string

+ Secret string

+ ServerName string

+ func (t *ClusterMemberJoinToken) String() string

+ type ClusterMemberPost struct

+ ServerName string

+ type ClusterMemberPut struct

+ Config map[string]string

+ Description string

+ FailureDomain string

+ Groups []string

+ Roles []string

+ type ClusterMemberState struct

+ StoragePools map[string]StoragePoolState

+ SysInfo ClusterMemberSysInfo

+ type ClusterMemberStatePost struct

+ Action string

+ Mode string

+ type ClusterMemberSysInfo struct

+ BufferRAM uint64

+ FreeRAM uint64

+ FreeSwap uint64

+ LoadAverages []float64

+ Processes uint16

+ SharedRAM uint64

+ TotalRAM uint64

+ TotalSwap uint64

+ Uptime int64

+ type ClusterMembersPost struct

+ ServerName string

+ type ClusterPut struct

+ ClusterAddress string

+ ClusterCertificate string

+ ClusterToken string

+ ServerAddress string

+ type Event struct

+ Location string

+ Metadata json.RawMessage

+ Project string

+ Timestamp time.Time

+ Type string

+ func (event *Event) ToLogging() (EventLogRecord, error)

+ type EventLifecycle struct

+ Action string

+ Context map[string]any

+ Name string

+ Project string

+ Requestor *EventLifecycleRequestor

+ Source string

+ type EventLifecycleRequestor struct

+ Address string

+ Protocol string

+ Username string

+ type EventLogRecord struct

+ Ctx []any

+ Lvl string

+ Msg string

+ Time time.Time

+ type EventLogging struct

+ Context map[string]string

+ Level string

+ Message string

+ type Image struct

+ Aliases []ImageAlias

+ Architecture string

+ Cached bool

+ CreatedAt time.Time

+ Filename string

+ Fingerprint string

+ LastUsedAt time.Time

+ Project string

+ Size int64

+ Type string

+ UpdateSource *ImageSource

+ UploadedAt time.Time

+ func (img *Image) URL(apiVersion string, project string) *URL

+ func (img *Image) Writable() ImagePut

+ type ImageAlias struct

+ Description string

+ Name string

+ type ImageAliasesEntry struct

+ Name string

+ Type string

+ type ImageAliasesEntryPost struct

+ Name string

+ type ImageAliasesEntryPut struct

+ Description string

+ Target string

+ type ImageAliasesPost struct

+ type ImageExportPost struct

+ Aliases []ImageAlias

+ Certificate string

+ Profiles []string

+ Project string

+ Secret string

+ Target string

+ type ImageMetadata struct

+ Architecture string

+ CreationDate int64

+ ExpiryDate int64

+ Properties map[string]string

+ Templates map[string]*ImageMetadataTemplate

+ type ImageMetadataTemplate struct

+ CreateOnly bool

+ GID string

+ Mode string

+ Properties map[string]string

+ Template string

+ UID string

+ When []string

+ type ImagePut struct

+ AutoUpdate bool

+ ExpiresAt time.Time

+ Profiles []string

+ Properties map[string]string

+ Public bool

+ type ImageSource struct

+ Alias string

+ Certificate string

+ ImageType string

+ Protocol string

+ Server string

+ type ImagesPost struct

+ Aliases []ImageAlias

+ CompressionAlgorithm string

+ Filename string

+ Source *ImagesPostSource

+ type ImagesPostSource struct

+ Fingerprint string

+ Mode string

+ Name string

+ Project string

+ Secret string

+ Type string

+ URL string

+ type InitClusterPreseed struct

+ ClusterCertificatePath string

+ type InitLocalPreseed struct

+ Networks []InitNetworksProjectPost

+ Profiles []ProfilesPost

+ Projects []ProjectsPost

+ StoragePools []StoragePoolsPost

+ type InitNetworksProjectPost struct

+ Project string

+ type InitPreseed struct

+ Cluster *InitClusterPreseed

+ Server InitLocalPreseed

+ type Instance struct

+ CreatedAt time.Time

+ ExpandedConfig map[string]string

+ ExpandedDevices map[string]map[string]string

+ LastUsedAt time.Time

+ Location string

+ Name string

+ Project string

+ Status string

+ StatusCode StatusCode

+ Type string

+ func (c *Instance) URL(apiVersion string, project string) *URL

+ func (c *Instance) Writable() InstancePut

+ func (c Instance) IsActive() bool

+ type InstanceBackup struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ InstanceOnly bool

+ Name string

+ OptimizedStorage bool

+ type InstanceBackupPost struct

+ Name string

+ type InstanceBackupsPost struct

+ CompressionAlgorithm string

+ ExpiresAt time.Time

+ InstanceOnly bool

+ Name string

+ OptimizedStorage bool

+ type InstanceConsoleControl struct

+ Args map[string]string

+ Command string

+ type InstanceConsolePost struct

+ Height int

+ Type string

+ Width int

+ type InstanceExecControl struct

+ Args map[string]string

+ Command string

+ Signal int

+ type InstanceExecPost struct

+ Command []string

+ Cwd string

+ Environment map[string]string

+ Group uint32

+ Height int

+ Interactive bool

+ RecordOutput bool

+ User uint32

+ WaitForWS bool

+ Width int

+ type InstanceFull struct

+ Backups []InstanceBackup

+ Snapshots []InstanceSnapshot

+ State *InstanceState

+ type InstancePost struct

+ AllowInconsistent bool

+ Config map[string]string

+ Devices map[string]map[string]string

+ InstanceOnly bool

+ Live bool

+ Migration bool

+ Name string

+ Pool string

+ Profiles []string

+ Project string

+ Target *InstancePostTarget

+ type InstancePostTarget struct

+ Certificate string

+ Operation string

+ Websockets map[string]string

+ type InstancePut struct

+ Architecture string

+ Config map[string]string

+ Description string

+ Devices map[string]map[string]string

+ Ephemeral bool

+ Profiles []string

+ Restore string

+ Stateful bool

+ type InstanceRebuildPost struct

+ Source InstanceSource

+ type InstanceSnapshot struct

+ Architecture string

+ Config map[string]string

+ CreatedAt time.Time

+ Devices map[string]map[string]string

+ Ephemeral bool

+ ExpandedConfig map[string]string

+ ExpandedDevices map[string]map[string]string

+ LastUsedAt time.Time

+ Name string

+ Profiles []string

+ Size int64

+ Stateful bool

+ func (c *InstanceSnapshot) Writable() InstanceSnapshotPut

+ type InstanceSnapshotPost struct

+ Live bool

+ Migration bool

+ Name string

+ Target *InstancePostTarget

+ type InstanceSnapshotPut struct

+ ExpiresAt time.Time

+ type InstanceSnapshotsPost struct

+ ExpiresAt *time.Time

+ Name string

+ Stateful bool

+ type InstanceSource struct

+ Alias string

+ AllowInconsistent bool

+ BaseImage string

+ Certificate string

+ Fingerprint string

+ InstanceOnly bool

+ Live bool

+ Mode string

+ Operation string

+ Project string

+ Properties map[string]string

+ Protocol string

+ Refresh bool

+ Secret string

+ Server string

+ Source string

+ Type string

+ Websockets map[string]string

+ type InstanceState struct

+ CPU InstanceStateCPU

+ Disk map[string]InstanceStateDisk

+ Memory InstanceStateMemory

+ Network map[string]InstanceStateNetwork

+ Pid int64

+ Processes int64

+ StartedAt time.Time

+ Status string

+ StatusCode StatusCode

+ type InstanceStateCPU struct

+ Usage int64

+ type InstanceStateDisk struct

+ Total int64

+ Usage int64

+ type InstanceStateMemory struct

+ SwapUsage int64

+ SwapUsagePeak int64

+ Total int64

+ Usage int64

+ UsagePeak int64

+ type InstanceStateNetwork struct

+ Addresses []InstanceStateNetworkAddress

+ Counters InstanceStateNetworkCounters

+ HostName string

+ Hwaddr string

+ Mtu int

+ State string

+ Type string

+ type InstanceStateNetworkAddress struct

+ Address string

+ Family string

+ Netmask string

+ Scope string

+ type InstanceStateNetworkCounters struct

+ BytesReceived int64

+ BytesSent int64

+ ErrorsReceived int64

+ ErrorsSent int64

+ PacketsDroppedInbound int64

+ PacketsDroppedOutbound int64

+ PacketsReceived int64

+ PacketsSent int64

+ type InstanceStatePut struct

+ Action string

+ Force bool

+ Stateful bool

+ Timeout int

+ type InstanceType string

+ type InstancesPost struct

+ InstanceType string

+ Name string

+ Source InstanceSource

+ Start bool

+ Type InstanceType

+ type InstancesPut struct

+ State *InstanceStatePut

+ type MetadataConfig map[MetadataConfigEntityName]map[MetadataConfigGroupName]MetadataConfigGroup

+ type MetadataConfigEntityName string

+ type MetadataConfigGroup struct

+ Keys []map[string]MetadataConfigKey

+ type MetadataConfigGroupName string

+ type MetadataConfigKey struct

+ Condition string

+ Default string

+ Description string

+ LiveUpdate string

+ LongDescription string

+ Scope string

+ Type string

+ type MetadataConfiguration struct

+ Config MetadataConfig

+ func (m *MetadataConfiguration) GetKeys(entity string, group string) (map[string]MetadataConfigKey, error)

+ type Network struct

+ Locations []string

+ Managed bool

+ Name string

+ Project string

+ Status string

+ Type string

+ UsedBy []string

+ func (network *Network) Writable() NetworkPut

+ type NetworkACL struct

+ Project string

+ UsedBy []string

+ func (acl *NetworkACL) Writable() NetworkACLPut

+ type NetworkACLPost struct

+ Name string

+ type NetworkACLPut struct

+ Config map[string]string

+ Description string

+ Egress []NetworkACLRule

+ Ingress []NetworkACLRule

+ type NetworkACLRule struct

+ Action string

+ Description string

+ Destination string

+ DestinationPort string

+ ICMPCode string

+ ICMPType string

+ Protocol string

+ Source string

+ SourcePort string

+ State string

+ func (r *NetworkACLRule) Normalise()

+ type NetworkACLsPost struct

+ type NetworkAllocations struct

+ Address string

+ Hwaddr string

+ NAT bool

+ Type string

+ UsedBy string

+ type NetworkForward struct

+ ListenAddress string

+ Location string

+ func (f *NetworkForward) Etag() []any

+ func (f *NetworkForward) Writable() NetworkForwardPut

+ type NetworkForwardPort struct

+ Description string

+ ListenPort string

+ Protocol string

+ TargetAddress string

+ TargetPort string

+ func (p *NetworkForwardPort) Normalise()

+ type NetworkForwardPut struct

+ Config map[string]string

+ Description string

+ Ports []NetworkForwardPort

+ func (f *NetworkForwardPut) Normalise()

+ type NetworkForwardsPost struct

+ ListenAddress string

+ func (f *NetworkForwardsPost) Normalise()

+ type NetworkIntegration struct

+ Name string

+ Type string

+ UsedBy []string

+ func (f *NetworkIntegration) Writable() NetworkIntegrationPut

+ type NetworkIntegrationPost struct

+ Name string

+ type NetworkIntegrationPut struct

+ Config map[string]string

+ Description string

+ type NetworkIntegrationsPost struct

+ Name string

+ Type string

+ type NetworkLease struct

+ Address string

+ Hostname string

+ Hwaddr string

+ Location string

+ Type string

+ type NetworkLoadBalancer struct

+ ListenAddress string

+ Location string

+ func (f *NetworkLoadBalancer) Etag() []any

+ func (f *NetworkLoadBalancer) Writable() NetworkLoadBalancerPut

+ type NetworkLoadBalancerBackend struct

+ Description string

+ Name string

+ TargetAddress string

+ TargetPort string

+ func (p *NetworkLoadBalancerBackend) Normalise()

+ type NetworkLoadBalancerPort struct

+ Description string

+ ListenPort string

+ Protocol string

+ TargetBackend []string

+ func (p *NetworkLoadBalancerPort) Normalise()

+ type NetworkLoadBalancerPut struct

+ Backends []NetworkLoadBalancerBackend

+ Config map[string]string

+ Description string

+ Ports []NetworkLoadBalancerPort

+ func (f *NetworkLoadBalancerPut) Normalise()

+ type NetworkLoadBalancersPost struct

+ ListenAddress string

+ type NetworkPeer struct

+ Name string

+ Status string

+ TargetIntegration string

+ TargetNetwork string

+ TargetProject string

+ Type string

+ UsedBy []string

+ func (p *NetworkPeer) Etag() []any

+ func (p *NetworkPeer) Writable() NetworkPeerPut

+ type NetworkPeerPut struct

+ Config map[string]string

+ Description string

+ type NetworkPeersPost struct

+ Name string

+ TargetIntegration string

+ TargetNetwork string

+ TargetProject string

+ Type string

+ type NetworkPost struct

+ Name string

+ type NetworkPut struct

+ Config map[string]string

+ Description string

+ type NetworkState struct

+ Addresses []NetworkStateAddress

+ Bond *NetworkStateBond

+ Bridge *NetworkStateBridge

+ Counters NetworkStateCounters

+ Hwaddr string

+ Mtu int

+ OVN *NetworkStateOVN

+ State string

+ Type string

+ VLAN *NetworkStateVLAN

+ type NetworkStateAddress struct

+ Address string

+ Family string

+ Netmask string

+ Scope string

+ type NetworkStateBond struct

+ DownDelay uint64

+ LowerDevices []string

+ MIIFrequency uint64

+ MIIState string

+ Mode string

+ TransmitPolicy string

+ UpDelay uint64

+ type NetworkStateBridge struct

+ ForwardDelay uint64

+ ID string

+ STP bool

+ UpperDevices []string

+ VLANDefault uint64

+ VLANFiltering bool

+ type NetworkStateCounters struct

+ BytesReceived int64

+ BytesSent int64

+ PacketsReceived int64

+ PacketsSent int64

+ type NetworkStateOVN struct

+ Chassis string

+ LogicalRouter string

+ type NetworkStateVLAN struct

+ LowerDevice string

+ VID uint64

+ type NetworkZone struct

+ Name string

+ Project string

+ UsedBy []string

+ func (f *NetworkZone) Writable() NetworkZonePut

+ type NetworkZonePut struct

+ Config map[string]string

+ Description string

+ type NetworkZoneRecord struct

+ Name string

+ func (f *NetworkZoneRecord) Writable() NetworkZoneRecordPut

+ type NetworkZoneRecordEntry struct

+ TTL uint64

+ Type string

+ Value string

+ type NetworkZoneRecordPut struct

+ Config map[string]string

+ Description string

+ Entries []NetworkZoneRecordEntry

+ type NetworkZoneRecordsPost struct

+ Name string

+ type NetworkZonesPost struct

+ Name string

+ type NetworksPost struct

+ Name string

+ Type string

+ type Operation struct

+ Class string

+ CreatedAt time.Time

+ Description string

+ Err string

+ ID string

+ Location string

+ MayCancel bool

+ Metadata map[string]any

+ Resources map[string][]string

+ Status string

+ StatusCode StatusCode

+ UpdatedAt time.Time

+ func (op *Operation) ToCertificateAddToken() (*CertificateAddToken, error)

+ func (op *Operation) ToClusterJoinToken() (*ClusterMemberJoinToken, error)

+ type Profile struct

+ Name string

+ Project string

+ UsedBy []string

+ func (profile *Profile) URL(apiVersion string, projectName string) *URL

+ func (profile *Profile) Writable() ProfilePut

+ type ProfilePost struct

+ Name string

+ type ProfilePut struct

+ Config map[string]string

+ Description string

+ Devices map[string]map[string]string

+ type ProfilesPost struct

+ Name string

+ type Project struct

+ Name string

+ UsedBy []string

+ func (project *Project) URL(apiVersion string) *URL

+ func (project *Project) Writable() ProjectPut

+ type ProjectPost struct

+ Name string

+ type ProjectPut struct

+ Config map[string]string

+ Description string

+ type ProjectState struct

+ Resources map[string]ProjectStateResource

+ type ProjectStateResource struct

+ Limit int64

+ Usage int64

+ type ProjectsPost struct

+ Name string

+ type Resources struct

+ CPU ResourcesCPU

+ GPU ResourcesGPU

+ Load ResourcesLoad

+ Memory ResourcesMemory

+ Network ResourcesNetwork

+ PCI ResourcesPCI

+ Storage ResourcesStorage

+ System ResourcesSystem

+ USB ResourcesUSB

+ type ResourcesCPU struct

+ Architecture string

+ Sockets []ResourcesCPUSocket

+ Total uint64

+ type ResourcesCPUCache struct

+ Level uint64

+ Size uint64

+ Type string

+ type ResourcesCPUCore struct

+ Core uint64

+ Die uint64

+ Flags []string

+ Frequency uint64

+ Threads []ResourcesCPUThread

+ type ResourcesCPUSocket struct

+ Cache []ResourcesCPUCache

+ Cores []ResourcesCPUCore

+ Frequency uint64

+ FrequencyMinimum uint64

+ FrequencyTurbo uint64

+ Name string

+ Socket uint64

+ Vendor string

+ type ResourcesCPUThread struct

+ ID int64

+ Isolated bool

+ NUMANode uint64

+ Online bool

+ Thread uint64

+ type ResourcesGPU struct

+ Cards []ResourcesGPUCard

+ Total uint64

+ type ResourcesGPUCard struct

+ DRM *ResourcesGPUCardDRM

+ Driver string

+ DriverVersion string

+ Mdev map[string]ResourcesGPUCardMdev

+ NUMANode uint64

+ Nvidia *ResourcesGPUCardNvidia

+ PCIAddress string

+ Product string

+ ProductID string

+ SRIOV *ResourcesGPUCardSRIOV

+ USBAddress string

+ Vendor string

+ VendorID string

+ type ResourcesGPUCardDRM struct

+ CardDevice string

+ CardName string

+ ControlDevice string

+ ControlName string

+ ID uint64

+ RenderDevice string

+ RenderName string

+ type ResourcesGPUCardMdev struct

+ API string

+ Available uint64

+ Description string

+ Devices []string

+ Name string

+ type ResourcesGPUCardNvidia struct

+ Architecture string

+ Brand string

+ CUDAVersion string

+ CardDevice string

+ CardName string

+ Model string

+ NVRMVersion string

+ UUID string

+ type ResourcesGPUCardSRIOV struct

+ CurrentVFs uint64

+ MaximumVFs uint64

+ VFs []ResourcesGPUCard

+ type ResourcesLoad struct

+ Average10Min float64

+ Average1Min float64

+ Average5Min float64

+ Processes int

+ type ResourcesMemory struct

+ HugepagesSize uint64

+ HugepagesTotal uint64

+ HugepagesUsed uint64

+ Nodes []ResourcesMemoryNode

+ Total uint64

+ Used uint64

+ type ResourcesMemoryNode struct

+ HugepagesTotal uint64

+ HugepagesUsed uint64

+ NUMANode uint64

+ Total uint64

+ Used uint64

+ type ResourcesNetwork struct

+ Cards []ResourcesNetworkCard

+ Total uint64

+ type ResourcesNetworkCard struct

+ Driver string

+ DriverVersion string

+ FirmwareVersion string

+ NUMANode uint64

+ PCIAddress string

+ Ports []ResourcesNetworkCardPort

+ Product string

+ ProductID string

+ SRIOV *ResourcesNetworkCardSRIOV

+ USBAddress string

+ VDPA *ResourcesNetworkCardVDPA

+ Vendor string

+ VendorID string

+ type ResourcesNetworkCardPort struct

+ Address string

+ AutoNegotiation bool

+ ID string

+ Infiniband *ResourcesNetworkCardPortInfiniband

+ LinkDetected bool

+ LinkDuplex string

+ LinkSpeed uint64

+ Port uint64

+ PortType string

+ Protocol string

+ SupportedModes []string

+ SupportedPorts []string

+ TransceiverType string

+ type ResourcesNetworkCardPortInfiniband struct

+ IsSMDevice string

+ IsSMName string

+ MADDevice string

+ MADName string

+ VerbDevice string

+ VerbName string

+ type ResourcesNetworkCardSRIOV struct

+ CurrentVFs uint64

+ MaximumVFs uint64

+ VFs []ResourcesNetworkCard

+ type ResourcesNetworkCardVDPA struct

+ Device string

+ Name string

+ type ResourcesPCI struct

+ Devices []ResourcesPCIDevice

+ Total uint64

+ type ResourcesPCIDevice struct

+ Driver string

+ DriverVersion string

+ IOMMUGroup uint64

+ NUMANode uint64

+ PCIAddress string

+ Product string

+ ProductID string

+ VPD ResourcesPCIVPD

+ Vendor string

+ VendorID string

+ type ResourcesPCIVPD struct

+ Entries map[string]string

+ ProductName string

+ type ResourcesStorage struct

+ Disks []ResourcesStorageDisk

+ Total uint64

+ type ResourcesStorageDisk struct

+ BlockSize uint64

+ Device string

+ DeviceID string

+ DevicePath string

+ FirmwareVersion string

+ ID string

+ Model string

+ NUMANode uint64

+ PCIAddress string

+ Partitions []ResourcesStorageDiskPartition

+ RPM uint64

+ ReadOnly bool

+ Removable bool

+ Serial string

+ Size uint64

+ Type string

+ USBAddress string

+ WWN string

+ type ResourcesStorageDiskPartition struct

+ Device string

+ ID string

+ Partition uint64

+ ReadOnly bool

+ Size uint64

+ type ResourcesStoragePool struct

+ Inodes ResourcesStoragePoolInodes

+ Space ResourcesStoragePoolSpace

+ type ResourcesStoragePoolInodes struct

+ Total uint64

+ Used uint64

+ type ResourcesStoragePoolSpace struct

+ Total uint64

+ Used uint64

+ type ResourcesSystem struct

+ Chassis *ResourcesSystemChassis

+ Family string

+ Firmware *ResourcesSystemFirmware

+ Motherboard *ResourcesSystemMotherboard

+ Product string

+ Serial string

+ Sku string

+ Type string

+ UUID string

+ Vendor string

+ Version string

+ type ResourcesSystemChassis struct

+ Serial string

+ Type string

+ Vendor string

+ Version string

+ type ResourcesSystemFirmware struct

+ Date string

+ Vendor string

+ Version string

+ type ResourcesSystemMotherboard struct

+ Product string

+ Serial string

+ Vendor string

+ Version string

+ type ResourcesUSB struct

+ Devices []ResourcesUSBDevice

+ Total uint64

+ type ResourcesUSBDevice struct

+ BusAddress uint64

+ DeviceAddress uint64

+ Interfaces []ResourcesUSBDeviceInterface

+ Product string

+ ProductID string

+ Serial string

+ Speed float64

+ Vendor string

+ VendorID string

+ type ResourcesUSBDeviceInterface struct

+ Class string

+ ClassID uint64

+ Driver string

+ DriverVersion string

+ Number uint64

+ SubClass string

+ SubClassID uint64

+ type Response struct

+ Code int

+ Error string

+ Metadata json.RawMessage

+ Operation string

+ Status string

+ StatusCode int

+ Type ResponseType

+ func (r *Response) MetadataAsMap() (map[string]any, error)

+ func (r *Response) MetadataAsOperation() (*Operation, error)

+ func (r *Response) MetadataAsStringSlice() ([]string, error)

+ func (r *Response) MetadataAsStruct(target any) error

+ type ResponseRaw struct

+ Code int

+ Error string

+ Metadata any

+ Operation string

+ Status string

+ StatusCode int

+ Type ResponseType

+ type ResponseType string

+ const AsyncResponse

+ const ErrorResponse

+ const SyncResponse

+ type Server struct

+ AuthUserMethod string

+ AuthUserName string

+ Environment ServerEnvironment

+ func (srv *Server) Writable() ServerPut

+ type ServerEnvironment struct

+ Addresses []string

+ Architectures []string

+ Certificate string

+ CertificateFingerprint string

+ Driver string

+ DriverVersion string

+ Firewall string

+ Kernel string

+ KernelArchitecture string

+ KernelFeatures map[string]string

+ KernelVersion string

+ LXCFeatures map[string]string

+ OSName string

+ OSVersion string

+ Project string

+ Server string

+ ServerClustered bool

+ ServerEventMode string

+ ServerName string

+ ServerPid int

+ ServerVersion string

+ Storage string

+ StorageSupportedDrivers []ServerStorageDriverInfo

+ StorageVersion string

+ type ServerPut struct

+ Config map[string]string

+ type ServerStorageDriverInfo struct

+ Name string

+ Remote bool

+ Version string

+ type ServerUntrusted struct

+ APIExtensions []string

+ APIStatus string

+ APIVersion string

+ Auth string

+ AuthMethods []string

+ Public bool

+ type StatusCode int

+ const Aborting

+ const Cancelled

+ const Cancelling

+ const Error

+ const Failure

+ const Freezing

+ const Frozen

+ const OperationCreated

+ const Pending

+ const Ready

+ const Running

+ const Started

+ const Starting

+ const Stopped

+ const Stopping

+ const Success

+ const Thawed

+ func StatusCodeFromString(status string) StatusCode

+ func (o StatusCode) IsFinal() bool

+ func (o StatusCode) String() string

+ type StatusError struct

+ func StatusErrorf(status int, format string, a ...any) StatusError

+ func (e StatusError) Error() string

+ func (e StatusError) Status() int

+ type StorageBucket struct

+ Location string

+ Name string

+ Project string

+ S3URL string

+ func (b *StorageBucket) Etag() []any

+ func (b *StorageBucket) URL(apiVersion string, poolName string, projectName string) *URL

+ func (b *StorageBucket) Writable() StorageBucketPut

+ type StorageBucketBackup struct

+ CompressionAlgorithm string

+ ExpiresAt time.Time

+ Name string

+ type StorageBucketBackupPost struct

+ Name string

+ type StorageBucketBackupsPost struct

+ CompressionAlgorithm string

+ ExpiresAt time.Time

+ Name string

+ type StorageBucketKey struct

+ Name string

+ func (b *StorageBucketKey) Etag() []any

+ func (b *StorageBucketKey) URL(apiVersion string, poolName string, projectName string, bucketName string) *URL

+ func (b *StorageBucketKey) Writable() StorageBucketKeyPut

+ type StorageBucketKeyPut struct

+ AccessKey string

+ Description string

+ Role string

+ SecretKey string

+ type StorageBucketKeysPost struct

+ Name string

+ type StorageBucketPut struct

+ Config map[string]string

+ Description string

+ type StorageBucketsPost struct

+ Name string

+ type StoragePool struct

+ Driver string

+ Locations []string

+ Name string

+ Status string

+ UsedBy []string

+ func (storagePool *StoragePool) Writable() StoragePoolPut

+ type StoragePoolPut struct

+ Config map[string]string

+ Description string

+ type StoragePoolState struct

+ type StoragePoolVolumeBackup struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ Name string

+ OptimizedStorage bool

+ VolumeOnly bool

+ type StoragePoolVolumeBackupPost struct

+ Name string

+ type StoragePoolVolumeBackupsPost struct

+ CompressionAlgorithm string

+ ExpiresAt time.Time

+ Name string

+ OptimizedStorage bool

+ VolumeOnly bool

+ type StoragePoolsPost struct

+ Driver string

+ Name string

+ type StorageVolume struct

+ ContentType string

+ CreatedAt time.Time

+ Location string

+ Name string

+ Project string

+ Type string

+ UsedBy []string

+ func (storageVolume *StorageVolume) Writable() StorageVolumePut

+ func (v *StorageVolume) URL(apiVersion string, poolName string) *URL

+ type StorageVolumePost struct

+ Migration bool

+ Name string

+ Pool string

+ Project string

+ Source StorageVolumeSource

+ Target *StorageVolumePostTarget

+ VolumeOnly bool

+ type StorageVolumePostTarget struct

+ Certificate string

+ Operation string

+ Websockets map[string]string

+ type StorageVolumePut struct

+ Config map[string]string

+ Description string

+ Restore string

+ type StorageVolumeSnapshot struct

+ Config map[string]string

+ ContentType string

+ CreatedAt time.Time

+ Name string

+ func (storageVolumeSnapshot *StorageVolumeSnapshot) Writable() StorageVolumeSnapshotPut

+ type StorageVolumeSnapshotPost struct

+ Migration bool

+ Name string

+ Target *StorageVolumePostTarget

+ type StorageVolumeSnapshotPut struct

+ Description string

+ ExpiresAt *time.Time

+ type StorageVolumeSnapshotsPost struct

+ ExpiresAt *time.Time

+ Name string

+ type StorageVolumeSource struct

+ Certificate string

+ Location string

+ Mode string

+ Name string

+ Operation string

+ Pool string

+ Project string

+ Refresh bool

+ Type string

+ VolumeOnly bool

+ Websockets map[string]string

+ type StorageVolumeState struct

+ Usage *StorageVolumeStateUsage

+ type StorageVolumeStateUsage struct

+ Total int64

+ Used uint64

+ type StorageVolumesPost struct

+ ContentType string

+ Name string

+ Source StorageVolumeSource

+ Type string

+ type URL struct

+ func NewURL() *URL

+ func (u *URL) Host(host string) *URL

+ func (u *URL) Path(pathParts ...string) *URL

+ func (u *URL) Project(projectName string) *URL

+ func (u *URL) Scheme(scheme string) *URL

+ func (u *URL) Target(clusterMemberName string) *URL

+ func (u *URL) WithQuery(key string, value string) *URL

+ type Warning struct

+ Count int

+ EntityURL string

+ FirstSeenAt time.Time

+ LastMessage string

+ LastSeenAt time.Time

+ Location string

+ Project string

+ Severity string

+ Type string

+ UUID string

+ type WarningPut struct

+ Status string

Other modules containing this package

github.com/lxc/incus

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL