Documentation ¶
Overview ¶
Package api contains Go structs for all API objects
Overview ¶
This package has Go structs for every API object, all the various structs are named after the object they represent and some variations of those structs exist for initial object creation, object update and object retrieval.
A few convenience functions are also tied to those structs which let you convert between the various strucs for a given object and also query some of the more complex metadata available.
Index ¶
- Constants
- Variables
- 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
- type AccessEntry
- type Certificate
- type CertificateAddToken
- type CertificatePut
- type CertificatesPost
- type Cluster
- type ClusterCertificatePut
- type ClusterGroup
- type ClusterGroupPost
- type ClusterGroupPut
- type ClusterGroupsPost
- type ClusterMember
- type ClusterMemberConfigKey
- type ClusterMemberJoinToken
- type ClusterMemberPost
- type ClusterMemberPut
- type ClusterMemberState
- type ClusterMemberStatePost
- type ClusterMemberSysInfo
- type ClusterMembersPost
- type ClusterPut
- type Event
- type EventLifecycle
- type EventLifecycleRequestor
- type EventLogRecord
- type EventLogging
- type Image
- type ImageAlias
- type ImageAliasesEntry
- type ImageAliasesEntryPost
- type ImageAliasesEntryPut
- type ImageAliasesPost
- type ImageExportPost
- type ImageMetadata
- type ImageMetadataTemplate
- type ImagePut
- type ImageSource
- type ImagesPost
- type ImagesPostSource
- type InitClusterPreseed
- type InitLocalPreseed
- type InitNetworksProjectPost
- type InitPreseed
- type Instance
- type InstanceBackup
- type InstanceBackupPost
- type InstanceBackupsPost
- type InstanceConsoleControl
- type InstanceConsolePost
- type InstanceExecControl
- type InstanceExecPost
- type InstanceFull
- type InstancePost
- type InstancePostTarget
- type InstancePut
- type InstanceRebuildPost
- type InstanceSnapshot
- type InstanceSnapshotPost
- type InstanceSnapshotPut
- type InstanceSnapshotsPost
- type InstanceSource
- type InstanceState
- type InstanceStateCPU
- type InstanceStateDisk
- type InstanceStateMemory
- type InstanceStateNetwork
- type InstanceStateNetworkAddress
- type InstanceStateNetworkCounters
- type InstanceStatePut
- type InstanceType
- type InstancesPost
- type InstancesPut
- type MetadataConfig
- type MetadataConfigEntityName
- type MetadataConfigGroup
- type MetadataConfigGroupName
- type MetadataConfigKey
- type MetadataConfiguration
- type Network
- type NetworkACL
- type NetworkACLPost
- type NetworkACLPut
- type NetworkACLRule
- type NetworkACLsPost
- type NetworkAllocations
- type NetworkForward
- type NetworkForwardPort
- type NetworkForwardPut
- type NetworkForwardsPost
- type NetworkIntegration
- type NetworkIntegrationPost
- type NetworkIntegrationPut
- type NetworkIntegrationsPost
- type NetworkLease
- type NetworkLoadBalancer
- type NetworkLoadBalancerBackend
- type NetworkLoadBalancerPort
- type NetworkLoadBalancerPut
- type NetworkLoadBalancersPost
- type NetworkPeer
- type NetworkPeerPut
- type NetworkPeersPost
- type NetworkPost
- type NetworkPut
- type NetworkState
- type NetworkStateAddress
- type NetworkStateBond
- type NetworkStateBridge
- type NetworkStateCounters
- type NetworkStateOVN
- type NetworkStateVLAN
- type NetworkZone
- type NetworkZonePut
- type NetworkZoneRecord
- type NetworkZoneRecordEntry
- type NetworkZoneRecordPut
- type NetworkZoneRecordsPost
- type NetworkZonesPost
- type NetworksPost
- type Operation
- type Profile
- type ProfilePost
- type ProfilePut
- type ProfilesPost
- type Project
- type ProjectPost
- type ProjectPut
- type ProjectState
- type ProjectStateResource
- type ProjectsPost
- type Resources
- type ResourcesCPU
- type ResourcesCPUCache
- type ResourcesCPUCore
- type ResourcesCPUSocket
- type ResourcesCPUThread
- type ResourcesGPU
- type ResourcesGPUCard
- type ResourcesGPUCardDRM
- type ResourcesGPUCardMdev
- type ResourcesGPUCardNvidia
- type ResourcesGPUCardSRIOV
- type ResourcesLoad
- type ResourcesMemory
- type ResourcesMemoryNode
- type ResourcesNetwork
- type ResourcesNetworkCard
- type ResourcesNetworkCardPort
- type ResourcesNetworkCardPortInfiniband
- type ResourcesNetworkCardSRIOV
- type ResourcesNetworkCardVDPA
- type ResourcesPCI
- type ResourcesPCIDevice
- type ResourcesPCIVPD
- type ResourcesStorage
- type ResourcesStorageDisk
- type ResourcesStorageDiskPartition
- type ResourcesStoragePool
- type ResourcesStoragePoolInodes
- type ResourcesStoragePoolSpace
- type ResourcesSystem
- type ResourcesSystemChassis
- type ResourcesSystemFirmware
- type ResourcesSystemMotherboard
- type ResourcesUSB
- type ResourcesUSBDevice
- type ResourcesUSBDeviceInterface
- type Response
- type ResponseRaw
- type ResponseType
- type Server
- type ServerEnvironment
- type ServerPut
- type ServerStorageDriverInfo
- type ServerUntrusted
- type StatusCode
- type StatusError
- type StorageBucket
- type StorageBucketBackup
- type StorageBucketBackupPost
- type StorageBucketBackupsPost
- type StorageBucketKey
- type StorageBucketKeyPut
- type StorageBucketKeysPost
- type StorageBucketPut
- type StorageBucketsPost
- type StoragePool
- type StoragePoolPut
- type StoragePoolState
- type StoragePoolsPost
- type StorageVolume
- type StorageVolumeBackup
- type StorageVolumeBackupPost
- type StorageVolumeBackupsPost
- type StorageVolumePost
- type StorageVolumePostTarget
- type StorageVolumePut
- type StorageVolumeSnapshot
- type StorageVolumeSnapshotPost
- type StorageVolumeSnapshotPut
- type StorageVolumeSnapshotsPost
- type StorageVolumeSource
- type StorageVolumeState
- type StorageVolumeStateUsage
- type StorageVolumesPost
- type URL
- type Warning
- type WarningPut
Examples ¶
Constants ¶
const ( // AuthenticationMethodTLS is the default authentication method for interacting with Incus remotely. AuthenticationMethodTLS = "tls" // AuthenticationMethodOIDC is a token based authentication method. AuthenticationMethodOIDC = "oidc" )
const ( EventTypeLifecycle = "lifecycle" EventTypeLogging = "logging" EventTypeOperation = "operation" EventTypeNetworkACL = "network-acl" )
Event types.
const ( EventLifecycleCertificateCreated = "certificate-created" EventLifecycleCertificateDeleted = "certificate-deleted" EventLifecycleCertificateUpdated = "certificate-updated" EventLifecycleClusterCertificateUpdated = "cluster-certificate-updated" EventLifecycleClusterDisabled = "cluster-disabled" EventLifecycleClusterEnabled = "cluster-enabled" EventLifecycleClusterGroupCreated = "cluster-group-created" EventLifecycleClusterGroupDeleted = "cluster-group-deleted" EventLifecycleClusterGroupRenamed = "cluster-group-renamed" EventLifecycleClusterGroupUpdated = "cluster-group-updated" EventLifecycleClusterMemberAdded = "cluster-member-added" EventLifecycleClusterMemberEvacuated = "cluster-member-evacuated" EventLifecycleClusterMemberHealed = "cluster-member-healed" EventLifecycleClusterMemberRemoved = "cluster-member-removed" EventLifecycleClusterMemberRenamed = "cluster-member-renamed" EventLifecycleClusterMemberRestored = "cluster-member-restored" EventLifecycleClusterMemberUpdated = "cluster-member-updated" EventLifecycleClusterTokenCreated = "cluster-token-created" EventLifecycleConfigUpdated = "config-updated" EventLifecycleImageAliasCreated = "image-alias-created" EventLifecycleImageAliasDeleted = "image-alias-deleted" EventLifecycleImageAliasRenamed = "image-alias-renamed" EventLifecycleImageAliasUpdated = "image-alias-updated" EventLifecycleImageCreated = "image-created" EventLifecycleImageDeleted = "image-deleted" EventLifecycleImageRefreshed = "image-refreshed" EventLifecycleImageRetrieved = "image-retrieved" EventLifecycleImageSecretCreated = "image-secret-created" EventLifecycleImageUpdated = "image-updated" EventLifecycleInstanceBackupCreated = "instance-backup-created" EventLifecycleInstanceBackupDeleted = "instance-backup-deleted" EventLifecycleInstanceBackupRenamed = "instance-backup-renamed" EventLifecycleInstanceBackupRetrieved = "instance-backup-retrieved" EventLifecycleInstanceConsole = "instance-console" EventLifecycleInstanceConsoleReset = "instance-console-reset" EventLifecycleInstanceConsoleRetrieved = "instance-console-retrieved" EventLifecycleInstanceCreated = "instance-created" EventLifecycleInstanceDeleted = "instance-deleted" EventLifecycleInstanceExec = "instance-exec" EventLifecycleInstanceFileDeleted = "instance-file-deleted" EventLifecycleInstanceFilePushed = "instance-file-pushed" EventLifecycleInstanceFileRetrieved = "instance-file-retrieved" EventLifecycleInstanceLogDeleted = "instance-log-deleted" EventLifecycleInstanceLogRetrieved = "instance-log-retrieved" EventLifecycleInstanceMetadataRetrieved = "instance-metadata-retrieved" EventLifecycleInstanceMetadataTemplateCreated = "instance-metadata-template-created" EventLifecycleInstanceMetadataTemplateDeleted = "instance-metadata-template-deleted" EventLifecycleInstanceMetadataTemplateRetrieved = "instance-metadata-template-retrieved" EventLifecycleInstanceMetadataUpdated = "instance-metadata-updated" EventLifecycleInstanceMigrated = "instance-migrated" EventLifecycleInstancePaused = "instance-paused" EventLifecycleInstanceReady = "instance-ready" EventLifecycleInstanceRenamed = "instance-renamed" EventLifecycleInstanceRestarted = "instance-restarted" EventLifecycleInstanceRestored = "instance-restored" EventLifecycleInstanceResumed = "instance-resumed" EventLifecycleInstanceShutdown = "instance-shutdown" EventLifecycleInstanceSnapshotCreated = "instance-snapshot-created" EventLifecycleInstanceSnapshotDeleted = "instance-snapshot-deleted" EventLifecycleInstanceSnapshotRenamed = "instance-snapshot-renamed" EventLifecycleInstanceSnapshotUpdated = "instance-snapshot-updated" EventLifecycleInstanceStarted = "instance-started" EventLifecycleInstanceStopped = "instance-stopped" EventLifecycleInstanceUpdated = "instance-updated" EventLifecycleNetworkACLCreated = "network-acl-created" EventLifecycleNetworkACLDeleted = "network-acl-deleted" EventLifecycleNetworkACLRenamed = "network-acl-renamed" EventLifecycleNetworkACLUpdated = "network-acl-updated" EventLifecycleNetworkCreated = "network-created" EventLifecycleNetworkDeleted = "network-deleted" EventLifecycleNetworkForwardCreated = "network-forward-created" EventLifecycleNetworkForwardDeleted = "network-forward-deleted" EventLifecycleNetworkForwardUpdated = "network-forward-updated" EventLifecycleNetworkIntegrationCreated = "network-integration-created" EventLifecycleNetworkIntegrationDeleted = "network-integration-deleted" EventLifecycleNetworkIntegrationRenamed = "network-integration-renamed" EventLifecycleNetworkIntegrationUpdated = "network-integration-updated" EventLifecycleNetworkLoadBalancerCreated = "network-load-balancer-created" EventLifecycleNetworkLoadBalancerDeleted = "network-load-balancer-deleted" EventLifecycleNetworkLoadBalancerUpdated = "network-load-balancer-updated" EventLifecycleNetworkPeerCreated = "network-peer-created" EventLifecycleNetworkPeerDeleted = "network-peer-deleted" EventLifecycleNetworkPeerUpdated = "network-peer-updated" EventLifecycleNetworkRenamed = "network-renamed" EventLifecycleNetworkUpdated = "network-updated" EventLifecycleNetworkZoneCreated = "network-zone-created" EventLifecycleNetworkZoneDeleted = "network-zone-deleted" EventLifecycleNetworkZoneRecordCreated = "network-zone-record-created" EventLifecycleNetworkZoneRecordDeleted = "network-zone-record-deleted" EventLifecycleNetworkZoneRecordUpdated = "network-zone-record-updated" EventLifecycleNetworkZoneUpdated = "network-zone-updated" EventLifecycleOperationCancelled = "operation-cancelled" EventLifecycleProfileCreated = "profile-created" EventLifecycleProfileDeleted = "profile-deleted" EventLifecycleProfileRenamed = "profile-renamed" EventLifecycleProfileUpdated = "profile-updated" EventLifecycleProjectCreated = "project-created" EventLifecycleProjectDeleted = "project-deleted" EventLifecycleProjectRenamed = "project-renamed" EventLifecycleProjectUpdated = "project-updated" EventLifecycleStorageBucketBackupCreated = "storage-bucket-backup-created" EventLifecycleStorageBucketBackupDeleted = "storage-bucket-backup-deleted" EventLifecycleStorageBucketBackupRenamed = "storage-bucket-backup-renamed" EventLifecycleStorageBucketBackupRetrieved = "storage-bucket-backup-retrieved" EventLifecycleStorageBucketCreated = "storage-bucket-created" EventLifecycleStorageBucketDeleted = "storage-bucket-deleted" EventLifecycleStorageBucketKeyCreated = "storage-bucket-key-created" EventLifecycleStorageBucketKeyDeleted = "storage-bucket-key-deleted" EventLifecycleStorageBucketKeyUpdated = "storage-bucket-key-updated" EventLifecycleStorageBucketUpdated = "storage-bucket-updated" EventLifecycleStoragePoolCreated = "storage-pool-created" EventLifecycleStoragePoolDeleted = "storage-pool-deleted" EventLifecycleStoragePoolUpdated = "storage-pool-updated" EventLifecycleStorageVolumeBackupCreated = "storage-volume-backup-created" EventLifecycleStorageVolumeBackupDeleted = "storage-volume-backup-deleted" EventLifecycleStorageVolumeBackupRenamed = "storage-volume-backup-renamed" EventLifecycleStorageVolumeBackupRetrieved = "storage-volume-backup-retrieved" EventLifecycleStorageVolumeCreated = "storage-volume-created" EventLifecycleStorageVolumeDeleted = "storage-volume-deleted" EventLifecycleStorageVolumeRenamed = "storage-volume-renamed" EventLifecycleStorageVolumeRestored = "storage-volume-restored" EventLifecycleStorageVolumeSnapshotCreated = "storage-volume-snapshot-created" EventLifecycleStorageVolumeSnapshotDeleted = "storage-volume-snapshot-deleted" EventLifecycleStorageVolumeSnapshotRenamed = "storage-volume-snapshot-renamed" EventLifecycleStorageVolumeSnapshotUpdated = "storage-volume-snapshot-updated" EventLifecycleStorageVolumeUpdated = "storage-volume-updated" EventLifecycleWarningAcknowledged = "warning-acknowledged" EventLifecycleWarningDeleted = "warning-deleted" EventLifecycleWarningReset = "warning-reset" )
Define consts for all the lifecycle events.
const CertificateTypeClient = "client"
CertificateTypeClient indicates a client certificate type.
const CertificateTypeMetrics = "metrics"
CertificateTypeMetrics indicates a metrics certificate type.
const CertificateTypeServer = "server"
CertificateTypeServer indicates a server certificate type.
const CertificateTypeUnknown = "unknown"
CertificateTypeUnknown indicates an unknown certificate type.
const InstanceTypeAny = InstanceType("")
InstanceTypeAny defines the instance type value for requesting any instance type.
const InstanceTypeContainer = InstanceType("container")
InstanceTypeContainer defines the instance type value for a container.
const InstanceTypeVM = InstanceType("virtual-machine")
InstanceTypeVM defines the instance type value for a virtual-machine.
const NetworkStatusCreated = "Created"
NetworkStatusCreated network is fully created.
const NetworkStatusErrored = "Errored"
NetworkStatusErrored network is in error status.
const NetworkStatusPending = "Pending"
NetworkStatusPending network is pending creation on other cluster nodes.
NetworkStatusUnavailable network failed to initialize.
const NetworkStatusUnknown = "Unknown"
NetworkStatusUnknown network is in unknown status.
const OperationClassTask = "task"
OperationClassTask represents the Task OperationClass.
const OperationClassToken = "token"
OperationClassToken represents the Token OperationClass.
const OperationClassWebsocket = "websocket"
OperationClassWebsocket represents the Websocket OperationClass.
const ProjectDefaultName = "default"
ProjectDefaultName is the name of the default project that can never be deleted.
const SecretNameControl = "control"
SecretNameControl is the secret name used for the migration control connection.
const SecretNameFilesystem = "fs"
SecretNameFilesystem is the secret name used for the migration filesystem connection.
const SecretNameState = "criu" // Legacy value used for backward compatibility for clients.
SecretNameState is the secret name used for the migration state connection.
const StoragePoolStatusCreated = "Created"
StoragePoolStatusCreated storage pool is fully created.
const StoragePoolStatusErrored = "Errored"
StoragePoolStatusErrored storage pool is in error status.
const StoragePoolStatusPending = "Pending"
StoragePoolStatusPending storage pool is pending creation on other cluster nodes.
const StoragePoolStatusUnknown = "Unknown"
StoragePoolStatusUnknown storage pool is in unknown status.
const StoragePoolStatusUnvailable = "Unavailable"
StoragePoolStatusUnvailable storage pool failed to initialize.
Variables ¶
var StatusCodeNames = map[StatusCode]string{ OperationCreated: "Operation created", Started: "Started", Stopped: "Stopped", Running: "Running", Cancelling: "Cancelling", Pending: "Pending", Success: "Success", Failure: "Failure", Cancelled: "Cancelled", Starting: "Starting", Stopping: "Stopping", Aborting: "Aborting", Freezing: "Freezing", Frozen: "Frozen", Thawed: "Thawed", Error: "Error", Ready: "Ready", }
StatusCodeNames associates a status code to its name.
Functions ¶
func GetParentAndSnapshotName ¶
GetParentAndSnapshotName returns the parent name, snapshot name, and whether it actually was a snapshot name.
func ParseFileHeaders ¶
ParseFileHeaders extracts the file ownership, type, mode and operation type from HTTP headers.
func StatusErrorCheck ¶
StatusErrorCheck returns whether or not err was caused by a StatusError and if it matches one of the optional status codes.
func StatusErrorMatch ¶
StatusErrorMatch checks if err was caused by StatusError. Can optionally also check whether the StatusError's status code matches one of the supplied status codes in matchStatus. Returns the matched StatusError status code and true if match criteria are met, otherwise false.
Types ¶
type Access ¶
type Access []AccessEntry
Access represents everyone that may access a particular resource.
swagger:model
API extension: instance_access.
type AccessEntry ¶
type AccessEntry struct { // Certificate fingerprint // Example: 636b69519d27ae3b0e398cb7928043846ce1e3842f0ca7a589993dd913ab8cc9 Identifier string `json:"identifier" yaml:"identifier"` // The role associated with the certificate // Example: admin, view, operator Role string `json:"role" yaml:"role"` // Which authorization method the certificate uses // Example: tls, openfga Provider string `json:"provider" yaml:"provider"` }
AccessEntry represents an entity having access to the resource.
swagger:model
API extension: instance_access.
type Certificate ¶
type Certificate struct { CertificatePut `yaml:",inline"` // SHA256 fingerprint of the certificate // Read only: true // Example: fd200419b271f1dc2a5591b693cc5774b7f234e1ff8c6b78ad703b6888fe2b69 Fingerprint string `json:"fingerprint" yaml:"fingerprint"` }
Certificate represents a certificate
swagger:model
func (*Certificate) URL ¶
func (c *Certificate) URL(apiVersion string) *URL
URL returns the URL for the certificate.
func (*Certificate) Writable ¶
func (c *Certificate) Writable() CertificatePut
Writable converts a full Certificate struct into a CertificatePut struct (filters read-only fields).
type CertificateAddToken ¶
type CertificateAddToken struct { // The name of the new client // Example: user@host ClientName string `json:"client_name" yaml:"client_name"` // The fingerprint of the network certificate // Example: 57bb0ff4340b5bb28517e062023101adf788c37846dc8b619eb2c3cb4ef29436 Fingerprint string `json:"fingerprint" yaml:"fingerprint"` // The addresses of the server // Example: ["10.98.30.229:8443"] Addresses []string `json:"addresses" yaml:"addresses"` // The random join secret // Example: 2b2284d44db32675923fe0d2020477e0e9be11801ff70c435e032b97028c35cd Secret string `json:"secret" yaml:"secret"` // The token's expiry date. // Example: 2021-03-23T17:38:37.753398689-04:00 ExpiresAt time.Time `json:"expires_at" yaml:"expires_at"` }
CertificateAddToken represents the fields contained within an encoded certificate add token.
swagger:model
API extension: certificate_token.
func (*CertificateAddToken) String ¶
func (t *CertificateAddToken) String() string
String encodes the certificate add token as JSON and then base64.
type CertificatePut ¶
type CertificatePut struct { // Name associated with the certificate // Example: castiana Name string `json:"name" yaml:"name"` // Usage type for the certificate // Example: client Type string `json:"type" yaml:"type"` // Whether to limit the certificate to listed projects // Example: true // // API extension: certificate_project Restricted bool `json:"restricted" yaml:"restricted"` // List of allowed projects (applies when restricted) // Example: ["default", "foo", "bar"] // // API extension: certificate_project Projects []string `json:"projects" yaml:"projects"` // The certificate itself, as PEM encoded X509 (or as base64 encoded X509 on POST) // Example: X509 PEM certificate // // API extension: certificate_self_renewal Certificate string `json:"certificate" yaml:"certificate"` // Certificate description // Example: X509 certificate // // API extension: certificate_description Description string `json:"description" yaml:"description"` }
CertificatePut represents the modifiable fields of a certificate
swagger:model
API extension: certificate_update.
type CertificatesPost ¶
type CertificatesPost struct { CertificatePut `yaml:",inline"` // Trust token (used to add an untrusted client) // Example: blah TrustToken string `json:"trust_token" yaml:"trust_token"` // Whether to create a certificate add token // Example: true // // API extension: certificate_token Token bool `json:"token" yaml:"token"` }
CertificatesPost represents the fields of a new certificate
swagger:model
type Cluster ¶
type Cluster struct { // Name of the cluster member answering the request // Example: server01 ServerName string `json:"server_name" yaml:"server_name"` // Whether clustering is enabled // Example: true Enabled bool `json:"enabled" yaml:"enabled"` // List of member configuration keys (used during join) // Example: [] // // API extension: clustering_join MemberConfig []ClusterMemberConfigKey `json:"member_config" yaml:"member_config"` }
Cluster represents high-level information about a cluster.
swagger:model
API extension: clustering.
type ClusterCertificatePut ¶
type ClusterCertificatePut struct { // The new certificate (X509 PEM encoded) for the cluster // Example: X509 PEM certificate ClusterCertificate string `json:"cluster_certificate" yaml:"cluster_certificate"` // The new certificate key (X509 PEM encoded) for the cluster // Example: X509 PEM certificate key ClusterCertificateKey string `json:"cluster_certificate_key" yaml:"cluster_certificate_key"` }
ClusterCertificatePut represents the certificate and key pair for all cluster members
swagger:model
API extension: clustering_update_certs.
type ClusterGroup ¶
type ClusterGroup struct { ClusterGroupPut `yaml:",inline"` ClusterGroupPost `yaml:",inline"` }
ClusterGroup represents a cluster group.
swagger:model
API extension: clustering_groups.
func (*ClusterGroup) Writable ¶
func (c *ClusterGroup) Writable() ClusterGroupPut
Writable converts a full ClusterGroup struct into a ClusterGroupPut struct (filters read-only fields).
type ClusterGroupPost ¶
type ClusterGroupPost struct { // The new name of the cluster group // Example: group1 Name string `json:"name" yaml:"name"` }
ClusterGroupPost represents the fields required to rename a cluster group.
swagger:model
API extension: clustering_groups.
type ClusterGroupPut ¶
type ClusterGroupPut struct { // The description of the cluster group // Example: amd64 servers Description string `json:"description" yaml:"description"` // List of members in this group // Example: ["server01", "server02"] Members []string `json:"members" yaml:"members"` }
ClusterGroupPut represents the modifiable fields of a cluster group.
swagger:model
API extension: clustering_groups.
type ClusterGroupsPost ¶
type ClusterGroupsPost struct { ClusterGroupPut // The new name of the cluster group // Example: group1 Name string `json:"name" yaml:"name"` }
ClusterGroupsPost represents the fields available for a new cluster group.
swagger:model
API extension: clustering_groups.
type ClusterMember ¶
type ClusterMember struct { ClusterMemberPut `yaml:",inline"` // Name of the cluster member // Example: server01 ServerName string `json:"server_name" yaml:"server_name"` // URL at which the cluster member can be reached // Example: https://10.0.0.1:8443 URL string `json:"url" yaml:"url"` // Whether the cluster member is a database server // Example: true Database bool `json:"database" yaml:"database"` // Current status // Example: Online Status string `json:"status" yaml:"status"` // Additional status information // Example: fully operational Message string `json:"message" yaml:"message"` // The primary architecture of the cluster member // Example: x86_64 // // API extension: clustering_architecture Architecture string `json:"architecture" yaml:"architecture"` }
ClusterMember represents a member of a cluster.
swagger:model
API extension: clustering.
func (*ClusterMember) Writable ¶
func (member *ClusterMember) Writable() ClusterMemberPut
Writable converts a full Profile struct into a ProfilePut struct (filters read-only fields).
type ClusterMemberConfigKey ¶
type ClusterMemberConfigKey struct { // The kind of configuration key (network, storage-pool, ...) // Example: storage-pool Entity string `json:"entity" yaml:"entity"` // The name of the object requiring this key // Example: local Name string `json:"name" yaml:"name"` // The name of the key // Example: source Key string `json:"key" yaml:"key"` // The value on the answering cluster member // Example: /dev/sdb Value string `json:"value" yaml:"value"` // A human friendly description key // Example: "source" property for storage pool "local" Description string `json:"description" yaml:"description"` }
ClusterMemberConfigKey represents a single config key that a new member of the cluster is required to provide when joining.
The Value field is empty when getting clustering information with GET /1.0/cluster, and should be filled by the joining server when performing a PUT /1.0/cluster join request.
swagger:model
API extension: clustering_join.
type ClusterMemberJoinToken ¶
type ClusterMemberJoinToken struct { // The name of the new cluster member // Example: server02 ServerName string `json:"server_name" yaml:"server_name"` // The fingerprint of the network certificate // Example: 57bb0ff4340b5bb28517e062023101adf788c37846dc8b619eb2c3cb4ef29436 Fingerprint string `json:"fingerprint" yaml:"fingerprint"` // The addresses of existing online cluster members // Example: ["10.98.30.229:8443"] Addresses []string `json:"addresses" yaml:"addresses"` // The random join secret. // Example: 2b2284d44db32675923fe0d2020477e0e9be11801ff70c435e032b97028c35cd Secret string `json:"secret" yaml:"secret"` // The token's expiry date. // Example: 2021-03-23T17:38:37.753398689-04:00 ExpiresAt time.Time `json:"expires_at" yaml:"expires_at"` }
ClusterMemberJoinToken represents the fields contained within an encoded cluster member join token.
swagger:model
API extension: clustering_join_token.
func (*ClusterMemberJoinToken) String ¶
func (t *ClusterMemberJoinToken) String() string
String encodes the cluster member join token as JSON and then base64.
type ClusterMemberPost ¶
type ClusterMemberPost struct { // The new name of the cluster member // Example: server02 ServerName string `json:"server_name" yaml:"server_name"` }
ClusterMemberPost represents the fields required to rename a cluster member.
swagger:model
API extension: clustering.
type ClusterMemberPut ¶
type ClusterMemberPut struct { // List of roles held by this cluster member // Example: ["database"] // // API extension: clustering_roles Roles []string `json:"roles" yaml:"roles"` // Name of the failure domain for this cluster member // Example: rack1 // // API extension: clustering_failure_domains FailureDomain string `json:"failure_domain" yaml:"failure_domain"` // Cluster member description // Example: AMD Epyc 32c/64t // // API extension: clustering_description Description string `json:"description" yaml:"description"` // Additional configuration information // Example: {"scheduler.instance": "all"} // // API extension: clustering_config Config map[string]string `json:"config" yaml:"config"` // List of cluster groups this member belongs to // Example: ["group1", "group2"] // // API extension: clustering_groups Groups []string `json:"groups" yaml:"groups"` }
ClusterMemberPut represents the modifiable fields of a cluster member
swagger:model
API extension: clustering_edit_roles.
type ClusterMemberState ¶
type ClusterMemberState struct { SysInfo ClusterMemberSysInfo `json:"sysinfo" yaml:"sysinfo"` StoragePools map[string]StoragePoolState `json:"storage_pools" yaml:"storage_pools"` }
ClusterMemberState represents the state of a cluster member.
swagger:model
API extension: cluster_member_state.
type ClusterMemberStatePost ¶
type ClusterMemberStatePost struct { // The action to be performed. Valid actions are "evacuate" and "restore". // Example: evacuate Action string `json:"action" yaml:"action"` // Override the configured evacuation mode. // Example: stop // // API extension: clustering_evacuate_mode Mode string `json:"mode" yaml:"mode"` }
ClusterMemberStatePost represents the fields required to evacuate a cluster member.
swagger:model
API extension: clustering_evacuation.
type ClusterMemberSysInfo ¶
type ClusterMemberSysInfo struct { Uptime int64 `json:"uptime" yaml:"uptime"` LoadAverages []float64 `json:"load_averages" yaml:"load_averages"` TotalRAM uint64 `json:"total_ram" yaml:"total_ram"` FreeRAM uint64 `json:"free_ram" yaml:"free_ram"` BufferRAM uint64 `json:"buffered_ram" yaml:"buffered_ram"` TotalSwap uint64 `json:"total_swap" yaml:"total_swap"` FreeSwap uint64 `json:"free_swap" yaml:"free_swap"` Processes uint16 `json:"processes" yaml:"processes"` }
ClusterMemberSysInfo represents the sysinfo of a cluster member.
swagger:model
API extension: cluster_member_state.
type ClusterMembersPost ¶
type ClusterMembersPost struct { // The name of the new cluster member // Example: server02 ServerName string `json:"server_name" yaml:"server_name"` }
ClusterMembersPost represents the fields required to request a join token to add a member to the cluster.
swagger:model
API extension: clustering_join_token.
type ClusterPut ¶
type ClusterPut struct { Cluster `yaml:",inline"` // The address of the cluster you wish to join // Example: 10.0.0.1:8443 ClusterAddress string `json:"cluster_address" yaml:"cluster_address"` // The expected certificate (X509 PEM encoded) for the cluster // Example: X509 PEM certificate ClusterCertificate string `json:"cluster_certificate" yaml:"cluster_certificate"` // The local address to use for cluster communication // Example: 10.0.0.2:8443 // // API extension: clustering_join ServerAddress string `json:"server_address" yaml:"server_address"` // The cluster join token for the cluster you're trying to join // Example: blah // // API extension: clustering_join ClusterToken string `json:"cluster_token" yaml:"cluster_token"` }
ClusterPut represents the fields required to bootstrap or join a cluster.
swagger:model
API extension: clustering.
type Event ¶
type Event struct { // Event type (one of operation, logging or lifecycle) // Example: lifecycle Type string `yaml:"type" json:"type"` // Time at which the event was sent // Example: 2021-02-24T19:00:45.452649098-05:00 Timestamp time.Time `yaml:"timestamp" json:"timestamp"` // JSON encoded metadata (see EventLogging, EventLifecycle or Operation) // Example: {"action": "instance-started", "source": "/1.0/instances/c1", "context": {}} Metadata json.RawMessage `yaml:"metadata" json:"metadata"` // Originating cluster member // Example: server01 // // API extension: event_location Location string `yaml:"location,omitempty" json:"location,omitempty"` // Project the event belongs to. // Example: default // // API extension: event_project Project string `yaml:"project,omitempty" json:"project,omitempty"` }
Event represents an event entry (over websocket)
swagger:model
func (*Event) ToLogging ¶
func (event *Event) ToLogging() (EventLogRecord, error)
ToLogging creates log record for the event.
type EventLifecycle ¶
type EventLifecycle struct { Action string `yaml:"action" json:"action"` Source string `yaml:"source" json:"source"` Context map[string]any `yaml:"context,omitempty" json:"context,omitempty"` // API extension: event_lifecycle_requestor Requestor *EventLifecycleRequestor `yaml:"requestor,omitempty" json:"requestor,omitempty"` // API extension: event_lifecycle_name_and_project Name string `yaml:"name,omitempty" json:"name,omitempty"` Project string `yaml:"project,omitempty" json:"project,omitempty"` }
EventLifecycle represets a lifecycle type event entry
API extension: event_lifecycle.
type EventLifecycleRequestor ¶
type EventLifecycleRequestor struct { Username string `yaml:"username" json:"username"` Protocol string `yaml:"protocol" json:"protocol"` // Requestor address // Example: 10.0.2.15 // // API extension: event_lifecycle_requestor_address Address string `yaml:"address" json:"address"` }
EventLifecycleRequestor represents the initial requestor for an event
API extension: event_lifecycle_requestor.
type EventLogRecord ¶
EventLogRecord represents single log record.
type EventLogging ¶
type EventLogging struct { Message string `yaml:"message" json:"message"` Level string `yaml:"level" json:"level"` Context map[string]string `yaml:"context" json:"context"` }
EventLogging represents a logging type event entry (admin only).
type Image ¶
type Image struct { ImagePut `yaml:",inline"` // List of aliases Aliases []ImageAlias `json:"aliases" yaml:"aliases"` // Architecture // Example: x86_64 Architecture string `json:"architecture" yaml:"architecture"` // Whether the image is an automatically cached remote image // Example: true Cached bool `json:"cached" yaml:"cached"` // Original filename // Example: 06b86454720d36b20f94e31c6812e05ec51c1b568cf3a8abd273769d213394bb.rootfs Filename string `json:"filename" yaml:"filename"` // Full SHA-256 fingerprint // Example: 06b86454720d36b20f94e31c6812e05ec51c1b568cf3a8abd273769d213394bb Fingerprint string `json:"fingerprint" yaml:"fingerprint"` // Size of the image in bytes // Example: 272237676 Size int64 `json:"size" yaml:"size"` // Where the image came from UpdateSource *ImageSource `json:"update_source,omitempty" yaml:"update_source,omitempty"` // Type of image (container or virtual-machine) // Example: container // // API extension: image_types Type string `json:"type" yaml:"type"` // When the image was originally created // Example: 2021-03-23T20:00:00-04:00 CreatedAt time.Time `json:"created_at" yaml:"created_at"` // Last time the image was used // Example: 2021-03-22T20:39:00.575185384-04:00 LastUsedAt time.Time `json:"last_used_at" yaml:"last_used_at"` // When the image was added to this server // Example: 2021-03-24T14:18:15.115036787-04:00 UploadedAt time.Time `json:"uploaded_at" yaml:"uploaded_at"` // Project name // Example: project1 // // API extension: images_all_projects Project string `json:"project" yaml:"project"` }
Image represents an image
swagger:model
type ImageAlias ¶
type ImageAlias struct { // Name of the alias // Example: ubuntu-22.04 Name string `json:"name" yaml:"name"` // Description of the alias // Example: Our preferred Ubuntu image Description string `json:"description" yaml:"description"` }
ImageAlias represents an alias from the alias list of an image
swagger:model
type ImageAliasesEntry ¶
type ImageAliasesEntry struct { ImageAliasesEntryPut `yaml:",inline"` // Alias name // Example: ubuntu-22.04 Name string `json:"name" yaml:"name"` // Alias type (container or virtual-machine) // Example: container // // API extension: image_types Type string `json:"type" yaml:"type"` }
ImageAliasesEntry represents an image alias
swagger:model
type ImageAliasesEntryPost ¶
type ImageAliasesEntryPost struct { // Alias name // Example: ubuntu-22.04 Name string `json:"name" yaml:"name"` }
ImageAliasesEntryPost represents the required fields to rename an image alias
swagger:model
type ImageAliasesEntryPut ¶
type ImageAliasesEntryPut struct { // Alias description // Example: Our preferred Ubuntu image Description string `json:"description" yaml:"description"` // Target fingerprint for the alias // Example: 06b86454720d36b20f94e31c6812e05ec51c1b568cf3a8abd273769d213394bb Target string `json:"target" yaml:"target"` }
ImageAliasesEntryPut represents the modifiable fields of an image alias
swagger:model
type ImageAliasesPost ¶
type ImageAliasesPost struct {
ImageAliasesEntry `yaml:",inline"`
}
ImageAliasesPost represents a new image alias
swagger:model
type ImageExportPost ¶
type ImageExportPost struct { // Target server URL // Example: https://1.2.3.4:8443 Target string `json:"target" yaml:"target"` // Image receive secret // Example: RANDOM-STRING Secret string `json:"secret" yaml:"secret"` // Remote server certificate // Example: X509 PEM certificate Certificate string `json:"certificate" yaml:"certificate"` // List of aliases to set on the image Aliases []ImageAlias `json:"aliases" yaml:"aliases"` // Project name // Example: project1 // // API extension: image_target_project Project string `json:"project" yaml:"project"` // List of profiles to use // Example: ["default"] // // API extension: image_copy_profile Profiles []string `json:"profiles" yaml:"profiles"` }
ImageExportPost represents the fields required to export an image
swagger:model
API extension: images_push_relay.
type ImageMetadata ¶
type ImageMetadata struct { // Architecture name // Example: x86_64 Architecture string `json:"architecture" yaml:"architecture"` // Image creation data (as UNIX epoch) // Example: 1620655439 CreationDate int64 `json:"creation_date" yaml:"creation_date"` // Image expiry data (as UNIX epoch) // Example: 1620685757 ExpiryDate int64 `json:"expiry_date" yaml:"expiry_date"` // Descriptive properties // Example: {"os": "Ubuntu", "release": "jammy", "variant": "cloud"} Properties map[string]string `json:"properties" yaml:"properties"` // Template for files in the image Templates map[string]*ImageMetadataTemplate `json:"templates" yaml:"templates"` }
ImageMetadata represents image metadata (used in image tarball)
swagger:model
type ImageMetadataTemplate ¶
type ImageMetadataTemplate struct { // When to trigger the template (create, copy or start) // Example: create When []string `json:"when" yaml:"when"` // Whether to trigger only if the file is missing // Example: false CreateOnly bool `json:"create_only" yaml:"create_only"` // The template itself as a valid pongo2 template // Example: pongo2-template Template string `json:"template" yaml:"template"` // Key/value properties to pass to the template // Example: {"foo": "bar"} Properties map[string]string `json:"properties" yaml:"properties"` // The file owner uid. // Example: 1000 // // API extension: image_template_permissions UID string `json:"uid,omitempty" yaml:"uid,omitempty"` // The file owner gid. // Example: 1000 // // API extension: image_template_permissions GID string `json:"gid,omitempty" yaml:"gid,omitempty"` // The file permissions. // Example: 644 // // API extension: image_template_permissions Mode string `json:"mode,omitempty" yaml:"mode,omitempty"` }
ImageMetadataTemplate represents a template entry in image metadata (used in image tarball)
swagger:model
type ImagePut ¶
type ImagePut struct { // Whether the image should auto-update when a new build is available // Example: true AutoUpdate bool `json:"auto_update" yaml:"auto_update"` // Descriptive properties // Example: {"os": "Ubuntu", "release": "jammy", "variant": "cloud"} Properties map[string]string `json:"properties" yaml:"properties"` // Whether the image is available to unauthenticated users // Example: false Public bool `json:"public" yaml:"public"` // When the image becomes obsolete // Example: 2025-03-23T20:00:00-04:00 // // API extension: images_expiry ExpiresAt time.Time `json:"expires_at" yaml:"expires_at"` // List of profiles to use when creating from this image (if none provided by user) // Example: ["default"] // // API extension: image_profiles Profiles []string `json:"profiles" yaml:"profiles"` }
ImagePut represents the modifiable fields of an image
swagger:model
type ImageSource ¶
type ImageSource struct { // Source alias to download from // Example: jammy Alias string `json:"alias" yaml:"alias"` // Source server certificate (if not trusted by system CA) // Example: X509 PEM certificate Certificate string `json:"certificate" yaml:"certificate"` // Source server protocol // Example: simplestreams Protocol string `json:"protocol" yaml:"protocol"` // URL of the source server // Example: https://images.linuxcontainers.org Server string `json:"server" yaml:"server"` // Type of image (container or virtual-machine) // Example: container // // API extension: image_types ImageType string `json:"image_type" yaml:"image_type"` }
ImageSource represents the source of an image
swagger:model
type ImagesPost ¶
type ImagesPost struct { ImagePut `yaml:",inline"` // Original filename of the image // Example: image.tar.xz Filename string `json:"filename" yaml:"filename"` // Source of the image Source *ImagesPostSource `json:"source" yaml:"source"` // Compression algorithm to use when turning an instance into an image // Example: gzip // // API extension: image_compression_algorithm CompressionAlgorithm string `json:"compression_algorithm" yaml:"compression_algorithm"` // Aliases to add to the image // Example: [{"name": "foo"}, {"name": "bar"}] // // API extension: image_create_aliases Aliases []ImageAlias `json:"aliases" yaml:"aliases"` }
ImagesPost represents the fields available for a new image
swagger:model
type ImagesPostSource ¶
type ImagesPostSource struct { ImageSource `yaml:",inline"` // Transfer mode (push or pull) // Example: pull Mode string `json:"mode" yaml:"mode"` // Type of image source (instance, snapshot, image or url) // Example: instance Type string `json:"type" yaml:"type"` // Source URL (for type "url") // Example: https://some-server.com/some-directory/ URL string `json:"url" yaml:"url"` // Instance name (for type "instance" or "snapshot") // Example: c1/snap0 Name string `json:"name" yaml:"name"` // Source image fingerprint (for type "image") // Example: 8ae945c52bb2f2df51c923b04022312f99bbb72c356251f54fa89ea7cf1df1d0 Fingerprint string `json:"fingerprint" yaml:"fingerprint"` // Source image server secret token (when downloading private images) // Example: RANDOM-STRING Secret string `json:"secret" yaml:"secret"` // Source project name // Example: project1 // // API extension: image_source_project Project string `json:"project" yaml:"project"` }
ImagesPostSource represents the source of a new image
swagger:model
type InitClusterPreseed ¶
type InitClusterPreseed struct { ClusterPut `yaml:",inline"` // The path to the cluster certificate // Example: /tmp/cluster.crt ClusterCertificatePath string `json:"cluster_certificate_path" yaml:"cluster_certificate_path"` }
InitClusterPreseed represents initialization configuration for the cluster.
swagger:model
API extension: preseed.
type InitLocalPreseed ¶
type InitLocalPreseed struct { ServerPut `yaml:",inline"` // Networks by project to add // Example: Network on the "default" project Networks []InitNetworksProjectPost `json:"networks" yaml:"networks"` // Storage Pools to add // Example: local dir storage pool StoragePools []StoragePoolsPost `json:"storage_pools" yaml:"storage_pools"` // Profiles to add // Example: "default" profile with a root disk device Profiles []ProfilesPost `json:"profiles" yaml:"profiles"` // Projects to add // Example: "default" project Projects []ProjectsPost `json:"projects" yaml:"projects"` }
InitLocalPreseed represents initialization configuration.
swagger:model
API extension: preseed.
type InitNetworksProjectPost ¶
type InitNetworksProjectPost struct { NetworksPost `yaml:",inline"` // Project in which the network will reside // Example: "default" Project string }
InitNetworksProjectPost represents the fields of a new network along with its associated project.
swagger:model
API extension: preseed.
type InitPreseed ¶
type InitPreseed struct { Server InitLocalPreseed `yaml:",inline"` Cluster *InitClusterPreseed `json:"cluster" yaml:"cluster"` }
InitPreseed represents initialization configuration that can be supplied to `init`.
swagger:model
API extension: preseed.
type Instance ¶
type Instance struct { InstancePut `yaml:",inline"` // Instance creation timestamp // Example: 2021-03-23T20:00:00-04:00 CreatedAt time.Time `json:"created_at" yaml:"created_at"` // Expanded configuration (all profiles and local config merged) // Example: {"security.nesting": "true"} ExpandedConfig map[string]string `json:"expanded_config,omitempty" yaml:"expanded_config,omitempty"` // Expanded devices (all profiles and local devices merged) // Example: {"root": {"type": "disk", "pool": "default", "path": "/"}} ExpandedDevices map[string]map[string]string `json:"expanded_devices,omitempty" yaml:"expanded_devices,omitempty"` // Instance name // Example: foo Name string `json:"name" yaml:"name"` // Instance status (see instance_state) // Example: Running Status string `json:"status" yaml:"status"` // Instance status code (see instance_state) // Example: 101 StatusCode StatusCode `json:"status_code" yaml:"status_code"` // Last start timestamp // Example: 2021-03-23T20:00:00-04:00 LastUsedAt time.Time `json:"last_used_at" yaml:"last_used_at"` // What cluster member this instance is located on // Example: server01 Location string `json:"location" yaml:"location"` // The type of instance (container or virtual-machine) // Example: container Type string `json:"type" yaml:"type"` // Instance project name // Example: foo // // API extension: instance_all_projects Project string `json:"project" yaml:"project"` }
Instance represents an instance.
swagger:model
API extension: instances.
func (Instance) IsActive ¶
IsActive checks whether the instance state indicates the instance is active.
API extension: instances.
func (*Instance) Writable ¶
func (c *Instance) Writable() InstancePut
Writable converts a full Instance struct into a InstancePut struct (filters read-only fields).
API extension: instances.
type InstanceBackup ¶
type InstanceBackup struct { // Backup name // Example: backup0 Name string `json:"name" yaml:"name"` // When the backup was created // Example: 2021-03-23T16:38:37.753398689-04:00 CreatedAt time.Time `json:"created_at" yaml:"created_at"` // When the backup expires (gets auto-deleted) // Example: 2021-03-23T17:38:37.753398689-04:00 ExpiresAt time.Time `json:"expires_at" yaml:"expires_at"` // Whether to ignore snapshots // Example: false InstanceOnly bool `json:"instance_only" yaml:"instance_only"` // Whether to use a pool-optimized binary format (instead of plain tarball) // Example: true OptimizedStorage bool `json:"optimized_storage" yaml:"optimized_storage"` }
InstanceBackup represents an instance backup.
swagger:model
API extension: instances.
type InstanceBackupPost ¶
type InstanceBackupPost struct { // New backup name // Example: backup1 Name string `json:"name" yaml:"name"` }
InstanceBackupPost represents the fields available for the renaming of a instance backup.
swagger:model
API extension: instances.
type InstanceBackupsPost ¶
type InstanceBackupsPost struct { // Backup name // Example: backup0 Name string `json:"name" yaml:"name"` // When the backup expires (gets auto-deleted) // Example: 2021-03-23T17:38:37.753398689-04:00 ExpiresAt time.Time `json:"expires_at" yaml:"expires_at"` // Whether to ignore snapshots // Example: false InstanceOnly bool `json:"instance_only" yaml:"instance_only"` // Whether to use a pool-optimized binary format (instead of plain tarball) // Example: true OptimizedStorage bool `json:"optimized_storage" yaml:"optimized_storage"` // What compression algorithm to use // Example: gzip // // API extension: backup_compression_algorithm CompressionAlgorithm string `json:"compression_algorithm" yaml:"compression_algorithm"` }
InstanceBackupsPost represents the fields available for a new instance backup.
swagger:model
API extension: instances.
type InstanceConsoleControl ¶
type InstanceConsoleControl struct { Command string `json:"command" yaml:"command"` Args map[string]string `json:"args" yaml:"args"` }
InstanceConsoleControl represents a message on the instance console "control" socket.
API extension: instances.
type InstanceConsolePost ¶
type InstanceConsolePost struct { // Console width in columns (console type only) // Example: 80 Width int `json:"width" yaml:"width"` // Console height in rows (console type only) // Example: 24 Height int `json:"height" yaml:"height"` // Type of console to attach to (console or vga) // Example: console // // API extension: console_vga_type Type string `json:"type" yaml:"type"` }
InstanceConsolePost represents an instance console request.
swagger:model
API extension: instances.
type InstanceExecControl ¶
type InstanceExecControl struct { Command string `json:"command" yaml:"command"` Args map[string]string `json:"args" yaml:"args"` Signal int `json:"signal" yaml:"signal"` }
InstanceExecControl represents a message on the instance exec "control" socket.
API extension: instances.
type InstanceExecPost ¶
type InstanceExecPost struct { // Command and its arguments // Example: ["bash"] Command []string `json:"command" yaml:"command"` // Whether to wait for all websockets to be connected before spawning the command // Example: true WaitForWS bool `json:"wait-for-websocket" yaml:"wait-for-websocket"` // Whether the command is to be spawned in interactive mode (singled PTY instead of 3 PIPEs) // Example: true Interactive bool `json:"interactive" yaml:"interactive"` // Additional environment to pass to the command // Example: {"FOO": "BAR"} Environment map[string]string `json:"environment" yaml:"environment"` // Terminal width in characters (for interactive) // Example: 80 Width int `json:"width" yaml:"width"` // Terminal height in rows (for interactive) // Example: 24 Height int `json:"height" yaml:"height"` // Whether to capture the output for later download (requires non-interactive) RecordOutput bool `json:"record-output" yaml:"record-output"` // UID of the user to spawn the command as // Example: 1000 User uint32 `json:"user" yaml:"user"` // GID of the user to spawn the command as // Example: 1000 Group uint32 `json:"group" yaml:"group"` // Current working directory for the command // Example: /home/foo/ Cwd string `json:"cwd" yaml:"cwd"` }
InstanceExecPost represents an instance exec request.
swagger:model
API extension: instances.
type InstanceFull ¶
type InstanceFull struct { Instance `yaml:",inline"` // List of backups. Backups []InstanceBackup `json:"backups" yaml:"backups"` // Current state. State *InstanceState `json:"state" yaml:"state"` // List of snapshots. Snapshots []InstanceSnapshot `json:"snapshots" yaml:"snapshots"` }
InstanceFull is a combination of Instance, InstanceBackup, InstanceState and InstanceSnapshot.
swagger:model
API extension: instances.
type InstancePost ¶
type InstancePost struct { // New name for the instance // Example: bar Name string `json:"name" yaml:"name"` // Whether the instance is being migrated to another server // Example: false Migration bool `json:"migration" yaml:"migration"` // Whether to perform a live migration (migration only) // Example: false Live bool `json:"live" yaml:"live"` // Whether snapshots should be discarded (migration only) // Example: false InstanceOnly bool `json:"instance_only" yaml:"instance_only"` // Target for the migration, will use pull mode if not set (migration only) Target *InstancePostTarget `json:"target" yaml:"target"` // Target pool for local cross-pool move // Example: baz // // API extension: instance_pool_move Pool string `json:"pool" yaml:"pool"` // Target project for local cross-project move // Example: foo // // API extension: instance_project_move Project string `json:"project" yaml:"project"` // AllowInconsistent allow inconsistent copies when migrating. // Example: false // // API extension: instance_allow_inconsistent_copy AllowInconsistent bool `json:"allow_inconsistent" yaml:"allow_inconsistent"` // Instance configuration file. // Example: {"security.nesting": "true"} // // API extension: instance_move_config Config map[string]string // Instance devices. // Example: {"root": {"type": "disk", "pool": "default", "path": "/"}} // // API extension: instance_move_config Devices map[string]map[string]string // List of profiles applied to the instance. // Example: ["default"] // // API extension: instance_move_config Profiles []string }
InstancePost represents the fields required to rename/move an instance.
swagger:model
API extension: instances.
type InstancePostTarget ¶
type InstancePostTarget struct { // The certificate of the migration target // Example: X509 PEM certificate Certificate string `json:"certificate" yaml:"certificate"` // The operation URL on the remote target // Example: https://1.2.3.4:8443/1.0/operations/5e8e1638-5345-4c2d-bac9-2c79c8577292 Operation string `json:"operation,omitempty" yaml:"operation,omitempty"` // Migration websockets credentials // Example: {"migration": "random-string", "criu": "random-string"} Websockets map[string]string `json:"secrets,omitempty" yaml:"secrets,omitempty"` }
InstancePostTarget represents the migration target host and operation.
swagger:model
API extension: instances.
type InstancePut ¶
type InstancePut struct { // Architecture name // Example: x86_64 Architecture string `json:"architecture" yaml:"architecture"` // Instance configuration (see doc/instances.md) // Example: {"security.nesting": "true"} Config map[string]string `json:"config" yaml:"config"` // Instance devices (see doc/instances.md) // Example: {"root": {"type": "disk", "pool": "default", "path": "/"}} Devices map[string]map[string]string `json:"devices" yaml:"devices"` // Whether the instance is ephemeral (deleted on shutdown) // Example: false Ephemeral bool `json:"ephemeral" yaml:"ephemeral"` // List of profiles applied to the instance // Example: ["default"] Profiles []string `json:"profiles" yaml:"profiles"` // If set, instance will be restored to the provided snapshot name // Example: snap0 Restore string `json:"restore,omitempty" yaml:"restore,omitempty"` // Whether the instance currently has saved state on disk // Example: false Stateful bool `json:"stateful" yaml:"stateful"` // Instance description // Example: My test instance Description string `json:"description" yaml:"description"` }
InstancePut represents the modifiable fields of an instance.
swagger:model
API extension: instances.
type InstanceRebuildPost ¶
type InstanceRebuildPost struct { // Rebuild source Source InstanceSource `json:"source" yaml:"source"` }
InstanceRebuildPost indicates how to rebuild an instance.
swagger:model
API extension: instances_rebuild.
type InstanceSnapshot ¶
type InstanceSnapshot struct { InstanceSnapshotPut `yaml:",inline"` // Architecture name // Example: x86_64 Architecture string `json:"architecture" yaml:"architecture"` // Instance configuration (see doc/instances.md) // Example: {"security.nesting": "true"} Config map[string]string `json:"config" yaml:"config"` // Instance creation timestamp // Example: 2021-03-23T20:00:00-04:00 CreatedAt time.Time `json:"created_at" yaml:"created_at"` // Instance devices (see doc/instances.md) // Example: {"root": {"type": "disk", "pool": "default", "path": "/"}} Devices map[string]map[string]string `json:"devices" yaml:"devices"` // Whether the instance is ephemeral (deleted on shutdown) // Example: false Ephemeral bool `json:"ephemeral" yaml:"ephemeral"` // Expanded configuration (all profiles and local config merged) // Example: {"security.nesting": "true"} ExpandedConfig map[string]string `json:"expanded_config,omitempty" yaml:"expanded_config,omitempty"` // Expanded devices (all profiles and local devices merged) // Example: {"root": {"type": "disk", "pool": "default", "path": "/"}} ExpandedDevices map[string]map[string]string `json:"expanded_devices,omitempty" yaml:"expanded_devices,omitempty"` // Last start timestamp // Example: 2021-03-23T20:00:00-04:00 LastUsedAt time.Time `json:"last_used_at" yaml:"last_used_at"` // Snapshot name // Example: foo Name string `json:"name" yaml:"name"` // List of profiles applied to the instance // Example: ["default"] Profiles []string `json:"profiles" yaml:"profiles"` // Whether the instance currently has saved state on disk // Example: false Stateful bool `json:"stateful" yaml:"stateful"` // Size of the snapshot in bytes // Example: 143360 // // API extension: snapshot_disk_usage Size int64 `json:"size" yaml:"size"` }
InstanceSnapshot represents an instance snapshot.
swagger:model
API extension: instances.
func (*InstanceSnapshot) Writable ¶
func (c *InstanceSnapshot) Writable() InstanceSnapshotPut
Writable converts a full InstanceSnapshot struct into a InstanceSnapshotPut struct (filters read-only fields).
API extension: instances.
type InstanceSnapshotPost ¶
type InstanceSnapshotPost struct { // New name for the snapshot // Example: foo Name string `json:"name" yaml:"name"` // Whether this is a migration request // Example: false Migration bool `json:"migration" yaml:"migration"` // Migration target for push migration (requires migration) Target *InstancePostTarget `json:"target" yaml:"target"` // Whether to perform a live migration (requires migration) // Example: false Live bool `json:"live,omitempty" yaml:"live,omitempty"` }
InstanceSnapshotPost represents the fields required to rename/move an instance snapshot.
swagger:model
API extension: instances.
type InstanceSnapshotPut ¶
type InstanceSnapshotPut struct { // When the snapshot expires (gets auto-deleted) // Example: 2021-03-23T17:38:37.753398689-04:00 ExpiresAt time.Time `json:"expires_at" yaml:"expires_at"` }
InstanceSnapshotPut represents the modifiable fields of an instance snapshot.
swagger:model
API extension: instances.
type InstanceSnapshotsPost ¶
type InstanceSnapshotsPost struct { // Snapshot name // Example: snap0 Name string `json:"name" yaml:"name"` // Whether the snapshot should include runtime state // Example: false Stateful bool `json:"stateful" yaml:"stateful"` // When the snapshot expires (gets auto-deleted) // Example: 2021-03-23T17:38:37.753398689-04:00 // // API extension: snapshot_expiry_creation ExpiresAt *time.Time `json:"expires_at" yaml:"expires_at"` }
InstanceSnapshotsPost represents the fields available for a new instance snapshot.
swagger:model
API extension: instances.
type InstanceSource ¶
type InstanceSource struct { // Source type // Example: image Type string `json:"type" yaml:"type"` // Certificate (for remote images or migration) // Example: X509 PEM certificate Certificate string `json:"certificate" yaml:"certificate"` // Image alias name (for image source) // Example: ubuntu/22.04 Alias string `json:"alias,omitempty" yaml:"alias,omitempty"` // Image fingerprint (for image source) // Example: ed56997f7c5b48e8d78986d2467a26109be6fb9f2d92e8c7b08eb8b6cec7629a Fingerprint string `json:"fingerprint,omitempty" yaml:"fingerprint,omitempty"` // Image filters (for image source) // Example: {"os": "Ubuntu", "release": "jammy", "variant": "cloud"} Properties map[string]string `json:"properties,omitempty" yaml:"properties,omitempty"` // Remote server URL (for remote images) // Example: https://images.linuxcontainers.org Server string `json:"server,omitempty" yaml:"server,omitempty"` // Remote server secret (for remote private images) // Example: RANDOM-STRING Secret string `json:"secret,omitempty" yaml:"secret,omitempty"` // Protocol name (for remote image) // Example: simplestreams Protocol string `json:"protocol,omitempty" yaml:"protocol,omitempty"` // Base image fingerprint (for faster migration) // Example: ed56997f7c5b48e8d78986d2467a26109be6fb9f2d92e8c7b08eb8b6cec7629a BaseImage string `json:"base-image,omitempty" yaml:"base-image,omitempty"` // Whether to use pull or push mode (for migration) // Example: pull Mode string `json:"mode,omitempty" yaml:"mode,omitempty"` // Remote operation URL (for migration) // Example: https://1.2.3.4:8443/1.0/operations/1721ae08-b6a8-416a-9614-3f89302466e1 Operation string `json:"operation,omitempty" yaml:"operation,omitempty"` // Map of migration websockets (for migration) // Example: {"criu": "RANDOM-STRING", "rsync": "RANDOM-STRING"} Websockets map[string]string `json:"secrets,omitempty" yaml:"secrets,omitempty"` // Existing instance name or snapshot (for copy) // Example: foo/snap0 Source string `json:"source,omitempty" yaml:"source,omitempty"` // Whether this is a live migration (for migration) // Example: false Live bool `json:"live,omitempty" yaml:"live,omitempty"` // Whether the copy should skip the snapshots (for copy) // Example: false InstanceOnly bool `json:"instance_only,omitempty" yaml:"instance_only,omitempty"` // Whether this is refreshing an existing instance (for migration and copy) // Example: false Refresh bool `json:"refresh,omitempty" yaml:"refresh,omitempty"` // Source project name (for copy and local image) // Example: blah Project string `json:"project,omitempty" yaml:"project,omitempty"` // Whether to ignore errors when copying (e.g. for volatile files) // Example: false // // API extension: instance_allow_inconsistent_copy AllowInconsistent bool `json:"allow_inconsistent" yaml:"allow_inconsistent"` }
InstanceSource represents the creation source for a new instance.
swagger:model
API extension: instances.
type InstanceState ¶
type InstanceState struct { // Current status (Running, Stopped, Frozen or Error) // Example: Running Status string `json:"status" yaml:"status"` // Numeric status code (101, 102, 110, 112) // Example: 101 StatusCode StatusCode `json:"status_code" yaml:"status_code"` // Disk usage key/value pairs Disk map[string]InstanceStateDisk `json:"disk" yaml:"disk"` // Memory usage information Memory InstanceStateMemory `json:"memory" yaml:"memory"` // Network usage key/value pairs Network map[string]InstanceStateNetwork `json:"network" yaml:"network"` // PID of the runtime // Example: 7281 Pid int64 `json:"pid" yaml:"pid"` // Number of processes in the instance // Example: 50 Processes int64 `json:"processes" yaml:"processes"` // CPU usage information CPU InstanceStateCPU `json:"cpu" yaml:"cpu"` // The time that the instance started at // // API extension: instance_state_started_at. StartedAt time.Time `json:"started_at" yaml:"started_at"` }
InstanceState represents an instance's state.
swagger:model
API extension: instances.
type InstanceStateCPU ¶
type InstanceStateCPU struct { // CPU usage in nanoseconds // Example: 3637691016 Usage int64 `json:"usage" yaml:"usage"` }
InstanceStateCPU represents the cpu information section of an instance's state.
swagger:model
API extension: instances.
type InstanceStateDisk ¶
type InstanceStateDisk struct { // Disk usage in bytes // Example: 502239232 Usage int64 `json:"usage" yaml:"usage"` // Total size in bytes // Example: 502239232 // // API extension: instances_state_total Total int64 `json:"total" yaml:"total"` }
InstanceStateDisk represents the disk information section of an instance's state.
swagger:model
API extension: instances.
type InstanceStateMemory ¶
type InstanceStateMemory struct { // Memory usage in bytes // Example: 73248768 Usage int64 `json:"usage" yaml:"usage"` // Peak memory usage in bytes // Example: 73785344 UsagePeak int64 `json:"usage_peak" yaml:"usage_peak"` // Total memory size in bytes // Example: 12297557 // // API extension: instances_state_total Total int64 `json:"total" yaml:"total"` // SWAP usage in bytes // Example: 12297557 SwapUsage int64 `json:"swap_usage" yaml:"swap_usage"` // Peak SWAP usage in bytes // Example: 12297557 SwapUsagePeak int64 `json:"swap_usage_peak" yaml:"swap_usage_peak"` }
InstanceStateMemory represents the memory information section of an instance's state.
swagger:model
API extension: instances.
type InstanceStateNetwork ¶
type InstanceStateNetwork struct { // List of IP addresses Addresses []InstanceStateNetworkAddress `json:"addresses" yaml:"addresses"` // Traffic counters Counters InstanceStateNetworkCounters `json:"counters" yaml:"counters"` // MAC address // Example: 00:16:3e:0c:ee:dd Hwaddr string `json:"hwaddr" yaml:"hwaddr"` // Name of the interface on the host // Example: vethbbcd39c7 HostName string `json:"host_name" yaml:"host_name"` // MTU (maximum transmit unit) for the interface // Example: 1500 Mtu int `json:"mtu" yaml:"mtu"` // Administrative state of the interface (up/down) // Example: up State string `json:"state" yaml:"state"` // Type of interface (broadcast, loopback, point-to-point, ...) // Example: broadcast Type string `json:"type" yaml:"type"` }
InstanceStateNetwork represents the network information section of an instance's state.
swagger:model
API extension: instances.
type InstanceStateNetworkAddress ¶
type InstanceStateNetworkAddress struct { // Network family (inet or inet6) // Example: inet6 Family string `json:"family" yaml:"family"` // IP address // Example: fd42:4c81:5770:1eaf:216:3eff:fe0c:eedd Address string `json:"address" yaml:"address"` // Network mask // Example: 64 Netmask string `json:"netmask" yaml:"netmask"` // Address scope (local, link or global) // Example: global Scope string `json:"scope" yaml:"scope"` }
InstanceStateNetworkAddress represents a network address as part of the network section of an instance's state.
swagger:model
API extension: instances.
type InstanceStateNetworkCounters ¶
type InstanceStateNetworkCounters struct { // Number of bytes received // Example: 192021 BytesReceived int64 `json:"bytes_received" yaml:"bytes_received"` // Number of bytes sent // Example: 10888579 BytesSent int64 `json:"bytes_sent" yaml:"bytes_sent"` // Number of packets received // Example: 1748 PacketsReceived int64 `json:"packets_received" yaml:"packets_received"` // Number of packets sent // Example: 964 PacketsSent int64 `json:"packets_sent" yaml:"packets_sent"` // Number of errors received // Example: 14 ErrorsReceived int64 `json:"errors_received" yaml:"errors_received"` // Number of errors sent // Example: 41 ErrorsSent int64 `json:"errors_sent" yaml:"errors_sent"` // Number of outbound packets dropped // Example: 541 PacketsDroppedOutbound int64 `json:"packets_dropped_outbound" yaml:"packets_dropped_outbound"` // Number of inbound packets dropped // Example: 179 PacketsDroppedInbound int64 `json:"packets_dropped_inbound" yaml:"packets_dropped_inbound"` }
InstanceStateNetworkCounters represents packet counters as part of the network section of an instance's state.
swagger:model
API extension: instances.
type InstanceStatePut ¶
type InstanceStatePut struct { // State change action (start, stop, restart, freeze, unfreeze) // Example: start Action string `json:"action" yaml:"action"` // How long to wait (in s) before giving up (when force isn't set) // Example: 30 Timeout int `json:"timeout" yaml:"timeout"` // Whether to force the action (for stop and restart) // Example: false Force bool `json:"force" yaml:"force"` // Whether to store the runtime state (for stop) // Example: false Stateful bool `json:"stateful" yaml:"stateful"` }
InstanceStatePut represents the modifiable fields of an instance's state.
swagger:model
API extension: instances.
type InstanceType ¶
type InstanceType string
InstanceType represents the type if instance being returned or requested via the API.
type InstancesPost ¶
type InstancesPost struct { InstancePut `yaml:",inline"` // Instance name // Example: foo Name string `json:"name" yaml:"name"` // Creation source Source InstanceSource `json:"source" yaml:"source"` // Cloud instance type (AWS, GCP, Azure, ...) to emulate with limits // Example: t1.micro InstanceType string `json:"instance_type" yaml:"instance_type"` // Type (container or virtual-machine) // Example: container Type InstanceType `json:"type" yaml:"type"` // Whether to start the instance after creation // Example: true // // API extension: instance_create_start Start bool `json:"start" yaml:"start"` }
InstancesPost represents the fields available for a new instance.
swagger:model
API extension: instances.
type InstancesPut ¶
type InstancesPut struct { // Desired runtime state State *InstanceStatePut `json:"state" yaml:"state"` }
InstancesPut represents the fields available for a mass update.
swagger:model
API extension: instance_bulk_state_change.
type MetadataConfig ¶
type MetadataConfig map[MetadataConfigEntityName]map[MetadataConfigGroupName]MetadataConfigGroup
MetadataConfig repreents metadata about configuration keys
swagger:model
API extension: metadata_configuration.
type MetadataConfigEntityName ¶
type MetadataConfigEntityName string
MetadataConfigEntityName represents a main API object type Example: instance
swagger:model
API extension: metadata_configuration.
type MetadataConfigGroup ¶
type MetadataConfigGroup struct {
Keys []map[string]MetadataConfigKey `json:"keys" yaml:"keys"`
}
MetadataConfigGroup represents a group of config keys
swagger:model
API extension: metadata_configuration.
type MetadataConfigGroupName ¶
type MetadataConfigGroupName string
MetadataConfigGroupName represents the name of a group of config keys Example: volatile
swagger:model
API extension: metadata_configuration.
type MetadataConfigKey ¶
type MetadataConfigKey struct { // Condition specifies the condition that must be met for the option to be taken into account // Example: container Condition string `json:"condition,omitempty" yaml:"condition,omitempty"` // Scope defines if option apply to cluster or to the local server // Example: global Scope string `json:"scope,omitempty" yaml:"scope,omitempty"` // Type specifies the type of the option // Example: string Type string `json:"type" yaml:"type"` // DefaultDesc specify default value for configuration // Example: "`DHCP on eth0`" Default string `json:"defaultdesc,omitempty" yaml:"defaultdesc,omitempty"` // LiveUpdate specifies whether the server must be restarted for the option to be updated // Example: "no" LiveUpdate string `json:"liveupdate,omitempty" yaml:"liveupdate,omitempty"` // ShortDesc provides short description for the configuration // Example: "Kernel modules to load before starting the instance" Description string `json:"shortdesc" yaml:"shortdesc"` // LongDesc provides long description for the option // Example: "Specify the kernel modules as a comma-separated list." LongDescription string `json:"longdesc" yaml:"longdesc"` }
MetadataConfigKey describe a configuration key
swagger:model
API extension: metadata_configuration.
type MetadataConfiguration ¶
type MetadataConfiguration struct { // Metadata about configuration keys. // Example: {'configs': {'instance': {...}}} Config MetadataConfig `json:"configs" yaml:"configs"` }
MetadataConfiguration represents a server's exposed configuration metadata
swagger:model
API extension: metadata_configuration.
func (*MetadataConfiguration) GetKeys ¶
func (m *MetadataConfiguration) GetKeys(entity string, group string) (map[string]MetadataConfigKey, error)
GetKeys provides an easy way to interact with MetadataConfiguration.
type Network ¶
type Network struct { NetworkPut `yaml:",inline"` // The network name // Read only: true // Example: mybr0 Name string `json:"name" yaml:"name"` // The network type // Read only: true // Example: bridge Type string `json:"type" yaml:"type"` // List of URLs of objects using this profile // Read only: true // Example: ["/1.0/profiles/default", "/1.0/instances/c1"] UsedBy []string `json:"used_by" yaml:"used_by"` // Whether this is a managed network // Read only: true // Example: true // // API extension: network Managed bool `json:"managed" yaml:"managed"` // The state of the network (for managed network in clusters) // Read only: true // Example: Created // // API extension: clustering Status string `json:"status" yaml:"status"` // Cluster members on which the network has been defined // Read only: true // Example: ["server01", "server02", "server03"] // // API extension: clustering Locations []string `json:"locations" yaml:"locations"` // Project name // Example: project1 // // API extension: networks_all_projects Project string `json:"project" yaml:"project"` }
Network represents a network
swagger:model
func (*Network) Writable ¶
func (network *Network) Writable() NetworkPut
Writable converts a full Network struct into a NetworkPut struct (filters read-only fields).
type NetworkACL ¶
type NetworkACL struct { NetworkACLPost `yaml:",inline"` NetworkACLPut `yaml:",inline"` // List of URLs of objects using this profile // Read only: true // Example: ["/1.0/instances/c1", "/1.0/instances/v1", "/1.0/networks/mybr0"] UsedBy []string `json:"used_by" yaml:"used_by"` // Resources that use the ACL. // Project name // Example: project1 // // API extension: network_acls_all_projects Project string `json:"project" yaml:"project"` // Project the ACL belongs to. }
NetworkACL used for displaying an ACL.
swagger:model
API extension: network_acl.
func (*NetworkACL) Writable ¶
func (acl *NetworkACL) Writable() NetworkACLPut
Writable converts a full NetworkACL struct into a NetworkACLPut struct (filters read-only fields).
type NetworkACLPost ¶
type NetworkACLPost struct { // The new name for the ACL // Example: bar Name string `json:"name" yaml:"name"` // Name of ACL. }
NetworkACLPost used for renaming an ACL.
swagger:model
API extension: network_acl.
type NetworkACLPut ¶
type NetworkACLPut struct { // Description of the ACL // Example: Web servers Description string `json:"description" yaml:"description"` // List of egress rules (order independent) Egress []NetworkACLRule `json:"egress" yaml:"egress"` // List of ingress rules (order independent) Ingress []NetworkACLRule `json:"ingress" yaml:"ingress"` // ACL configuration map (refer to doc/network-acls.md) // Example: {"user.mykey": "foo"} Config map[string]string `json:"config" yaml:"config"` }
NetworkACLPut used for updating an ACL.
swagger:model
API extension: network_acl.
type NetworkACLRule ¶
type NetworkACLRule struct { // Action to perform on rule match // Example: allow Action string `json:"action" yaml:"action"` // Source address // Example: @internal Source string `json:"source,omitempty" yaml:"source,omitempty"` // Destination address // Example: 8.8.8.8/32,8.8.4.4/32 Destination string `json:"destination,omitempty" yaml:"destination,omitempty"` // Protocol // Example: udp Protocol string `json:"protocol,omitempty" yaml:"protocol,omitempty"` // Source port // Example: 1234 SourcePort string `json:"source_port,omitempty" yaml:"source_port,omitempty"` // Destination port // Example: 53 DestinationPort string `json:"destination_port,omitempty" yaml:"destination_port,omitempty"` // Type of ICMP message (for ICMP protocol) // Example: 8 ICMPType string `json:"icmp_type,omitempty" yaml:"icmp_type,omitempty"` // ICMP message code (for ICMP protocol) // Example: 0 ICMPCode string `json:"icmp_code,omitempty" yaml:"icmp_code,omitempty"` // Description of the rule // Example: Allow DNS queries to Google DNS Description string `json:"description,omitempty" yaml:"description,omitempty"` // State of the rule // Example: enabled State string `json:"state" yaml:"state"` }
NetworkACLRule represents a single rule in an ACL ruleset. Refer to doc/network-acls.md for details.
swagger:model
API extension: network_acl.
func (*NetworkACLRule) Normalise ¶
func (r *NetworkACLRule) Normalise()
Normalise normalises the fields in the rule so that they are comparable with ones stored.
type NetworkACLsPost ¶
type NetworkACLsPost struct { NetworkACLPost `yaml:",inline"` NetworkACLPut `yaml:",inline"` }
NetworkACLsPost used for creating an ACL.
swagger:model
API extension: network_acl.
type NetworkAllocations ¶
type NetworkAllocations struct { // The network address of the allocation (in CIDR format) // Example: 192.0.2.1/24 Address string `json:"addresses" yaml:"addresses"` // Hwaddr is the MAC address of the entity consuming the network address Hwaddr string `json:"hwaddr" yaml:"hwaddr"` // Whether the entity comes from a network that performs egress source NAT NAT bool `json:"nat" yaml:"nat"` // Type of the entity consuming the network address Type string `json:"type" yaml:"type"` // Name of the entity consuming the network address UsedBy string `json:"used_by" yaml:"used_by"` }
NetworkAllocations used for displaying network addresses used by a consuming entity e.g, instance, network forward, load-balancer, network...
swagger:model
API extension: network_allocations.
type NetworkForward ¶
type NetworkForward struct { NetworkForwardPut `yaml:",inline"` // The listen address of the forward // Example: 192.0.2.1 ListenAddress string `json:"listen_address" yaml:"listen_address"` // What cluster member this record was found on // Example: server01 Location string `json:"location" yaml:"location"` }
NetworkForward used for displaying an network address forward.
swagger:model
API extension: network_forward.
func (*NetworkForward) Etag ¶
func (f *NetworkForward) Etag() []any
Etag returns the values used for etag generation.
func (*NetworkForward) Writable ¶
func (f *NetworkForward) Writable() NetworkForwardPut
Writable converts a full NetworkForward struct into a NetworkForwardPut struct (filters read-only fields).
type NetworkForwardPort ¶
type NetworkForwardPort struct { // Description of the forward port // Example: My web server forward Description string `json:"description" yaml:"description"` // Protocol for port forward (either tcp or udp) // Example: tcp Protocol string `json:"protocol" yaml:"protocol"` // ListenPort(s) to forward (comma delimited ranges) // Example: 80,81,8080-8090 ListenPort string `json:"listen_port" yaml:"listen_port"` // TargetPort(s) to forward ListenPorts to (allows for many-to-one) // Example: 80,81,8080-8090 TargetPort string `json:"target_port" yaml:"target_port"` // TargetAddress to forward ListenPorts to // Example: 198.51.100.2 TargetAddress string `json:"target_address" yaml:"target_address"` }
NetworkForwardPort represents a port specification in a network address forward
swagger:model
API extension: network_forward.
func (*NetworkForwardPort) Normalise ¶
func (p *NetworkForwardPort) Normalise()
Normalise normalises the fields in the rule so that they are comparable with ones stored.
type NetworkForwardPut ¶
type NetworkForwardPut struct { // Description of the forward listen IP // Example: My public IP forward Description string `json:"description" yaml:"description"` // Forward configuration map (refer to doc/network-forwards.md) // Example: {"user.mykey": "foo"} Config map[string]string `json:"config" yaml:"config"` // Port forwards (optional) Ports []NetworkForwardPort `json:"ports" yaml:"ports"` }
NetworkForwardPut represents the modifiable fields of a network address forward
swagger:model
API extension: network_forward.
func (*NetworkForwardPut) Normalise ¶
func (f *NetworkForwardPut) Normalise()
Normalise normalises the fields in the rule so that they are comparable with ones stored.
type NetworkForwardsPost ¶
type NetworkForwardsPost struct { NetworkForwardPut `yaml:",inline"` // The listen address of the forward // Example: 192.0.2.1 ListenAddress string `json:"listen_address" yaml:"listen_address"` }
NetworkForwardsPost represents the fields of a new network address forward
swagger:model
API extension: network_forward.
func (*NetworkForwardsPost) Normalise ¶
func (f *NetworkForwardsPost) Normalise()
Normalise normalises the fields in the rule so that they are comparable with ones stored.
type NetworkIntegration ¶
type NetworkIntegration struct { NetworkIntegrationPut `yaml:",inline"` // The name of the integration // Example: region1 Name string `json:"name" yaml:"name"` // The type of integration // Example: ovn Type string `json:"type" yaml:"type"` // List of URLs of objects using this network integration // Read only: true // Example: ["/1.0/networks/foo", "/1.0/networks/bar"] UsedBy []string `json:"used_by" yaml:"used_by"` // Resources that use the integration. }
NetworkIntegration represents a network integration.
swagger:model
API extension: network_integrations.
func (*NetworkIntegration) Writable ¶
func (f *NetworkIntegration) Writable() NetworkIntegrationPut
Writable converts a full NetworkIntegration struct into a NetworkIntegrationPut struct (filters read-only fields).
type NetworkIntegrationPost ¶
type NetworkIntegrationPost struct { // The new name for the network integration // Example: region2 Name string `json:"name" yaml:"name"` }
NetworkIntegrationPost represents the fields required to rename a network integration
swagger:model
API extension: network_integrations.
type NetworkIntegrationPut ¶
type NetworkIntegrationPut struct { // Description of the network integration // Example: OVN interconnection for region1 Description string `json:"description" yaml:"description"` // Integration configuration map (refer to doc/network-integrations.md) // Example: {"user.mykey": "foo"} Config map[string]string `json:"config" yaml:"config"` }
NetworkIntegrationPut represents the modifiable fields of a network integration
swagger:model
API extension: network_integrations.
type NetworkIntegrationsPost ¶
type NetworkIntegrationsPost struct { NetworkIntegrationPut `yaml:",inline"` // The name of the integration // Example: region1 Name string `json:"name" yaml:"name"` // The type of integration // Example: ovn Type string `json:"type" yaml:"type"` }
NetworkIntegrationsPost represents the fields of a new network integration
swagger:model
API extension: network_integrations.
type NetworkLease ¶
type NetworkLease struct { // The hostname associated with the record // Example: c1 Hostname string `json:"hostname" yaml:"hostname"` // The MAC address // Example: 00:16:3e:2c:89:d9 Hwaddr string `json:"hwaddr" yaml:"hwaddr"` // The IP address // Example: 10.0.0.98 Address string `json:"address" yaml:"address"` // The type of record (static or dynamic) // Example: dynamic Type string `json:"type" yaml:"type"` // What cluster member this record was found on // Example: server01 // // API extension: network_leases_location Location string `json:"location" yaml:"location"` }
NetworkLease represents a DHCP lease
swagger:model
API extension: network_leases.
type NetworkLoadBalancer ¶
type NetworkLoadBalancer struct { NetworkLoadBalancerPut `yaml:",inline"` // The listen address of the load balancer // Example: 192.0.2.1 ListenAddress string `json:"listen_address" yaml:"listen_address"` // What cluster member this record was found on // Example: server01 Location string `json:"location" yaml:"location"` }
NetworkLoadBalancer used for displaying a network load balancer
swagger:model
API extension: network_load_balancer.
func (*NetworkLoadBalancer) Etag ¶
func (f *NetworkLoadBalancer) Etag() []any
Etag returns the values used for etag generation.
func (*NetworkLoadBalancer) Writable ¶
func (f *NetworkLoadBalancer) Writable() NetworkLoadBalancerPut
Writable converts a full NetworkLoadBalancer struct into a NetworkLoadBalancerPut struct (filters read-only fields).
type NetworkLoadBalancerBackend ¶
type NetworkLoadBalancerBackend struct { // Name of the load balancer backend // Example: c1-http Name string `json:"name" yaml:"name"` // Description of the load balancer backend // Example: C1 webserver Description string `json:"description" yaml:"description"` // TargetPort(s) to forward ListenPorts to (allows for many-to-one) // Example: 80,81,8080-8090 TargetPort string `json:"target_port" yaml:"target_port"` // TargetAddress to forward ListenPorts to // Example: 198.51.100.2 TargetAddress string `json:"target_address" yaml:"target_address"` }
NetworkLoadBalancerBackend represents a target backend specification in a network load balancer
swagger:model
API extension: network_load_balancer.
func (*NetworkLoadBalancerBackend) Normalise ¶
func (p *NetworkLoadBalancerBackend) Normalise()
Normalise normalises the fields in the load balancer backend so that they are comparable with ones stored.
type NetworkLoadBalancerPort ¶
type NetworkLoadBalancerPort struct { // Description of the load balancer port // Example: My web server load balancer Description string `json:"description" yaml:"description"` // Protocol for load balancer port (either tcp or udp) // Example: tcp Protocol string `json:"protocol" yaml:"protocol"` // ListenPort(s) of load balancer (comma delimited ranges) // Example: 80,81,8080-8090 ListenPort string `json:"listen_port" yaml:"listen_port"` // TargetBackend backend names to load balance ListenPorts to // Example: ["c1-http","c2-http"] TargetBackend []string `json:"target_backend" yaml:"target_backend"` }
NetworkLoadBalancerPort represents a port specification in a network load balancer
swagger:model
API extension: network_load_balancer.
func (*NetworkLoadBalancerPort) Normalise ¶
func (p *NetworkLoadBalancerPort) Normalise()
Normalise normalises the fields in the load balancer port so that they are comparable with ones stored.
type NetworkLoadBalancerPut ¶
type NetworkLoadBalancerPut struct { // Description of the load balancer listen IP // Example: My public IP load balancer Description string `json:"description" yaml:"description"` // Load balancer configuration map (refer to doc/network-load-balancers.md) // Example: {"user.mykey": "foo"} Config map[string]string `json:"config" yaml:"config"` // Backends (optional) Backends []NetworkLoadBalancerBackend `json:"backends" yaml:"backends"` // Port forwards (optional) Ports []NetworkLoadBalancerPort `json:"ports" yaml:"ports"` }
NetworkLoadBalancerPut represents the modifiable fields of a network load balancer
swagger:model
API extension: network_load_balancer.
func (*NetworkLoadBalancerPut) Normalise ¶
func (f *NetworkLoadBalancerPut) Normalise()
Normalise normalises the fields in the load balancer so that they are comparable with ones stored.
type NetworkLoadBalancersPost ¶
type NetworkLoadBalancersPost struct { NetworkLoadBalancerPut `yaml:",inline"` // The listen address of the load balancer // Example: 192.0.2.1 ListenAddress string `json:"listen_address" yaml:"listen_address"` }
NetworkLoadBalancersPost represents the fields of a new network load balancer
swagger:model
API extension: network_load_balancer.
type NetworkPeer ¶
type NetworkPeer struct { NetworkPeerPut `yaml:",inline"` // Name of the peer // Read only: true // Example: project1-network1 Name string `json:"name" yaml:"name"` // Name of the target project // Read only: true // Example: project1 TargetProject string `json:"target_project,omitempty" yaml:"target_project,omitempty"` // Name of the target network // Read only: true // Example: network1 TargetNetwork string `json:"target_network,omitempty" yaml:"target_network,omitempty"` // The state of the peering // Read only: true // Example: Pending Status string `json:"status" yaml:"status"` // List of URLs of objects using this network peering // Read only: true // Example: ["/1.0/network-acls/test", "/1.0/network-acls/foo"] UsedBy []string `json:"used_by" yaml:"used_by"` // Type of peer // Example: local // // API extension: network_integrations. Type string `json:"type" yaml:"type"` // Name of the target integration // Example: ovn-ic1 // // API extension: network_integrations. TargetIntegration string `json:"target_integration,omitempty" yaml:"target_integration,omitempty"` }
NetworkPeer used for displaying a network peering.
swagger:model
API extension: network_forward.
func (*NetworkPeer) Etag ¶
func (p *NetworkPeer) Etag() []any
Etag returns the values used for etag generation.
func (*NetworkPeer) Writable ¶
func (p *NetworkPeer) Writable() NetworkPeerPut
Writable converts a full NetworkPeer struct into a NetworkPeerPut struct (filters read-only fields).
type NetworkPeerPut ¶
type NetworkPeerPut struct { // Description of the peer // Example: Peering with network1 in project1 Description string `json:"description" yaml:"description"` // Peer configuration map (refer to doc/network-peers.md) // Example: {"user.mykey": "foo"} Config map[string]string `json:"config" yaml:"config"` }
NetworkPeerPut represents the modifiable fields of a network peering
swagger:model
API extension: network_peer.
type NetworkPeersPost ¶
type NetworkPeersPost struct { NetworkPeerPut `yaml:",inline"` // Name of the peer // Example: project1-network1 Name string `json:"name" yaml:"name"` // Name of the target project // Example: project1 TargetProject string `json:"target_project,omitempty" yaml:"target_project,omitempty"` // Name of the target network // Example: network1 TargetNetwork string `json:"target_network,omitempty" yaml:"target_network,omitempty"` // Type of peer // Example: local // // API extension: network_integrations. Type string `json:"type" yaml:"type"` // Name of the target integration // Example: ovn-ic1 // // API extension: network_integrations. TargetIntegration string `json:"target_integration,omitempty" yaml:"target_integration,omitempty"` }
NetworkPeersPost represents the fields of a new network peering
swagger:model
API extension: network_peer.
type NetworkPost ¶
type NetworkPost struct { // The new name for the network // Example: mybr1 Name string `json:"name" yaml:"name"` }
NetworkPost represents the fields required to rename a network
swagger:model
API extension: network.
type NetworkPut ¶
type NetworkPut struct { // Network configuration map (refer to doc/networks.md) // Example: {"ipv4.address": "10.0.0.1/24", "ipv4.nat": "true", "ipv6.address": "none"} Config map[string]string `json:"config" yaml:"config"` // Description of the profile // Example: My new bridge // // API extension: entity_description Description string `json:"description" yaml:"description"` }
NetworkPut represents the modifiable fields of a network
swagger:model
API extension: network.
type NetworkState ¶
type NetworkState struct { // List of addresses Addresses []NetworkStateAddress `json:"addresses" yaml:"addresses"` // Interface counters Counters NetworkStateCounters `json:"counters" yaml:"counters"` // MAC address // Example: 00:16:3e:5a:83:57 Hwaddr string `json:"hwaddr" yaml:"hwaddr"` // MTU // Example: 1500 Mtu int `json:"mtu" yaml:"mtu"` // Link state // Example: up State string `json:"state" yaml:"state"` // Interface type // Example: broadcast Type string `json:"type" yaml:"type"` // Additional bond interface information // // API extension: network_state_bond_bridge Bond *NetworkStateBond `json:"bond" yaml:"bond"` // Additional bridge interface information // // API extension: network_state_bond_bridge Bridge *NetworkStateBridge `json:"bridge" yaml:"bridge"` // Additional vlan interface information // // API extension: network_state_vlan VLAN *NetworkStateVLAN `json:"vlan" yaml:"vlan"` // Additional OVN network information // // API extension: network_state_ovn OVN *NetworkStateOVN `json:"ovn" yaml:"ovn"` }
NetworkState represents the network state
swagger:model
type NetworkStateAddress ¶
type NetworkStateAddress struct { // Address family // Example: inet Family string `json:"family" yaml:"family"` // IP address // Example: 10.0.0.1 Address string `json:"address" yaml:"address"` // IP netmask (CIDR) // Example: 24 Netmask string `json:"netmask" yaml:"netmask"` // Address scope // Example: global Scope string `json:"scope" yaml:"scope"` }
NetworkStateAddress represents a network address
swagger:model
type NetworkStateBond ¶
type NetworkStateBond struct { // Bonding mode // Example: 802.3ad Mode string `json:"mode" yaml:"mode"` // Transmit balancing policy // Example: layer3+4 TransmitPolicy string `json:"transmit_policy" yaml:"transmit_policy"` // Delay on link up (ms) // Example: 0 UpDelay uint64 `json:"up_delay" yaml:"up_delay"` // Delay on link down (ms) // Example: 0 DownDelay uint64 `json:"down_delay" yaml:"down_delay"` // How often to check for link state (ms) // Example: 100 MIIFrequency uint64 `json:"mii_frequency" yaml:"mii_frequency"` // Bond link state // Example: up MIIState string `json:"mii_state" yaml:"mii_state"` // List of devices that are part of the bond // Example: ["eth0", "eth1"] LowerDevices []string `json:"lower_devices" yaml:"lower_devices"` }
NetworkStateBond represents bond specific state
swagger:model
API extension: network_state_bond_bridge.
type NetworkStateBridge ¶
type NetworkStateBridge struct { // Bridge ID // Example: 8000.0a0f7c6edbd9 ID string `json:"id" yaml:"id"` // Whether STP is enabled // Example: false STP bool `json:"stp" yaml:"stp"` // Delay on port join (ms) // Example: 1500 ForwardDelay uint64 `json:"forward_delay" yaml:"forward_delay"` // Default VLAN ID // Example: 1 VLANDefault uint64 `json:"vlan_default" yaml:"vlan_default"` // Whether VLAN filtering is enabled // Example: false VLANFiltering bool `json:"vlan_filtering" yaml:"vlan_filtering"` // List of devices that are in the bridge // Example: ["eth0", "eth1"] UpperDevices []string `json:"upper_devices" yaml:"upper_devices"` }
NetworkStateBridge represents bridge specific state
swagger:model
API extension: network_state_bond_bridge.
type NetworkStateCounters ¶
type NetworkStateCounters struct { // Number of bytes received // Example: 250542118 BytesReceived int64 `json:"bytes_received" yaml:"bytes_received"` // Number of bytes sent // Example: 17524040140 BytesSent int64 `json:"bytes_sent" yaml:"bytes_sent"` // Number of packets received // Example: 1182515 PacketsReceived int64 `json:"packets_received" yaml:"packets_received"` // Number of packets sent // Example: 1567934 PacketsSent int64 `json:"packets_sent" yaml:"packets_sent"` }
NetworkStateCounters represents packet counters
swagger:model
type NetworkStateOVN ¶
type NetworkStateOVN struct { // OVN network chassis name // Example: server01 Chassis string `json:"chassis" yaml:"chassis"` // OVN logical router name // Example: incus-net1-lr // // API extension: network_state_ovn_lr LogicalRouter string `json:"logical_router" yaml:"logical_router"` }
NetworkStateOVN represents OVN specific state
swagger:model
API extension: network_state_ovn.
type NetworkStateVLAN ¶
type NetworkStateVLAN struct { // Parent device // Example: eth0 LowerDevice string `json:"lower_device" yaml:"lower_device"` // VLAN ID // Example: 100 VID uint64 `json:"vid" yaml:"vid"` }
NetworkStateVLAN represents VLAN specific state
swagger:model
API extension: network_state_vlan.
type NetworkZone ¶
type NetworkZone struct { NetworkZonePut `yaml:",inline"` // The name of the zone (DNS domain name) // Example: example.net Name string `json:"name" yaml:"name"` // List of URLs of objects using this network zone // Read only: true // Example: ["/1.0/networks/foo", "/1.0/networks/bar"] UsedBy []string `json:"used_by" yaml:"used_by"` // Resources that use the zone. // Project name // Example: project1 // // API extension: network_zones_all_projects Project string `json:"project" yaml:"project"` }
NetworkZone represents a network zone (DNS).
swagger:model
API extension: network_dns.
func (*NetworkZone) Writable ¶
func (f *NetworkZone) Writable() NetworkZonePut
Writable converts a full NetworkZone struct into a NetworkZonePut struct (filters read-only fields).
type NetworkZonePut ¶
type NetworkZonePut struct { // Description of the network zone // Example: Internal domain Description string `json:"description" yaml:"description"` // Zone configuration map (refer to doc/network-zones.md) // Example: {"user.mykey": "foo"} Config map[string]string `json:"config" yaml:"config"` }
NetworkZonePut represents the modifiable fields of a network zone
swagger:model
API extension: network_dns.
type NetworkZoneRecord ¶
type NetworkZoneRecord struct { NetworkZoneRecordPut `yaml:",inline"` // The name of the record // Example: @ Name string `json:"name" yaml:"name"` }
NetworkZoneRecord represents a network zone (DNS) record.
swagger:model
API extension: network_dns_records.
func (*NetworkZoneRecord) Writable ¶
func (f *NetworkZoneRecord) Writable() NetworkZoneRecordPut
Writable converts a full NetworkZoneRecord struct into a NetworkZoneRecordPut struct (filters read-only fields).
type NetworkZoneRecordEntry ¶
type NetworkZoneRecordEntry struct { // Type of DNS entry // Example: TXT Type string `json:"type" yaml:"type"` // TTL for the entry // Example: 3600 TTL uint64 `json:"ttl,omitempty" yaml:"ttl,omitempty"` // Value for the record // Example: v=spf1 mx ~all Value string `json:"value" yaml:"value"` }
NetworkZoneRecordEntry represents the fields in a record entry
swagger:model
API extension: network_dns_records.
type NetworkZoneRecordPut ¶
type NetworkZoneRecordPut struct { // Description of the record // Example: SPF record Description string `json:"description" yaml:"description"` // Entries in the record Entries []NetworkZoneRecordEntry `json:"entries" yaml:"entries"` // Advanced configuration for the record // Example: {"user.mykey": "foo"} Config map[string]string `json:"config" yaml:"config"` }
NetworkZoneRecordPut represents the modifiable fields of a network zone record
swagger:model
API extension: network_dns_records.
type NetworkZoneRecordsPost ¶
type NetworkZoneRecordsPost struct { NetworkZoneRecordPut `yaml:",inline"` // The record name in the zone // Example: @ Name string `json:"name" yaml:"name"` }
NetworkZoneRecordsPost represents the fields of a new network zone record
swagger:model
API extension: network_dns_records.
type NetworkZonesPost ¶
type NetworkZonesPost struct { NetworkZonePut `yaml:",inline"` // The name of the zone (DNS domain name) // Example: example.net Name string `json:"name" yaml:"name"` }
NetworkZonesPost represents the fields of a new network zone
swagger:model
API extension: network_dns.
type NetworksPost ¶
type NetworksPost struct { NetworkPut `yaml:",inline"` // The name of the new network // Example: mybr1 Name string `json:"name" yaml:"name"` // The network type (refer to doc/networks.md) // Example: bridge Type string `json:"type" yaml:"type"` }
NetworksPost represents the fields of a new network
swagger:model
API extension: network.
type Operation ¶
type Operation struct { // UUID of the operation // Example: 6916c8a6-9b7d-4abd-90b3-aedfec7ec7da ID string `json:"id" yaml:"id"` // Type of operation (task, token or websocket) // Example: websocket Class string `json:"class" yaml:"class"` // Description of the operation // Example: Executing command Description string `json:"description" yaml:"description"` // Operation creation time // Example: 2021-03-23T17:38:37.753398689-04:00 CreatedAt time.Time `json:"created_at" yaml:"created_at"` // Operation last change // Example: 2021-03-23T17:38:37.753398689-04:00 UpdatedAt time.Time `json:"updated_at" yaml:"updated_at"` // Status name // Example: Running Status string `json:"status" yaml:"status"` // Status code // Example: 103 StatusCode StatusCode `json:"status_code" yaml:"status_code"` // Affected resourcs // Example: {"instances": ["/1.0/instances/foo"]} Resources map[string][]string `json:"resources" yaml:"resources"` // Operation specific metadata // Example: {"command": ["bash"], "environment": {"HOME": "/root", "LANG": "C.UTF-8", "PATH": "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", "TERM": "xterm", "USER": "root"}, "fds": {"0": "da3046cf02c0116febf4ef3fe4eaecdf308e720c05e5a9c730ce1a6f15417f66", "1": "05896879d8692607bd6e4a09475667da3b5f6714418ab0ee0e5720b4c57f754b"}, "interactive": true} Metadata map[string]any `json:"metadata" yaml:"metadata"` // Whether the operation can be canceled // Example: false MayCancel bool `json:"may_cancel" yaml:"may_cancel"` // Operation error mesage // Example: Some error message Err string `json:"err" yaml:"err"` // What cluster member this record was found on // Example: server01 // // API extension: operation_location Location string `json:"location" yaml:"location"` }
Operation represents a background operation
swagger:model
func (*Operation) ToCertificateAddToken ¶
func (op *Operation) ToCertificateAddToken() (*CertificateAddToken, error)
ToCertificateAddToken creates a certificate add token from the operation metadata.
func (*Operation) ToClusterJoinToken ¶
func (op *Operation) ToClusterJoinToken() (*ClusterMemberJoinToken, error)
ToClusterJoinToken creates a cluster join token from the operation metadata.
type Profile ¶
type Profile struct { ProfilePut `yaml:",inline"` // The profile name // Read only: true // Example: foo Name string `json:"name" yaml:"name" db:"primary=yes"` // List of URLs of objects using this profile // Read only: true // Example: ["/1.0/instances/c1", "/1.0/instances/v1"] // // API extension: profile_usedby UsedBy []string `json:"used_by" yaml:"used_by"` // Project name // Example: project1 // // API extension: profiles_all_projects Project string `json:"project" yaml:"project"` }
Profile represents a profile
swagger:model
func (*Profile) Writable ¶
func (profile *Profile) Writable() ProfilePut
Writable converts a full Profile struct into a ProfilePut struct (filters read-only fields).
type ProfilePost ¶
type ProfilePost struct { // The new name for the profile // Example: bar Name string `json:"name" yaml:"name"` }
ProfilePost represents the fields required to rename a profile
swagger:model
type ProfilePut ¶
type ProfilePut struct { // Instance configuration map (refer to doc/instances.md) // Example: {"limits.cpu": "4", "limits.memory": "4GiB"} Config map[string]string `json:"config" yaml:"config"` // Description of the profile // Example: Medium size instances Description string `json:"description" yaml:"description"` // List of devices // Example: {"root": {"type": "disk", "pool": "default", "path": "/"}, "eth0": {"type": "nic", "network": "mybr0", "name": "eth0"}} Devices map[string]map[string]string `json:"devices" yaml:"devices"` }
ProfilePut represents the modifiable fields of a profile
swagger:model
type ProfilesPost ¶
type ProfilesPost struct { ProfilePut `yaml:",inline"` // The name of the new profile // Example: foo Name string `json:"name" yaml:"name" db:"primary=yes"` }
ProfilesPost represents the fields of a new profile
swagger:model
type Project ¶
type Project struct { ProjectPut `yaml:",inline"` // The project name // Read only: true // Example: foo Name string `json:"name" yaml:"name"` // List of URLs of objects using this project // Read only: true // Example: ["/1.0/images/0e60015346f06627f10580d56ac7fffd9ea775f6d4f25987217d5eed94910a20", "/1.0/instances/c1", "/1.0/networks/mybr0", "/1.0/profiles/default", "/1.0/storage-pools/default/volumes/custom/blah"] UsedBy []string `json:"used_by" yaml:"used_by"` }
Project represents a project
swagger:model
API extension: projects.
func (*Project) Writable ¶
func (project *Project) Writable() ProjectPut
Writable converts a full Project struct into a ProjectPut struct (filters read-only fields)
API extension: projects.
type ProjectPost ¶
type ProjectPost struct { // The new name for the project // Example: bar Name string `json:"name" yaml:"name"` }
ProjectPost represents the fields required to rename a project
swagger:model
API extension: projects.
type ProjectPut ¶
type ProjectPut struct { // Project configuration map (refer to doc/projects.md) // Example: {"features.profiles": "true", "features.networks": "false"} Config map[string]string `json:"config" yaml:"config"` // Description of the project // Example: My new project Description string `json:"description" yaml:"description"` }
ProjectPut represents the modifiable fields of a project
swagger:model
API extension: projects.
type ProjectState ¶
type ProjectState struct { // Allocated and used resources // Read only: true // Example: {"containers": {"limit": 10, "usage": 4}, "cpu": {"limit": 20, "usage": 16}} Resources map[string]ProjectStateResource `json:"resources" yaml:"resources"` }
ProjectState represents the current running state of a project
swagger:model
API extension: project_usage.
type ProjectStateResource ¶
type ProjectStateResource struct { // Limit for the resource (-1 if none) // Example: 10 Limit int64 // Current usage for the resource // Example: 4 Usage int64 }
ProjectStateResource represents the state of a particular resource in a project
swagger:model
API extension: project_usage.
type ProjectsPost ¶
type ProjectsPost struct { ProjectPut `yaml:",inline"` // The name of the new project // Example: foo Name string `json:"name" yaml:"name"` }
ProjectsPost represents the fields of a new project
swagger:model
API extension: projects.
type Resources ¶
type Resources struct { // CPU information CPU ResourcesCPU `json:"cpu" yaml:"cpu"` // Memory information Memory ResourcesMemory `json:"memory" yaml:"memory"` // GPU devices // // API extension: resources_gpu GPU ResourcesGPU `json:"gpu" yaml:"gpu"` // Network devices // // API extension: resources_v2 Network ResourcesNetwork `json:"network" yaml:"network"` // Storage devices // // API extension: resources_v2 Storage ResourcesStorage `json:"storage" yaml:"storage"` // USB devices // // API extension: resources_usb_pci USB ResourcesUSB `json:"usb" yaml:"usb"` // PCI devices // // API extension: resources_usb_pci PCI ResourcesPCI `json:"pci" yaml:"pci"` // System information // // API extension: resources_system System ResourcesSystem `json:"system" yaml:"system"` // Load average information // // API extension: resources_load Load ResourcesLoad `json:"load" yaml:"load"` }
Resources represents the system hardware resources
swagger:model
API extension: resources.
type ResourcesCPU ¶
type ResourcesCPU struct { // Architecture name // Example: x86_64 // // API extension: resources_v2 Architecture string `json:"architecture" yaml:"architecture"` // List of CPU sockets Sockets []ResourcesCPUSocket `json:"sockets" yaml:"sockets"` // Total number of CPU threads (from all sockets and cores) // Example: 1 Total uint64 `json:"total" yaml:"total"` }
ResourcesCPU represents the cpu resources available on the system
swagger:model
API extension: resources.
type ResourcesCPUCache ¶
type ResourcesCPUCache struct { // Cache level (usually a number from 1 to 3) // Example: 1 Level uint64 `json:"level" yaml:"level"` // Type of cache (Data, Instruction, Unified, ...) // Example: Data Type string `json:"type" yaml:"type"` // Size of the cache (in bytes) // Example: 32768 Size uint64 `json:"size" yaml:"size"` }
ResourcesCPUCache represents a CPU cache
swagger:model
API extension: resources_v2.
type ResourcesCPUCore ¶
type ResourcesCPUCore struct { // Core identifier within the socket // Example: 0 Core uint64 `json:"core" yaml:"core"` // What die the CPU is a part of (for chiplet designs) // Example: 0 // // API extension: resources_cpu_core_die Die uint64 `json:"die" yaml:"die"` // List of threads Threads []ResourcesCPUThread `json:"threads" yaml:"threads"` // Current frequency // Example: 3500 Frequency uint64 `json:"frequency,omitempty" yaml:"frequency,omitempty"` // List of CPU flags // Example: [] // // API extension: resources_cpu_flags Flags []string `json:"flags" yaml:"flags"` }
ResourcesCPUCore represents a CPU core on the system
swagger:model
API extension: resources_v2.
type ResourcesCPUSocket ¶
type ResourcesCPUSocket struct { // Product name // Example: Intel(R) Core(TM) i5-7300U CPU @ 2.60GHz Name string `json:"name,omitempty" yaml:"name,omitempty"` // Vendor name // Example: GenuineIntel Vendor string `json:"vendor,omitempty" yaml:"vendor,omitempty"` // Socket number // Example: 0 Socket uint64 `json:"socket" yaml:"socket"` // List of CPU caches Cache []ResourcesCPUCache `json:"cache,omitempty" yaml:"cache,omitempty"` // List of CPU cores Cores []ResourcesCPUCore `json:"cores" yaml:"cores"` // Current CPU frequency (Mhz) // Example: 3499 Frequency uint64 `json:"frequency,omitempty" yaml:"frequency,omitempty"` // Minimum CPU frequency (Mhz) // Example: 400 FrequencyMinimum uint64 `json:"frequency_minimum,omitempty" yaml:"frequency_minimum,omitempty"` // Maximum CPU frequency (Mhz) // Example: 3500 FrequencyTurbo uint64 `json:"frequency_turbo,omitempty" yaml:"frequency_turbo,omitempty"` }
ResourcesCPUSocket represents a CPU socket on the system
swagger:model
API extension: resources_v2.
type ResourcesCPUThread ¶
type ResourcesCPUThread struct { // Thread ID (used for CPU pinning) // Example: 0 ID int64 `json:"id" yaml:"id"` // NUMA node the thread is a part of // Example: 0 NUMANode uint64 `json:"numa_node" yaml:"numa_node"` // Thread identifier within the core // Example: 0 Thread uint64 `json:"thread" yaml:"thread"` // Whether the thread is online (enabled) // Example: true Online bool `json:"online" yaml:"online"` // Whether the thread has been isolated (outside of normal scheduling) // Example: false // // API extension: resource_cpu_isolated Isolated bool `json:"isolated" yaml:"isolated"` }
ResourcesCPUThread represents a CPU thread on the system
swagger:model
API extension: resources_v2.
type ResourcesGPU ¶
type ResourcesGPU struct { // List of GPUs Cards []ResourcesGPUCard `json:"cards" yaml:"cards"` // Total number of GPUs // Example: 1 Total uint64 `json:"total" yaml:"total"` }
ResourcesGPU represents the GPU resources available on the system
swagger:model
API extension: resources_gpu.
type ResourcesGPUCard ¶
type ResourcesGPUCard struct { // Kernel driver currently associated with the GPU // Example: i915 Driver string `json:"driver,omitempty" yaml:"driver,omitempty"` // Version of the kernel driver // Example: 5.8.0-36-generic DriverVersion string `json:"driver_version,omitempty" yaml:"driver_version,omitempty"` // DRM information (if card is in used by the host) DRM *ResourcesGPUCardDRM `json:"drm,omitempty" yaml:"drm,omitempty"` // SRIOV information (when supported by the card) SRIOV *ResourcesGPUCardSRIOV `json:"sriov,omitempty" yaml:"sriov,omitempty"` // NVIDIA specific information Nvidia *ResourcesGPUCardNvidia `json:"nvidia,omitempty" yaml:"nvidia,omitempty"` // Map of available mediated device profiles // Example: null // // API extension: resources_gpu_mdev Mdev map[string]ResourcesGPUCardMdev `json:"mdev,omitempty" yaml:"mdev,omitempty"` // NUMA node the GPU is a part of // Example: 0 NUMANode uint64 `json:"numa_node" yaml:"numa_node"` // PCI address // Example: 0000:00:02.0 PCIAddress string `json:"pci_address,omitempty" yaml:"pci_address,omitempty"` // Name of the vendor // Example: Intel Corporation Vendor string `json:"vendor,omitempty" yaml:"vendor,omitempty"` // PCI ID of the vendor // Example: 8086 VendorID string `json:"vendor_id,omitempty" yaml:"vendor_id,omitempty"` // Name of the product // Example: HD Graphics 620 Product string `json:"product,omitempty" yaml:"product,omitempty"` // PCI ID of the product // Example: 5916 ProductID string `json:"product_id,omitempty" yaml:"product_id,omitempty"` // USB address (for USB cards) // Example: 2:7 // // API extension: resources_gpu_usb USBAddress string `json:"usb_address,omitempty" yaml:"usb_address,omitempty"` }
ResourcesGPUCard represents a GPU card on the system
swagger:model
API extension: resources_v2.
type ResourcesGPUCardDRM ¶
type ResourcesGPUCardDRM struct { // DRM card ID // Example: 0 ID uint64 `json:"id" yaml:"id"` // Card device name // Example: card0 CardName string `json:"card_name" yaml:"card_name"` // Card device number // Example: 226:0 CardDevice string `json:"card_device" yaml:"card_device"` // Control device name // Example: controlD64 ControlName string `json:"control_name,omitempty" yaml:"control_name,omitempty"` // Control device number // Example: 226:0 ControlDevice string `json:"control_device,omitempty" yaml:"control_device,omitempty"` // Render device name // Example: renderD128 RenderName string `json:"render_name,omitempty" yaml:"render_name,omitempty"` // Render device number // Example: 226:128 RenderDevice string `json:"render_device,omitempty" yaml:"render_device,omitempty"` }
ResourcesGPUCardDRM represents the Linux DRM configuration of the GPU
swagger:model
API extension: resources_v2.
type ResourcesGPUCardMdev ¶
type ResourcesGPUCardMdev struct { // The mechanism used by this device // Example: vfio-pci API string `json:"api" yaml:"api"` // Number of available devices of this profile // Example: 2 Available uint64 `json:"available" yaml:"available"` // Profile name // Example: i915-GVTg_V5_8 Name string `json:"name,omitempty" yaml:"name,omitempty"` // Profile description // Example: low_gm_size: 128MB\nhigh_gm_size: 512MB\nfence: 4\nresolution: 1920x1200\nweight: 4 Description string `json:"description,omitempty" yaml:"description,omitempty"` // List of active devices (UUIDs) // Example: ["42200aac-0977-495c-8c9e-6c51b9092a01", "b4950c00-1437-41d9-88f6-28d61cf9b9ef"] Devices []string `json:"devices" yaml:"devices"` }
ResourcesGPUCardMdev represents the mediated devices configuration of the GPU
swagger:model
API extension: resources_gpu_mdev.
type ResourcesGPUCardNvidia ¶
type ResourcesGPUCardNvidia struct { // Version of the CUDA API // Example: 11.0 CUDAVersion string `json:"cuda_version,omitempty" yaml:"cuda_version,omitempty"` // Version of the NVRM (usually driver version) // Example: 450.102.04 NVRMVersion string `json:"nvrm_version,omitempty" yaml:"nvrm_version,omitempty"` // Brand name // Example: GeForce Brand string `json:"brand" yaml:"brand"` // Model name // Example: GeForce GT 730 Model string `json:"model" yaml:"model"` // GPU UUID // Example: GPU-6ddadebd-dafe-2db9-f10f-125719770fd3 UUID string `json:"uuid,omitempty" yaml:"uuid,omitempty"` // Architecture (generation) // Example: 3.5 Architecture string `json:"architecture,omitempty" yaml:"architecture,omitempty"` // Card device name // Example: nvidia0 // // API extension: resources_v2 CardName string `json:"card_name" yaml:"card_name"` // Card device number // Example: 195:0 // // API extension: resources_v2 CardDevice string `json:"card_device" yaml:"card_device"` }
ResourcesGPUCardNvidia represents additional information for NVIDIA GPUs
swagger:model
API extension: resources_gpu.
type ResourcesGPUCardSRIOV ¶
type ResourcesGPUCardSRIOV struct { // Number of VFs currently configured // Example: 0 CurrentVFs uint64 `json:"current_vfs" yaml:"current_vfs"` // Maximum number of supported VFs // Example: 0 MaximumVFs uint64 `json:"maximum_vfs" yaml:"maximum_vfs"` // List of VFs (as additional GPU devices) // Example: null VFs []ResourcesGPUCard `json:"vfs" yaml:"vfs"` }
ResourcesGPUCardSRIOV represents the SRIOV configuration of the GPU
swagger:model
API extension: resources_v2.
type ResourcesLoad ¶
type ResourcesLoad struct { // Load average in the past minute // Example: 0.69 Average1Min float64 // Load average in the past 5 minutes // Example: 1.10 Average5Min float64 // Load average in the past 10 minutes // Example: 1.29 Average10Min float64 // The number of active processes // Example: 1234 Processes int }
ResourcesLoad represents system load information
swagger:model
API extension: resources_load.
type ResourcesMemory ¶
type ResourcesMemory struct { // List of NUMA memory nodes // Example: null // // API extension: resources_v2 Nodes []ResourcesMemoryNode `json:"nodes,omitempty" yaml:"nodes,omitempty"` // Total of memory huge pages (bytes) // Example: 429284917248 HugepagesTotal uint64 `json:"hugepages_total" yaml:"hugepages_total"` // Used memory huge pages (bytes) // Example: 429284917248 HugepagesUsed uint64 `json:"hugepages_used" yaml:"hugepages_used"` // Size of memory huge pages (bytes) // Example: 2097152 HugepagesSize uint64 `json:"hugepages_size" yaml:"hugepages_size"` // Used system memory (bytes) // Example: 557450502144 Used uint64 `json:"used" yaml:"used"` // Total system memory (bytes) // Example: 687194767360 Total uint64 `json:"total" yaml:"total"` }
ResourcesMemory represents the memory resources available on the system
swagger:model
API extension: resources.
type ResourcesMemoryNode ¶
type ResourcesMemoryNode struct { // NUMA node identifier // Example: 0 NUMANode uint64 `json:"numa_node" yaml:"numa_node"` // Used memory huge pages (bytes) // Example: 214536552448 HugepagesUsed uint64 `json:"hugepages_used" yaml:"hugepages_used"` // Total of memory huge pages (bytes) // Example: 214536552448 HugepagesTotal uint64 `json:"hugepages_total" yaml:"hugepages_total"` // Used system memory (bytes) // Example: 264880439296 Used uint64 `json:"used" yaml:"used"` // Total system memory (bytes) // Example: 343597383680 Total uint64 `json:"total" yaml:"total"` }
ResourcesMemoryNode represents the node-specific memory resources available on the system
swagger:model
API extension: resources_v2.
type ResourcesNetwork ¶
type ResourcesNetwork struct { // List of network cards Cards []ResourcesNetworkCard `json:"cards" yaml:"cards"` // Total number of network cards // Example: 1 Total uint64 `json:"total" yaml:"total"` }
ResourcesNetwork represents the network cards available on the system
swagger:model
API extension: resources_v2.
type ResourcesNetworkCard ¶
type ResourcesNetworkCard struct { // Kernel driver currently associated with the card // Example: atlantic Driver string `json:"driver,omitempty" yaml:"driver,omitempty"` // Version of the kernel driver // Example: 5.8.0-36-generic DriverVersion string `json:"driver_version,omitempty" yaml:"driver_version,omitempty"` // List of ports on the card Ports []ResourcesNetworkCardPort `json:"ports,omitempty" yaml:"ports,omitempty"` // SRIOV information (when supported by the card) SRIOV *ResourcesNetworkCardSRIOV `json:"sriov,omitempty" yaml:"sriov,omitempty"` // vDPA information (when supported by the card) // // API extension: ovn_nic_acceleration_vdpa VDPA *ResourcesNetworkCardVDPA `json:"vdpa,omitempty" yaml:"vdpa,omitempty"` // NUMA node the card is a part of // Example: 0 NUMANode uint64 `json:"numa_node" yaml:"numa_node"` // PCI address (for PCI cards) // Example: 0000:0d:00.0 PCIAddress string `json:"pci_address,omitempty" yaml:"pci_address,omitempty"` // Name of the vendor // Example: Aquantia Corp. Vendor string `json:"vendor,omitempty" yaml:"vendor,omitempty"` // PCI ID of the vendor // Example: 1d6a VendorID string `json:"vendor_id,omitempty" yaml:"vendor_id,omitempty"` // Name of the product // Example: AQC107 NBase-T/IEEE Product string `json:"product,omitempty" yaml:"product,omitempty"` // PCI ID of the product // Example: 87b1 ProductID string `json:"product_id,omitempty" yaml:"product_id,omitempty"` // Current firmware version // Example: 3.1.100 // // API extension: resources_network_firmware FirmwareVersion string `json:"firmware_version,omitempty" yaml:"firmware_version,omitempty"` // USB address (for USB cards) // Example: 2:7 // // API extension: resources_network_usb USBAddress string `json:"usb_address,omitempty" yaml:"usb_address,omitempty"` }
ResourcesNetworkCard represents a network card on the system
swagger:model
API extension: resources_v2.
type ResourcesNetworkCardPort ¶
type ResourcesNetworkCardPort struct { // Port identifier (interface name) // Example: eth0 ID string `json:"id" yaml:"id"` // MAC address // Example: 00:23:a4:01:01:6f Address string `json:"address,omitempty" yaml:"address,omitempty"` // Port number // Example: 0 Port uint64 `json:"port" yaml:"port"` // Transport protocol // Example: ethernet Protocol string `json:"protocol" yaml:"protocol"` // List of supported modes // Example: ["100baseT/Full", "1000baseT/Full", "2500baseT/Full", "5000baseT/Full", "10000baseT/Full"] SupportedModes []string `json:"supported_modes,omitempty" yaml:"supported_modes,omitempty"` // List of supported port types // Example: ["twisted pair"] SupportedPorts []string `json:"supported_ports,omitempty" yaml:"supported_ports,omitempty"` // Current port type // Example: twisted pair PortType string `json:"port_type,omitempty" yaml:"port_type,omitempty"` // Type of transceiver used // Example: internal TransceiverType string `json:"transceiver_type,omitempty" yaml:"transceiver_type,omitempty"` // Whether auto negotiation is used // Example: true AutoNegotiation bool `json:"auto_negotiation" yaml:"auto_negotiation"` // Whether a link was detected // Example: true LinkDetected bool `json:"link_detected" yaml:"link_detected"` // Current speed (Mbit/s) // Example: 10000 LinkSpeed uint64 `json:"link_speed,omitempty" yaml:"link_speed,omitempty"` // Duplex type // Example: full LinkDuplex string `json:"link_duplex,omitempty" yaml:"link_duplex,omitempty"` // Additional information for infiniband devices // // API extension: resources_infiniband Infiniband *ResourcesNetworkCardPortInfiniband `json:"infiniband,omitempty" yaml:"infiniband,omitempty"` }
ResourcesNetworkCardPort represents a network port on the system
swagger:model
API extension: resources_v2.
type ResourcesNetworkCardPortInfiniband ¶
type ResourcesNetworkCardPortInfiniband struct { // ISSM device name // Example: issm0 IsSMName string `json:"issm_name,omitempty" yaml:"issm_name,omitempty"` // ISSM device number // Example: 231:64 IsSMDevice string `json:"issm_device,omitempty" yaml:"issm_device,omitempty"` // MAD device name // Example: umad0 MADName string `json:"mad_name,omitempty" yaml:"mad_name,omitempty"` // MAD device number // Example: 231:0 MADDevice string `json:"mad_device,omitempty" yaml:"mad_device,omitempty"` // Verb device name // Example: uverbs0 VerbName string `json:"verb_name,omitempty" yaml:"verb_name,omitempty"` // Verb device number // Example: 231:192 VerbDevice string `json:"verb_device,omitempty" yaml:"verb_device,omitempty"` }
ResourcesNetworkCardPortInfiniband represents the Linux Infiniband configuration for the port
swagger:model
API extension: resources_infiniband.
type ResourcesNetworkCardSRIOV ¶
type ResourcesNetworkCardSRIOV struct { // Number of VFs currently configured // Example: 0 CurrentVFs uint64 `json:"current_vfs" yaml:"current_vfs"` // Maximum number of supported VFs // Example: 0 MaximumVFs uint64 `json:"maximum_vfs" yaml:"maximum_vfs"` // List of VFs (as additional Network devices) // Example: null VFs []ResourcesNetworkCard `json:"vfs" yaml:"vfs"` }
ResourcesNetworkCardSRIOV represents the SRIOV configuration of the network card
swagger:model
API extension: resources_v2.
type ResourcesNetworkCardVDPA ¶
type ResourcesNetworkCardVDPA struct { // Name of the VDPA device Name string `json:"name" yaml:"name"` // Device identifier of the VDPA device Device string `json:"device" yaml:"device"` }
ResourceNetworkCardVDPA represents the VDPA configuration of the network card
swagger:model
API extension: ovn_nic_acceleration_vdpa.
type ResourcesPCI ¶
type ResourcesPCI struct { // List of PCI devices Devices []ResourcesPCIDevice `json:"devices" yaml:"devices"` // Total number of PCI devices // Example: 1 Total uint64 `json:"total" yaml:"total"` }
ResourcesPCI represents the PCI devices available on the system
swagger:model
API extension: resources_usb_pci.
type ResourcesPCIDevice ¶
type ResourcesPCIDevice struct { // Kernel driver currently associated with the GPU // Example: mgag200 Driver string `json:"driver" yaml:"driver"` // Version of the kernel driver // Example: 5.8.0-36-generic DriverVersion string `json:"driver_version" yaml:"driver_version"` // NUMA node the card is a part of // Example: 0 NUMANode uint64 `json:"numa_node" yaml:"numa_node"` // PCI address // Example: 0000:07:03.0 PCIAddress string `json:"pci_address" yaml:"pci_address"` // Name of the vendor // Example: Matrox Electronics Systems Ltd. Vendor string `json:"vendor" yaml:"vendor"` // PCI ID of the vendor // Example: 102b VendorID string `json:"vendor_id" yaml:"vendor_id"` // Name of the product // Example: MGA G200eW WPCM450 Product string `json:"product" yaml:"product"` // PCI ID of the product // Example: 0532 ProductID string `json:"product_id" yaml:"product_id"` // IOMMU group number // Example: 20 // // API extension: resources_pci_iommu IOMMUGroup uint64 `json:"iommu_group" yaml:"iommu_group"` // Vital Product Data // Example: // // API extension: resources_pci_vpd VPD ResourcesPCIVPD `json:"vpd" yaml:"vpd"` }
ResourcesPCIDevice represents a PCI device
swagger:model
API extension: resources_usb_pci.
type ResourcesPCIVPD ¶
type ResourcesPCIVPD struct { // Hardware provided product name. // Example: HP Ethernet 1Gb 4-port 331i Adapter ProductName string `json:"product_name,omitempty" yaml:"product_name,omitempty"` // Vendor provided key/value pairs. // Example: {"EC": ""A-5545", "MN": "103C", "V0": "5W PCIeGen2"} Entries map[string]string `json:"entries,omitempty" yaml:"entries,omitempty"` }
ResourcesPCIVPD represents VPD entries for a device
swagger:model
API extension: resources_pci_vpd.
type ResourcesStorage ¶
type ResourcesStorage struct { // List of disks Disks []ResourcesStorageDisk `json:"disks" yaml:"disks"` // Total number of partitions // Example: 1 Total uint64 `json:"total" yaml:"total"` }
ResourcesStorage represents the local storage
swagger:model
API extension: resources_v2.
type ResourcesStorageDisk ¶
type ResourcesStorageDisk struct { // ID of the disk (device name) // Example: nvme0n1 ID string `json:"id" yaml:"id"` // Device number // Example: 259:0 Device string `json:"device" yaml:"device"` // Disk model name // Example: INTEL SSDPEKKW256G7 Model string `json:"model,omitempty" yaml:"model,omitempty"` // Storage type // Example: nvme Type string `json:"type,omitempty" yaml:"type,omitempty"` // Whether the disk is read-only // Example: false ReadOnly bool `json:"read_only" yaml:"read_only"` // Total size of the disk (bytes) // Example: 256060514304 Size uint64 `json:"size" yaml:"size"` // Whether the disk is removable (hot-plug) // Example: false Removable bool `json:"removable" yaml:"removable"` // WWN identifier // Example: eui.0000000001000000e4d25cafae2e4c00 WWN string `json:"wwn,omitempty" yaml:"wwn,omitempty"` // NUMA node the disk is a part of // Example: 0 NUMANode uint64 `json:"numa_node" yaml:"numa_node"` // Device by-path identifier // Example: pci-0000:05:00.0-nvme-1 // // API extension: resources_disk_sata DevicePath string `json:"device_path,omitempty" yaml:"device_path,omitempty"` // Block size // Example: 512 // // API extension: resources_disk_sata BlockSize uint64 `json:"block_size" yaml:"block_size"` // Current firmware version // Example: PSF121C // // API extension: resources_disk_sata FirmwareVersion string `json:"firmware_version,omitempty" yaml:"firmware_version,omitempty"` // Rotation speed (RPM) // Example: 0 // // API extension: resources_disk_sata RPM uint64 `json:"rpm" yaml:"rpm"` // Serial number // Example: BTPY63440ARH256D // // API extension: resources_disk_sata Serial string `json:"serial,omitempty" yaml:"serial,omitempty"` // Device by-id identifier // Example: nvme-eui.0000000001000000e4d25cafae2e4c00 // // API extension: resources_disk_id DeviceID string `json:"device_id" yaml:"device_id"` // List of partitions Partitions []ResourcesStorageDiskPartition `json:"partitions" yaml:"partitions"` // PCI address // Example: 0000:05:00.0 // // API extension: resources_disk_address PCIAddress string `json:"pci_address,omitempty" yaml:"pci_address,omitempty"` // USB address // Example: 3:5 // // API extension: resources_disk_address USBAddress string `json:"usb_address,omitempty" yaml:"usb_address,omitempty"` }
ResourcesStorageDisk represents a disk
swagger:model
API extension: resources_v2.
type ResourcesStorageDiskPartition ¶
type ResourcesStorageDiskPartition struct { // ID of the partition (device name) // Example: nvme0n1p1 ID string `json:"id" yaml:"id"` // Device number // Example: 259:1 Device string `json:"device" yaml:"device"` // Whether the partition is read-only // Example: false ReadOnly bool `json:"read_only" yaml:"read_only"` // Size of the partition (bytes) // Example: 254933278208 Size uint64 `json:"size" yaml:"size"` // Partition number // Example: 1 Partition uint64 `json:"partition" yaml:"partition"` }
ResourcesStorageDiskPartition represents a partition on a disk
swagger:model
API extension: resources_v2.
type ResourcesStoragePool ¶
type ResourcesStoragePool struct { // Disk space usage Space ResourcesStoragePoolSpace `json:"space,omitempty" yaml:"space,omitempty"` // DIsk inode usage Inodes ResourcesStoragePoolInodes `json:"inodes,omitempty" yaml:"inodes,omitempty"` }
ResourcesStoragePool represents the resources available to a given storage pool
swagger:model
API extension: resources.
type ResourcesStoragePoolInodes ¶
type ResourcesStoragePoolInodes struct { // Used inodes // Example: 23937695 Used uint64 `json:"used" yaml:"used"` // Total inodes // Example: 30709993797 Total uint64 `json:"total" yaml:"total"` }
ResourcesStoragePoolInodes represents the inodes available to a given storage pool
swagger:model
API extension: resources.
type ResourcesStoragePoolSpace ¶
type ResourcesStoragePoolSpace struct { // Used disk space (bytes) // Example: 343537419776 Used uint64 `json:"used,omitempty" yaml:"used,omitempty"` // Total disk space (bytes) // Example: 420100937728 Total uint64 `json:"total" yaml:"total"` }
ResourcesStoragePoolSpace represents the space available to a given storage pool
swagger:model
API extension: resources.
type ResourcesSystem ¶
type ResourcesSystem struct { // System UUID // Example: 7fa1c0cc-2271-11b2-a85c-aab32a05d71a UUID string `json:"uuid" yaml:"uuid"` // System vendor // Example: LENOVO Vendor string `json:"vendor" yaml:"vendor"` // System model // Example: 20HRCTO1WW Product string `json:"product" yaml:"product"` // System family // Example: ThinkPad X1 Carbon 5th Family string `json:"family" yaml:"family"` // System version // Example: ThinkPad X1 Carbon 5th Version string `json:"version" yaml:"version"` // System nanufacturer SKU // LENOVO_MT_20HR_BU_Think_FM_ThinkPad X1 Carbon 5th Sku string `json:"sku" yaml:"sku"` // System serial number // Example: PY3DD4X9 Serial string `json:"serial" yaml:"serial"` // System type (unknown, physical, virtual-machine, container, ...) // Example: physical Type string `json:"type" yaml:"type"` // Firmware details Firmware *ResourcesSystemFirmware `json:"firmware" yaml:"firmware"` // Chassis details Chassis *ResourcesSystemChassis `json:"chassis" yaml:"chassis"` // Motherboard details Motherboard *ResourcesSystemMotherboard `json:"motherboard" yaml:"motherboard"` }
ResourcesSystem represents the system
swagger:model
API extension: resources_system.
type ResourcesSystemChassis ¶
type ResourcesSystemChassis struct { // Chassis vendor // Example: Lenovo Vendor string `json:"vendor" yaml:"vendor"` // Chassis type // Example: Notebook Type string `json:"type" yaml:"type"` // Chassis serial number // Example: PY3DD4X9 Serial string `json:"serial" yaml:"serial"` // Chassis version/revision // Example: None Version string `json:"version" yaml:"version"` }
ResourcesSystemChassis represents the system chassis
swagger:model
API extension: resources_system.
type ResourcesSystemFirmware ¶
type ResourcesSystemFirmware struct { // Firmware vendor // Example: Lenovo Vendor string `json:"vendor" yaml:"vendor"` // Firmware build date // Example: 10/14/2020 Date string `json:"date" yaml:"date"` // Firmware version // Example: N1MET64W (1.49) Version string `json:"version" yaml:"version"` }
ResourcesSystemFirmware represents the system firmware
swagger:model
API extension: resources_system.
type ResourcesSystemMotherboard ¶
type ResourcesSystemMotherboard struct { // Motherboard vendor // Example: Lenovo Vendor string `json:"vendor" yaml:"vendor"` // Motherboard model // Example: 20HRCTO1WW Product string `json:"product" yaml:"product"` // Motherboard serial number // Example: L3CF4FX003A Serial string `json:"serial" yaml:"serial"` // Motherboard version/revision // Example: None Version string `json:"version" yaml:"version"` }
ResourcesSystemMotherboard represents the motherboard
swagger:model
API extension: resources_system.
type ResourcesUSB ¶
type ResourcesUSB struct { // List of USB devices Devices []ResourcesUSBDevice `json:"devices" yaml:"devices"` // Total number of USB devices // Example: 1 Total uint64 `json:"total" yaml:"total"` }
ResourcesUSB represents the USB devices available on the system
swagger:model
API extension: resources_usb_pci.
type ResourcesUSBDevice ¶
type ResourcesUSBDevice struct { // USB address (bus) // Example: 1 BusAddress uint64 `json:"bus_address" yaml:"bus_address"` // USB address (device) // Example: 3 DeviceAddress uint64 `json:"device_address" yaml:"device_address"` // USB serial number // Example: DAE005fp // // API extension: device_usb_serial. Serial string `json:"serial" yaml:"serial"` // List of USB interfaces Interfaces []ResourcesUSBDeviceInterface `json:"interfaces" yaml:"interfaces"` // Name of the vendor // Example: ATEN International Co., Ltd Vendor string `json:"vendor" yaml:"vendor"` // USB ID of the vendor // Example: 0557 VendorID string `json:"vendor_id" yaml:"vendor_id"` // Name of the product // Example: Hermon USB hidmouse Device Product string `json:"product" yaml:"product"` // USB ID of the product // Example: 2221 ProductID string `json:"product_id" yaml:"product_id"` // Transfer speed (Mbit/s) // Example: 12 Speed float64 `json:"speed" yaml:"speed"` }
ResourcesUSBDevice represents a USB device
swagger:model
API extension: resources_usb_pci.
type ResourcesUSBDeviceInterface ¶
type ResourcesUSBDeviceInterface struct { // Class of USB interface // Example: Human Interface Device Class string `json:"class" yaml:"class"` // ID of the USB interface class // Example: 3 ClassID uint64 `json:"class_id" yaml:"class_id"` // Kernel driver currently associated with the device // Example: usbhid Driver string `json:"driver" yaml:"driver"` // Version of the kernel driver // Example: 5.8.0-36-generic DriverVersion string `json:"driver_version" yaml:"driver_version"` // Interface number // Example: 0 Number uint64 `json:"number" yaml:"number"` // Sub class of the interface // Example: Boot Interface Subclass SubClass string `json:"subclass" yaml:"subclass"` // ID of the USB interface sub class // Example: 1 SubClassID uint64 `json:"subclass_id" yaml:"subclass_id"` }
ResourcesUSBDeviceInterface represents a USB device interface
swagger:model
API extension: resources_usb_pci.
type Response ¶
type Response struct { Type ResponseType `json:"type" yaml:"type"` // Valid only for Sync responses Status string `json:"status" yaml:"status"` StatusCode int `json:"status_code" yaml:"status_code"` // Valid only for Async responses Operation string `json:"operation" yaml:"operation"` // Valid only for Error responses Code int `json:"error_code" yaml:"error_code"` Error string `json:"error" yaml:"error"` // Valid for Sync and Error responses Metadata json.RawMessage `json:"metadata" yaml:"metadata"` }
Response represents an operation.
func (*Response) MetadataAsMap ¶
MetadataAsMap parses the Response metadata into a map.
func (*Response) MetadataAsOperation ¶
MetadataAsOperation turns the Response metadata into an Operation.
func (*Response) MetadataAsStringSlice ¶
MetadataAsStringSlice parses the Response metadata into a slice of string.
func (*Response) MetadataAsStruct ¶
MetadataAsStruct parses the Response metadata into a provided struct.
type ResponseRaw ¶
type ResponseRaw struct { Type ResponseType `json:"type" yaml:"type"` // Valid only for Sync responses Status string `json:"status" yaml:"status"` StatusCode int `json:"status_code" yaml:"status_code"` // Valid only for Async responses Operation string `json:"operation" yaml:"operation"` // Valid only for Error responses Code int `json:"error_code" yaml:"error_code"` Error string `json:"error" yaml:"error"` Metadata any `json:"metadata" yaml:"metadata"` }
ResponseRaw represents an operation in its original form.
type ResponseType ¶
type ResponseType string
ResponseType represents a valid response type.
const ( SyncResponse ResponseType = "sync" AsyncResponse ResponseType = "async" ErrorResponse ResponseType = "error" )
Response types.
type Server ¶
type Server struct { ServerUntrusted `yaml:",inline"` // The current API user identifier // Read only: true // Example: uid=201105 // // API extension: auth_user AuthUserName string `json:"auth_user_name" yaml:"auth_user_name"` // The current API user login method // Read only: true // Example: unix // // API extension: auth_user AuthUserMethod string `json:"auth_user_method" yaml:"auth_user_method"` // Read-only status/configuration information // Read only: true Environment ServerEnvironment `json:"environment" yaml:"environment"` }
Server represents a server configuration
swagger:model
type ServerEnvironment ¶
type ServerEnvironment struct { // List of addresses the server is listening on // Example: [":8443"] Addresses []string `json:"addresses" yaml:"addresses"` // List of architectures supported by the server // Example: ["x86_64", "i686"] Architectures []string `json:"architectures" yaml:"architectures"` // Server certificate as PEM encoded X509 // Example: X509 PEM certificate Certificate string `json:"certificate" yaml:"certificate"` // Server certificate fingerprint as SHA256 // Example: fd200419b271f1dc2a5591b693cc5774b7f234e1ff8c6b78ad703b6888fe2b69 CertificateFingerprint string `json:"certificate_fingerprint" yaml:"certificate_fingerprint"` // List of supported instance drivers (separate by " | ") // Example: lxc | qemu Driver string `json:"driver" yaml:"driver"` // List of supported instance driver versions (separate by " | ") // Example: 4.0.7 | 5.2.0 DriverVersion string `json:"driver_version" yaml:"driver_version"` // Current firewall driver // Example: nftables // // API extension: firewall_driver Firewall string `json:"firewall" yaml:"firewall"` // OS kernel name // Example: Linux Kernel string `json:"kernel" yaml:"kernel"` // OS kernel architecture // Example: x86_64 KernelArchitecture string `json:"kernel_architecture" yaml:"kernel_architecture"` // Map of kernel features that were tested on startup // Example: {"netnsid_getifaddrs": "true", "seccomp_listener": "true"} // // API extension: kernel_features KernelFeatures map[string]string `json:"kernel_features" yaml:"kernel_features"` // Kernel version // Example: 5.4.0-36-generic KernelVersion string `json:"kernel_version" yaml:"kernel_version"` // Map of LXC features that were tested on startup // Example: {"cgroup2": "true", "devpts_fd": "true", "pidfd": "true"} // // API extension: lxc_features LXCFeatures map[string]string `json:"lxc_features" yaml:"lxc_features"` // Name of the operating system (Linux distribution) // Example: Ubuntu // // API extension: api_os OSName string `json:"os_name" yaml:"os_name"` // Version of the operating system (Linux distribution) // Example: 22.04 // // API extension: api_os OSVersion string `json:"os_version" yaml:"os_version"` // Current project name // Example: default // // API extension: projects Project string `json:"project" yaml:"project"` // Server implementation name // Example: incus Server string `json:"server" yaml:"server"` // Whether the server is part of a cluster // Example: false // // API extension: clustering ServerClustered bool `json:"server_clustered" yaml:"server_clustered"` // Mode that the event distribution subsystem is operating in on this server. // Either "full-mesh", "hub-server" or "hub-client". // Example: full-mesh // // API extension: event_hub ServerEventMode string `json:"server_event_mode" yaml:"server_event_mode"` // Server hostname // Example: castiana // // API extension: clustering ServerName string `json:"server_name" yaml:"server_name"` // PID of the daemon // Example: 1453969 ServerPid int `json:"server_pid" yaml:"server_pid"` // Server version // Example: 4.11 ServerVersion string `json:"server_version" yaml:"server_version"` // List of active storage drivers (separate by " | ") // Example: dir | zfs Storage string `json:"storage" yaml:"storage"` // List of active storage driver versions (separate by " | ") // Example: 1 | 0.8.4-1ubuntu11 StorageVersion string `json:"storage_version" yaml:"storage_version"` // List of supported storage drivers StorageSupportedDrivers []ServerStorageDriverInfo `json:"storage_supported_drivers" yaml:"storage_supported_drivers"` }
ServerEnvironment represents the read-only environment fields of a server configuration.
type ServerPut ¶
type ServerPut struct { // Server configuration map (refer to doc/server.md) // Example: {"core.https_address": ":8443"} Config map[string]string `json:"config" yaml:"config"` }
ServerPut represents the modifiable fields of a server configuration
swagger:model
type ServerStorageDriverInfo ¶
type ServerStorageDriverInfo struct { // Name of the driver // Example: zfs // // API extension: server_supported_storage_drivers Name string // Version of the driver // Example: 0.8.4-1ubuntu11 // // API extension: server_supported_storage_drivers Version string // Whether the driver has remote volumes // Example: false // // API extension: server_supported_storage_drivers Remote bool }
ServerStorageDriverInfo represents the read-only info about a storage driver
swagger:model
API extension: server_supported_storage_drivers.
type ServerUntrusted ¶
type ServerUntrusted struct { ServerPut `yaml:",inline"` // List of supported API extensions // Read only: true // Example: ["etag", "patch", "network", "storage"] APIExtensions []string `json:"api_extensions" yaml:"api_extensions"` // Support status of the current API (one of "devel", "stable" or "deprecated") // Read only: true // Example: stable APIStatus string `json:"api_status" yaml:"api_status"` // API version number // Read only: true // Example: 1.0 APIVersion string `json:"api_version" yaml:"api_version"` // Whether the client is trusted (one of "trusted" or "untrusted") // Read only: true // Example: untrusted Auth string `json:"auth" yaml:"auth"` // Whether the server is public-only (only public endpoints are implemented) // Read only: true // Example: false Public bool `json:"public" yaml:"public"` // List of supported authentication methods // Read only: true // Example: ["tls"] // // API extension: macaroon_authentication AuthMethods []string `json:"auth_methods" yaml:"auth_methods"` }
ServerUntrusted represents a server configuration for an untrusted client
swagger:model
type StatusCode ¶
type StatusCode int
StatusCode represents a valid operation and container status.
const ( OperationCreated StatusCode = 100 Started StatusCode = 101 Stopped StatusCode = 102 Running StatusCode = 103 Cancelling StatusCode = 104 Pending StatusCode = 105 Starting StatusCode = 106 Stopping StatusCode = 107 Aborting StatusCode = 108 Freezing StatusCode = 109 Frozen StatusCode = 110 Thawed StatusCode = 111 Error StatusCode = 112 Ready StatusCode = 113 Success StatusCode = 200 Failure StatusCode = 400 Cancelled StatusCode = 401 )
Status codes.
func StatusCodeFromString ¶
func StatusCodeFromString(status string) StatusCode
StatusCodeFromString returns the status code of the giving status name.
func (StatusCode) IsFinal ¶
func (o StatusCode) IsFinal() bool
IsFinal will return true if the status code indicates an end state.
func (StatusCode) String ¶
func (o StatusCode) String() string
String returns a suitable string representation for the status code.
type StatusError ¶
type StatusError struct {
// contains filtered or unexported fields
}
StatusError error type that contains an HTTP status code and message.
func StatusErrorf ¶
func StatusErrorf(status int, format string, a ...any) StatusError
StatusErrorf returns a new StatusError containing the specified status and message.
func (StatusError) Error ¶
func (e StatusError) Error() string
Error returns the error message or the http.StatusText() of the status code if message is empty.
type StorageBucket ¶
type StorageBucket struct { StorageBucketPut `yaml:",inline"` // Bucket name // Example: foo // // API extension: storage_buckets Name string `json:"name" yaml:"name"` // Bucket S3 URL // Example: https://127.0.0.1:8080/foo // // API extension: storage_buckets S3URL string `json:"s3_url" yaml:"s3_url"` // What cluster member this record was found on // Example: server01 // // API extension: storage_buckets Location string `json:"location" yaml:"location"` // Project name // Example: project1 // // API extension: storage_buckets_all_projects Project string `json:"project" yaml:"project"` }
StorageBucket represents the fields of a storage pool bucket
swagger:model
API extension: storage_buckets.
func (*StorageBucket) Etag ¶
func (b *StorageBucket) Etag() []any
Etag returns the values used for etag generation.
func (*StorageBucket) URL ¶
func (b *StorageBucket) URL(apiVersion string, poolName string, projectName string) *URL
URL returns the URL for the bucket.
func (*StorageBucket) Writable ¶
func (b *StorageBucket) Writable() StorageBucketPut
Writable converts a full StorageBucket struct into a StorageBucketPut struct (filters read-only fields).
type StorageBucketBackup ¶
type StorageBucketBackup struct { // Backup name // Example: backup0 Name string `json:"name" yaml:"name"` // When the backup expires (gets auto-deleted) // Example: 2021-03-23T17:38:37.753398689-04:00 ExpiresAt time.Time `json:"expires_at" yaml:"expires_at"` // What compression algorithm to use // Example: gzip CompressionAlgorithm string `json:"compression_algorithm" yaml:"compression_algorithm"` }
StorageBucketBackup represents the fields available for a new storage bucket backup
swagger:model
API extension: storage_bucket_backup.
type StorageBucketBackupPost ¶
type StorageBucketBackupPost struct { // New backup name // Example: backup1 Name string `json:"name" yaml:"name"` }
StorageBucketBackupPost represents the fields available for the renaming of a bucket backup
swagger:model
API extension: storage_bucket_backup.
type StorageBucketBackupsPost ¶
type StorageBucketBackupsPost struct { // Backup name // Example: backup0 Name string `json:"name" yaml:"name"` // When the backup expires (gets auto-deleted) // Example: 2021-03-23T17:38:37.753398689-04:00 ExpiresAt time.Time `json:"expires_at" yaml:"expires_at"` // What compression algorithm to use // Example: gzip CompressionAlgorithm string `json:"compression_algorithm" yaml:"compression_algorithm"` }
StorageBucketBackupsPost represents the fields available for a new storage bucket backup
swagger:model
API extension: storage_bucket_backup.
type StorageBucketKey ¶
type StorageBucketKey struct { StorageBucketKeyPut `yaml:",inline"` // Key name // Example: my-read-only-key // // API extension: storage_buckets Name string `json:"name" yaml:"name"` }
StorageBucketKey represents the fields of a storage pool bucket key
swagger:model
API extension: storage_buckets.
func (*StorageBucketKey) Etag ¶
func (b *StorageBucketKey) Etag() []any
Etag returns the values used for etag generation.
func (*StorageBucketKey) URL ¶
func (b *StorageBucketKey) URL(apiVersion string, poolName string, projectName string, bucketName string) *URL
URL for the deployment instance set.
func (*StorageBucketKey) Writable ¶
func (b *StorageBucketKey) Writable() StorageBucketKeyPut
Writable converts a full StorageBucketKey struct into a StorageBucketKeyPut struct (filters read-only fields).
type StorageBucketKeyPut ¶
type StorageBucketKeyPut struct { // Description of the storage bucket key // Example: My read-only bucket key // // API extension: storage_buckets Description string `json:"description" yaml:"description"` // Whether the key can perform write actions or not. // Example: read-only // // API extension: storage_buckets Role string `json:"role" yaml:"role"` // Access key // Example: 33UgkaIBLBIxb7O1 // // API extension: storage_buckets AccessKey string `json:"access-key" yaml:"access-key"` // Secret key // Example: kDQD6AOgwHgaQI1UIJBJpPaiLgZuJbq0 // // API extension: storage_buckets SecretKey string `json:"secret-key" yaml:"secret-key"` }
StorageBucketKeyPut represents the modifiable fields of a storage pool bucket key
swagger:model
API extension: storage_buckets.
type StorageBucketKeysPost ¶
type StorageBucketKeysPost struct { StorageBucketKeyPut `yaml:",inline"` // Key name // Example: my-read-only-key // // API extension: storage_buckets Name string `json:"name" yaml:"name"` }
StorageBucketKeysPost represents the fields of a new storage pool bucket key
swagger:model
API extension: storage_buckets.
type StorageBucketPut ¶
type StorageBucketPut struct { // Storage bucket configuration map // Example: {"size": "50GiB"} // // API extension: storage_buckets Config map[string]string `json:"config" yaml:"config"` // Description of the storage bucket // Example: My custom bucket // // API extension: storage_buckets Description string `json:"description" yaml:"description"` }
StorageBucketPut represents the modifiable fields of a storage pool bucket
swagger:model
API extension: storage_buckets.
type StorageBucketsPost ¶
type StorageBucketsPost struct { StorageBucketPut `yaml:",inline"` // Bucket name // Example: foo // // API extension: storage_buckets Name string `json:"name" yaml:"name"` }
StorageBucketsPost represents the fields of a new storage pool bucket
swagger:model
API extension: storage_buckets.
type StoragePool ¶
type StoragePool struct { StoragePoolPut `yaml:",inline"` // Storage pool name // Example: local Name string `json:"name" yaml:"name"` // Storage pool driver (btrfs, ceph, cephfs, cephobject, dir, lvm, lvmcluster or zfs) // Example: zfs Driver string `json:"driver" yaml:"driver"` // List of URLs of objects using this storage pool // Example: ["/1.0/profiles/default", "/1.0/instances/c1"] UsedBy []string `json:"used_by" yaml:"used_by"` // Pool status (Pending, Created, Errored or Unknown) // Read only: true // Example: Created // // API extension: clustering Status string `json:"status" yaml:"status"` // Cluster members on which the storage pool has been defined // Read only: true // Example: ["server01", "server02", "server03"] // // API extension: clustering Locations []string `json:"locations" yaml:"locations"` }
StoragePool represents the fields of a storage pool.
swagger:model
API extension: storage.
func (*StoragePool) Writable ¶
func (storagePool *StoragePool) Writable() StoragePoolPut
Writable converts a full StoragePool struct into a StoragePoolPut struct (filters read-only fields).
type StoragePoolPut ¶
type StoragePoolPut struct { // Storage pool configuration map (refer to doc/storage.md) // Example: {"volume.block.filesystem": "ext4", "volume.size": "50GiB"} Config map[string]string `json:"config" yaml:"config"` // Description of the storage pool // Example: Local SSD pool // // API extension: entity_description Description string `json:"description" yaml:"description"` }
StoragePoolPut represents the modifiable fields of a storage pool.
swagger:model
API extension: storage.
type StoragePoolState ¶
type StoragePoolState struct {
ResourcesStoragePool `yaml:",inline"`
}
StoragePoolState represents the state of a storage pool.
swagger:model
API extension: cluster_member_state.
type StoragePoolsPost ¶
type StoragePoolsPost struct { StoragePoolPut `yaml:",inline"` // Storage pool name // Example: local Name string `json:"name" yaml:"name"` // Storage pool driver (btrfs, ceph, cephfs, cephobject, dir, lvm, lvmcluster or zfs) // Example: zfs Driver string `json:"driver" yaml:"driver"` }
StoragePoolsPost represents the fields of a new storage pool
swagger:model
API extension: storage.
type StorageVolume ¶
type StorageVolume struct { StorageVolumePut `yaml:",inline"` // Volume name // Example: foo Name string `json:"name" yaml:"name"` // Volume type // Example: custom Type string `json:"type" yaml:"type"` // List of URLs of objects using this storage volume // Example: ["/1.0/instances/blah"] UsedBy []string `json:"used_by" yaml:"used_by"` // What cluster member this record was found on // Example: server01 // // API extension: clustering Location string `json:"location" yaml:"location"` // Volume content type (filesystem or block) // Example: filesystem // // API extension: custom_block_volumes ContentType string `json:"content_type" yaml:"content_type"` // Project containing the volume. // Example: default // // API extension: storage_volumes_all_projects Project string `json:"project" yaml:"project"` // Volume creation timestamp // Example: 2021-03-23T20:00:00-04:00 // API extension: storage_volumes_created_at CreatedAt time.Time `json:"created_at" yaml:"created_at"` }
StorageVolume represents the fields of a storage volume.
swagger:model
API extension: storage.
func (*StorageVolume) URL ¶
func (v *StorageVolume) URL(apiVersion string, poolName string) *URL
URL returns the URL for the volume.
func (*StorageVolume) Writable ¶
func (storageVolume *StorageVolume) Writable() StorageVolumePut
Writable converts a full StorageVolume struct into a StorageVolumePut struct (filters read-only fields).
type StorageVolumeBackup ¶ added in v6.0.2
type StorageVolumeBackup struct { // Backup name // Example: backup0 Name string `json:"name" yaml:"name"` // When the backup was created // Example: 2021-03-23T16:38:37.753398689-04:00 CreatedAt time.Time `json:"created_at" yaml:"created_at"` // When the backup expires (gets auto-deleted) // Example: 2021-03-23T17:38:37.753398689-04:00 ExpiresAt time.Time `json:"expires_at" yaml:"expires_at"` // Whether to ignore snapshots // Example: false VolumeOnly bool `json:"volume_only" yaml:"volume_only"` // Whether to use a pool-optimized binary format (instead of plain tarball) // Example: true OptimizedStorage bool `json:"optimized_storage" yaml:"optimized_storage"` }
StorageVolumeBackup represents a volume backup
swagger:model
API extension: custom_volume_backup.
type StorageVolumeBackupPost ¶ added in v6.0.2
type StorageVolumeBackupPost struct { // New backup name // Example: backup1 Name string `json:"name" yaml:"name"` }
StorageVolumeBackupPost represents the fields available for the renaming of a volume backup
swagger:model
API extension: custom_volume_backup.
type StorageVolumeBackupsPost ¶ added in v6.0.2
type StorageVolumeBackupsPost struct { // Backup name // Example: backup0 Name string `json:"name" yaml:"name"` // When the backup expires (gets auto-deleted) // Example: 2021-03-23T17:38:37.753398689-04:00 ExpiresAt time.Time `json:"expires_at" yaml:"expires_at"` // Whether to ignore snapshots // Example: false VolumeOnly bool `json:"volume_only" yaml:"volume_only"` // Whether to use a pool-optimized binary format (instead of plain tarball) // Example: true OptimizedStorage bool `json:"optimized_storage" yaml:"optimized_storage"` // What compression algorithm to use // Example: gzip CompressionAlgorithm string `json:"compression_algorithm" yaml:"compression_algorithm"` }
StorageVolumeBackupsPost represents the fields available for a new volume backup
swagger:model
API extension: custom_volume_backup.
type StorageVolumePost ¶
type StorageVolumePost struct { // New volume name // Example: foo Name string `json:"name" yaml:"name"` // New storage pool // Example: remote // // API extension: storage_api_local_volume_handling Pool string `json:"pool,omitempty" yaml:"pool,omitempty"` // Initiate volume migration // Example: false // // API extension: storage_api_remote_volume_handling Migration bool `json:"migration" yaml:"migration"` // Migration target (for push mode) // // API extension: storage_api_remote_volume_handling Target *StorageVolumePostTarget `json:"target" yaml:"target"` // Whether snapshots should be discarded (migration only) // Example: false // // API extension: storage_api_remote_volume_snapshots VolumeOnly bool `json:"volume_only" yaml:"volume_only"` // New project name // Example: foo // // API extension: storage_volume_project_move Project string `json:"project,omitempty" yaml:"project,omitempty"` // Migration source // // API extension: cluster_internal_custom_volume_copy Source StorageVolumeSource `json:"source" yaml:"source"` }
StorageVolumePost represents the fields required to rename a storage pool volume
swagger:model
API extension: storage_api_volume_rename.
type StorageVolumePostTarget ¶
type StorageVolumePostTarget struct { // The certificate of the migration target // Example: X509 PEM certificate Certificate string `json:"certificate" yaml:"certificate"` // Remote operation URL (for migration) // Example: https://1.2.3.4:8443/1.0/operations/1721ae08-b6a8-416a-9614-3f89302466e1 Operation string `json:"operation,omitempty" yaml:"operation,omitempty"` // Migration websockets credentials // Example: {"migration": "random-string"} Websockets map[string]string `json:"secrets,omitempty" yaml:"secrets,omitempty"` }
StorageVolumePostTarget represents the migration target host and operation
swagger:model
API extension: storage_api_remote_volume_handling.
type StorageVolumePut ¶
type StorageVolumePut struct { // Storage volume configuration map (refer to doc/storage.md) // Example: {"zfs.remove_snapshots": "true", "size": "50GiB"} Config map[string]string `json:"config" yaml:"config"` // Description of the storage volume // Example: My custom volume // // API extension: entity_description Description string `json:"description" yaml:"description"` // Name of a snapshot to restore // Example: snap0 // // API extension: storage_api_volume_snapshots Restore string `json:"restore,omitempty" yaml:"restore,omitempty"` }
StorageVolumePut represents the modifiable fields of a storage volume
swagger:model
API extension: storage.
type StorageVolumeSnapshot ¶
type StorageVolumeSnapshot struct { StorageVolumeSnapshotPut `json:",inline" yaml:",inline"` // Snapshot name // Example: snap0 Name string `json:"name" yaml:"name"` // Storage volume configuration map (refer to doc/storage.md) // Example: {"zfs.remove_snapshots": "true", "size": "50GiB"} Config map[string]string `json:"config" yaml:"config"` // The content type (filesystem or block) // Example: filesystem // // API extension: custom_block_volumes ContentType string `json:"content_type" yaml:"content_type"` // Volume snapshot creation timestamp // Example: 2021-03-23T20:00:00-04:00 // API extension: storage_volumes_created_at CreatedAt time.Time `json:"created_at" yaml:"created_at"` }
StorageVolumeSnapshot represents a storage volume snapshot
swagger:model
API extension: storage_api_volume_snapshots.
func (*StorageVolumeSnapshot) Writable ¶
func (storageVolumeSnapshot *StorageVolumeSnapshot) Writable() StorageVolumeSnapshotPut
Writable converts a full StorageVolumeSnapshot struct into a StorageVolumeSnapshotPut struct (filters read-only fields).
type StorageVolumeSnapshotPost ¶
type StorageVolumeSnapshotPost struct { // New snapshot name // Example: snap1 Name string `json:"name" yaml:"name"` // Initiate volume snapshot migration // Example: false // // API extension: storage_api_remote_volume_snapshot_copy Migration bool `json:"migration" yaml:"migration"` // Migration target (for push mode) // // API extension: storage_api_remote_volume_snapshot_copy Target *StorageVolumePostTarget `json:"target" yaml:"target"` }
StorageVolumeSnapshotPost represents the fields required to rename/move a storage volume snapshot
swagger:model
API extension: storage_api_volume_snapshots.
type StorageVolumeSnapshotPut ¶
type StorageVolumeSnapshotPut struct { // Description of the storage volume // Example: My custom volume Description string `json:"description" yaml:"description"` // When the snapshot expires (gets auto-deleted) // Example: 2021-03-23T17:38:37.753398689-04:00 // // API extension: custom_volume_snapshot_expiry ExpiresAt *time.Time `json:"expires_at" yaml:"expires_at"` }
StorageVolumeSnapshotPut represents the modifiable fields of a storage volume
swagger:model
API extension: storage_api_volume_snapshots.
type StorageVolumeSnapshotsPost ¶
type StorageVolumeSnapshotsPost struct { // Snapshot name // Example: snap0 Name string `json:"name" yaml:"name"` // When the snapshot expires (gets auto-deleted) // Example: 2021-03-23T17:38:37.753398689-04:00 // // API extension: custom_volume_snapshot_expiry ExpiresAt *time.Time `json:"expires_at" yaml:"expires_at"` }
StorageVolumeSnapshotsPost represents the fields available for a new storage volume snapshot
swagger:model
API extension: storage_api_volume_snapshots.
type StorageVolumeSource ¶
type StorageVolumeSource struct { // Source volume name (for copy) // Example: foo Name string `json:"name" yaml:"name"` // Source type (copy or migration) // Example: copy Type string `json:"type" yaml:"type"` // Source storage pool (for copy) // Example: local Pool string `json:"pool" yaml:"pool"` // Certificate (for migration) // Example: X509 PEM certificate // // API extension: storage_api_remote_volume_handling Certificate string `json:"certificate" yaml:"certificate"` // Whether to use pull or push mode (for migration) // Example: pull // // API extension: storage_api_remote_volume_handling Mode string `json:"mode,omitempty" yaml:"mode,omitempty"` // Remote operation URL (for migration) // Example: https://1.2.3.4:8443/1.0/operations/1721ae08-b6a8-416a-9614-3f89302466e1 // // API extension: storage_api_remote_volume_handling Operation string `json:"operation,omitempty" yaml:"operation,omitempty"` // Map of migration websockets (for migration) // Example: {"rsync": "RANDOM-STRING"} // // API extension: storage_api_remote_volume_handling Websockets map[string]string `json:"secrets,omitempty" yaml:"secrets,omitempty"` // Whether snapshots should be discarded (for migration) // Example: false // // API extension: storage_api_volume_snapshots VolumeOnly bool `json:"volume_only" yaml:"volume_only"` // Whether existing destination volume should be refreshed // Example: false // // API extension: custom_volume_refresh Refresh bool `json:"refresh" yaml:"refresh"` // Source project name // Example: foo // // API extension: storage_api_project Project string `json:"project,omitempty" yaml:"project,omitempty"` // What cluster member this record was found on // Example: server01 // // API extension: cluster_internal_custom_volume_copy Location string `json:"location" yaml:"location"` }
StorageVolumeSource represents the creation source for a new storage volume
swagger:model
API extension: storage_api_local_volume_handling.
type StorageVolumeState ¶
type StorageVolumeState struct { // Volume usage Usage *StorageVolumeStateUsage `json:"usage" yaml:"usage"` }
StorageVolumeState represents the live state of the volume
swagger:model
API extension: storage_volume_state.
type StorageVolumeStateUsage ¶
type StorageVolumeStateUsage struct { // Used space in bytes // Example: 1693552640 Used uint64 `json:"used,omitempty" yaml:"used,omitempty"` // Storage volume size in bytes // Example: 5189222192 // // API extension: storage_volume_state_total Total int64 `json:"total" yaml:"total"` }
StorageVolumeStateUsage represents the disk usage of a volume
swagger:model
API extension: storage_volume_state.
type StorageVolumesPost ¶
type StorageVolumesPost struct { StorageVolumePut `yaml:",inline"` // Volume name // Example: foo Name string `json:"name" yaml:"name"` // Volume type (container, custom, image or virtual-machine) // Example: custom Type string `json:"type" yaml:"type"` // Migration source // // API extension: storage_api_local_volume_handling Source StorageVolumeSource `json:"source" yaml:"source"` // Volume content type (filesystem or block) // Example: filesystem // // API extension: custom_block_volumes ContentType string `json:"content_type" yaml:"content_type"` }
StorageVolumesPost represents the fields of a new storage pool volume
swagger:model
API extension: storage.
type URL ¶
URL represents an endpoint for the REST API.
Example ¶
u := NewURL() fmt.Println(u.Path("1.0", "networks", "name-with-/-in-it")) fmt.Println(u.Project("default")) fmt.Println(u.Project("project-with-%-in-it")) fmt.Println(u.Target("")) fmt.Println(u.Target("member-with-%-in-it")) fmt.Println(u.Host("example.com")) fmt.Println(u.Scheme("https"))
Output: /1.0/networks/name-with-%2F-in-it /1.0/networks/name-with-%2F-in-it /1.0/networks/name-with-%2F-in-it?project=project-with-%25-in-it /1.0/networks/name-with-%2F-in-it?project=project-with-%25-in-it /1.0/networks/name-with-%2F-in-it?project=project-with-%25-in-it&target=member-with-%25-in-it //example.com/1.0/networks/name-with-%2F-in-it?project=project-with-%25-in-it&target=member-with-%25-in-it https://example.com/1.0/networks/name-with-%2F-in-it?project=project-with-%25-in-it&target=member-with-%25-in-it
func (*URL) Path ¶
Path sets the path of the URL from one or more path parts. It appends each of the pathParts (escaped using url.PathEscape) prefixed with "/" to the URL path.
func (*URL) Project ¶
Project sets the "project" query parameter in the URL if the projectName is not empty or "default".
type Warning ¶
type Warning struct { WarningPut `yaml:",inline"` // UUID of the warning // Example: e9e9da0d-2538-4351-8047-46d4a8ae4dbb UUID string `json:"uuid" yaml:"uuid"` // What cluster member this warning occurred on // Example: server01 Location string `json:"location" yaml:"location"` // The project the warning occurred in // Example: default Project string `json:"project" yaml:"project"` // Type type of warning // Example: Couldn't find CGroup Type string `json:"type" yaml:"type"` // The number of times this warning occurred // Example: 1 Count int `json:"count" yaml:"count"` // The first time this warning occurred // Example: 2021-03-23T17:38:37.753398689-04:00 FirstSeenAt time.Time `json:"first_seen_at" yaml:"first_seen_at"` // The last time this warning occurred // Example: 2021-03-23T17:38:37.753398689-04:00 LastSeenAt time.Time `json:"last_seen_at" yaml:"last_seen_at"` // The warning message // Example: Couldn't find the CGroup blkio.weight, disk priority will be ignored LastMessage string `json:"last_message" yaml:"last_message"` // The severity of this warning // Example: low Severity string `json:"severity" yaml:"severity"` // The entity affected by this warning // Example: /1.0/instances/c1?project=default EntityURL string `json:"entity_url" yaml:"entity_url"` }
Warning represents a warning entry.
swagger:model
API extension: warnings.
type WarningPut ¶
type WarningPut struct { // Status of the warning (new, acknowledged, or resolved) // Example: new Status string `json:"status" yaml:"status"` }
WarningPut represents the modifiable fields of a warning.
swagger:model
API extension: warnings.
Source Files ¶
- access.go
- auth.go
- certificate.go
- cluster.go
- cluster_state.go
- doc.go
- error.go
- event.go
- event_lifecycle.go
- headers.go
- image.go
- init.go
- instance.go
- instance_backup.go
- instance_console.go
- instance_exec.go
- instance_snapshot.go
- instance_state.go
- metadata.go
- migration.go
- network.go
- network_acl.go
- network_allocation.go
- network_forward.go
- network_integration.go
- network_load_balancer.go
- network_peer.go
- network_zone.go
- operation.go
- profile.go
- project.go
- resource.go
- response.go
- server.go
- status_code.go
- storage_pool.go
- storage_pool_bucket.go
- storage_pool_bucket_backup.go
- storage_pool_volume.go
- storage_pool_volume_backup.go
- storage_pool_volume_snapshot.go
- storage_pool_volume_state.go
- url.go
- warning.go