baremetal

type API struct {
	// contains filtered or unexported fields
}

type CPU struct {
	// Name name of the CPU
	Name string `json:"name"`
	// Cores number of cores of the CPU
	Cores uint32 `json:"cores"`
	// Threads number of threads of the CPU
	Threads uint32 `json:"threads"`

	Frequency uint32 `json:"frequency"`
}

type CreateRemoteServerAccessRequest struct {
	Zone scw.Zone `json:"-"`
	// ServerID iD of the server
	ServerID string `json:"-"`
	// IP the IP authorized to connect to the given server
	IP string `json:"ip"`
}

type CreateServerRequest struct {
	Zone scw.Zone `json:"-"`
	// OfferID offer ID of the new server
	OfferID string `json:"offer_id"`
	// OrganizationID organization ID with which the server will be created
	OrganizationID string `json:"organization_id"`
	// Name name of the server (≠hostname)
	Name string `json:"name"`
	// Description description associated to the server, max 255 characters
	Description string `json:"description"`
	// Tags tags to associate to the server
	Tags []string `json:"tags"`
}

type DeleteRemoteServerAccessRequest struct {
	Zone scw.Zone `json:"-"`
	// ServerID iD of the server
	ServerID string `json:"-"`
}

type DeleteServerRequest struct {
	Zone scw.Zone `json:"-"`
	// ServerID iD of the server to delete
	ServerID string `json:"-"`
}

type Disk struct {
	// Capacity capacity of the disk in GB
	Capacity uint64 `json:"capacity"`
	// Type type of the disk
	Type string `json:"type"`
}

type GetRemoteServerAccessRequest struct {
	Zone scw.Zone `json:"-"`
	// ServerID iD of the server
	ServerID string `json:"-"`
}

type GetServerRequest struct {
	Zone scw.Zone `json:"-"`
	// ServerID iD of the server
	ServerID string `json:"-"`
}

type IP struct {
	// ID iD of the IP
	ID string `json:"id"`
	// Address address of the IP
	Address net.IP `json:"address"`
	// Reverse reverse IP value
	Reverse string `json:"reverse"`
	// Version version of IP (v4 or v6)
	//
	// Default value: Ipv4
	Version IPVersion `json:"version"`
	// ReverseStatus status of the reverse
	//
	// Default value: unknown
	ReverseStatus IPReverseStatus `json:"reverse_status"`
	// ReverseStatusMessage a message related to the reverse status, in case of an error for example
	ReverseStatusMessage *string `json:"reverse_status_message"`
}

type IPReverseStatus string

type IPVersion string

type InstallServerRequest struct {
	Zone scw.Zone `json:"-"`
	// ServerID server ID to install
	ServerID string `json:"-"`
	// OsID iD of the OS to install on the server
	OsID string `json:"os_id"`
	// Hostname hostname of the server
	Hostname string `json:"hostname"`
	// SSHKeyIDs sSH key IDs authorized on the server
	SSHKeyIDs []string `json:"ssh_key_ids"`
}

type ListOffersRequest struct {
	Zone scw.Zone `json:"-"`
	// Page page number
	Page *int32 `json:"-"`
	// PageSize number of offers per page
	PageSize *uint32 `json:"-"`
}

type ListOffersResponse struct {
	// TotalCount total count of matching offers
	TotalCount uint32 `json:"total_count"`
	// Offers offers that match filters
	Offers []*Offer `json:"offers"`
}

type ListOsRequest struct {
	Zone scw.Zone `json:"-"`
	// Page page number
	Page *int32 `json:"-"`
	// PageSize number of OS per page
	PageSize *uint32 `json:"-"`
}

type ListOsResponse struct {
	// TotalCount total count of matching OS
	TotalCount uint32 `json:"total_count"`
	// Os oS that match filters
	Os []*Os `json:"os"`
}

type ListServerEventsRequest struct {
	Zone scw.Zone `json:"-"`
	// ServerID iD of the server events searched
	ServerID string `json:"-"`
	// Page page number
	Page *int32 `json:"-"`
	// PageSize number of server events per page
	PageSize *uint32 `json:"-"`
	// OrderBy order of the server events
	//
	// Default value: created_at_asc
	OrderBy ListServerEventsRequestOrderBy `json:"-"`
}

type ListServerEventsRequestOrderBy string

type ListServerEventsResponse struct {
	// TotalCount total count of matching events
	TotalCount uint32 `json:"total_count"`
	// Event server events that match filters
	Event []*ServerEvent `json:"event"`
}

type ListServersRequest struct {
	Zone scw.Zone `json:"-"`
	// Page page number
	Page *int32 `json:"-"`
	// PageSize number of server per page
	PageSize *uint32 `json:"-"`
	// OrderBy order of the servers
	//
	// Default value: created_at_asc
	OrderBy ListServersRequestOrderBy `json:"-"`
	// Tags filter servers by tags
	Tags []string `json:"-"`
	// Status filter servers by status
	Status []string `json:"-"`
	// Name filter servers by name
	Name *string `json:"-"`
}

type ListServersRequestOrderBy string

type ListServersResponse struct {
	// TotalCount total count of matching servers
	TotalCount uint32 `json:"total_count"`
	// Servers servers that match filters
	Servers []*Server `json:"servers"`
}

type Memory struct {
	Capacity uint64 `json:"capacity"`

	Type string `json:"type"`

	Frequency uint32 `json:"frequency"`

	Ecc bool `json:"ecc"`
}

