Server Class

Server Class

A virtual machine (VM) instance running on a host.

Inheritance Hierarchy

SystemObject
  OpenStack.Compute.v2_1ServerReference
    OpenStack.Compute.v2_1ServerSummary
      OpenStack.Compute.v2_1Server

Namespace: OpenStack.Compute.v2_1
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c

Syntax

C++

Copy

public class Server : ServerSummary

Public Class Server
	Inherits ServerSummary

public ref class Server : public ServerSummary

type Server =  
    class
        inherit ServerSummary
    end

The Server type exposes the following members.

Constructors

	Name	Description
	Server	Initializes a new instance of the Server class.

Top

Methods

	Name	Description
	AssociateFloatingIPAsync	Associates a floating IP address to the server.
	AttachVolumeAsync	Attaches a volume to a server.
	CancelResizeAsync	Cancels and reverts a pending resize action for a server. (Inherited from ServerReference.)
	ConfirmResizeAsync	Confirms a pending resize action for a server. (Inherited from ServerReference.)
	DeleteAsync	Deletes a server. (Inherited from ServerReference.)
	DisassociateFloatingIPAsync	Disassociate a floating IP address from a server.
	GetAddressAsync	(Inherited from ServerReference.)
	GetConsoleOutputAsync	Shows console output for a server instance. (Inherited from ServerReference.)
	GetMetadataAsync	Gets all metadata for a server. (Inherited from ServerReference.)
	GetMetadataItemAsync	Shows details for a metadata item, by key, for a server. (Inherited from ServerReference.)
	GetRdpConsoleAsync	Gets an RDP console for a server. (Inherited from ServerReference.)
	GetSerialConsoleAsync	Gets a serial console for a server. (Inherited from ServerReference.)
	GetServerAsync	Shows details for a server. (Inherited from ServerReference.)
	GetSpiceConsoleAsync	Gets a SPICE console for a server. (Inherited from ServerReference.)
	GetVncConsoleAsync	Gets a VNC console for a server. (Inherited from ServerReference.)
	ListActionSummariesAsync	Lists the actions which have been applied to a sever. (Inherited from ServerReference.)
	ListAddressesAsync	Lists IP addresses that are assigned to a server. (Inherited from ServerReference.)
	ListVolumesAsync	Lists the volume attachments for a server. (Inherited from ServerReference.)
	RebootAsync	Reboots a server. (Inherited from ServerReference.)
	RescueAsync	Puts a server in rescue mode and changes its status to RESCUE. (Inherited from ServerReference.)
	ResizeAsync	Resizes a server. Depending on the cloud configuration, ConfirmResizeServerAsync(String, CancellationToken) may need to be called to complete the resize operation. (Inherited from ServerReference.)
	ResumeAsync	Resumes a suspended server and changes its status to ACTIVE. (Inherited from ServerReference.)
	SnapshotAsync	Creates a snapshot image from a server. (Inherited from ServerReference.)
	StartAsync	Starts a stopped server and changes its status to ACTIVE. (Inherited from ServerReference.)
	StopAsync	Stops a running server and changes its status to SHUTOFF. (Inherited from ServerReference.)
	SuspendAsync	Suspends a server and changes its status to SUSPENDED. (Inherited from ServerReference.)
	UnrescueAsync	Unrescues a server. Changes status to ACTIVE. (Inherited from ServerReference.)
	UpdateAsync	Updates the editable attributes of a server.
	WaitForStatusAsync(ServerStatus, NullableTimeSpan, NullableTimeSpan, IProgressBoolean, CancellationToken)	Waits for the server to reach the specified status.
	WaitForStatusAsync(IEnumerableServerStatus, NullableTimeSpan, NullableTimeSpan, IProgressBoolean, CancellationToken)	Waits for the server to reach the specified status.
	WaitUntilActiveAsync	Waits the until the server is active.
	WaitUntilDeletedAsync	Waits for the server to be deleted. Treats a 404 NotFound exception as confirmation that it is deleted. (Overrides ServerReferenceWaitUntilDeletedAsync(NullableTimeSpan, NullableTimeSpan, IProgressBoolean, CancellationToken).)

Top

