The following sections describes Deployer operations in the Oracle Virtual Assembly Builder Deployer Web Service API which are used to manage assembly archives and deployment aspects of the software system contained therein:
The following designations apply to parameters in the "Other Parameters in HTTP Query String" sections of each operation:
1..1 : Parameter is required, and can have exactly one occurrence.
1..* : Parameter is required, and can have multiple occurrences.
0..1 : Parameter is optional, and can have exactly one occurrence, if provided.
0..* : Parameter is optional, and can have multiple occurrences, if provided.
This operation grants access to an assembly to other users. This operation can only be called by the assembly owner or Cloud Admin. The owner is defined to be the user who first uploaded the assembly to the Deployer.
A user who is granted access may register the assembly with a target and create an assembly instance.
Other Parameters in HTTP Query String
user 1..*
assembly.name 1..1
POST
N/A
Synchronous.
text/xml Element: AddAssemblyUsersResult
This operation creates an assembly instance for an assembly.
Other Parameters in HTTP Query String
assembly.name 1..1
assembly.version 1..1
target 1..1
plan.name 0..1
POST
application/octetstream
Plan file
Synchronous.
text/xml Element: CreateAssemblyInstanceResult
This operation creates one or more tags for a resource.
Other Parameters in HTTP Query String
tag 1..*
resource.id 1..1
POST
N/A
Synchronous.
text/xml Element: CreateTagsResult
This operation deletes an assembly archive from the Deployer. This operation may only be performed if there are no registrations for the assembly archive.
Other Parameters in HTTP Query String
assembly.name 1..1
assembly.version 1..1
POST
N/A
Synchronous.
text/xml Element: DeleteAssemblyArchiveResult
This operation deletes an assembly instance. This operation can only be executed when the assembly is in an undeployed state.
Other Parameters in HTTP Query String
assembly.instance.id
1..1
POST
N/A
Synchronous.
text/xml Element: DeleteAssemblyInstanceResult
This operation deletes resources associated with an assembly version.
Other Parameters in HTTP Query String
assembly.name
1..1
assembly.version
1..1
file
0..1 (a list of resource paths to be deleted. If unset, will delete all resources).
POST
N/A
Synchronous.
text/xml Element: DeleteAssemblyResourcesResult
This operation deletes a deployment plan from the Deployer repository (note, this operation fails if you try to delete a plan that is in use).
Other Parameters in HTTP Query String
assembly.name
1..1
assembly.version
1..1
assembly.plan.name
1..1
POST
N/A
Synchronous.
text/xml Element: DeleteDeploymentPlanResult
This operation deletes log events in the system. If you do not supply any parameters, all events are deleted.
Other Parameters in HTTP Query String
event.type 0..1
user 0..1
assembly.instance.id 0..1
POST
N/A
Synchronous.
text/xml Element: DeleteLogEventsResult
This operation deletes one or more previously completed requests.
Other Parameters in HTTP Query String
request.id 1..1
POST
N/A
Synchronous.
text/xml Element: DeleteRequestsResult
This operation deletes one or more tags for a resource.
Other Parameters in HTTP Query String
tag 1..*
resource.id 1..1
POST
N/A
Synchronous.
text/xml Element: DeleteTagsResult
This operation deploys an assembly instance. This operation orchestrates the creation of the initial instances for the deployment defined in the OVF and deployment plan.
Other Parameters in HTTP Query String
assembly.instance.id 1..1
POST
Request Contexrequest contextt
N/A
Asynchronous.
text/xml Element: DeployAssemblyInstanceResult
This operation describes one or more assembly archives in the Deployer repository.
Other Parameters in HTTP Query String
assembly.name 1..*
GET
N/A
Synchronous.
text/xml Element: DescribeAssemblyArchivesResult
This operation describes one or more deployed instances of an assembly.
In addition to information about the IDs and states of the deployed instances, the response content includes a list of elements that indicate the name, IP address, network name, and public/private status for each network interface of an appliance instance.
Other Parameters in HTTP Query String
assembly.instance.id 0..1
appliance.id 0..1
instance.id 0..1
GET
N/A
Synchronous.
text/xml Element: DescribeApplianceInstancesResult
This operation describes one or more assembly instances.
Other Parameters in HTTP Query String
assembly.instance.id 1..*
GET
N/A
Synchronous.
text/xml Element: DescribeAssemblyInstancesResult
This operation describes resources associated with an assembly.
Other Parameters in HTTP Query String
assembly.name
1..1
assembly.version
1..1
GET
N/A
Synchronous.
text/xml Element: DescribeAssemblyResourcesResult
This operation describes one or more users of an assembly.
Other Parameters in HTTP Query String
assembly.name 1..1
GET
N/A
Synchronous.
text/xml Element: DescribeAssemblyUsersResult
This operation provides version information for the Deployer.
Other Parameters in HTTP Query String
N/A
GET
N/A
Synchronous.
text/xml Element: RedeployAssemblyInstanceResult
This operation describes log events in the system. If you do not supply any parameters, all events are described, otherwise, the result is filtered by the parameters you supply.
The Deployer tracks certain VM lifecycle events for viewing by an OVAB administrator. The events are:
VM_CREATE
VM_START
VM_STOP
VM DESTROY
The following information is stored for each VM_START, VM_STOP and VM_DESTROY event:
user
timestamp
deployment ID
assembly name
appliance path
appliance instance index
The following information is stored for each VM_CREATE operation:
CPU requirement
MEMORY requirement
DISK requirement
Other Parameters in HTTP Query String
user 0..1
assembly.instance.id 0..1
after.time 0..1
before.time 0..1
GET
N/A
Synchronous.
text/xml Element: DescribeLogEventsResult
This operation describes one or more assembly registrations.
Other Parameters in HTTP Query String
assembly.name 1..1
assembly.version 1..1
GET
N/A
Synchronous.
text/xml Element: DescribeRegistrationsResult
This operation describes one or more previously issued requests.
Other Parameters in HTTP Query String
request.id 1..*
GET
N/A
Synchronous.
text/xml Element: DescribeRequestsResult
This operation describes one or more scaling groups.
Other Parameters in HTTP Query String
assembly.instance.id 0..*
scalinggroup.id 0..*
GET
N/A
Synchronous.
text/xml Element: DescribeScalingGroupsResult
This operation describes one or more tags for a resource.
Other Parameters in HTTP Query String
tag 1..*
resource.id 1..1
GET
N/A
Synchronous.
text/xml Element: DescribeTagsResult
This operation describes one or more assembly instance targets.
Other Parameters in HTTP Query String
target 1..*
GET
N/A
Synchronous.
text/xml Element: DescribeTargetsResult
This operation describes one or more networks.
Other Parameters in HTTP Query String
target 1..1
id 0..*
GET
N/A
Synchronous.
text/xml Element: DescribeVnetsResult
This operation downloads an assembly from the Deployer.
Other Parameters in HTTP Query String
assembly.name 1..1
assembly.version 1..1
POST
N/A
Synchronous.
application/octet-stream
assembly archive (.ova file)
This operation downloads assembly metadata descriptor from the Deployer.
Other Parameters in HTTP Query String
assembly.name 1..1
assembly.version 1..1
POST
N/A
Synchronous.
application/octet-stream
assembly metadata (.ovf file)
This operation downloads a resources zip file from the Deployer repository.
Other Parameters in HTTP Query String
assembly.name
1..1
assembly.version
1..1
POST
N/A
Synchronous.
application/octet-stream Assembly Resources Zip file
This operation redeploys an assembly instance.
Other Parameters in HTTP Query String
assembly.instance.id
1..1
POST
N/A
Asynchronous.
text/xml Element: RedeployAssemblyInstanceResult
This operation registers the archive with the backend virtualization system (Oracle VM).
Other Parameters in HTTP Query String
assembly.name
1..1
assembly.version
1..1
assembly.desc
1..1
POST
N/A
Synchronous.
text/xml Element: RegisterAssemblyArchiveResult
This operation removes users from an assembly.
Other Parameters in HTTP Query String
user 1..*
assembly.name 1..1
POST
N/A
Asynchronous.
text/xml Element: RemoveAssemblyUsersResult
This operation restarts an assembly instance.
Other Parameters in HTTP Query String
assembly.instance.id 1..1
POST
N/A
Asynchronous.
text/xml Element: RestartAssemblyInstanceResult
This operation resumes all vServers of an assembly instance.
Other Parameters in HTTP Query String
assembly.instance.id 1..1
POST
N/A
Asynchronous.
text/xml Element: ResumeAssemblyInstanceResult
This operation scales an appliance. This operation changes the number of instances desired for an appliance and will lead to instances being created and started or stopped and destroyed depending on the new number.
Other Parameters in HTTP Query String
scalinggroup.id 1..1
target 1..1
POST
N/A
Asynchronous.
text/xml Element: ScaleApplianceResult
This operation starts an assembly instance.
Other Parameters in HTTP Query String
deployment.id 1..1
POST
N/A
Asynchronous.
text/xml Element: StartAssemblyInstanceResult
This operation stops an assembly instance.
Other Parameters in HTTP Query String
assembly.instance.id 1..1
force 0..1 (default is false)
POST
N/A
Asynchronous.
text/xml Element: StopAssemblyInstanceResult
This operation suspends all vServers of an assembly instance. This is a virtual hibernate operation where the OS is not shut down.
Other Parameters in HTTP Query String
assembly.instance.id 1..1
POST
N/A
Asynchronous.
text/xml Element: SuspendAssemblyInstanceResult
This operation undeploys the assembly instance.
Other Parameters in HTTP Query String
assembly.instance.id 1..1
POST
N/A
Asynchronous.
text/xml Element: UndeployAssemblyInstanceResult
This operation removes the registration artifacts from the backend virtualization system (target). This operation can only be called if there are no assembly instances for this assembly archive in the target.
Other Parameters in HTTP Query String
assembly.version 1..1
assembly.name 1..1
target 1..1
POST
N/A
Synchronous.
text/xml Element: UnregisterAssemblyArchiveResult
This operation allows you to modify the description information for the assembly archive.
Note:
To upload a new version, you would call UploadAssemblyArchive again.
Other Parameters in HTTP Query String
assembly.name 1..1
assembly.version 1..1
assembly.desc 1..1
POST
N/A
Synchronous.
text/xml Element: UpdateAssemblyArchiveResult
This operation is used to upload an assembly operation from a client to the Deployer. The Deployer will keep multiple versions of an assembly archive so you may call this operation more than once for the same assembly.
Other Parameters in HTTP Query String
assembly.name 1..1
POST
application/octetstream
Assembly archive (.ova file)
Synchronous.
text/xml Element: UploadAssemblyArchiveResult
This operation uploads a resources zip file to the Deployer repository, and associates it with an assembly version.
You typically handle assembly resources as a set and would upload the resources in a single operation. If you needed to replace the resources you delete all of the resources and replace them with an upload of a new set of resources. This is the default behavior of these operations.
In the case of disk images, you may prefer replace a single image without incurring the cost of re-uploading all the resources. Also, since scripts are generally not tightly coupled to the assembly itself, you may want to modify or add scripts without having to re-upload all the resources.
For these reasons, these operations have optional options to support these scenarios. The DeleteAssemblyResources operation has a files option that allow you to specify a subset of files to be deleted. The default behavior if this is not supplied is to delete all resources. You can use the files option in conjunction with the append option of UploadAssemblyResources. The append option provides a way to add to the existing set of resources. You can achieve the notion of “replace” by deleting a subset of the resources – using the files option – and then uploading replacements for just those files with the append option of UploadAssemblyResources.
Other Parameters in HTTP Query String
assembly.name
1..1
assembly.version
1..1
append
0..1 (Allows upload of additional resources. Without this option, an attempt to do a second upload is rejected).
POST
application/octet-stream Assembly Resources zip file
Synchronous.
text/xml Element: UploadAssemblyResourcesResult
This operation uploads a deployment plan for an existing assembly to the Deployer repository. Provides a mechanism to store deployment plans in the deployer repository associated with a specific assembly version. Because you can specify a plan name to the CreateAssemblyInstance operation that references a previously uploaded deployment plan, uploading a plan at assembly creation time is optional.
Other Parameters in HTTP Query String
assembly.instance.id
1..1
POST
application/octet-stream deployment plan xml or zip stream
Synchronous.
text/xml Element: UploadDeploymentPlanResult
This operation checks to see if the target of an assembly instance has enough resources to deploy the assembly. It checks the following resources:
Memory availability
Disk availability
Network availability. Checks if the network with the name specified in the plan exists in the target.
ValidateAssemblyInstanceResources performs a deployer side check. There is also a ValidateAssemblyArchiveResources CLI operation which performs the same checks, but against an assembly archive that only exists on the client. There is no Web service equivalent of this operation. ValidateAssemblyArchiveResources works by querying the Deployer for current resource availability and then does the validation locally on the client using the data returned.
Other Parameters in HTTP Query String
assembly.instance.id 1..1
GET
N/A
Asynchronous.
text/xml Element: ValidateAssemblyInstanceResult