Changed1

[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]

vmware-cloud-director

Set Config

Description

Sets a configuration property to the provided value.

Request

URL

put

https://{api_host}/cloudapi/1.0.0/site/configurations/{urn}

Copy

Path Parameters

string

urn Required

URN containing the name of the configuration property such as (urn:vcloud:configuration:)

Request Body

Config of type(s) application/json Required

The configuration with the desired value.

Show optional properties

{
	"name": "string"
}

{
	"defaultValue": {},
	"description": "string",
	"maxValue": 0,
	"minValue": 0,
	"name": "string",
	"restartRequired": false,
	"timestamp": "string",
	"typedValue": {
		"type": "string",
		"value": {}
	}
}

string

name Required

Name of the configuration property.

InlineConfigDefaultValue

defaultValue Introduced Optional

Default value of the configuration property.

string

description Introduced Optional

A string describing the configuration property.

number as double

maxValue Introduced Optional

Maximum value for this configuration property.

number as double

minValue Introduced Optional

Minimum value for this configuration property.

boolean

restartRequired Introduced Optional

Represents if the cell needs to be rebooted for a change to this property to take effect.

string as date-time

timestamp Introduced Optional

Maximum value for this configuration property.

TypedValue

typedValue Optional

The value of the configuration property.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Response

Response Body

200 OK

Returns Config of type(s) application/json;version=36.3

{
	"defaultValue": {},
	"description": "string",
	"maxValue": 0,
	"minValue": 0,
	"name": "string",
	"restartRequired": false,
	"timestamp": "string",
	"typedValue": {
		"type": "string",
		"value": {}
	}
}

string

name Required

Name of the configuration property.

InlineConfigDefaultValue

defaultValue Introduced Optional

Default value of the configuration property.

string

description Introduced Optional

A string describing the configuration property.

number as double

maxValue Introduced Optional

Maximum value for this configuration property.

number as double

minValue Introduced Optional

Minimum value for this configuration property.

boolean

restartRequired Introduced Optional

Represents if the cell needs to be rebooted for a change to this property to take effect.

string as date-time

timestamp Introduced Optional

Maximum value for this configuration property.

TypedValue

typedValue Optional

The value of the configuration property.

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"defaultValue":{},"description":"string","maxValue":0,"minValue":0,"name":"string","restartRequired":false,"timestamp":"string","typedValue":{"type":"string","value":{}}}' https://{api_host}/cloudapi/1.0.0/site/configurations/{urn}

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vcloud-event: com/vmware/vcloud/event/configuration/property/modify

vmware-cloud-director

What's changed in v36.3?

INTRODUCED

Availability

Added in 36.0

Configurations Operations

get

Get Config Introduced

get

Get Configs

put

Set Config Introduced

Set Config

Request

URL

Path Parameters

Request Body

Authentication

ApiKeyAuth

Response

Response Body

200 OK

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

Vendor Extensions

What's changed in v36.3?

Availability

On This Page

Configurations Operations

Was this page helpful?