---
title: System.CloudCredentials
slug: ps/help/en_us/vtm/controlapi/systemcloudcredentials
docTags: 
createdAt: 2026-08-02T08:52:22.847Z
---

URI: http\://soap.zeus.com/zxtm/1.0/System/CloudCredentials/

The System.CloudCredentials interface allows management of Cloud Credentials. Using this interface, you can create, delete and rename sets of cloud credentials, and manage their configuration.

### Methods

### addCloudCredentials( class\_names, class\_values ) throws ObjectAlreadyExists, InvalidInput

Add new sets of cloud credentials.

```bash
void addCloudCredentials(
String[] class_names
System.CloudCredentials.CredentialsData[] class_values
)
```

### copyCloudCredentials( class\_names, new\_names ) throws ObjectAlreadyExists, ObjectDoesNotExist, InvalidObjectName, DeploymentError

Copy the named set of cloud credentials.

```bash
void copyCloudCredentials(
String[] class_names
String[] new_names
)
```

### deleteCloudCredentials( class\_names ) throws ObjectDoesNotExist, DeploymentError

Delete the named sets of cloud credentials.

```bash
void deleteCloudCredentials(
String[] class_names
)
```

### getApiServer( class\_names ) throws ObjectDoesNotExist

Get the vcenter server hostname or IP address.

```bash
String[] getApiServer(
String[] class_names
)
```

### getApiServerByLocation( location, class\_names ) throws ObjectDoesNotExist

Get the vcenter server hostname or IP address. This is a location specific function, any action will operate on the specified location.

```bash
String[] getApiServerByLocation(
String location
String[] class_names
)
```

### getChangeProcessTimeout( class\_names ) throws ObjectDoesNotExist

Get the amount of time change calls are allowed to take

```bash
Unsigned Integer[] getChangeProcessTimeout(
String[] class_names
)
```

### getChangeProcessTimeoutByLocation( location, class\_names ) throws ObjectDoesNotExist

Get the amount of time change calls are allowed to take This is a location specific function, any action will operate on the specified location.

```bash
Unsigned Integer[] getChangeProcessTimeoutByLocation(
String location
String[] class_names
)
```

### getCloudCredentialsNames()

Get the names of all the configured cloud credentials.

```bash
String[] getCloudCredentialsNames()
```

### getCred1( class\_names ) throws ObjectDoesNotExist

Get the cloud user name

```bash
String[] getCred1(
String[] class_names
)
```

### getCred1ByLocation( location, class\_names ) throws ObjectDoesNotExist

Get the cloud user name This is a location specific function, any action will operate on the specified location.

```bash
String[] getCred1ByLocation(
String location
String[] class_names
)
```

### getScript( class\_names ) throws ObjectDoesNotExist

Get the script

```bash
String[] getScript(
String[] class_names
)
```

### getScriptByLocation( location, class\_names ) throws ObjectDoesNotExist

Get the script This is a location specific function, any action will operate on the specified location.

```bash
String[] getScriptByLocation(
String location
String[] class_names
)
```

### getUpdateInterval( class\_names ) throws ObjectDoesNotExist

Get the interval at which cloud status is queried

```bash
Unsigned Integer[] getUpdateInterval(
String[] class_names
)
```

### getUpdateIntervalByLocation( location, class\_names ) throws ObjectDoesNotExist

Get the interval at which cloud status is queried This is a location specific function, any action will operate on the specified location.

```bash
Unsigned Integer[] getUpdateIntervalByLocation(
String location
String[] class_names
)
```

### renameCloudCredentials( class\_names, new\_names ) throws ObjectAlreadyExists, ObjectDoesNotExist, InvalidObjectName, DeploymentError

Rename the named sets of cloud credentials.

```bash
void renameCloudCredentials(
String[] class_names
String[] new_names
)
```

### setApiServer( class\_names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError

Set the vcenter server hostname or IP address.

```bash
void setApiServer(
String[] class_names
String[] values
)
```

### setApiServerByLocation( location, class\_names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError

Set the vcenter server hostname or IP address. This is a location specific function, any action will operate on the specified location.

```bash
void setApiServerByLocation(
String location
String[] class_names
String[] values
)
```

### setChangeProcessTimeout( class\_names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError

Set the amount of time change calls are allowed to take

```bash
void setChangeProcessTimeout(
String[] class_names
Unsigned Integer[] values
)
```

### setChangeProcessTimeoutByLocation( location, class\_names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError

Set the amount of time change calls are allowed to take This is a location specific function, any action will operate on the specified location.

```bash
void setChangeProcessTimeoutByLocation(
String location
String[] class_names
Unsigned Integer[] values
)
```

### setCred1( class\_names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError

Set the cloud user name

```bash
void setCred1(
String[] class_names
String[] values
)
```

### setCred1ByLocation( location, class\_names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError

Set the cloud user name This is a location specific function, any action will operate on the specified location.

```bash
void setCred1ByLocation(
String location
String[] class_names
String[] values
)
```

### setCred2( class\_names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError

Set the cloud user password

```bash
void setCred2(
String[] class_names
String[] values
)
```

### setCred2ByLocation( location, class\_names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError

Set the cloud user password This is a location specific function, any action will operate on the specified location.

```bash
void setCred2ByLocation(
String location
String[] class_names
String[] values
)
```

### setCred3( class\_names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError

Set the cloud user authentication token

```bash
void setCred3(
String[] class_names
String[] values
)
```

### setCred3ByLocation( location, class\_names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError

Set the cloud user authentication token This is a location specific function, any action will operate on the specified location.

```bash
void setCred3ByLocation(
String location
String[] class_names
String[] values
)
```

### setScript( class\_names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError

Set the script

```bash
void setScript(
String[] class_names
String[] values
)
```

### setScriptByLocation( location, class\_names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError

Set the script This is a location specific function, any action will operate on the specified location.

```bash
void setScriptByLocation(
String location
String[] class_names
String[] values
)
```

### setUpdateInterval( class\_names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError

Set the interval at which cloud status is queried

```bash
void setUpdateInterval(
String[] class_names
Unsigned Integer[] values
)
```

### setUpdateIntervalByLocation( location, class\_names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError

Set the interval at which cloud status is queried This is a location specific function, any action will operate on the specified location.

```bash
void setUpdateIntervalByLocation(
String location
String[] class_names
Unsigned Integer[] values
)
```

### Structures

### System.CloudCredentials.CredentialsData

This structure contains the information needed to create CloudCredentials

```bash
struct System.CloudCredentials.CredentialsData {
# The user name (mandatory)
String cred1;
# The password (mandatory)
String cred2;
# The authorization token (can be empty)
String cred3;
# The script to use for API calls (mandatory)
String script;
# Time period to wait between status API calls in seconds
Integer update_interval;
}
```