metalgo

package module

v0.42.5 Latest Latest Go to latest Published: Dec 8, 2025 License: MIT Imports: 28 Imported by: 30

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/metal-stack/metal-go

Links

Open Source Insights

README ¶

metal-go

Metal Go API Client.

Documentation ¶

Index ¶

func AuthType(authType string) option
type Client
- func NewClient(baseURL string, options ...ClientOption) (Client, error)
- func NewDriver(baseURL, bearer, hmacKey string, options ...option) (Client, error)
type ClientOption

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AuthType ¶ added in v0.9.2

func AuthType(authType string) option

AuthType sets the authType for HMAC-Auth

Types ¶

type Client ¶ added in v0.18.1

type Client interface {
	Audit() audit.ClientService
	Filesystemlayout() filesystemlayout.ClientService
	Firewall() firewall.ClientService
	Firmware() firmware.ClientService
	Health() health.ClientService
	Image() image.ClientService
	IP() ip.ClientService
	Machine() machine.ClientService
	Network() network.ClientService
	Partition() partition.ClientService
	Project() project.ClientService
	Size() size.ClientService
	Sizeimageconstraint() sizeimageconstraint.ClientService
	SwitchOperations() switch_operations.ClientService
	Tenant() tenant.ClientService
	User() user.ClientService
	Version() version.ClientService
	VPN() vpn.ClientService
}

func NewClient ¶ added in v0.41.1

func NewClient(baseURL string, options ...ClientOption) (Client, error)

func NewDriver ¶

func NewDriver(baseURL, bearer, hmacKey string, options ...option) (Client, error)

NewDriver Create a new Driver for Metal to given url. Either bearer OR hmacKey must be set. Deprecated: Use NewClient instead

type ClientOption ¶ added in v0.41.1

type ClientOption func(cfg *clientOptionConfig)

func BearerToken ¶ added in v0.41.1

func BearerToken(bearer string) ClientOption

func HMACAuth ¶ added in v0.41.1

func HMACAuth(hmac string, authType string) ClientOption

func TLSClientConfig ¶ added in v0.41.1

func TLSClientConfig(config *tls.Config) ClientOption

Source Files ¶

View all Source files

metal.go

Directories ¶

Path	Synopsis
api
client
client/audit
client/filesystemlayout
client/firewall
client/firmware
client/health
client/image
client/ip
client/machine
client/network
client/partition
client/project
client/size
client/sizeimageconstraint
client/switch_operations
client/tenant
client/user
client/version
client/vpn
models
test
client Code generated by generate_mock_client.go.	Code generated by generate_mock_client.go.
client/generate command
mocks/audit
mocks/filesystemlayout
mocks/firewall
mocks/firmware
mocks/health
mocks/image
mocks/ip
mocks/machine
mocks/network
mocks/partition
mocks/project
mocks/size
mocks/sizeimageconstraint
mocks/switch_operations
mocks/tenant
mocks/user
mocks/version
mocks/vpn

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