package
1.20.3
Repository: https://github.com/metal-automata/fleetdb.git
Documentation: pkg.go.dev

# Packages

nolint.

# Functions

CompareCapabilitySlices compares slices of ComponentCapability using Name as the key and checks Description and Enabled fields for changes.
Compare metdata data slices for changes.
NewClient will return a fleetdb client configured to talk to the given URL.
NewClientWithToken will initialize a new hollow client with the given auth token and URL.
Initializes and returns a new common.Device to fleetdbapi.Server converter skipSlugCheck when set will cause the convertor to not verify the components are of a valid ComponentSlugType in fleetdbapi this check should not be disabled for when the converted inventory has to be stored in fleetdb.
OperatorURLQueryDecoder will be passed to a urlquery decoder to escape Operator types from query strings TODO; If we swap OperatorComparitorType and OperatorLogicalType to ints, this function will not be needed.
OperatorURLQueryEncoder will be passed to a urlquery encoder to escape Operator types from query strings TODO; If we swap OperatorComparitorType and OperatorLogicalType to ints, this function will not be needed.
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
comparison operators.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
logical operators.
No description provided by the author
No description provided by the author
modifiers.
OperatorComparitorEqual means the value has to match the keys exactly.
OperatorComparitorGreaterThan will convert the value at the given key to an int and return results that are greater than Value.
OperatorComparitorLessThan will convert the value at the given key to an int and return results that are less than Value.
OperatorComparitorLike allows you to pass in a value with % in it and match anything like it.
OperatorComparitorNotEqual means the value has to match the keys exactly, but then exclude those matches.
OperatorLogicalAND informs the SQL Builder to use AND when adding the param to the SQL Query.
OperatorLogicalOR informs the SQL Builder to use OR when adding the param to the SQL Query.
ServerCredentialTypeBMC returns the slug for the builtin ServerCredentialType used to store BMC passwords.

# Variables

DefaultPaginationSize represents the default number of records that are returned per page.
ErrComponentType indicates the component type is not supported.
ErrCredentialEncrypt is returned when theres an internal error encrypting the secret.
ErrDBQuery indicates a DB query returned an error.
No description provided by the author
No description provided by the author
No description provided by the author
ErrNoNextPage is the error returned when there is not an additional page of resources.
No description provided by the author
ErrUUIDParse is returned when the UUID is invalid.
ErrValidatePayload is returned when the received payload failed validation.
FleetDB attribute namespace for firmware set labels.
Inband identifies data collected through the ironlib image running on the host OS.
MaxPaginationSize represents the maximum number of records that can be returned per page.
Outofband identifies data collected through the host BMC.

# Structs

AttributeListParams allow you to filter the results based on attributes.
Attributes provide the ability to apply namespaced settings to an entity.
BiosConfigComponent represents a BIOS Configuration Component.
BiosConfigComponentQuery defines values you can query BiosConfigComponents with.
BiosConfigSet represents a BIOS Configuration Set.
BiosConfigSetListParams params is an array of potential expressions when querying.
BiosConfigSetQuery defines values you can query BiosConfigSets with.
BiosConfigSetQueryParams defines a BiosConfigSetQuery struct and operators you can use to query BiosConfigSets with.
BiosConfigSetting represents a BIOS Configuration Component Setting.
BiosConfigSettingQuery defines values you can query BiosConfigSettings with.
Client has the ability to talk to a fleetdb api server running at the given URI.
ClientError is returned when invalid arguments are provided to the client.
No description provided by the author
ComponentChangeAccept is the payload sent by the client to merge component add/deletes records.
ComponentChangeReport represents addition/removal of server components to or from an existing set.
No description provided by the author
ComponentFirmwareSet represents a group of firmwares.
ComponentFirmwareSetListParams allows you to filter the results.
ComponentFirmwareSetRequest represents the payload to create a firmware set.
ComponentFirmwareVersion represents a firmware file.
ComponentFirmwareVersionListParams allows you to filter the results.
No description provided by the author
No description provided by the author
Converter converts from the common.Device type to the fleetdbapi Server,Component types This is an exported type to enable fleetdbapi clients to publish server inventory data.
No description provided by the author
Filter represents a query parameter.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Link represents an address to a page.
PaginationParams allow you to paginate the results.
Router provides a router for the v1 API.
Server represents a server in a facility.
No description provided by the author
ServerComponent represents a component of a server.
Set fields in this struct to for additional data to be included in the response.
ServerComponentListParams allows you to filter the results by server components.
ServerComponentType provides a way to group server components by the type.
ServerComponentTypeListParams allows you to filter the results.
ServerCredential provides a way to encrypt secrets about a server in the database.
ServerCredentialType represents a type of server secret.
ServerError is returned when the client receives an error back from the server.
ServerGetParams allows you to filter server results and specify what related data to include.
No description provided by the author
ServerResponse represents the data that the server will return on any given call.
ServerResponseLinks represent links that could be returned on a page.
No description provided by the author

# Interfaces

ClientInterface provides an interface for the expected calls to interact with a fleetdb api.
Doer is an interface for an HTTP client that can make requests.
A type that implements the FilterTarget is required to be passed into FilterParams.

# Type aliases

CollectionMethod indicates how the data was collected.
No description provided by the author
ComponentSlugMap holds a lookup map for component slug to component type objs.
No description provided by the author
No description provided by the author
OperatorComparitorType is used to control what kind of search is performed for any query.
OperatorLogicalType is used to define how to group a query with other queries.
ServerComponentSlice is a slice of ServerComponent objects.
ServerComponentTypeSlice is a slice of the ServerComponentType.