Extension Methods

	Name	Description
	AssociateFloatingIP	Associates a floating IP address to the server. (Defined by ServerExtensions_v2_1.)
	AttachVolume	Attaches a volume to a server. (Defined by ServerExtensions_v2_1.)
	CancelResize	Cancels and reverts a pending resize action for a server. (Defined by ServerExtensions_v2_1.)
	ConfirmResize	Confirms a pending resize action for a server. (Defined by ServerExtensions_v2_1.)
	Delete	Deletes a server. (Defined by ServerExtensions_v2_1.)
	DisassociateFloatingIP	Disassociate a floating IP address from a server. (Defined by ServerExtensions_v2_1.)
	EvacuateAsync	(Defined by ServerExtensions.)
	GetAddress	Shows details for a server. (Defined by ServerExtensions_v2_1.)
	GetConsoleOutput	Shows console output for a server instance. (Defined by ServerExtensions_v2_1.)
	GetMetadata	Gets all metadata for a server. (Defined by ServerExtensions_v2_1.)
	GetMetadataItem	Shows details for a metadata item, by key, for a server. (Defined by ServerExtensions_v2_1.)
	GetRdpConsole	Gets an RDP console for a server. (Defined by ServerExtensions_v2_1.)
	GetSerialConsole	Gets a SPICE console for a server. (Defined by ServerExtensions_v2_1.)
	GetServer	Shows details for a server. (Defined by ServerExtensions_v2_1.)
	GetSpiceConsole	Gets a SPICE console for a server. (Defined by ServerExtensions_v2_1.)
	GetVncConsole	Gets a VNC console for a server. (Defined by ServerExtensions_v2_1.)
	ListActionSummaries	Lists the actions which have been applied to a sever. (Defined by ServerExtensions_v2_1.)
	ListAddresses	Shows details for a server. (Defined by ServerExtensions_v2_1.)
	ListVolumes	Lists the volume attachments for a server. (Defined by ServerExtensions_v2_1.)
	Reboot	Reboots a server. (Defined by ServerExtensions_v2_1.)
	Rescue	Puts a server in rescue mode and changes its status to RESCUE. (Defined by ServerExtensions_v2_1.)
	Resize	Resizes a server. Depending on the cloud configuration, ConfirmResizeServerAsync(String, CancellationToken) may need to be called to complete the resize operation. (Defined by ServerExtensions_v2_1.)
	Resume	Resumes a suspended server and changes its status to ACTIVE. (Defined by ServerExtensions_v2_1.)
	Snapshot	Creates a snapshot image from a server. (Defined by ServerExtensions_v2_1.)
	Start	Starts a stopped server and changes its status to ACTIVE. (Defined by ServerExtensions_v2_1.)
	Stop	Stops a running server and changes its status to SHUTOFF. (Defined by ServerExtensions_v2_1.)
	Suspend	Suspends a server and changes its status to SUSPENDED. (Defined by ServerExtensions_v2_1.)
	Unrescue	Puts a server in rescue mode and changes its status to RESCUE. (Defined by ServerExtensions_v2_1.)
	Update	Updates the editable attributes of a server. (Defined by ServerExtensions_v2_1.)
	WaitForStatus(ServerStatus, NullableTimeSpan, NullableTimeSpan, IProgressBoolean)	Overloaded. Waits for the server to reach the specified status. (Defined by ServerExtensions_v2_1.)
	WaitForStatus(IEnumerableServerStatus, NullableTimeSpan, NullableTimeSpan, IProgressBoolean)	Overloaded. Waits for the server to reach the specified status. (Defined by ServerExtensions_v2_1.)
	WaitUntilActive	Waits the until the server is active. (Defined by ServerExtensions_v2_1.)
	WaitUntilDeleted	Waits for the server to be deleted. Treats a 404 NotFound exception as confirmation that it is deleted. (Defined by ServerExtensions_v2_1.)

Top

Properties

	Name	Description
	Addresses	The IP addresses for the server.
	AdminPassword	The administrative password. The password is only available immediately after creating the server, and otherwise is empty.
	AttachedVolumes	The attached volumes, if any.
	AvailabilityZone	The availability zone in which the server is located.
	Created	The date and time when the resource was created.
	Deleted	The date and time when the server was deleted.
	DiskConfig	The server disk configuration.
	Flavor	The flavor for the server instance.
	HostId	The host identifier.
	Id	The server identifier. (Inherited from ServerReference.)
	Image	The image for the server instance.
	IPv4Address	The server v4 IP address.
	IPv6Address	The server v6 IP address.
	KeyPairName	The name of associated key pair, if any.
	LastModified	The date and time when the resource was updated.
	Launched	The date and time when the server was launched.
	Metadata	The associated metadata key and value pairs.
	Name	The server name. (Inherited from ServerSummary.)
	PowerState	The power state of the server.
	Progress	A percentage value of the build progress.
	SecurityGroups	Associated security groups.
	Status	The server status.
	TaskState	The task state of the server.
	VMState	The underlying VM state.

Top

Version Information

.NET Framework

Supported in: 4.5

openstack.net

Supported in: 1.6

Reference

OpenStack.Compute.v2_1 Namespace