TeamCity Kotlin DSL 2025.11/jetbrains.buildServer.configs.kotlin/VMwareVSphereCloudProfile

VMwareVSphereCloudProfile

open class VMwareVSphereCloudProfile : CloudProfile

fun ProjectFeatures.vmwareVSphereCloudProfile(init: VMwareVSphereCloudProfile.() -> Unit = {})

Definition of an agent cloud profile for VMware vSphere and vCenter in a project.

Example. VMware Cloud Profile using secret keys

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        vmwareVSphereCloudProfile {
            id = "vmw-1"
            name = "VMware vSphere - 1"
            username = "user"
            password = "credentialsJson:******"
            vCenterURL = "https://vcenter.internal.mycompany.com"
        }
Content copied to clipboard
    }
}

Example. Disabled VMware Cloud Profile using a different server URL that will create a single instante that will either terminate in 30 minutes or after it finishes the build

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        vmwareVSphereCloudProfile {
            id = "vmw-1"
            name = "VMware vSphere - 1"
            username = "user"
            password = "credentialsJson:******"
            vCenterURL = "https://vcenter.internal.mycompany.com"
            serverURL = "https://jetbrains.com/teamcity"
            terminateAfterBuild = true
            terminateBeforeFullHourMinutes = 30
            maxInstancesCount = 1
        }
Content copied to clipboard
    }
}

Constructors

VMwareVSphereCloudProfile

constructor(init: VMwareVSphereCloudProfile.() -> Unit = {})

Properties

description

var description: String?

enabled

var enabled: Boolean?

var id: String?

Project feature id, if not specified will be generated

maxInstancesCount

var maxInstancesCount: Int?

name

var name: String?

params

val params: List<Parameter>

password

var password: String?

serverURL

var serverURL: String?

terminateAfterBuild

var terminateAfterBuild: Boolean?

terminateBeforeFullHourMinutes

var terminateBeforeFullHourMinutes: Int?

terminateIdleMinutes

var terminateIdleMinutes: Int?

terminateTotalWorkMinutes

var terminateTotalWorkMinutes: Int?

type

var type: String

Project feature type

username

var username: String?

vCenterURL

var vCenterURL: String?

yamlParams

val yamlParams: List<Parameter>

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean>

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false", yamlName: String? = null): DelegateProvider<Boolean?>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null, yamlName: String? = null): DelegateProvider<T>

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): ProjectFeature

Creates an instance of this project feature via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

doubleParameter

fun doubleParameter(customName: String? = null): DelegateProvider<Double>

fun doubleParameter(customName: String? = null, yamlName: String? = null): DelegateProvider<Double>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): DelegateProvider<E>

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null, yamlName: String? = null): DelegateProvider<E>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): DelegateProvider<Int>

fun intParameter(customName: String? = null, yamlName: String? = null): DelegateProvider<Int>

param

fun param(name: String, value: String)

Adds parameter with specified name and value

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

open fun stringParameter(customName: String? = null): DelegateProvider<String>

open fun stringParameter(customName: String? = null, yamlName: String? = null): DelegateProvider<String>

toString

open override fun toString(): String

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer