Adds the vSphere machine to cloud config's machine pool
POST/v1/cloudconfigs/vsphere/:configUid/machinePools/:machinePoolName/machines
Adds the vSphere machine to cloud config's machine pool
Request
Path Parameters
Cluster's cloud config uid
Machine pool name
Header Parameters
Scope the request to the specified project uid
- application/json
Body
Array [
]
Array [
]
Array [
]
Array [
]
Deprecated. Not used for the resource info.
Deprecated. Cloud type of the machine.
metadata
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations
object
Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set.
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
labels
object
Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
Name of the resource.
UID is the unique identifier generated for the resource. This is not an input field for any request.
spec
object
vSphere cloud VM definition spec
images
object[]
full path of the image template location it contains datacenter/folder/templatename etc eg: /mydc/vm/template/spectro/workerpool-1-centos
instanceType
object
DiskGiB is the size of a virtual machine's disk, in GiB. Defaults to the analogue property value in the template from which this machine is cloned.
MemoryMiB is the size of a virtual machine's memory, in MiB. Defaults to the analogue property value in the template from which this machine is cloned.
NumCPUs is the number of virtual processors in a virtual machine. Defaults to the analogue property value in the template from which this machine is cloned.
nics
object[]
required
NTPServers is a list of NTP servers to use instead of the machine image's default NTP server list.
placement
object
required
Both ClusterConfig and MachinePoolConfig will have PlacementConfig MachinePoolconfig.Placements will overwrite values defined in ClusterConfig Currently the convention is: Datacenter / Folder / ImageTemplateFolder / Network should be defined at ClusterConfig Cluster / ResourcePool / Datastore / Network is defined at MachinePool ClusterConfig Network should only indicate use DHCP or not MachinePool Network should contain the actual network and IPPool
Cluster is the computecluster in vsphere
Datacenter is the name or inventory path of the datacenter where this machine's VM is created/located.
Datastore is the datastore in which VMs are created/located.
Folder is the folder in which VMs are created/located.
ImageTemplateFolder is the folder in which VMs templates are created/located. if empty will use default value spectro-templates
network
object
ipPool
object
IPPool defines static IPs available. Gateway, Prefix, Nameserver, if defined, will be default values for all Pools
Gateway is the gateway ip address
nameserver
object
Nameserver define search domains and nameserver addresses
pools
object[]
Pools contains the list of IP addresses pools
End is the last IP address that can be rendered. It is used as a validation that the rendered IP is in bound.
Gateway is the gateway ip address
nameserver
object
Nameserver define search domains and nameserver addresses
Prefix is the mask of the network as integer (max 128)
Start is the first ip address that can be rendered
Subnet is used to validate that the rendered IP is in bounds. eg: 192.168.0.0/24 If Start value is not given, start value is derived from the subnet ip incremented by 1 (start value is 192.168.0.1 for subnet 192.168.0.0/24)
Prefix is the mask of the network as integer (max 128)
UID is the UID of this IPPool, used by Hubble
NetworkName is the name of the network in which VMs are created/located.
parentPoolRef
object
ObjectReference contains enough information to let you inspect or modify the referred object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent.
UID of the referent.
support dhcp or static IP, if false, use DHCP
ResourcePool is the resource pool within the above computecluster Cluster
StoragePolicyName of the storage policy to use with this Virtual Machine
UID for this placement
VcenterServer is the address of the vSphere endpoint
status
object
cloud machine status
health
object
Machine health state
conditions
object[]
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
Possible values: [Pending, Provisioning, Provisioned, Running, Deleting, Deleted, Failed, Unknown]
maintenanceStatus
object
Machine maintenance status
Responses
- 201
Created successfully
Response Headers
AuditUid
string
Audit uid for the request
- application/json
- Schema
- Example (from schema)
Schema
{
"uid": "string"
}