type Offer struct {
	// ID iD of the offer
	ID string `json:"id"`
	// Name name of the offer
	Name string `json:"name"`
	// Stock stock level
	//
	// Default value: empty
	Stock OfferStock `json:"stock"`
	// Bandwidth bandwidth available with the offer
	Bandwidth uint32 `json:"bandwidth"`
	// CommercialRange commercial range of the offer
	CommercialRange string `json:"commercial_range"`
	// PriceByMinute price of the offer by minutes, this field is deprecated, please use `price_per_sixty_minutes` instead
	PriceByMinute *scw.Money `json:"price_by_minute"`
	// PriceByMonth price of the offer by months, this field is deprecated, please use `price_per_month` instead
	PriceByMonth *scw.Money `json:"price_by_month"`
	// PricePerSixtyMinutes price of the offer for the next 60 minutes (a server order at 11h32 will be payed until 12h32)
	PricePerSixtyMinutes *scw.Money `json:"price_per_sixty_minutes"`
	// PricePerMonth price of the offer per months
	PricePerMonth *scw.Money `json:"price_per_month"`
	// Disk disks specifications of the offer
	Disk []*Disk `json:"disk"`
	// Enable true if the offer is currently available
	Enable bool `json:"enable"`
	// CPU cPU specifications of the offer
	CPU []*CPU `json:"cpu"`
	// Memory memory specifications of the offer
	Memory []*Memory `json:"memory"`
	// QuotaName name of the quota associated to the offer
	QuotaName string `json:"quota_name"`
}

type OfferStock string

type Os struct {
	// ID iD of the OS
	ID string `json:"id"`
	// Name name of the OS
	Name string `json:"name"`
	// Version version of the OS
	Version string `json:"version"`
}

type RebootServerRequest struct {
	Zone scw.Zone `json:"-"`
	// ServerID iD of the server to reboot
	ServerID string `json:"-"`
	// BootType the type of boot
	//
	// Default value: normal
	BootType RebootServerRequestBootType `json:"boot_type"`
}

type RebootServerRequestBootType string

type RemoteServerAccess struct {
	// URL uRL to access to the server console
	URL string `json:"url"`
	// Login the login to use for the remote access authentification
	Login string `json:"login"`
	// Password the password to use for the remote access authentification
	Password string `json:"password"`
	// ExpiresAt the date after which the remote access will be closed
	ExpiresAt time.Time `json:"expires_at"`
}

type Server struct {
	// ID iD of the server
	ID string `json:"id"`
	// OrganizationID organization ID the server is attached to
	OrganizationID string `json:"organization_id"`
	// Name name of the server
	Name string `json:"name"`
	// Description description of the server
	Description string `json:"description"`
	// UpdatedAt date of last modification of the server
	UpdatedAt time.Time `json:"updated_at"`
	// CreatedAt date of creation of the server
	CreatedAt time.Time `json:"created_at"`
	// Status status of the server
	//
	// Default value: unknown
	Status ServerStatus `json:"status"`
	// OfferID offer ID of the server
	OfferID string `json:"offer_id"`
	// Install information about the last installation of the server
	Install *ServerInstall `json:"install"`
	// Tags array of customs tags attached to the server
	Tags []string `json:"tags"`
	// IPs array of IPs attached to the server
	IPs []*IP `json:"ips"`
	// Domain domain of the server
	Domain string `json:"domain"`
	// BootType boot type of the server
	//
	// Default value: normal
	BootType ServerBootType `json:"boot_type"`
}

type ServerBootType string

type ServerEvent struct {
	// ID iD of the server for whom the action will be applied
	ID string `json:"id"`
	// Action the action that will be applied to the server
	Action string `json:"action"`
	// UpdatedAt date of last modification of the action
	UpdatedAt time.Time `json:"updated_at"`
	// CreatedAt date of creation of the action
	CreatedAt time.Time `json:"created_at"`
}

type ServerInstall struct {
	// OsID iD of the OS
	OsID string `json:"os_id"`
	// Hostname host defined in the server install
	Hostname string `json:"hostname"`
	// SSHKeyIDs sSH public key IDs defined in the server install
	SSHKeyIDs []string `json:"ssh_key_ids"`
	// Status status of the server install
	//
	// Default value: unknown
	Status ServerInstallStatus `json:"status"`
}

type ServerInstallStatus string

type ServerStatus string

type StartServerRequest struct {
	Zone scw.Zone `json:"-"`
	// ServerID iD of the server to start
	ServerID string `json:"-"`
}

type StopServerRequest struct {
	Zone scw.Zone `json:"-"`
	// ServerID iD of the server to stop
	ServerID string `json:"-"`
}

type UpdateIPRequest struct {
	Zone scw.Zone `json:"-"`
	// ServerID iD of the server
	ServerID string `json:"-"`
	// IPID iD of the IP to update
	IPID string `json:"-"`
	// Reverse new reverse IP to update, not updated if null
	Reverse *string `json:"reverse"`
}

type UpdateServerRequest struct {
	Zone scw.Zone `json:"-"`
	// ServerID iD of the server to update
	ServerID string `json:"-"`
	// Name name of the server (≠hostname), not updated if null
	Name *string `json:"name"`
	// Description description associated to the server, max 255 characters, not updated if null
	Description *string `json:"description"`
	// Tags tags associated to the server, not updated if null
	Tags *[]string `json:"tags"`
}

type WaitForServerInstallRequest struct {
	ServerID string
	Zone     scw.Zone
	Timeout  time.Duration
}

type WaitForServerRequest struct {
	ServerID string
	Zone     scw.Zone
	Timeout  time.Duration
}