Server Class

Server Class

Extends SimpleServer with detailed information about a server.

Inheritance Hierarchy

SystemObject
  net.openstack.Core.DomainExtensibleJsonObject
    net.openstack.Core.DomainProviderStateBaseIComputeProvider
      net.openstack.Core.DomainServerBase
        net.openstack.Core.DomainSimpleServer
          net.openstack.Core.DomainServer

Namespace: net.openstack.Core.Domain
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c

Syntax

C++

Copy

[JsonObjectAttribute(MemberSerialization.OptIn)]
public class Server : SimpleServer

<JsonObjectAttribute(MemberSerialization.OptIn)>
Public Class Server
	Inherits SimpleServer

[JsonObjectAttribute(MemberSerialization::OptIn)]
public ref class Server : public SimpleServer

[<JsonObjectAttribute(MemberSerialization.OptIn)>]
type Server =  
    class
        inherit SimpleServer
    end

The Server type exposes the following members.

Constructors

	Name	Description
	Server	Initializes a new instance of the Server class

Top

Methods

	Name	Description
	AddMetadata(Metadata)	Updates the metadata for the server.
	AddMetadata(String, String)	Adds or updates the value for the specified metadata item.
	AttachVolume	Attaches a volume to the server. (Inherited from ServerBase.)
	ConfirmResize	Confirms a completed asynchronous server resize action. (Inherited from ServerBase.)
	CreateSnapshot	Creates a new snapshot image for a specified server at its current state. (Inherited from ServerBase.)
	CreateVirtualInterface	Creates a virtual interface for the specified network and attaches the network to the server.
	Delete	Marks the server for asynchronous deletion.
	DeleteMetadata	Deletes the specified metadata items from the server.
	DeleteMetadataItem	Deletes the specified metadata item from the server.
	DeleteVirtualInterface	Deletes the specified virtual interface from the server.
	DetachVolume	Detaches the specified volume from the server. (Inherited from ServerBase.)
	GetDetails	Gets the detailed information for the server. (Inherited from ServerBase.)
	GetMetadata	Gets the metadata associated with the server.
	GetVolumes	Lists the volume attachments for the server.
	HardReboot	Initiates an asynchronous hard reboot operation on the specified server. (Inherited from ServerBase.)
	ListAddresses	Lists all networks and server addresses associated with a server.
	ListAddressesByNetwork	Lists addresses for the server associated with the specified network.
	ListVirtualInterfaces	Lists the virtual interfaces for the server.
	ListVolumes	Lists the volume attachments for the server. (Inherited from ServerBase.)
	Rebuild	Initiates an asynchronous rebuild of the server. (Inherited from ServerBase.)
	Refresh	Updates the current instance to match the values in the Server instance returned from a call to GetDetails. (Inherited from ServerBase.)
	Rescue	Places the server in rescue mode. (Inherited from ServerBase.)
	Resize	Initiates an asynchronous resize of the server. A server resize is performed by specifying a new Flavor for the server. (Inherited from ServerBase.)
	RevertResize	Cancels and reverts a server resize action. (Inherited from ServerBase.)
	SetMetadata	Sets the metadata associated with the server, replacing any existing metadata.
	Snapshot	Creates a new snapshot image for the server at its current state.
	SoftReboot	Initiates an asynchronous soft reboot operation on the specified server. (Inherited from ServerBase.)
	UnRescue	Takes the server out of rescue mode. (Inherited from ServerBase.)
	UpdateMetadata	Updates the metadata for the server.
	UpdateMetadataItem	Sets the value for the specified metadata item. If the key already exists, it is updated; otherwise, a new metadata item is added.
	WaitForActive	Waits for the server to enter the Active state. (Inherited from ServerBase.)
	WaitForDeleted	Waits for the server to enter the Deleted state. (Inherited from ServerBase.)
	WaitForState(ServerState, ServerState, Int32, NullableTimeSpan, ActionInt32)	Waits for the server to enter a specified state. (Inherited from ServerBase.)
	WaitForState(ServerState, ServerState, Int32, NullableTimeSpan, ActionInt32)	Waits for the server to enter any one of a set of specified states. (Inherited from ServerBase.)

Top

Properties

Name

Description

AccessIPv4

Gets the public IP version 4 access address.

Caution
The value of this property is not defined by OpenStack, and may not be consistent across vendors.

AccessIPv6

Gets the public IP version 6 access address.

Caution
The value of this property is not defined by OpenStack, and may not be consistent across vendors.

Addresses

Gets the public and private IP addresses for the server.

Caution
The value of this property is not defined by OpenStack, and may not be consistent across vendors.

Created

Gets the time stamp for the creation date.

Caution
The value of this property is not defined by OpenStack, and may not be consistent across vendors.

DiskConfig

Gets the disk configuration used for creating, rebuilding, or resizing the server. If the value was not explicitly specified in the create, rebuild, or resize request, the server inherits the value from the image it was created from.

ExtensionData

Gets a map of object properties which did not map to another field or property during JSON deserialization. The keys of the map represent the property names, and the values are JToken instances containing the parsed JSON values.

(Inherited from ExtensibleJsonObject.)

Flavor

Gets basic information about the flavor for the server.

Caution
The value of this property is not defined by OpenStack, and may not be consistent across vendors.

HostId

Gets the host ID for the server.

Gets the unique identifier for the server.

Caution
The value of this property is not defined by OpenStack, and may not be consistent across vendors.

(Inherited from ServerBase.)

Image

Gets basic information about the image the server was created from.

Caution
The value of this property is not defined by OpenStack, and may not be consistent across vendors.

Links

Gets a collection of links related to the current server.

(Inherited from ServerBase.)

Name

Gets the server name.

Caution
The value of this property is not defined by OpenStack, and may not be consistent across vendors.

(Inherited from SimpleServer.)

PowerState

Gets the power state for the server.

Progress

Gets the build completion progress, as a percentage.

Caution
The value of this property is not defined by OpenStack, and may not be consistent across vendors.

Status

Gets the server status.

Caution
The value of this property is not defined by OpenStack, and may not be consistent across vendors.

TaskState

Gets the task state for the server.

TenantId

Gets the tenant ID of the server.

Caution
The value of this property is not defined by OpenStack, and may not be consistent across vendors.

Updated

Gets the time stamp for the last update.

Caution
The value of this property is not defined by OpenStack, and may not be consistent across vendors.

UserId

Gets the user ID for the server.

Caution
The value of this property is not defined by OpenStack, and may not be consistent across vendors.

VMState

Gets the virtual machine (VM) state for the server.

Top

Version Information

.NET Framework

Supported in: 4.5

openstack.net

Supported in: 1.6, 1.5, 1.4, 1.3.6

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

net.openstack.Core.Domain Namespace

IComputeProviderGetDetails(String, String, CloudIdentity)

Other Resources

Get Server Details (OpenStack Compute API v2 and Extensions Reference)