Click or drag to resize
IComputeProviderSetServerMetadataItem Method
Sets the value for the specified metadata item. If the key already exists, it is updated; otherwise, a new metadata item is added.

Namespace: net.openstack.Core.Providers
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax
bool SetServerMetadataItem(
	string serverId,
	string key,
	string value,
	string region = null,
	CloudIdentity identity = null
)

Parameters

serverId
Type: SystemString
The server ID. This is obtained from ServerBase.Id.
key
Type: SystemString
The metadata key.
value
Type: SystemString
The new value for the metadata item.
region (Optional)
Type: SystemString
The region in which to execute this action. If not specified, the user's default region will be used.
identity (Optional)
Type: net.openstack.Core.DomainCloudIdentity
The cloud identity to use for this request. If not specified, the default identity for the current provider instance will be used.

Return Value

Type: Boolean
if the metadata for the server was successfully updated; otherwise, .
Exceptions
ExceptionCondition
ArgumentNullException If serverId is .

-or-

If key is .

-or-

If value is .

ArgumentException If serverId is empty.

-or-

If key is empty.

NotSupportedException If the provider does not support the given identity type.

-or-

The specified region is not supported.

InvalidOperationException If identity is and no default identity is available for the provider.

-or-

If region is and no default region is available for the provider.

ResponseExceptionIf the REST API request failed.
Version Information

.NET Framework

Supported in: 4.5

openstack.net

Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also