Skip to main content
Version: latest

Retrieves a list of vSphere machines

GET 
/v1/cloudconfigs/vsphere/:configUid/machinePools/:machinePoolName/machines

Retrieves a list of vSphere machines

Request​

Path Parameters

    configUid stringrequired

    Cluster's cloud config uid

    machinePoolName stringrequired

    Machine pool name

Query Parameters

    fields string

    Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name

    filters string

    Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws

    Server will be restricted to certain fields based on the indexed data for each resource.

    orderBy string

    Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1

    limit int64

    Default value: 50

    limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.

    offset int64

    offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.

    continue string

    continue token to paginate the subsequent data items

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Responses​

An array of vSphere machine items

Schema

    items

    object[]

    required

  • Array [

    • apiVersionstring

    Deprecated. Not used for the resource info.

    kindstring

    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.

    property name*string
    creationTimestampdate-time

    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.

    deletionTimestampdate-time

    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

    property name*string
    lastModifiedTimestampdate-time

    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.

    namestring

    Name of the resource.

    uidstring

    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[]

  • Array [

    • fullPathstring

    full path of the image template location it contains datacenter/folder/templatename etc eg: /mydc/vm/template/spectro/workerpool-1-centos

    statestring

  • ]

    • instanceType

    object

    diskGiBint32required

    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.

    memoryMiBint64required

    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.

    numCPUsint32required

    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

  • Array [

    • indexint8
    macAddressstring
    networkNamestringrequired
    privateIPsstring[]

  • ]

    • ntpServersstring[]

    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

    clusterstring

    Cluster is the computecluster in vsphere

    datacenterstring

    Datacenter is the name or inventory path of the datacenter where this machine's VM is created/located.

    datastorestring

    Datastore is the datastore in which VMs are created/located.

    folderstring

    Folder is the folder in which VMs are created/located.

    imageTemplateFolderstring

    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

    gatewaystring

    Gateway is the gateway ip address

    nameserver

    object

    Nameserver define search domains and nameserver addresses

    addressesstring[]
    searchstring[]

    pools

    object[]

    Pools contains the list of IP addresses pools

  • Array [

    • endstring

    End is the last IP address that can be rendered. It is used as a validation that the rendered IP is in bound.

    gatewaystring

    Gateway is the gateway ip address

    nameserver

    object

    Nameserver define search domains and nameserver addresses

    addressesstring[]
    searchstring[]
    prefixint32

    Prefix is the mask of the network as integer (max 128)

    startstring

    Start is the first ip address that can be rendered

    subnetstring

    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)

  • ]

    • prefixint32

    Prefix is the mask of the network as integer (max 128)

    uidstring

    UID is the UID of this IPPool, used by Hubble

    networkNamestringrequired

    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.

    kindstring

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

    namestring

    Name of the referent.

    uidstring

    UID of the referent.

    staticIpboolean

    support dhcp or static IP, if false, use DHCP

    resourcePoolstring

    ResourcePool is the resource pool within the above computecluster Cluster

    storagePolicyNamestring

    StoragePolicyName of the storage policy to use with this Virtual Machine

    uidstring

    UID for this placement

    vcenterServerstringrequired

    VcenterServer is the address of the vSphere endpoint

    status

    object

    cloud machine status

    health

    object

    Machine health state

    conditions

    object[]

  • Array [

    • messagestring
    reasonstring
    statusstring
    typestring

  • ]

    • lastHeartBeatTimestampdate-time

    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.

    statestring
    instanceStatestring

    Possible values: [Pending, Provisioning, Provisioned, Running, Deleting, Deleted, Failed, Unknown]

    maintenanceStatus

    object

    Machine maintenance status

    actionstring
    messagestring
    statestring

  • ]

    • listmeta

    object

    ListMeta describes metadata for the resource listing

    continuestring

    Next token for the pagination. Next token is equal to empty string indicates end of result set.

    countinteger

    Total count of the resources which might change during pagination based on the resources addition or deletion

    limitinteger

    Number of records feteched

    offsetinteger

    The next offset for the pagination. Starting index for which next request will be placed.

Loading...