MachineInventory [elemental.cattle.io/v1beta1]

Type
object

Specification

PropertyTypeDescription
apiVersionstring

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kindstring

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject
statusobject

.spec

Type
object
PropertyTypeDescription
ipAddressClaimsobject

IPAddressClaims is a map of IPAddressClaim associated to this machine. The map key is the ipAddressPool.name.

ipAddressPoolsobject

IPAddressPools is a list of IPAddressPool associated to this machine.

machineHashstring

MachineHash the hash of the identifier used by the host to identify to the operator. This is used when the host authenticates without TPM. Both the authentication method and the identifier used to derive the hash depend upon the MachineRegistration spec.config.elemental.registration.auth value.

networkobject

NetworkConfig is the final NetworkConfig.

observedNetworkobject

ObservedNetwork is a live-ISO-side snapshot of the host's actual network configuration uploaded by elemental-register during initial registration (Alauda fork). It is informational only and is intentionally kept separate from Network (the target/template network). Consumers such as baremetal providers can read this to know what the host looked like before install-time network reconfiguration.

tpmHashstring

TPMHash the hash of the TPM EK public key. This is used if you are using TPM2 to identifiy nodes. You can obtain the TPM by running rancherd get-tpm-hash on the node. Or nodes can report their TPM hash by using the MachineRegister.

.spec.ipAddressClaims

Description
IPAddressClaims is a map of IPAddressClaim associated to this machine. The map key is the ipAddressPool.name.
Type
object

.spec.ipAddressPools

Description
IPAddressPools is a list of IPAddressPool associated to this machine.
Type
object

.spec.network

Description
NetworkConfig is the final NetworkConfig.
Type
object
PropertyTypeDescription
config

Config contains the network config template (nmc, nmstate, or nmconnections formats)

configuratorstring

Configurator

ipAddressesobject

IPAddresses contains a map of claimed IPAddresses

.spec.network.ipAddresses

Description
IPAddresses contains a map of claimed IPAddresses
Type
object

.spec.observedNetwork

Description
ObservedNetwork is a live-ISO-side snapshot of the host's actual network configuration uploaded by elemental-register during initial registration (Alauda fork). It is informational only and is intentionally kept separate from Network (the target/template network). Consumers such as baremetal providers can read this to know what the host looked like before install-time network reconfiguration.
Type
object
PropertyTypeDescription
connectionsobject

Connections holds the host's persisted NetworkManager keyfiles verbatim, keyed by the connection file's base name (without the .nmconnection suffix). Anything present here was created by an operator: NetworkManager keeps its own auto-default connections in memory, with no file on disk.

The install and reset paths feed these back to the host unchanged, which is how a bond, VLAN or bridge configured from the live ISO survives into the installed system. Every other registration reports them and discards them, so editing this field has no effect on the host.

dnsServersarray

DNSServers observed (typically from /etc/resolv.conf).

interfacesarray

Interfaces observed on the host.

routesarray

Routes observed in the host's routing table.

searchDomainsarray

SearchDomains observed.

.spec.observedNetwork.connections

Description
Connections holds the host's persisted NetworkManager keyfiles verbatim, keyed by the connection file's base name (without the .nmconnection suffix). Anything present here was created by an operator: NetworkManager keeps its own auto-default connections in memory, with no file on disk. The install and reset paths feed these back to the host unchanged, which is how a bond, VLAN or bridge configured from the live ISO survives into the installed system. Every other registration reports them and discards them, so editing this field has no effect on the host.
Type
object

.spec.observedNetwork.dnsServers

Description
DNSServers observed (typically from /etc/resolv.conf).
Type
array

.spec.observedNetwork.dnsServers[]

Type
string

.spec.observedNetwork.interfaces

Description
Interfaces observed on the host.
Type
array

.spec.observedNetwork.interfaces[]

Description
ObservedInterface describes a single network interface on the host.
Type
object
Required
name
PropertyTypeDescription
addressesarray

Addresses assigned to the interface, in CIDR form (e.g. 10.0.0.5/24, fe80::1/64). Both IPv4 and IPv6 may appear.

kindstring

Kind is the link type read from /sys/class/net//uevent DEVTYPE. It is empty for a plain physical ethernet device, and otherwise carries the kernel's own name for the link type: bond, vlan, bridge, ...

macstring

MAC is the hardware address.

masterstring

Master is the name of the aggregating link this interface is enslaved to, resolved from the /sys/class/net//master symlink. It is empty for an interface that stands on its own.

mtuinteger

MTU in bytes.

namestring

Name is the OS-level interface name (e.g. eth0, ens3).

.spec.observedNetwork.interfaces[].addresses

Description
Addresses assigned to the interface, in CIDR form (e.g. 10.0.0.5/24, fe80::1/64). Both IPv4 and IPv6 may appear.
Type
array

.spec.observedNetwork.interfaces[].addresses[]

Type
string

.spec.observedNetwork.routes

Description
Routes observed in the host's routing table.
Type
array

.spec.observedNetwork.routes[]

Description
ObservedRoute describes a single routing table entry.
Type
object
Required
destination
PropertyTypeDescription
destinationstring

Destination CIDR, or the literal string "default" for the default route.

gatewaystring

Gateway is the next-hop IP, if any.

interfacestring

Interface is the outgoing device name, if any.

metricinteger

Metric of the route.

.spec.observedNetwork.searchDomains

Description
SearchDomains observed.
Type
array

.spec.observedNetwork.searchDomains[]

Type
string

.status

Type
object
PropertyTypeDescription
conditionsarray

