CloudServersProvider.UpdateServerMetadata Method |
Updates the metadata for the specified server.
Namespace: net.openstack.Providers.RackspaceAssembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntaxpublic bool UpdateServerMetadata(
string serverId,
Metadata metadata,
string region = null,
CloudIdentity identity = null
)
Public Function UpdateServerMetadata (
serverId As String,
metadata As Metadata,
Optional region As String = Nothing,
Optional identity As CloudIdentity = Nothing
) As Boolean
public:
virtual bool UpdateServerMetadata(
String^ serverId,
Metadata^ metadata,
String^ region = nullptr,
CloudIdentity^ identity = nullptr
) sealed
abstract UpdateServerMetadata :
serverId : string *
metadata : Metadata *
?region : string *
?identity : CloudIdentity
(* Defaults:
let _region = defaultArg region null
let _identity = defaultArg identity null
*)
-> bool
override UpdateServerMetadata :
serverId : string *
metadata : Metadata *
?region : string *
?identity : CloudIdentity
(* Defaults:
let _region = defaultArg region null
let _identity = defaultArg identity null
*)
-> bool
Parameters
- serverId
- Type: System.String
The server ID. This is obtained from ServerBase.Id. - metadata
- Type: net.openstack.Core.Domain.Metadata
The server metadata to update. - region (Optional)
- Type: System.String
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.Domain.CloudIdentity
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:
Booleantrue if the metadata for the server was successfully updated; otherwise,
false.
Implements
IComputeProvider.UpdateServerMetadata(String, Metadata, String, CloudIdentity)
ExceptionsException | Condition |
---|
ArgumentNullException |
If serverId is null.
-or- If metadata is null. |
ArgumentException |
If serverId is empty.
-or- If metadata contains any values with empty keys. |
NotSupportedException |
If the provider does not support the given identity type.
-or- The specified region is not supported. |
InvalidOperationException |
If identity is null and no default identity is available for the provider.
-or- If region is null and no default region is available for the provider. |
ResponseException | If the REST API request failed. |
Remarks
For each item in metadata, if the key exists, the value is updated; otherwise, the item is added.
Version Information.NET Framework
Supported in: 4.5
openstack.net
Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also