Server.UpdateMetadataItem Method

ServerUpdateMetadataItem 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.Domain
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c

Syntax

C++

Copy

public bool UpdateMetadataItem(
	string key,
	string value
)

Public Function UpdateMetadataItem ( 
	key As String,
	value As String
) As Boolean

public:
bool UpdateMetadataItem(
	String^ key, 
	String^ value
)

member UpdateMetadataItem : 
        key : string * 
        value : string -> bool

Parameters

key: Type: SystemString
The metadata key.
value: Type: SystemString
The new value for the metadata item.

Return Value

Type: Boolean
if the metadata for the server was successfully updated; otherwise, .

Exceptions

Exception	Condition
ArgumentNullException	If key is . -or- If value is .
ArgumentException	If key is empty.
ResponseException	If the REST API request failed.

Exception

Condition

ArgumentNullException

If key is .

-or-

If value is .

ArgumentException

If key is empty.

ResponseException

If 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

Reference

Server Class

net.openstack.Core.Domain Namespace

IComputeProviderSetServerMetadataItem(String, String, String, String, CloudIdentity)

Other Resources

Set Metadata Item (OpenStack Compute API v2 and Extensions Reference)