Defines a vServer and lists the available operations for managing it.
A vServer is a virtual server; it has its own identity, storage, network interfaces, and configuration, which exist for the lifetime of the vServer.
The APIs and CLI provide operations for:
Use either the cloud infrastructure API actions or the cloud infrastructure CLI command to perform these operations.
Describes the purpose of a vServer and how users create them.
A vServer is a virtual server or a virtual machine (VM). It has a standalone operating system and consumes CPU and memory resources from its virtual datacenter (vDC). A vServer has its own identity, storage, interfaces, and configuration, which exist for the full lifetime of the vServer. For network connectivity, the vServer can be a member of one or more virtual networks (vNets).
Users with a cloud account create vServers for their applications and manage the vServers, using computing, network, and storage resources of the vDC. To create a vServer, Cloud Users use a template of a vServer type that specifies the platform and characteristics such as CPU, memory size, and network bandwidth so that each vServer is created consistently and within the limits of the account quota. In addition to local storage, a vServer can be defined to use hard disk storage by associating the vserver with one or more volumes.
Lists the API action and CLI command for displaying a vServer type.
A cloud user can get information about all available vServer types for an account. The cloud user can restrict the vServer types included in the result by specifying filters. The result includes a list of the vServer types found and additional information for each vServer type.
If the response is an empty list, contact your cloud administrator to verify your cloud user's privileges.
The attributes displayed for each vServer type are:
ID
Name
Description
Memory Size
Storage Size
vCPU
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
Example 3-63 Listing vServer types using the Cloud Infrastructure API
https://<EnterpriseControllerHostname>/iaas/?Action=DescribeVserverTypes&Version=1&Timestamp=1318625453358&Expires=1318625753358&AccessKeyId=AK_2&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1
Example 3-64 Listing vServer types using the Cloud Infrastructure CLI
iaas-describe-vserver-types --base-url https://<EnterpriseControllerHostname>/ -a ak.file -H
Lists the API action and CLI command for creating a vServer.
A cloud user can create a one or more vServers based on a server template. When a vServer is created, it is automatically started.
You can create a vServer using a static or an automatic method for IP address assignment. When using the static method, you can create only a single vServer and you must use an allocated vIP address from the specified vNets. When using the automatic IP assignment method, you can create one or more vServers an IP addresses are automatically assigned from each specified vNets.
When a cloud user creates a vServer, the following resources are required:
A vServer type
A server template
One or more vNets
One or more IP addresses, when using the option for static IP assignment.
Depending on the needs of the user and the virtualization type of the vDC, a cloud user can also specify the following resources:
A key pair
One or more volumes
A distribution group
In addition, a cloud user can specify the following values when creating a vServer:
A host name to override vServer default internal host name, which is same as vServer name.
A root password for the vServer
A local user and password
One or more messages for the vServer
Enable or disable high availability
When creating a vServer, a cloud user has the option to change the high availability feature for the vServer, which is set by the value of the HighAvailabilityDefault capability of the vDC. If a cloud user chooses not to use the default value, an option is available to specify a value and to enable the HighAvailabilityUserControl capability of the vDC. Cloud users can also enable or disable high availability for an existing vServer, according to the procedure in "Modifying Attributes of an Account Resource".
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
|
RunVserverRequest for static IP assignment |
iaas-run-vserver for static IP assignment |
|
RunVserverRequest for automatic IP assignment |
iaas-run-vserver for automatic IP assignment |
Example 3-65 Creating a vServer using the Cloud Infrastructure API
https://<EnterpriseControllerHostname>/iaas/?Action=RunVserver&Version=1&Timestamp=1321379615665&Expires=1321379915665&vserverType=457&keyName=myKeyPair&vnets.1=VNET-84ada392-1c13-4f86-8365-1cf7f9c8aadf&name=myVserver&ipAddresses.1=192.0.2.2&serverTemplateId=TMPL-9e4a9ed3-e675-45f1-9d7c-b21c25a55632&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1
Example 3-66 Creating a vServer using the Cloud Infrastructure CLI
iaas-run-vserver --base-url https://<EnterpriseControllerHostname>/ -a ~/ak.file --vnets VNET-84ada392-1c13-4f86-8365-1cf7f9c8aadf --key-name myKeyPair --name myVserver --server-template-id TMPL-9e4a9ed3-e675-45f1-9d7c-b21c25a55632 --ip-addresses 192.0.2.2 --vserver-type 457
Lists the API action and CLI command for deleting a vServer.
A cloud user can delete a vServer. Deleting a vServer results in shutting down the vServer followed by the deletion of the vServer.
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
Example 3-67 Deleting a vServer using the Cloud Infrastructure API
https://<EnterpriseControllerHostname>/iaas/?Action=TerminateVservers&Version=1&Timestamp=1321385662260&Expires=1321385962260&vserverIds.1=VSRV-0fb57293-347c-4717-96ef-6dd23154596f&force=true&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1
Example 3-68 Deleting a vServer using the Cloud Infrastructure CLI
iaas-terminate-vservers --base-url https://<EnterpriseControllerHostname>/ -a ~/ak.file --vserver-ids VSRV-0fb57293-347c-4717-96ef-6dd23154596f --force
Lists the API action and CLI command for displaying a vServer.
A cloud user can get information about all available vServers for an account. The cloud user can restrict the vServers included in the result by specifying filters. The result includes a list of the vServers found and additional information for each vServer.
The attributes displayed for each vServer are:
ID: ID of the vServer
Name: Name of the vServer
Description: Description of the vServer
Status: Status of the vServer
vNets: IDs of the vNets to which the vServer belongs to
IP addresses: IP addresses associated with the vServer
Server template ID: ID of the server template that the vServer is based on
Key pair name: Name of the key pair installed in the vServer for secure shell access
vServer type: vServer type that the vServer is based on
HA: Flag to indicate whether the vServer is set to automatic recovery
Distribution group: ID of the distribution group the vServer belongs to
Volumes: ID of the volumes associated with the vServer
vCPU: Number of virtual CPUs allocated to a vServer
Memory: Total memory allocated to a vServer
Dedicated storage: Total storage dedicated to the vServer
Attached storage: Total storage of the volumes attached to the vServer
Tags: List of tags associated with the vServer
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
Example 3-69 Viewing vServer information using the Cloud Infrastructure API
https://<EnterpriseControllerHostname>/iaas/?Action=DescribeVservers&Version=1&Timestamp=1320105338731&Expires=1320105638731&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1
Example 3-70 Viewing vServer information using the Cloud Infrastructure CLI
iaas-describe-vservers --base-url https://<EnterpriseControllerHostname>/ -a ak.file -H
Lists the API action and CLI command for displaying metrics about vServers.
A cloud user can get information about the CPU usage of the vServers. The cloud user can restrict the vServers included in the result by specifying filters. The result includes a list of the vServers found and additional information for each vServer.
The attributes displayed for each vServer are:
ID: ID of the vServer
Name: Name of the vServer
Description: Description of the vServer
Status: Status of the vServer
CPU usage: CPU usage of the vServer
Tags: List of tags associated with the vServer
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
Example 3-71 Viewing vServer metrics using the Cloud Infrastructure API
https://<EnterpriseControllerHostname>/iaas/?Action=DescribeVserverMetrics&Version=1&Timestamp=1320105338731&Expires=1320105638731&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1
Example 3-72 Viewing vServer metrics using the Cloud Infrastructure CLI
iaas-describe-vserver-metrics --base-url https://<EnterpriseControllerHostname>/ -a ak.file -H
Lists the API action and CLI command for stopping a vServer.
A cloud user can stop a vServer. When a vServer is stopped, the guest operating system is shut down. A stopped vServer can be restarted.
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
Example 3-73 Stopping a vServer using the Cloud Infrastructure API
https://<EnterpriseControllerHostname>/iaas/?Action=StopVservers&Version=1&Timestamp=1320105610783&Expires=1320105910783&vserverIds.1=VSRV-c1e236e6-ef4d-4936-911a-97923dfbc291&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1
Example 3-74 Stopping a vServer using the Cloud Infrastructure CLI
iaas-stop-vservers --base-url https://<EnterpriseControllerHostname>/ -a ak.file --vserver-ids VSRV-c1e236e6-ef4d-4936-911a-97923dfbc291
Lists the API action and CLI command for starting a vServer.
A cloud user can start a vServer that has been stopped. The restarted vServer might not get the same IP address as the original vServer.
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
Example 3-75 Starting a vServer using the Cloud Infrastructure API
https://<EnterpriseControllerHostname>/iaas/?Action=StartVservers&Version=1&Timestamp=1320104759496&Expires=1320105059496&vserverIds.1=VSRV-c1e236e6-ef4d-4936-911a-97923dfbc291&AccessKeyId=AK_3&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1
Example 3-76 Starting a vServer using the Cloud Infrastructure CLI
iaas-start-vservers --base-url https://<EnterpriseControllerHostname>/ -a ak.file --vserver-ids VSRV-c1e236e6-ef4d-4936-911a-97923dfbc291
Lists the API action and CLI command for rebooting a vServer.
A cloud user can reboot a vServer. Rebooting a vServer does not change the IP address and other resources of the vServer.
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
Example 3-77 Rebooting a vServer using the Cloud Infrastructure API
https://<EnterpriseControllerHostname>/iaas/?Action=RebootVservers&Version=1&Timestamp=1321380470326&Expires=1321380770326&vserverIds.1=VSRV-0fb57293-347c-4717-96ef-6dd23154596f&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1
Example 3-78 Rebooting a vServer using the Cloud Infrastructure CLI
iaas-reboot-vservers --base-url https://<EnterpriseControllerHostname>/ -a ~/ak.file --vserver-ids VSRV-0fb57293-347c-4717-96ef-6dd23154596f
Lists the API action and CLI command for sending a message to a vServer.
A cloud user can send messages to a vServer and these messages can be read from the guest operating system. The messages are sent to a common buffer in the virtualization layer that has a limited size. This action might return an error if the size limit is reached or if the vServer is not in an appropriate state to send messages.
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
Example 3-79 Sending messages to a vServer using the Cloud Infrastructure API
ttps://<EnterpriseControllerHostname>/iaas/?Action=SendMessagesToVserver&Version=1&Timestamp=1321381585564&Expires=1321381885564&messages.1.value=Running&messages.1.key=myStatus&vserverId=VSRV-8ae29df9-ccfe-4184-acb8-10080665d7f6&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1
Example 3-80 Sending messages to a vServer using the Cloud Infrastructure CLI
iaas-send-messages-to-vserver --base-url https://<EnterpriseControllerHostname>/ -a ~/ak.file --vserver-id VSRV-8ae29df9-ccfe-4184-acb8-10080665d7f6 --messages com.oracle.ovab.test=Running
Lists the API action and CLI command for receiving a vServer message.
A cloud user can read a message sent by a vServer. The message is read from the common buffer in the virtualization layer by name. This action might return an error if the vServer is not in appropriate state to receive messages.
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
Example 3-81 Receiving message from a vServer using the Cloud Infrastructure API
https://<EnterpriseControllerHostname>/iaas/?Action=ReceiveMessageFromVserver&Version=1&Timestamp=1321381585564&Expires=1321381885564&vserverId=VSRV-8ae29df9-ccfe-4184-acb8-10080665d7f6&key=myMessageKey&AccessKeyId=AK_1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST&SignatureMethod=SHA512withRSA&SignatureVersion=1
Example 3-82 Receiving message from a vServer using the Cloud Infrastructure CLI
iaas-receive-message-from-server --base-url https://<EnterpriseControllerHostname>/ -a ~/ak.file --vserver-id VSRV-8ae29df9-ccfe-4184-acb8-10080665d7f6 --key com.oracle.ovab.test-response