Skip to main content

Updates the cluster configuration information

PUT 
/v1/cloudconfigs/vsphere/:configUid/clusterConfig

Updates the cluster configuration information

Request​

Path Parameters

    configUid stringrequired

    Cluster's cloud config uid

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

    clusterConfig

    object

    controlPlaneEndpoint

    object

    The optional control plane endpoint, which can be an IP or FQDN

    ddnsSearchDomainstring

    DDNSSearchDomain is the search domain used for resolving IP addresses when the EndpointType is DDNS. This search domain is appended to the generated Hostname to obtain the complete DNS name for the endpoint. If Host is already a DDNS FQDN, DDNSSearchDomain is not required

    hoststring

    IP or FQDN(External/DDNS)

    typestring

    Possible values: [VIP, External, DDNS]

    VIP or External

    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

    network info

    networkNamestringrequired

    NetworkName is the name of the network in which VMs are created/located.

    parentPoolUidstring

    ParentPoolRef Uid to the ParentPool which allocates IPs for this IPPool

    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

    sshKeysstring[]

    SSHKeys specifies a list of ssh authorized keys for the 'spectro' user

    staticIpboolean

    whether this cluster should use dhcp or static IP, if false, use DHCP if this is set, then all machinepools should have staticIP with provided IPPool adding this as an additional standalone flag without relating to placement.Nework main reason is to enable more validation for placement.Network.StaticIP which should come together with valid Network.IPPool and Network.Name

Responses​

The resource was updated successfully

Loading...