diff --git a/doc/index.html b/doc/index.html index 5c16a203..4a82891c 100644 --- a/doc/index.html +++ b/doc/index.html @@ -675,7 +675,7 @@
Macaddress returns true if the given string is a valid macadress
Macaddress returns true if the given string is a valid macaddress
MachineRole are used to define which infra role a microservice must provide to call this method
MachineRole are used to define which machine role a microservice must provide to call this method
MachineAndFilesystemlayout
MatchMachine
+MatchMachineAndFilesystemLayout
| id | string | - | Id of this imageLayout |
+ Id of this image |
| meta | Meta | - | Meta for this ip |
+ Meta for this image |
| name | string | optional | -Name of this imageLayout |
+ Name of this image |
| description | string | optional | -Description of this imageLayout |
+ Description of this image |
| ip | string | - | Ip the ip to update |
+ Ip the ip address to update |
| meta | Meta | - | Meta for this ip |
+ Meta for this partition |
| partition | Partition | - | Ip the partition |
+ Partition is the partition |
partitions | Partition | repeated | -Ips the partitions |
+ Partitions are the partitions |
@@ -11145,7 +11137,7 @@ string | optional | UUID if this field is set, this specific machine will be allocated if it is not in available state and not currently allocated. -this field overrules size and partition. +this field takes precedence over size and partition. Can only be used with ADMIN_ROLE_EDITOR |
@@ -11279,7 +11271,7 @@
| machine | Machine | - | Machine which was deleteds |
+ Machine which was deleted |
@@ -11451,7 +11443,7 @@
| query | metalstack.api.v2.MachineBMCQuery | - | Query to list one ore more bmcs of more machines |
+ Query to list one ore more bmcs of many machines |
@@ -12492,7 +12484,7 @@
| project | string | - | Project is the uuid of the project to get |
+ Project is the uuid of the project to delete |
@@ -13930,7 +13922,7 @@
| value | -MachineProvisioningEvent | +metalstack.api.v2.MachineProvisioningEvent |
|
| Field | Type | Label | Description |
| time | -google.protobuf.Timestamp | -- | Time the event occurred at |
-
| event | -ProvisioningEventType | -- | Event that occurred |
-
| message | -string | -- | Message describes the event in more detail |
-
ProvisioningEventType is a short description of a machine event.
-| Name | Number | Description |
| PROVISIONING_EVENT_TYPE_UNSPECIFIED | -0 | -PROVISIONING_EVENT_TYPE_UNSPECIFIED is unspecified |
-
| PROVISIONING_EVENT_TYPE_ALIVE | -1 | -PROVISIONING_EVENT_TYPE_ALIVE means the machine has reported itself to the API not long ago |
-
| PROVISIONING_EVENT_TYPE_CRASHED | -2 | -PROVISIONING_EVENT_TYPE_CRASHED means an irregularity in the machine's lifecycle |
-
| PROVISIONING_EVENT_TYPE_PXE_BOOTING | -3 | -PROVISIONING_EVENT_TYPE_PXE_BOOTING is sent when an unprovisioned machine requests a boot image via PXE |
-
| PROVISIONING_EVENT_TYPE_PLANNED_REBOOT | -4 | -PROVISIONING_EVENT_TYPE_PLANNED_REBOOT means the machine was scheduled for reboot |
-
| PROVISIONING_EVENT_TYPE_PREPARING | -5 | -PROVISIONING_EVENT_TYPE_PREPARING means the metal-hammer has started |
-
| PROVISIONING_EVENT_TYPE_REGISTERING | -6 | -PROVISIONING_EVENT_TYPE_REGISTERING means the metal-hammer is attempting to register the machine at the API |
-
| PROVISIONING_EVENT_TYPE_WAITING | -7 | -PROVISIONING_EVENT_TYPE_WAITING means the machine has successfully reached the state where it is waiting for allocation |
-
| PROVISIONING_EVENT_TYPE_INSTALLING | -8 | -PROVISIONING_EVENT_TYPE_INSTALLING means the machine was allocated and the requested OS is being installed |
-
| PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL | -9 | -PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL means the machine has successfully been installed and is now booting into the new OS |
-
| PROVISIONING_EVENT_TYPE_PHONED_HOME | -10 | -PROVISIONING_EVENT_TYPE_PHONED_HOME is sent periodically by an allocated machine to indicate its liveliness |
-
| PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM | -11 | -PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM means the machine was freed and is about to return into the pool of waiting machines |
-