Users Guide

API Objects
There are eight API objects that are included in the ASM SDK module. This section covers each object and the associated attributes
and methods.
NOTE: Not all API objects have attributes and/or methods.
ASMAppliance
This object establishes HTTPS connection to the ASM REST webservice to make the requests. This is the most crucial object for
the Integration.
Attributes:
• displayName (String): String value that represents the display name of the ASM Appliance
• services (Array of ASM: Service objects): Array of ASM: Service objects that are children of the ASM: Appliance
object.
• templates (Array of ASM: Template objects): Array of ASM: Template objects that are children of the ASM: Appliance
object.
Methods:
• addDuplicateServer: This method clones server from the configuration of an existing server component. It duplicates servers
which have the same relations to other resources (For example, duplicated servers are added to the cluster where original
server belongs to). Server pool must be able to allocate physical server resources for the chosen configuration. Returned object
is the Service with updated components.
– deployment — Target Service where new server components are added.
– targetServer –ServiceComponent of SERVER type that provides the configuration for the duplicate servers.
– newServerName — Name of the new servers; if more than one instance of servers is requested, sequence number is
appended to the name.
– numInstances — Specifies the number of server instances that are added to the Service.
• addDuplicateStorage: This method clones storage from the configuration of an existing storage component. Duplicated
storages have the same relations to other resources (For example, duplicated storages are used by the servers that the original
storage support). Target volume must be able to allocate resources for the chosen configuration. Returned object is the Service
with updated components. The target storage component must be a new storage that was created through the ASM (For
example, a new volume in EqualLogic was created by the ASM during the deployment or update).
– deployment — Target Service where new server components are added.
– targetStorage — ServiceComponent of STORAGE type that provides the configuration for the duplicate storages.
– newStorageName — Name of the new storages; if more than one instance of storages is requested, sequence number is
appended to the name.
– numInstances — Specifies the number of storage instances that are added to the Service.
• deployTemplate: Deploy a new Service with the configuration of the given Template.
NOTE: The target Template in ASM must autogenerate the required fields (For example, the host name of the
servers) other than the deployment name and description. Returned Service object describes the ASM service that
has been deployed.
– template — Target Template that is to provide the configuration for the new Service being deployed.
– deploymentName — Name of the new Service.
– description — Optional parameter that describes the deployed Service.
14