Conditions describe the state of the machine inventory object.

installobject

Install is the install session of a host booted from the live ISO with elemental-register --install, written by the registration server.

planobject

PlanStatus reflect the status of the plan owned by the machine inventory object.

.status.conditions

Description
Conditions describe the state of the machine inventory object.
Type
array

.status.conditions[]

Description
Condition contains details for one aspect of the current state of this API Resource.
Type
object
Required
lastTransitionTimemessagereasonstatustype
PropertyTypeDescription
lastTransitionTimestring

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

messagestring

message is a human readable message indicating details about the transition. This may be an empty string.

observedGenerationinteger

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reasonstring

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

statusstring

status of the condition, one of True, False, Unknown.

typestring

type of condition in CamelCase or in foo.example.com/CamelCase.

.status.install

Description
Install is the install session of a host booted from the live ISO with elemental-register --install, written by the registration server.
Type
object
PropertyTypeDescription
bootIDstring

BootID is the boot_id of the live boot the session belongs to.

candidatesarray

Candidates are the whole disks the live session reported.

installerstring

InstallerKind is status.install.installer, the backend that installs the OS.

lastSeenAtstring

LastSeenAt is refreshed by every registration of the live session.

messagestring
phasestring

InstallPhase is status.install.phase.

staleSystemDisksarray

StaleSystemDisks are the disks found carrying an old system layout.

targetDeviceIDstring

TargetDeviceID is the canonical ID of the disk the install was released to. While an installed host waits in the live ISO again, it is the disk its installed system is on.

.status.install.candidates

Description
Candidates are the whole disks the live session reported.
Type
array

.status.install.candidates[]

Description
InstallCandidate is one whole disk a live session reported.
Type
object
Required
eligibleid
PropertyTypeDescription
eligibleboolean

Eligible says whether the disk may be chosen as the install target; Reasons explains why not.

hasDataarray

HasData lists signatures of data found on the disk, e.g. LVM2_member. Automatic selection never picks such a disk.

idstring

ID is the canonical whole-disk ID: wwn:, nvme-eui:, nvme-nguid: or serial:; unidentified: when the disk has none. An unidentified: ID is derived from the kernel path and names the disk in this live boot only.

modelstring
pathstring

Path is the kernel device path in the reporting boot only.

reasonsarray
rotationalboolean
serialstring
sizeBytesinteger
staleSystemboolean

StaleSystem marks a disk that carries an old system layout.

transportstring
wwnstring

.status.install.candidates[].hasData

Description
HasData lists signatures of data found on the disk, e.g. LVM2_member. Automatic selection never picks such a disk.
Type
array

.status.install.candidates[].hasData[]

Type
string

.status.install.candidates[].reasons

Type
array

.status.install.candidates[].reasons[]

Type
string

.status.install.staleSystemDisks

Description
StaleSystemDisks are the disks found carrying an old system layout.
Type
array

.status.install.staleSystemDisks[]

Description
StaleSystemDisk is a disk, other than the install target, that carries an old system layout.
Type
object
Required
id
PropertyTypeDescription
actionstring

StaleSystemDiskAction says what the install does with a disk that carries an old system layout.

evidencearray
idstring
reasonstring

.status.install.staleSystemDisks[].evidence

Type
array

.status.install.staleSystemDisks[].evidence[]

Type
string

.status.plan

Description
PlanStatus reflect the status of the plan owned by the machine inventory object.
Type
object
PropertyTypeDescription
checksumstring

Checksum checksum of the created plan.

secretRefobject

PlanSecretRef a reference to the created plan secret.

statestring

State reflect state of the plan that belongs to the machine inventory.

.status.plan.secretRef

Description
PlanSecretRef a reference to the created plan secret.
Type
object
PropertyTypeDescription
apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

API Endpoints

The following API endpoints are available:

  • /apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/machineinventories
    • DELETE: delete collection of MachineInventory
    • GET: list objects of kind MachineInventory
    • POST: create a new MachineInventory
  • /apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/machineinventories/{name}
    • DELETE: delete the specified MachineInventory
    • GET: read the specified MachineInventory
    • PATCH: partially update the specified MachineInventory
    • PUT: replace the specified MachineInventory
  • /apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/machineinventories/{name}/status
    • GET: read status of the specified MachineInventory
    • PATCH: partially update status of the specified MachineInventory
    • PUT: replace status of the specified MachineInventory

/apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/machineinventories

HTTP method
DELETE
Description
delete collection of MachineInventory
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind MachineInventory
HTTP responses
HTTP codeResponse body
200 - OKMachineInventoryList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new MachineInventory
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyMachineInventory schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKMachineInventory schema
201 - CreatedMachineInventory schema
202 - AcceptedMachineInventory schema
401 - UnauthorizedEmpty

/apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/machineinventories/{name}

HTTP method
DELETE
Description
delete the specified MachineInventory
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified MachineInventory
HTTP responses
HTTP codeResponse body
200 - OKMachineInventory schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified MachineInventory
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKMachineInventory schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified MachineInventory
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyMachineInventory schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKMachineInventory schema
201 - CreatedMachineInventory schema
401 - UnauthorizedEmpty

/apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/machineinventories/{name}/status

HTTP method
GET
Description
read status of the specified MachineInventory
HTTP responses
HTTP codeResponse body
200 - OKMachineInventory schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified MachineInventory
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKMachineInventory schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified MachineInventory
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyMachineInventory schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKMachineInventory schema
201 - CreatedMachineInventory schema
401 - UnauthorizedEmpty