public interface InfraManagerIf
Modifier and Type | Field and Description |
---|---|
static int |
REPORT_DURATION_TYPE_LAST_DAY |
static int |
REPORT_DURATION_TYPE_LAST_HOUR |
static int |
REPORT_DURATION_TYPE_LAST_MONTH |
static java.lang.String |
REPORT_FORMAT_CSV |
static java.lang.String |
REPORT_FORMAT_EXCEL |
static java.lang.String |
REPORT_FORMAT_PDF |
Modifier and Type | Method and Description |
---|---|
void |
addAccount(java.lang.String userName,
Account hAct) |
int |
addGroup(java.lang.String userName,
Group group) |
int |
addServiceRequest(ServiceRequest request) |
boolean |
cancelWorkFlow(java.lang.String cancelledByUser,
int requestID) |
void |
changeLocaleTo(java.lang.String locale) |
WorkFlowAccessPrivilege |
checkWorkFlowAccess(java.lang.String userID,
int requestID) |
boolean |
copyFileToVM(VMWareVMSummary vms,
java.lang.String vmUserName,
java.lang.String vmPassword,
java.lang.String localFilePath,
java.lang.String guestFilePath) |
java.lang.String |
createMoResource(java.lang.String resourcePath,
java.lang.String jsonPayload,
java.lang.Object... accessArgs)
* The Method is used to perform the create operation for the MoResource
and its Payload.Used in the Custom tasks Cloupia scirpt to avoid internal
API class usage.
|
boolean |
createNetworkFile(java.lang.String fileLocation,
java.lang.String device,
java.lang.String ip,
java.lang.String gw,
java.lang.String nm,
boolean isStatic) |
int |
createVirtualService(VirtualServiceRequest req) |
boolean |
createWindowsNetworkConfig(java.lang.String fileLocation,
java.lang.String device,
java.lang.String ip,
java.lang.String gw,
java.lang.String nm) |
boolean |
deleteAccount(java.lang.String userName,
java.lang.String accountName) |
boolean |
deleteFormRecoveryStateData(ReportContext context,
java.lang.String formID) |
boolean |
deleteGroup(java.lang.String userName,
int groupID) |
java.lang.String |
deleteMoResource(java.lang.String resourcePath,
java.lang.String jsonPayload,
java.lang.Object... accessArgs)
* The Method is used to perform the delete operation for the MoResource
and its Payload.Used in the Custom tasks Cloupia scirpt to avoid internal
API class usage.
|
boolean |
deleteServiceRequest(int requestID) |
boolean |
deleteWorkFlowTaskEntry(long entryID) |
void |
diableUserHTTPSession(java.lang.String sessionID) |
FormResult |
doFormSubmit(java.lang.String user,
ReportContext context,
java.lang.String formID,
FormFieldData[] data) |
long |
executeVMCommand(VMWareVMSummary vms,
java.lang.String vmUserName,
java.lang.String vmPassword,
java.lang.String vmCommandPath,
java.lang.String[] commandArgs) |
boolean |
fileExistsOnVM(VMWareVMSummary vms,
java.lang.String vmUserName,
java.lang.String vmPassword,
java.lang.String guestFilePath) |
java.lang.String |
generateBackendReport(java.lang.String reportName,
ReportContext context,
java.lang.String durationName,
java.lang.String formatName) |
java.lang.String |
generateSampleBackendReport(java.lang.String reportName,
java.lang.String durationName,
java.lang.String formatName) |
Account |
getAccount(java.lang.String accountName) |
Account[] |
getAccounts(java.lang.String partnerID,
java.lang.String customerID) |
AccountStatus |
getAccountStatus(java.lang.String accountName) |
Account[] |
getAllAccounts() |
AccountStatus[] |
getAllAccountsStatus() |
Account[] |
getAllCloudAccounts() |
ContextActionStatus[] |
getAllContextActionStatus() |
DataCenter[] |
getAllDataCenters() |
Group[] |
getAllGroups() |
Group[] |
getAllGroupsIncludingMSPGroups() |
java.lang.String[] |
getAllowedOperations() |
DynReportContext[] |
getAllReportContexts() |
ContextAction[] |
getAllSupportedActions() |
ProfileDescriptor[] |
getAllVMProfiles() |
WFTaskDefinition[] |
getAllWFTaskDefinitions() |
java.lang.Object |
getAPIDelegate(java.lang.String namespace) |
ContextAction[] |
getApplicableActions(ReportContext context) |
ManagedReportDefinition[] |
getApplicableManagedReports(int menuID) |
ReportDefinition[] |
getApplicableReports(int menuID,
ReportContext context) |
BackendReportDetails[] |
getAvailableBackendReportDetails(ReportContext context) |
BackendReportDetails |
getBackendReportDetails(java.lang.String reportID) |
CatalogItem[] |
getCatalogItemListByGrpId(java.lang.String group) |
CloudHierarchyNode |
getCloudHierachyNode() |
ConfigForm |
getConfigFormReport(ReportContext context,
java.lang.String reportName) |
ConfigTable |
getConfigTableReport(ReportContext context,
java.lang.String reportName) |
ContextActionStatus[] |
getContextActionStatus(ReportContext context) |
ContextActionStatus[] |
getContextActionStatusByAccount(java.lang.String accountName) |
ContextActionStatus |
getContextActionStatusById(java.lang.String actionEntryId) |
CustomDashboardSettings |
getCustomDashboardSetting() |
CustomDashboardSettings[] |
getCustomDashboardSettings() |
DashboardView |
getDashboardView(int menuID,
int contextType,
java.lang.String viewnName) |
java.lang.String |
getDashletInfo() |
java.lang.String |
getDomainLogoURL(java.lang.String domainName) |
ConfigTableAction[] |
getDynamicActions(ReportContext selectedContext) |
java.lang.String |
getEndUserDashBoardCatalogItems(java.lang.String folderName) |
java.lang.String |
getEndUserDashBoardCatalogs() |
TabularReport |
getFormTabularReport(ReportContext context,
java.lang.String formID,
java.lang.String reportName) |
Group |
getGroup(int groupID) |
HeatMapReport |
getHeatMapReport(ReportContext context,
java.lang.String reportName) |
HistoricalReport |
getHistoricalReport(java.lang.String reportName,
java.lang.String durationName,
ReportContext context) |
java.lang.String |
getHtmlContent(java.lang.String tag,
ReportContext context) |
Image[] |
getImagesByAccount(java.lang.String acctName) |
FormResult |
getInitialFormData(ReportContext context,
java.lang.String formID) |
java.lang.String |
getMoResourceAsJson(java.lang.String resourcePath,
java.lang.Object... accessArgs)
* The Method is used to retrieve the MoResources Used in the Custom tasks
Cloupia scirpt to avoid internal API class usage.
|
java.lang.String[] |
getMSPUserList(java.lang.String loginName) |
java.lang.String |
getPrimaryIPAddress() |
CloupiaProductInfo |
getProductInfo() |
SearchableReport[] |
getSearchableReport() |
SearchableWorkflow[] |
getSearchableWorkflows() |
InvalidateSession |
getSessionDetailsRequestedForInvalidate(java.lang.String username) |
SessionManagement |
getSessionManagement() |
SnapshotReport |
getSnapshotReport(java.lang.String reportName,
ReportContext context) |
StackViewItem[] |
getStackViewItems(int vmID) |
SystemDashboard[] |
getSystemDashboard() |
TabularReport |
getTabularReport(java.lang.String reportName,
ReportContext context) |
TopologyData |
getTopologyData(ReportContext context,
java.lang.String topologyID) |
UIMenu |
getUIMenu() |
java.lang.String[] |
getUIOperations(java.lang.String role) |
UIProperty[] |
getUIProperties() |
UserSpecificBrandingInfo |
getUserBrandingInfo()
after user logged in.
|
UserFavoriteReportEntry[] |
getUserFavoriteReports() |
java.util.List<java.lang.String> |
getvFilerIPAddressByIdentityAndProtocol(java.lang.String vfilerIdentity,
java.lang.String protocol) |
VirtualServiceStatus |
getVirtualServiceStatus(int requestID) |
GenericVM |
getVMBasicInfo(int vmID) |
ProfileDescriptor[] |
getVMProfilesByCloudType(java.lang.String cloudType) |
VMUserData[] |
getVMsInGroup(int groupID) |
VMWareVMSummary |
getVMwareVMInfo(int vmID) |
WFTaskDefinitionList |
getWFTaskDefinitionList() |
WFInfo |
getWorkFlowInfo(long ID) |
boolean |
isCancellable(int requestID) |
boolean |
isESX5(VMWareVMSummary vms) |
WFValidationResultEntry[] |
minimalWfValidation(long id) |
FormResult |
moveFormPage(ReportContext context,
java.lang.String formID,
java.lang.String sessionID,
int currentPage,
int newPage) |
java.lang.String |
performAction(ReportContext context,
java.lang.String actionID,
java.lang.String comment,
java.lang.String user,
ActionParam[] params) |
java.lang.String |
performActionWithServiceRequest(int requestID,
ReportContext context,
java.lang.String actionID,
java.lang.String comment,
java.lang.String user,
ActionParam[] params) |
java.lang.String |
performOperationOnJSONPayload(java.lang.String operationName,
java.lang.String jsonPayloadString,
java.lang.Object... accessArgs)
The Method is used to perform operation for the JSON Payload.Used in the
Custom tasks Cloupia scirpt to avoid internal API class usage.
|
void |
persistApplicableVisibleManagedReports(java.lang.String userName,
int menuId,
ManagedReportDefinition[] reportDefinition) |
void |
persistApplicableVisibleReports(java.lang.String userName,
int menuId,
ReportContext context,
ReportDefinition[] reportDefinition) |
void |
persistLoginInfo(java.lang.String username,
java.lang.String password,
java.lang.String remoteHost,
java.lang.String userAgent,
boolean isLoginSuccess,
java.lang.String comments,
java.lang.String accessedOn,
long loginTimestamp,
java.lang.String clientType,
boolean isMalicious,
boolean isValidUser,
java.lang.String requestURIForLoginHistory) |
void |
persistMaxSessionNotification(java.lang.String userName,
long occurenceTime,
int limit,
java.lang.String clientType) |
void |
purgeLoginHistory(java.lang.String userName,
java.lang.String userAccessLevel,
long loginTimestamp) |
void |
removeRequestForSessionClearance(java.lang.String username) |
ReportContext |
resolveContext(int menuID,
ReportContext outerContext,
ReportContext selectedContext) |
void |
reSubmitWorkFlow(int requestID,
long configEntryID,
boolean skipApprovals) |
void |
saveDashboardView(DashboardView view) |
boolean |
saveTabularReportUserPreferences(java.lang.String reportID,
int menuID,
TabularReportCustomSpec[] specs) |
void |
saveUserFavoriteReports(UserFavoriteReportEntry[] entries) |
void |
setCustomDashboardSettings(CustomDashboardSettings settings) |
void |
setHTTPInfo(java.lang.String sessionID,
java.lang.String requestScheme,
java.lang.String requestServerName,
int requestServerPort) |
boolean |
submitWorkFlow(int requestID) |
void |
updateAccount(java.lang.String userName,
Account hAct) |
boolean |
updateGroup(java.lang.String userName,
Group group) |
void |
updateMailSettings(java.lang.String user,
MailSettings settings) |
java.lang.String |
updateMoResource(java.lang.String resourcePath,
java.lang.String payload,
java.lang.Object... accessArgs)
The Method is used to perform the update operation for the MoResource and
its Payload.Used in the Custom tasks Cloupia scirpt to avoid internal API
class usage.
|
void |
updateSystemParameters(java.lang.String user,
SystemParameters parms) |
void |
updateUserLocaleMap(java.lang.String loginName) |
java.lang.String |
updateWorkfFlowUserInput(WorkFlowUserInput input) |
void |
updateWorkFlowTaskEntry(CustomActionConfigEntry entry) |
boolean |
userAPIAddGroup(java.lang.String groupName,
java.lang.String description,
java.lang.String firtName,
java.lang.String lastName,
java.lang.String email) |
boolean |
userAPIAddUser(java.lang.String userID,
java.lang.String password,
java.lang.String firtName,
java.lang.String lastName,
java.lang.String email,
java.lang.String role,
java.lang.String groupName) |
boolean |
userAPICancelServiceRequest(int requestID) |
APITabularReport |
userAPIChargebackDetails() |
double |
userAPICheckFunds(java.lang.String userID)
Deprecated.
|
boolean |
userAPIconfigureIPAddressPool(java.lang.String accountName,
java.lang.String ipAddress,
int srID,
int groupID,
java.lang.String initiatinguser,
long reservedAt,
long reservedTill,
boolean isValID,
java.lang.String policyName,
java.lang.String componentName) |
java.lang.String |
userAPIConfigureVMLeaseTime(java.lang.String vmIDStr,
long dateTime) |
boolean |
userAPICreateCatalogItem(APICatalogItem catalogItem) |
int |
userAPICreateGroup(APIGroup apiGroup) |
int |
userAPICreateServiceContainer(java.lang.String groupName,
java.lang.String catalogName,
java.lang.String serviceContainerName,
java.lang.String comments) |
boolean |
userAPICreateVDC(APIVDCDetails vdcDetails) |
java.lang.String |
userAPICreateVMSnapshot(int vmID,
java.lang.String name,
java.lang.String description,
boolean isMemory,
boolean isQuiesce) |
boolean |
userAPICreateVMwareCluster(APIVMwareCluster cluster) |
boolean |
userAPIDeleteCatalogItem(java.lang.String catalogItemName) |
void |
userAPIDeleteCustomDashboardSetting(java.lang.String dashboardName) |
boolean |
userAPIDeleteGroup(int groupID) |
boolean |
userAPIDeleteUser(java.lang.String userID) |
boolean |
userAPIDeleteVMwareCluster(APIVMwareCluster cluster) |
FormResult |
userAPIDoFormSubmit(ReportContext reportContext,
java.lang.String formID,
FormFieldData[] data) |
boolean |
userAPIdoPostInstallConfiguration() |
java.lang.String |
userAPIExecuteVMAction(int vmID,
java.lang.String actionName,
java.lang.String comments) |
java.lang.String |
userAPIExportVDC(java.lang.String vdcName) |
APICustomWorkflowDefinitionList |
userAPIExportWorkflows(java.lang.String workflowNames) |
APITabularReport |
userAPIFilterTabularReport(java.lang.String contextName,
java.lang.String contextValue,
java.lang.String reportID,
java.lang.String columnLabel,
java.lang.String columnValue) |
APITabularReport |
userAPIGetAllCatalogs() |
java.util.List<APIContextDefinition> |
userAPIGetAllContexts() |
APITabularReport |
userAPIGetAllGroups()
Deprecated.
|
UserAccessProfile[] |
userAPIgetAllUserAccessProfiles(java.lang.String userName) |
APITabularReport |
userAPIGetAllVDCs() |
APITabularReport |
userAPIGetAllVMs() |
APITabularReport |
userAPIGetAPITabularReport(java.lang.String reportName) |
ManagedReportDefinition[] |
userAPIGetApplicableManagedReports() |
java.util.List<APIReportDefinition> |
userAPIGetAvailableReports(java.lang.String contextName,
java.lang.String contextValue) |
java.util.List<APIVMAction> |
userAPIGetAvailableVMActions(int vmID) |
FormLOVPair[] |
userAPIgetBMAOSList() |
APIProvisionParams |
userAPIGetCatalogDetails(java.lang.String catalogItemName) |
APITabularReport |
userAPIGetCatalogsPerGroup(java.lang.String groupName) |
APITabularReport |
userAPIGetCloudPollingHistoryReport() |
APITabularReport |
userAPIGetCloudsListReport() |
APITabularReport |
userAPIGetComputeAccountListReport() |
APITabularReport |
userAPIGetComputeServerListReport() |
java.util.ArrayList<APITabularReport> |
userAPIGetComputeServersListReport() |
java.lang.String |
userAPIGetCUICVersion() |
CustomDashboardSettings |
userAPIGetCustomDashboardSetting() |
APITabularReport |
userAPIGetDatastoreCapacityForCloudTabularReport(java.lang.String cloudName) |
APITabularReport |
userAPIGetDatastoreCapacityForVMTabularReport(java.lang.String vmID) |
APIStorageResizeRange |
userAPIGetDatastoreResizeRange(java.lang.String vmID,
java.lang.String datastoreName) |
ConfigTableAction |
userAPIGetGenerateReportAction(ReportContext context) |
java.util.List<APIGroup> |
userAPIGetGroupById(int groupId) |
java.util.List<APIGroup> |
userAPIGetGroupByName(java.lang.String groupName) |
java.util.List<APIGroup> |
userAPIGetGroups() |
APIHistoricalReport |
userAPIGetHistoricalReport(java.lang.String contextName,
java.lang.String contextValue,
java.lang.String reportID,
java.lang.String durationName) |
java.lang.String |
userAPIGetIconImageURL(java.lang.String imageID) |
FormResult |
userAPIGetInitialFormData(ReportContext reportContext,
java.lang.String formID) |
APISnapshotReport |
userAPIGetInstantDataReport(java.lang.String contextName,
java.lang.String contextValue,
java.lang.String reportID) |
java.util.List<IPAddressReservation> |
userAPIgetIPAddressPool() |
APITabularReport |
userAPIGetLicenseListReport() |
java.util.List<java.lang.String> |
userAPIGetLOVProvidersList() |
FormLOVPair[] |
userAPIGetLOVValues(java.lang.String type) |
java.lang.String[] |
userAPIGetMobileAccessPermissions() |
APIApprovalList |
userAPIGetMyApprovalList() |
APILoginProfile |
userAPIGetMyLoginProfile() |
java.lang.String |
userAPIGetNavigationMenu(int menuID) |
APITabularReport |
userAPIGetNetworkDevicesListReport() |
CloupiaProductInfo |
userAPIGetProductInfo() |
APITabularReport |
userAPIGetResourceAccounting() |
APITabularReport |
userAPIGetResourceAccountingDetails() |
APITabularReport |
userAPIGetResourceLimits(java.lang.String groupName) |
APITabularReport |
userAPIGetResourceLimitsForMyGroup() |
java.lang.String |
userAPIGetRESTAccessKey(java.lang.String userName) |
APIServiceRequestDetails |
userAPIGetServiceRequestDetails(int requestID) |
ServiceRequestLogEntry[] |
userAPIGetServiceRequestLogEntries(int srID,
int severity) |
ServiceRequestLogEntry[] |
userAPIGetServiceRequestLogEntriesAtLevels(int srID,
java.lang.String severityList) |
APITabularReport |
userAPIGetServiceRequests() |
APIWorkFlowStatus |
userAPIGetServiceRequestWorkFlow(int requestID) |
FormLOVPair[] |
userAPIgetStaticListByName(java.lang.String listName) |
APITabularReport |
userAPIGetStorageAccountListReport() |
APITabularReport |
userAPIGetSystemResourceUsageReport() |
APITabularReport |
userAPIGetSystemTasksReport() |
APITabularReport |
userAPIGetTabularReport(java.lang.String contextName,
java.lang.String contextValue,
java.lang.String reportID) |
APITabularReportMetadata |
userAPIGetTabularReportMetadata(java.lang.String contextName,
java.lang.String contextValue,
java.lang.String reportID) |
APITabularReport |
userAPIGetTabularReportWithMetaData(java.lang.String contextName,
java.lang.String contextValue,
java.lang.String reportID) |
APITabularReport |
userAPIGetTabularValues(java.lang.String type) |
APILoginProfile |
userAPIGetUserLoginProfile(java.lang.String userID) |
APIVMAccess |
userAPIGetVMAccessCredentials(int vmID) |
APITabularReport |
userAPIGetVMActionRequests(java.lang.String contextName,
java.lang.String contextValue) |
APIVMActionStatus |
userAPIGetVMActionStatus(java.lang.String requestID) |
APIVMList |
userAPIGetVMsForServiceRequest(int request) |
APITabularReport |
userAPIGetVMSnapshotDetails(int vmID) |
APITabularReport |
userAPIGetVMSummary(int vmID) |
APIWorkflowInputDetails |
userAPIGetWorkflowInputs(java.lang.String workflowName) |
java.lang.String |
userAPIGetWorkflowInputValue(java.lang.String fieldLabel,
int srID) |
java.util.List<WorkflowInputValue> |
userAPIGetWorkflowInputValues(int srID) |
CustomActionDefinition[] |
userAPIGetWorkflows(java.lang.String folderName)
Deprecated.
|
int |
userAPIGetWorkflowStatus(int srID) |
java.util.List<XenProvisionedVMDetails> |
userAPIGetXenDesktopProvisionedVMDetails(int srID) |
int |
userAPIHypervVMProvisioningWithVMNetwork(APIHypervProvisionParams apiHypervProvisionParams) |
boolean |
userAPIImportConvergedInfraConfig(java.lang.String user,
ConvergedInfraUnit infraUnit) |
VDC |
userAPIImportVDC(java.lang.String importedVDCString) |
boolean |
userAPIImportWorkflows(APIWFExport export)
Deprecated.
|
boolean |
userAPIIsMspMode() |
java.lang.String |
userAPIMoCreate(java.lang.String resourcePath,
java.lang.String payload) |
java.lang.String |
userAPIMoDelete(java.lang.String resourcePath,
java.lang.String payload) |
boolean |
userAPIModifyLoginProfilePassword(LoginProfileChangePasswordInfo passwordInfo) |
boolean |
userAPIModifyUserPassword(ModifyUserPasswordInfo userPasswordInfo) |
java.lang.String |
userAPIMoQuery(java.lang.String mo,
java.lang.String[] fields,
java.lang.String query) |
java.lang.String |
userAPIMoUpdate(java.lang.String resourcePath,
java.lang.String payload) |
APIUserOnBoardDetails |
userAPIOnBoarding(APIUserOnBoardParams inParams) |
int |
userAPIProvisionRequest(APIProvisionParams provisionParams) |
int |
userAPIProvisionRequestWithPortGroup(APIProvisionParams apiProvisionParams)
Deprecated.
|
java.lang.String |
userAPIReconfigureVM(int vmID,
long memorySizeInMB,
int numVCPUS,
java.lang.String comments) |
boolean |
userAPIRequestInventoryCollection(java.lang.String cloudName) |
boolean |
userAPIResetMyPassword(java.lang.String newPassword)
Deprecated.
: Use userAPIModifyLoginProfilePassword instead
|
boolean |
userAPIResetUserPassword(java.lang.String user,
java.lang.String newPassword,
boolean resetAPIKey)
Deprecated.
: Use userAPIModifyUserPassword instead.
|
APITabularReport |
userAPIResourceChargebackDetails() |
APITabularReport |
userAPIResourceChargebackDetailsByGroup(java.lang.String groupName) |
int |
userAPIRollbackWorkflow(int srID) |
int |
userAPIServiceContainerCatalogRequest(APIServiceContainerCatalogParams apiCatalog) |
boolean |
userAPISetVMProperties(int vmID,
java.lang.String userLabel) |
int |
userAPISubmitServiceRequest(java.lang.String catalogName,
java.lang.String vdcName,
int durationHours,
long beginTime,
int qty,
java.lang.String comments)
Deprecated.
|
int |
userAPISubmitServiceRequestCustom(java.lang.String catalogName,
java.lang.String vdcName,
java.lang.String vmName,
double vCPU,
double memory,
int durationHours,
long beginTime,
int qty,
java.lang.String comments)
Deprecated.
|
int |
userAPISubmitVAppServiceRequest(java.lang.String catalogName,
APINameValueList list) |
int |
userAPISubmitWorkflowServiceRequest(java.lang.String workflowName,
APINameValueList list,
int parentSRID) |
int |
userAPISubmitWorkflowServiceRequestWithGroup(java.lang.String workflowName,
APINameValueList list,
int parentSRID,
int GroupID) |
int |
userAPISubmitWorkflowServiceRequestWithStartTimeAndDurationHours(java.lang.String workflowName,
APINameValueList list,
int parentSRID,
long srStartTime,
int srDurationHours) |
boolean |
userAPIUpdateGroup(APIGroup apiGroup) |
boolean |
userAPIUpdateMyApproval(int requestID,
int entryID,
boolean isApproved,
java.lang.String comments) |
boolean |
userAPIUpdateOrchEventReceiverConfig(OrchestratorEventReceiverConfig[] configs) |
boolean |
userAPIUpdatePaymentStatus(APIMakePaymentParams inParams) |
boolean |
userAPIUpdateUser(APIUser apiUser) |
APIWFValidationResult |
userAPIValidateWorkFlow(java.lang.String workflowName) |
java.lang.String |
userAPIValidateWorkflowInput(java.lang.String validatorName,
java.lang.String inputValue) |
boolean |
userAPIVerifyConsoleAccessToken(java.lang.String token) |
boolean |
userAPIVerifyConvergedInfraConfig(java.lang.String user,
ConvergedInfraUnit infrastructureUnit) |
APILoginProfile |
userAPIVerifyUser(java.lang.String userID,
java.lang.String passWord) |
int |
userAPIVMWareCloneVMProvisionRequest(java.lang.String vmID,
java.lang.String vdcName,
java.lang.String vmName,
boolean useLinkedClone,
java.lang.String snapshotKey,
java.lang.String snapshotName,
java.lang.String comment,
double vCpus,
double memory,
java.lang.String chargeFrequency,
java.lang.String datastores,
java.lang.String opNicPortGroup,
java.lang.String credentials,
java.lang.String userID,
java.lang.String password,
boolean provisionDiskinSingleDatastore,
java.lang.String vmappChargeFrequency,
double activeVMCost,
double inactiveVMCost) |
int |
userAPIVMWareMoveVMProvisionRequest(java.lang.String vmID,
java.lang.String vdcName,
java.lang.String credentials,
java.lang.String userID,
java.lang.String password,
boolean provisionDiskinSingleDatastore,
java.lang.String vmappChargeFrequency,
double activeVMCost,
double inactiveVMCost,
java.lang.String comment,
double vCpus,
double memory,
java.lang.String datastores,
java.lang.String opNicPortGroup) |
int |
userAPIVMWareProvisionRequest(java.lang.String catalogName,
java.lang.String vdcName,
java.lang.String vmName,
java.lang.String comment,
double vCpus,
double memory,
java.lang.String datastores,
java.lang.String opNicPortGroup) |
APIWorkflowInputDetails |
userAPIWorkflowInputDetails(java.lang.String workflowName) |
void |
userLogOutEvent(java.lang.String username) |
void |
userLoinEvent(java.lang.String username) |
FormResult |
validateForm(ReportContext context,
java.lang.String formID,
FormFieldData[] data) |
WFValidationResultEntry[] |
validateWorkFlow(long id) |
java.lang.String[] |
verifyAccount(Account account,
boolean isUpdate) |
static final int REPORT_DURATION_TYPE_LAST_HOUR
static final int REPORT_DURATION_TYPE_LAST_DAY
static final int REPORT_DURATION_TYPE_LAST_MONTH
static final java.lang.String REPORT_FORMAT_PDF
static final java.lang.String REPORT_FORMAT_CSV
static final java.lang.String REPORT_FORMAT_EXCEL
CloudHierarchyNode getCloudHierachyNode() throws java.lang.Exception
java.lang.Exception
CloupiaProductInfo getProductInfo()
UserSpecificBrandingInfo getUserBrandingInfo()
java.lang.String getDomainLogoURL(java.lang.String domainName)
ProfileDescriptor[] getAllVMProfiles()
ProfileDescriptor[] getVMProfilesByCloudType(java.lang.String cloudType)
Image[] getImagesByAccount(java.lang.String acctName) throws java.lang.Exception
java.lang.Exception
void addAccount(java.lang.String userName, Account hAct) throws java.lang.Exception
java.lang.Exception
boolean userAPIImportConvergedInfraConfig(java.lang.String user, ConvergedInfraUnit infraUnit) throws java.lang.Exception
user
- : UCS Director user ID. This is a mandatory parameter.
Possible values {"admin","testUser"}infraUnit
- : Contains converged infrastructure account unit configuration
details to be imported. This is a mandatory parameter. For
possible values, see example.java.lang.Exception
boolean userAPIVerifyConvergedInfraConfig(java.lang.String user, ConvergedInfraUnit infrastructureUnit) throws java.lang.Exception
user
- : UCS Director user ID. This is a mandatory parameter.
Possible values{"admin","testUser"}infrastructureUnit
- : Contains infrastructure account details. This is a mandatory
parameter. For possible values, see example.java.lang.Exception
void updateAccount(java.lang.String userName, Account hAct) throws java.lang.Exception
java.lang.Exception
void setHTTPInfo(java.lang.String sessionID, java.lang.String requestScheme, java.lang.String requestServerName, int requestServerPort) throws java.lang.Exception
java.lang.Exception
void diableUserHTTPSession(java.lang.String sessionID) throws java.lang.Exception
java.lang.Exception
java.lang.String[] verifyAccount(Account account, boolean isUpdate) throws java.lang.Exception
java.lang.Exception
boolean deleteAccount(java.lang.String userName, java.lang.String accountName) throws java.lang.Exception
java.lang.Exception
Account[] getAccounts(java.lang.String partnerID, java.lang.String customerID) throws java.lang.Exception
java.lang.Exception
Account getAccount(java.lang.String accountName) throws java.lang.Exception
java.lang.Exception
Account[] getAllAccounts() throws java.lang.Exception
java.lang.Exception
Account[] getAllCloudAccounts() throws java.lang.Exception
java.lang.Exception
AccountStatus getAccountStatus(java.lang.String accountName) throws java.lang.Exception
java.lang.Exception
AccountStatus[] getAllAccountsStatus() throws java.lang.Exception
java.lang.Exception
ContextAction[] getAllSupportedActions()
ContextAction[] getApplicableActions(ReportContext context) throws java.lang.Exception
java.lang.Exception
java.lang.String performAction(ReportContext context, java.lang.String actionID, java.lang.String comment, java.lang.String user, ActionParam[] params) throws java.lang.Exception
java.lang.Exception
java.lang.String performActionWithServiceRequest(int requestID, ReportContext context, java.lang.String actionID, java.lang.String comment, java.lang.String user, ActionParam[] params) throws java.lang.Exception
java.lang.Exception
ContextActionStatus getContextActionStatusById(java.lang.String actionEntryId) throws java.lang.Exception
java.lang.Exception
ContextActionStatus[] getContextActionStatus(ReportContext context) throws java.lang.Exception
java.lang.Exception
ContextActionStatus[] getAllContextActionStatus() throws java.lang.Exception
java.lang.Exception
ContextActionStatus[] getContextActionStatusByAccount(java.lang.String accountName) throws java.lang.Exception
java.lang.Exception
HistoricalReport getHistoricalReport(java.lang.String reportName, java.lang.String durationName, ReportContext context) throws java.lang.Exception
java.lang.Exception
SnapshotReport getSnapshotReport(java.lang.String reportName, ReportContext context) throws java.lang.Exception
java.lang.Exception
TabularReport getTabularReport(java.lang.String reportName, ReportContext context) throws java.lang.Exception
java.lang.Exception
java.lang.String getHtmlContent(java.lang.String tag, ReportContext context) throws java.lang.Exception
java.lang.Exception
ReportDefinition[] getApplicableReports(int menuID, ReportContext context) throws java.lang.Exception
java.lang.Exception
ManagedReportDefinition[] getApplicableManagedReports(int menuID) throws java.lang.Exception
java.lang.Exception
java.lang.String generateBackendReport(java.lang.String reportName, ReportContext context, java.lang.String durationName, java.lang.String formatName) throws java.lang.Exception
formatName
- Format for the report (example: pdf, html)java.lang.Exception
java.lang.String generateSampleBackendReport(java.lang.String reportName, java.lang.String durationName, java.lang.String formatName) throws java.lang.Exception
java.lang.Exception
BackendReportDetails getBackendReportDetails(java.lang.String reportID) throws java.lang.Exception
java.lang.Exception
BackendReportDetails[] getAvailableBackendReportDetails(ReportContext context) throws java.lang.Exception
java.lang.Exception
int addGroup(java.lang.String userName, Group group) throws java.lang.Exception
java.lang.Exception
boolean updateGroup(java.lang.String userName, Group group) throws java.lang.Exception
java.lang.Exception
boolean deleteGroup(java.lang.String userName, int groupID) throws java.lang.Exception
java.lang.Exception
Group getGroup(int groupID) throws java.lang.Exception
java.lang.Exception
Group[] getAllGroups() throws java.lang.Exception
java.lang.Exception
Group[] getAllGroupsIncludingMSPGroups() throws java.lang.Exception
java.lang.Exception
void updateSystemParameters(java.lang.String user, SystemParameters parms) throws java.lang.Exception
java.lang.Exception
void updateMailSettings(java.lang.String user, MailSettings settings) throws java.lang.Exception
java.lang.Exception
FormResult getInitialFormData(ReportContext context, java.lang.String formID) throws java.lang.Exception
java.lang.Exception
boolean deleteFormRecoveryStateData(ReportContext context, java.lang.String formID) throws java.lang.Exception
java.lang.Exception
FormResult validateForm(ReportContext context, java.lang.String formID, FormFieldData[] data) throws java.lang.Exception
java.lang.Exception
FormResult moveFormPage(ReportContext context, java.lang.String formID, java.lang.String sessionID, int currentPage, int newPage) throws java.lang.Exception
java.lang.Exception
FormResult doFormSubmit(java.lang.String user, ReportContext context, java.lang.String formID, FormFieldData[] data) throws java.lang.Exception
java.lang.Exception
TabularReport getFormTabularReport(ReportContext context, java.lang.String formID, java.lang.String reportName) throws java.lang.Exception
java.lang.Exception
ConfigForm getConfigFormReport(ReportContext context, java.lang.String reportName) throws java.lang.Exception
java.lang.Exception
ConfigTable getConfigTableReport(ReportContext context, java.lang.String reportName) throws java.lang.Exception
java.lang.Exception
ConfigTableAction[] getDynamicActions(ReportContext selectedContext) throws java.lang.Exception
java.lang.Exception
HeatMapReport getHeatMapReport(ReportContext context, java.lang.String reportName) throws java.lang.Exception
java.lang.Exception
int addServiceRequest(ServiceRequest request) throws java.lang.Exception
java.lang.Exception
boolean deleteServiceRequest(int requestID) throws java.lang.Exception
java.lang.Exception
boolean submitWorkFlow(int requestID) throws java.lang.Exception
java.lang.Exception
boolean cancelWorkFlow(java.lang.String cancelledByUser, int requestID) throws java.lang.Exception
java.lang.Exception
boolean isCancellable(int requestID) throws java.lang.Exception
java.lang.Exception
java.lang.String updateWorkfFlowUserInput(WorkFlowUserInput input) throws java.lang.Exception
java.lang.Exception
WorkFlowAccessPrivilege checkWorkFlowAccess(java.lang.String userID, int requestID) throws java.lang.Exception
java.lang.Exception
int createVirtualService(VirtualServiceRequest req) throws java.lang.Exception
java.lang.Exception
VirtualServiceStatus getVirtualServiceStatus(int requestID) throws java.lang.Exception
java.lang.Exception
boolean saveTabularReportUserPreferences(java.lang.String reportID, int menuID, TabularReportCustomSpec[] specs) throws java.lang.Exception
java.lang.Exception
void saveDashboardView(DashboardView view) throws java.lang.Exception
java.lang.Exception
DashboardView getDashboardView(int menuID, int contextType, java.lang.String viewnName) throws java.lang.Exception
java.lang.Exception
DataCenter[] getAllDataCenters() throws java.lang.Exception
java.lang.Exception
CatalogItem[] getCatalogItemListByGrpId(java.lang.String group) throws java.lang.Exception
java.lang.Exception
VMUserData[] getVMsInGroup(int groupID) throws java.lang.Exception
java.lang.Exception
GenericVM getVMBasicInfo(int vmID) throws java.lang.Exception
java.lang.Exception
VMWareVMSummary getVMwareVMInfo(int vmID) throws java.lang.Exception
java.lang.Exception
WFTaskDefinition[] getAllWFTaskDefinitions() throws java.lang.Exception
java.lang.Exception
WFTaskDefinitionList getWFTaskDefinitionList() throws java.lang.Exception
java.lang.Exception
WFInfo getWorkFlowInfo(long ID) throws java.lang.Exception
java.lang.Exception
WFValidationResultEntry[] validateWorkFlow(long id) throws java.lang.Exception
java.lang.Exception
WFValidationResultEntry[] minimalWfValidation(long id) throws java.lang.Exception
java.lang.Exception
void updateWorkFlowTaskEntry(CustomActionConfigEntry entry) throws java.lang.Exception
java.lang.Exception
java.util.List<IPAddressReservation> userAPIgetIPAddressPool() throws java.lang.Exception
java.lang.Exception
boolean deleteWorkFlowTaskEntry(long entryID) throws java.lang.Exception
java.lang.Exception
CustomDashboardSettings getCustomDashboardSetting() throws java.lang.Exception
java.lang.Exception
void setCustomDashboardSettings(CustomDashboardSettings settings) throws java.lang.Exception
java.lang.Exception
void saveUserFavoriteReports(UserFavoriteReportEntry[] entries) throws java.lang.Exception
java.lang.Exception
UserFavoriteReportEntry[] getUserFavoriteReports() throws java.lang.Exception
java.lang.Exception
TopologyData getTopologyData(ReportContext context, java.lang.String topologyID) throws java.lang.Exception
java.lang.Exception
ReportContext resolveContext(int menuID, ReportContext outerContext, ReportContext selectedContext) throws java.lang.Exception
java.lang.Exception
StackViewItem[] getStackViewItems(int vmID) throws java.lang.Exception
java.lang.Exception
void changeLocaleTo(java.lang.String locale) throws java.lang.Exception
java.lang.Exception
UIProperty[] getUIProperties() throws java.lang.Exception
java.lang.Exception
java.lang.String userAPIGetNavigationMenu(int menuID) throws java.lang.Exception
menuID
- : Menu ID. This is a mandatory parameter. Possible values
{1,2,3,...}java.lang.Exception
CustomDashboardSettings userAPIGetCustomDashboardSetting() throws java.lang.Exception
java.lang.Exception
void userAPIDeleteCustomDashboardSetting(java.lang.String dashboardName) throws java.lang.Exception
dashboardName
- :
: name of the dashboard. This is a mandatory parameter. Possible
valuesFor possible values, see example.java.lang.Exception
int userAPISubmitServiceRequest(java.lang.String catalogName, java.lang.String vdcName, int durationHours, long beginTime, int qty, java.lang.String comments) throws java.lang.Exception
catalogName
- : Catalog name. This is a mandatory parameter. Possible values
{"testCat","cat_82"}vdcName
- : VDC name. This is a mandatory parameter. Possible values
{"vdc82","vdc1"}durationHours
- : Duration of VM provisioning in hours. After the specified
duration is complete, VM is automatically deprovisioned.
Possible values {1,2,...,use -1 to set no duration}beginTime
- : Schedules the time at when you want to start provisioning a
VM. Possible values { "January 1, 2014, 00:00:00 GMT", Use 0
or -1 to start the VM}qty
- : Number of vms to be provisioned. Possible values {1,2,3...}comments
- : Contains comments for VM provision. This is an optional
parameter.java.lang.Exception
int userAPICreateServiceContainer(java.lang.String groupName, java.lang.String catalogName, java.lang.String serviceContainerName, java.lang.String comments) throws java.lang.Exception
groupName
- : Group name. This is a mandatory parameter. Possible values{
"Default Group","SDK"...}catalogName
- : Catalog name. This is a mandatory parameter. Possible
values{"cat82","testCat"...}serviceContainerName
- : Service container name. This is a mandatory parameter.
Possible values{"testCont","container-1",..}comments
- : Create service container comments. This is an optional
parameter.java.lang.Exception
int userAPISubmitServiceRequestCustom(java.lang.String catalogName, java.lang.String vdcName, java.lang.String vmName, double vCPU, double memory, int durationHours, long beginTime, int qty, java.lang.String comments) throws java.lang.Exception
catalogName
- : Catalog name. This is a mandatory parameter. Possible values
{"cat82","testCat"...}vdcName
- : Virtual Datacenter(vdc) name. This is a mandatory parameter.
Possible values{"vdc82","vdc1",..}vmName
- : Virtual Machine(VM) name. This is a mandatory parameter.
Possible values {"VM1","VM2",...}vCPU
- : Number of virtual cpu for vM. This is an optional parameter.
Possible values {1,2,3,..,64}memory
- : Memory size in MB. This is an optional parameter. Possible
values {"256","512","1024",...., multiple of 256}durationHours
- : Duration of VM provisioning in hours. After reaching the
specified duration, VM is automatically deprovisioned. This is
an optional parameter. Possible values{1,2,...,use -1 to set
no duration}beginTime
- : Schedule the time when you want to start provisioning a VM.
This is an optional parameter. Possible values{
"January 1, 2014, 00:00:00 GMT", Use 0 or -1 to start the VM
provisioning}qty
- : number of VMs to be provisioned. This is a mandatory
parameter. Possible values{1,2,3,...}comments
- : Is comments to provision a vm. This is an optional
parameter.java.lang.Exception
int userAPISubmitVAppServiceRequest(java.lang.String catalogName, APINameValueList list) throws java.lang.Exception
catalogName
- : Catalog name. This is a mandatory parameter. Possible
values{"cat82","testCat"...}list
- : List contains virtual application catalog inforamtion as
name, value pair. This is a mandatory parameter. For possible
values, see example.java.lang.Exception
int userAPISubmitWorkflowServiceRequest(java.lang.String workflowName, APINameValueList list, int parentSRID) throws java.lang.Exception
workflowName
- : Workflow name which we use to submit the Service
Request(SR). For possible values, see example.list
- : List contains workflow input inforamtion as name, value
pair. This is a mandatory parameter. For possible values, see
example.parentSRID
- : Parent SR ID. This is an optional parameter. Possible values
{1,2,3..., use -1 if it is parent workflow}java.lang.Exception
int userAPISubmitWorkflowServiceRequestWithStartTimeAndDurationHours(java.lang.String workflowName, APINameValueList list, int parentSRID, long srStartTime, int srDurationHours) throws java.lang.Exception
workflowName
- :Workflow name that is going to be submitted. This is a
mandatory parameter. Possible values {1,2,3,...}list
- :List contains workflow input inforamtion as name, value pair.
This is a mandatory parameter. For possible values, see
example.parentSRID
- : Parent SR ID. This is an optional parameter. Possible values
{1,2,3,..., use -1 if it is parent workflow}srStartTime
- : Schedules when you want to submit service request. This is
an optional parameter. Possible values {
"January 1, 2014, 00:00:00 GMT", Use 0 or -1 to start submit
service request}srDurationHours
- :Duration to submit service request specified in hours. This
is an optional parameter. Possible values {1,2,...,use -1 to
set no duration}java.lang.Exception
int userAPISubmitWorkflowServiceRequestWithGroup(java.lang.String workflowName, APINameValueList list, int parentSRID, int GroupID) throws java.lang.Exception
workflowName
- : Workflow name to be submited as the Service Request(SR).
This is a mandatory parameter. For \possible values, see
example.list
- : List contains workflow input inforamtion as name, value
pair. This is a mandatory parameter. For possible values, see
example.parentSRID
- : Parent SR ID. This is an optional parameter. Possible values
{1,2,3,..,use -1 if it is parent workflow}GroupID
- : Group ID. This is a mandatory parameter. Possible values
{1,2,3,...}java.lang.Exception
APIWorkflowInputDetails userAPIWorkflowInputDetails(java.lang.String workflowName) throws java.lang.Exception
workflowName
- : workflow name. This is a mandatory parameter. For possible
values, see example.java.lang.Exception
APITabularReport userAPIGetVMSummary(int vmID) throws java.lang.Exception
vmID
- : Virtual Machine ID. This is a mandatory parameter. Possible
values{1,2,3,...}java.lang.Exception
APITabularReport userAPIGetAllVDCs() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIGetAllVMs() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIGetServiceRequests() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIGetResourceLimits(java.lang.String groupName) throws java.lang.Exception
groupName
- : Group name. This is a mandatory parameter. Possible values {
"Default Group","sdk",...}java.lang.Exception
APITabularReport userAPIGetResourceLimitsForMyGroup() throws java.lang.Exception
java.lang.Exception
boolean userAPICancelServiceRequest(int requestID) throws java.lang.Exception
requestID
- : Service request ID. This is a mandatory parameter. Possible
values {1,2,3,4,...}java.lang.Exception
APITabularReport userAPIGetResourceAccounting() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIGetResourceAccountingDetails() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIChargebackDetails() throws java.lang.Exception
java.lang.Exception
java.util.List<APIReportDefinition> userAPIGetAvailableReports(java.lang.String contextName, java.lang.String contextValue) throws java.lang.Exception
contextName
- : Report context name of the tabular report. This is a
mandatory parameter. For possible values, see report metadata
for respective report.contextValue
- : Report context value of the tabular report. This is a
mandatory parameter. For possible values, see report metadata
for respective report.java.lang.Exception
java.util.List<APIContextDefinition> userAPIGetAllContexts() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIGetTabularReport(java.lang.String contextName, java.lang.String contextValue, java.lang.String reportID) throws java.lang.Exception
contextName
- : Report context name of the tabular report. This is a
mandatory parameter. For possible values, see report metadata
from UI for respective reportcontextValue
- : Report context value of the tabular report. This is a
mandatory parameter. For possible values, see report metadata
from UI for respective reportreportID
- : Report ID of the tabular report. This is a mandatory
parameter. For possible values, see report metadata from UI
for respective reportjava.lang.Exception
APIHistoricalReport userAPIGetHistoricalReport(java.lang.String contextName, java.lang.String contextValue, java.lang.String reportID, java.lang.String durationName) throws java.lang.Exception
contextName
- : Report context name of the tabular report. This is a
mandatory parameter. For possible values, see report metadata
from UI for respective report.contextValue
- : Report context value of the tabular report. This is a
mandatory parameter. For possible values, see report metadata
from UI for respective report.reportID
- : Report ID of the tabular report. This is a mandatory
parameter. For possible values, see report metadata from UI
for respective report.durationName
- : duration name. This is a mandatory parameter. For possible
values, see example.java.lang.Exception
APISnapshotReport userAPIGetInstantDataReport(java.lang.String contextName, java.lang.String contextValue, java.lang.String reportID) throws java.lang.Exception
contextName
- : Report context name of the snapshot report. This is a
mandatory parameter. For possible values, see report metadata
from UI for respective reportcontextValue
- : Report context value of the snapshot report. This is a
mandatory parameter. For possible values, see report metadata
from UI for respective reportreportID
- : Report ID of the snapshot report. This is a mandatory
parameter. For possible values, see report metadata from UI
for respective reportjava.lang.Exception
APILoginProfile userAPIGetMyLoginProfile() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIGetCatalogsPerGroup(java.lang.String groupName) throws java.lang.Exception
groupName
- : Group name. This is a mandatory parameter. Possible values {
"Default Group","SDK",...}java.lang.Exception
APITabularReport userAPIGetAllCatalogs() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIGetVMActionRequests(java.lang.String contextName, java.lang.String contextValue) throws java.lang.Exception
contextName
- : VM action tabular report context Name. This is a mandatory
parameter. For possible values, see report meta data from UIcontextValue
- : VM action tabular report context value. This is a mandatory
parameter. For possible values, see report meta data from UIjava.lang.Exception
java.util.List<APIVMAction> userAPIGetAvailableVMActions(int vmID) throws java.lang.Exception
vmID
- : Virtual Machine ID(vmID). This is a mandatory
parameter.Possible values{1,2,3,4,...}java.lang.Exception
java.lang.String userAPIExecuteVMAction(int vmID, java.lang.String actionName, java.lang.String comments) throws java.lang.Exception
vmID
- : Virtual Machine ID. This is a mandatory parameter. possible
values, {1,2,3,4,...}actionName
- : vm action to be performed on the specified vm. This is a
mandatory parameter. possible values,
{"powerOn","powerOff","deployOVF","reboot",...}comments
- : Comments to perform VM action. This is an optional
parameter.java.lang.Exception
java.lang.String userAPIReconfigureVM(int vmID, long memorySizeInMB, int numVCPUS, java.lang.String comments) throws java.lang.Exception
vmID
- : Virtual Machine ID(vmID). This is a mandatory parameter.
possible values, {1,2,3,4,...}memorySizeInMB
- : Size of memory in MB. This is an optional parameter.
possible values, {"256","512","1024",...}numVCPUS
- : Number of vcpu for VM. This is an optional parameter.
possible values, {1,2,3,..}comments
- : Comments to reconfigure VM. This is an optional parameter.java.lang.Exception
APIVMActionStatus userAPIGetVMActionStatus(java.lang.String requestID) throws java.lang.Exception
requestID
- : VM action requestID used to get status. This is a mandatory
parameter. For possible values, see example.java.lang.Exception
boolean userAPISetVMProperties(int vmID, java.lang.String userLabel) throws java.lang.Exception
vmID
- : Virtual Machine ID. This is a mandatory parameter. Possible
values {1,2,3,4,...}userLabel
- : user label of VM. This is a mandatory parameter. Possible
values {"VMTeam","SDKTeam",...}java.lang.Exception
boolean userAPIAddUser(java.lang.String userID, java.lang.String password, java.lang.String firtName, java.lang.String lastName, java.lang.String email, java.lang.String role, java.lang.String groupName) throws java.lang.Exception
userID
- : login userID to UCS Director. This is a mandatory parameter.
Possible values{"admin","test","sdk",...}password
- : User's login password. This is a mandatory parameter.
Possible values{"admin","test",...}firtName
- : User's first name. This is an optional parameter.lastName
- : User's last name. This is an optional parameter.email
- : User's contact email address. This is a mandatory parameter.
Possible values{"nirakum2@cisco.com","lkandasa@cisco.com",...}role
- : Role name of the user. This is a mandatory parameter.
Possible values{"System Admin","Group Admin",
"Service End-User","Network Admin",...}groupName
- : Group name to which the user belongs. This is a mandatory
parameter. Possible values{"Default Values","SDK",...}java.lang.Exception
boolean userAPIAddGroup(java.lang.String groupName, java.lang.String description, java.lang.String firtName, java.lang.String lastName, java.lang.String email) throws java.lang.Exception
groupName
- : Group name. This is a mandatory parameter. Possible
values{"SDKGroup","QAGroup",...}description
- : Group description. This is an optional parameter.firtName
- : First name of group owner. This is an optional parameter.lastName
- : Last name of group owner. This is an optional parameter.email
- : Contact email address of group owner. This is a mandatory
parameter. Possible
values{"nirakum2@cisco.com","lkandasa@cisco.com",...}java.lang.Exception
APILoginProfile userAPIGetUserLoginProfile(java.lang.String userID) throws java.lang.Exception
userID
- : UCS Director login user ID. This is a mandatory parameter.
Possible values{"admin","test",..}java.lang.Exception
boolean userAPIDeleteUser(java.lang.String userID) throws java.lang.Exception
userID
- : UCS Director login user ID. This is a mandatory parameter.
Possible values{"admin","test",..}java.lang.Exception
APIVMAccess userAPIGetVMAccessCredentials(int vmID) throws java.lang.Exception
vmID
- : Virtual Machine ID. This is a mandatory parameter. Possible
values{1,2,3,4,...}java.lang.Exception
APITabularReport userAPIGetVMSnapshotDetails(int vmID) throws java.lang.Exception
vmID
- : Virtual Machine(VM) ID. This is a mandatory parameter.
Possible values {1,2,3,4,...}java.lang.Exception
java.lang.String userAPICreateVMSnapshot(int vmID, java.lang.String name, java.lang.String description, boolean isMemory, boolean isQuiesce) throws java.lang.Exception
vmID
- : Virtual Machine(VM) ID. This is a mandatory parameter.
Possible values {1,2,3,4,...}name
- : VM snapshot name. This is a mandatory parameter. Possible
valuesFor possible values, see example.description
- : Describes the snapshot information. This is an optional
parameter.isMemory
- : True to take a snapshot of the memory. Otherwise, it is
false. This is a mandatory parameter.isQuiesce
- : True to quiesce the file system. This is a mandatory
parameter.java.lang.Exception
APITabularReport userAPIGetTabularReportWithMetaData(java.lang.String contextName, java.lang.String contextValue, java.lang.String reportID) throws java.lang.Exception
contextName
- : Report context name. This is a mandatory parameter. For
possible values, see Report Meta data from UIcontextValue
- : Report context value for the context name. This is a
mandatory parameter. For possible values, see report metadata
from UI.reportID
- : Report name. This is a mandatory parameter. For possible
values, see report metadata.java.lang.Exception
@Deprecated boolean userAPIResetMyPassword(java.lang.String newPassword) throws java.lang.Exception
newPassword
- : Passes the new password for reset. This is a mandatory
parameter. Possible values{ non empty string of minimum 4 char
}java.lang.Exception
boolean userAPIModifyLoginProfilePassword(LoginProfileChangePasswordInfo passwordInfo) throws java.lang.Exception
passwordInfo
- : Password information of the user. Needs both the oldPassword
and the new password. This is a mandatory parameter. For
possible values, see example.java.lang.Exception
boolean userAPIModifyUserPassword(ModifyUserPasswordInfo userPasswordInfo) throws java.lang.Exception
userPasswordInfo
- : Password information required to modify the specified user's
password. Needs login profile password, user, new password to
set. This is a mandatory parameter. For possible values, see
example.java.lang.Exception
@Deprecated boolean userAPIResetUserPassword(java.lang.String user, java.lang.String newPassword, boolean resetAPIKey) throws java.lang.Exception
user
- : Username for which you want to reset the password. This is a
mandatory parameter. Possible values{"admin", "test",...}newPassword
- : New password to reset. This is a mandatory parameter.
Possible values {non-empty string of minimum 4 characters}resetAPIKey
- : True if you want to reset API key. Otherwise, it is false.
This is an optional parameter.java.lang.Exception
APIServiceRequestDetails userAPIGetServiceRequestDetails(int requestID) throws java.lang.Exception
requestID
- : Service request ID. This is a mandatory parameter. For
possible values, see service request report from UI.java.lang.Exception
APIWorkFlowStatus userAPIGetServiceRequestWorkFlow(int requestID) throws java.lang.Exception
requestID
- : Service request ID. This is a mandatory parameter. For
possible values, see Service Request Report from UIjava.lang.Exception
APIVMList userAPIGetVMsForServiceRequest(int request) throws java.lang.Exception
request
- : Service request ID. This is a mandatory parameter. For
possible values, see service request report from UI.java.lang.Exception
boolean userAPICreateVDC(APIVDCDetails vdcDetails) throws java.lang.Exception
vdcDetails
- : Contains virtual datacenter information to create VDC. This
is a mandatory parameter. For possible values, see example.java.lang.Exception
boolean userAPICreateCatalogItem(APICatalogItem catalogItem) throws java.lang.Exception
catalogItem
- : Contains catalog item information used to create the
catalog. This is a mandatory parameter. For possible values,
see example.java.lang.Exception
APIApprovalList userAPIGetMyApprovalList() throws java.lang.Exception
java.lang.Exception
boolean userAPIUpdateMyApproval(int requestID, int entryID, boolean isApproved, java.lang.String comments) throws java.lang.Exception
requestID
- : Service request ID. This is a mandatory parameter. For
possible values, see service request report from UI.entryID
- : Entry ID associated with the approval request. This is a
mandatory parameter. For possible values, see
userAPIGetMyApprovalList() for list entry IDs valid for the
user.isApproved
- : True if the request is approved. Otherwise, it is false.
This is a mandatory parametercomments
- : Comments to be logged along with the approval/rejection.
This is an optional parameter.java.lang.Exception
boolean userAPIRequestInventoryCollection(java.lang.String cloudName) throws java.lang.Exception
cloudName
- : Cloud name. This is a mandatory parameter. For possible
values, see example.java.lang.Exception
APIUserOnBoardDetails userAPIOnBoarding(APIUserOnBoardParams inParams) throws java.lang.Exception
inParams
- : Contains user, group, and VDC information. This is a
mandatory parameter. For possible values, see example.java.lang.Exception
APILoginProfile userAPIVerifyUser(java.lang.String userID, java.lang.String passWord) throws java.lang.Exception
userID
- : UCS Director login userID. This is a mandatory parameter.
Possible values{"admin","test",..}passWord
- : UCS Director login password. This is a mandatory parameter.
Possible values{"admin","cloupia123",..}java.lang.Exception
boolean userAPIUpdatePaymentStatus(APIMakePaymentParams inParams) throws java.lang.Exception
inParams
- : Contains payment information to update payment status. This
is a mandatory parameter. For possible values, see example.java.lang.Exception
double userAPICheckFunds(java.lang.String userID) throws java.lang.Exception
userID
- : UCS Director login userID. This is a mandatory parameter.
Possible values{"admin","test",..}java.lang.Exception
int userAPIProvisionRequest(APIProvisionParams provisionParams) throws java.lang.Exception
provisionParams
- : Contains VM information to provision. This is a mandatory
parameter. For possible values, see example.java.lang.Exception
java.lang.String userAPIMoQuery(java.lang.String mo, java.lang.String[] fields, java.lang.String query) throws java.lang.Exception
mo
- : Managed object name. This is a mandatory parameter. possible
values, {"mo" to query all mo as xml}fields
- : Input fields to query. This is a mandatory parameter. For
possible values, see example.query
- : Query string. This is a mandatory parameter. possible
values, {"/cloupia/api-v2/user", "/cloupia/api-v2/user/admin",
"/cloupia/api-v2/userAPI", "/cloupia/api-v2/.xsd",
"/cloupia/api-v2/WADL",....}java.lang.Exception
java.lang.String userAPIMoCreate(java.lang.String resourcePath, java.lang.String payload) throws java.lang.Exception
resourcePath
- : Resource path of api. This is a mandatory parameter.
Possible values { "/cloupia/api-v2/group",
"/cloupia/api-v2/userAPI",.....}payload
- : Generates input xml to request operation. This is a
mandatory parameter. For possible values, see example.java.lang.Exception
java.lang.String userAPIMoUpdate(java.lang.String resourcePath, java.lang.String payload) throws java.lang.Exception
resourcePath
- : API resource path. This is a mandatory parameter. Possible
values { "/cloupia/api-v2/group",
"/cloupia/api-v2/userAPI",.....}payload
- :Generates input XML to request operation. This is a mandatory
parameter. For possible values, see example.java.lang.Exception
java.lang.String userAPIMoDelete(java.lang.String resourcePath, java.lang.String payload) throws java.lang.Exception
resourcePath
- : API resource path. This is a mandatory parameter. Possible
values { "/cloupia/api-v2/group",
"/cloupia/api-v2/userAPI",.....}payload
- : Generates input XML to request operation. This is a
mandatory parameter. For possible values, see example.java.lang.Exception
APIProvisionParams userAPIGetCatalogDetails(java.lang.String catalogItemName) throws java.lang.Exception
java.lang.Exception
APIStorageResizeRange userAPIGetDatastoreResizeRange(java.lang.String vmID, java.lang.String datastoreName) throws java.lang.Exception
vmID
- : Virtual machine ID. This is a mandatory parameter. Possible
values {1,2,3,4,...}datastoreName
- : Data center name in UCS Director. This is a mandatory
parameter. Possible values { "DS_420","DSTest92",...}java.lang.Exception
APITabularReport userAPIGetAllGroups() throws java.lang.Exception
java.lang.Exception
UIMenu getUIMenu() throws java.lang.Exception
java.lang.Exception
java.lang.String[] getUIOperations(java.lang.String role) throws java.lang.Exception
java.lang.Exception
boolean userAPIconfigureIPAddressPool(java.lang.String accountName, java.lang.String ipAddress, int srID, int groupID, java.lang.String initiatinguser, long reservedAt, long reservedTill, boolean isValID, java.lang.String policyName, java.lang.String componentName) throws java.lang.Exception
accountName
- : Account name used to configure the IP Pool. This is a
mandatory parameter. For possible values, see example.ipAddress
- : IP address for configuring. This is a mandatory parameter.
For possible values, see example.srID
- : service request ID. This is a mandatory parameter. For
possible values, see service request report from .groupID
- : group ID. This is a mandatory parameter. Possibel values {
1,2,3,4,....}initiatinguser
- : initiating UCS Director user. This is an optional parameter.
possible values, { "admin", "service end-user",...}reservedAt
- : Timestamp for the reserved time. This is an optional
parameter. For possible values, see example.reservedTill
- : timestamp, IP addressed it is reserved till that
timestamp.This is an optional parameter. For possible values,
see example.isValID
- : Is to check whether valid or not. This is an optional
parameter. For possible values, see example.policyName
- : valID policy name.This is an optional parameter. For
possible values, see example.componentName
- : Component name. This is an optional parameter. For possible
values, see example.java.lang.Exception
CloupiaProductInfo userAPIGetProductInfo()
APITabularReport userAPIGetDatastoreCapacityForCloudTabularReport(java.lang.String cloudName) throws java.lang.Exception
cloudName
- : Cloud name available in UCS Director. This is a mandatory
parameter. For possible values, see virtual Accounts from UIjava.lang.Exception
APITabularReport userAPIGetDatastoreCapacityForVMTabularReport(java.lang.String vmID) throws java.lang.Exception
vmID
- : Virtual Machine(VM) ID. This is a mandatory parameter.
Possible values { 1,2,3,4,...}java.lang.Exception
java.util.List<java.lang.String> getvFilerIPAddressByIdentityAndProtocol(java.lang.String vfilerIdentity, java.lang.String protocol) throws java.lang.Exception
vfilerIdentity
- protocol
- java.lang.Exception
boolean userAPIVerifyConsoleAccessToken(java.lang.String token) throws java.lang.Exception
token
- : Alpha numeric character used to verify console access. This
is a mandatory parameter. Possible values {
"toK53872","ZCrQ0935",... token's length should be 8 char }java.lang.Exception
boolean userAPIImportWorkflows(APIWFExport export) throws java.lang.Exception
export
- : Contains user credentials and source URL. This is a
mandatory parameter. For possible values, see example.java.lang.Exception
APICustomWorkflowDefinitionList userAPIExportWorkflows(java.lang.String workflowNames) throws java.lang.Exception
workflowNames
- : Workflow name which you want to export. This is a mandatory
parameter. Possible values {"Send Email",
"GetAllAccounts",...}java.lang.Exception
int userAPIRollbackWorkflow(int srID) throws java.lang.Exception
srID
- : Service request ID. This is a mandatory parameter. Possible
values { 1,2,3,4,...}java.lang.Exception
ServiceRequestLogEntry[] userAPIGetServiceRequestLogEntries(int srID, int severity) throws java.lang.Exception
srID
- : Service request ID. This is a mandatory parameter. For
possible values, see service request report from UI.severity
- : Specifies severity of the log. Manadtory parameter. Possible
values { 1,2,3,4,.....}java.lang.Exception
ServiceRequestLogEntry[] userAPIGetServiceRequestLogEntriesAtLevels(int srID, java.lang.String severityList) throws java.lang.Exception
srID
- : Service request ID. This is a mandatory parameter. For
possible values, see service request report from UI.severityList
- : list of severity separated by comma( , ). This is a
mandatory parameter. Possible values { "1,2,3",
"6,2,3,9,10",....}java.lang.Exception
CustomActionDefinition[] userAPIGetWorkflows(java.lang.String folderName) throws java.lang.Exception
folderName
- : name of the folder which contains workflows. This is a
mandatory parameter. Possible values{ "System", "Default"
,.....}java.lang.Exception
boolean userAPIUpdateOrchEventReceiverConfig(OrchestratorEventReceiverConfig[] configs) throws java.lang.Exception
configs
- : Contains Orchestrator Event Receiver information. This is a
mandatory parameter. For possible values, see example.java.lang.Exception
APIWorkflowInputDetails userAPIGetWorkflowInputs(java.lang.String workflowName) throws java.lang.Exception
workflowName:
- Workflow name. This is a mandatory parameter. For possible
values, see example.java.lang.Exception
APIWFValidationResult userAPIValidateWorkFlow(java.lang.String workflowName) throws java.lang.Exception
workflowName
- : Name of the workflow. This is a mandatory parameter. For
possible values, see example.java.lang.Exception
boolean userAPICreateVMwareCluster(APIVMwareCluster cluster) throws java.lang.Exception
cluster
- : Contains VMware cluster information to be created. This is a
mandatory parameter. For possible values, see example.java.lang.Exception
boolean userAPIDeleteVMwareCluster(APIVMwareCluster cluster) throws java.lang.Exception
cluster
- : Contains VMware cluster information to be deleted. This is a
mandatory parameter. For possible values, see example.java.lang.Exception
int userAPIGetWorkflowStatus(int srID) throws java.lang.Exception
srID
- : Service request ID. This is a mandatory parameter. For
possible values, see service request report from UIjava.lang.Exception
void reSubmitWorkFlow(int requestID, long configEntryID, boolean skipApprovals) throws java.lang.Exception
java.lang.Exception
ManagedReportDefinition[] userAPIGetApplicableManagedReports() throws java.lang.Exception
java.lang.Exception
ConfigTableAction userAPIGetGenerateReportAction(ReportContext context) throws java.lang.Exception
context
- : ReportContext. This is a mandatory parameter. For possible
values, see report metadata from UI.java.lang.Exception
FormResult userAPIGetInitialFormData(ReportContext reportContext, java.lang.String formID) throws java.lang.Exception
reportContext
- : Report context name. This is a mandatory parameter. For
possible values, see report metadata from UI.formID
- : Form ID. This is a mandatory parameter. For possible values,
see examle.java.lang.Exception
FormResult userAPIDoFormSubmit(ReportContext reportContext, java.lang.String formID, FormFieldData[] data) throws java.lang.Exception
reportContext
- : Report context name. This is a mandatory parameter. For
possible values, see report metadata from UI.formID
- : form ID. This is a mandatory parameter. For possible values,
see example.data
- : Contains form field data as array . This is a mandatory
parameter. For possible values, see example.java.lang.Exception
java.util.List<XenProvisionedVMDetails> userAPIGetXenDesktopProvisionedVMDetails(int srID) throws java.lang.Exception
srID
- : Service request ID. This is a mandatory parameter. For
possible values, see service request report from UI.java.lang.Exception
java.lang.String userAPIGetCUICVersion() throws java.lang.Exception
java.lang.Exception
boolean fileExistsOnVM(VMWareVMSummary vms, java.lang.String vmUserName, java.lang.String vmPassword, java.lang.String guestFilePath) throws java.lang.Exception
java.lang.Exception
boolean copyFileToVM(VMWareVMSummary vms, java.lang.String vmUserName, java.lang.String vmPassword, java.lang.String localFilePath, java.lang.String guestFilePath) throws java.lang.Exception
java.lang.Exception
boolean createNetworkFile(java.lang.String fileLocation, java.lang.String device, java.lang.String ip, java.lang.String gw, java.lang.String nm, boolean isStatic) throws java.lang.Exception
java.lang.Exception
boolean createWindowsNetworkConfig(java.lang.String fileLocation, java.lang.String device, java.lang.String ip, java.lang.String gw, java.lang.String nm) throws java.lang.Exception
java.lang.Exception
long executeVMCommand(VMWareVMSummary vms, java.lang.String vmUserName, java.lang.String vmPassword, java.lang.String vmCommandPath, java.lang.String[] commandArgs) throws java.lang.Exception
java.lang.Exception
java.lang.String userAPIGetIconImageURL(java.lang.String imageID) throws java.lang.Exception
imageID
- : Icon image ID. This is a mandatory parameter. Possible
values { 1,2,3,4, ...}java.lang.Exception
boolean userAPIdoPostInstallConfiguration() throws java.lang.Exception
java.lang.Exception
java.lang.String[] userAPIGetMobileAccessPermissions() throws java.lang.Exception
java.lang.Exception
boolean isESX5(VMWareVMSummary vms) throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIResourceChargebackDetails() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIResourceChargebackDetailsByGroup(java.lang.String groupName) throws java.lang.Exception
groupName
- : UCS Director group name . This is a mandatory parameter.
Possible values{ "Default Group", "SDKGroup", "AdminGroup",
...}java.lang.Exception
APITabularReport userAPIGetSystemResourceUsageReport() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIGetSystemTasksReport() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIGetComputeAccountListReport() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIGetComputeServerListReport() throws java.lang.Exception
java.lang.Exception
java.util.ArrayList<APITabularReport> userAPIGetComputeServersListReport() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIGetCloudPollingHistoryReport() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIGetStorageAccountListReport() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIGetLicenseListReport() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIGetNetworkDevicesListReport() throws java.lang.Exception
java.lang.Exception
APITabularReport userAPIGetCloudsListReport() throws java.lang.Exception
java.lang.Exception
DynReportContext[] getAllReportContexts()
APITabularReportMetadata userAPIGetTabularReportMetadata(java.lang.String contextName, java.lang.String contextValue, java.lang.String reportID) throws java.lang.Exception
contextName
- : Context name. This is a mandatory parameter. Possible values
{"1" , "0"}contextValue
- : Context value. This is a mandatory parameter. Possible
values {"All Clouds" , "1" }reportID
- : Report-ID. This is a mandatory parameter. Possible values
{"VMS-T0" ,"EVENTS-T0"}java.lang.Exception
java.util.List<WorkflowInputValue> userAPIGetWorkflowInputValues(int srID) throws java.lang.Exception
srID
- : Service request ID. This is a mandatory parameter. For
possible values, see service request report from UI.java.lang.Exception
java.lang.String userAPIGetWorkflowInputValue(java.lang.String fieldLabel, int srID) throws java.lang.Exception
fieldLabel
- : Name of the input field which need to get the values. This
is a mandatory parameter. For possible values, see workflow
inputs.srID
- : Service request ID. This is a mandatory parameter. For
possible values, see service request report from UI.java.lang.Exception
java.lang.String getPrimaryIPAddress()
APITabularReport userAPIGetAPITabularReport(java.lang.String reportName) throws java.lang.Exception
reportName
- : Report name. This is a mandatory parameter. For possible
values, see report metadata from UIjava.lang.Exception
java.lang.Object getAPIDelegate(java.lang.String namespace)
java.util.List<java.lang.String> userAPIGetLOVProvidersList() throws java.lang.Exception
java.lang.Exception
FormLOVPair[] userAPIgetStaticListByName(java.lang.String listName) throws java.lang.Exception
listName
- : LOV List name. This is a mandatory parameter.Possible
values@see Rest API: userAPIGetLOVProvIDersList to get list of
lov namejava.lang.Exception
FormLOVPair[] userAPIgetBMAOSList() throws java.lang.Exception
java.lang.Exception
UserAccessProfile[] userAPIgetAllUserAccessProfiles(java.lang.String userName) throws java.lang.Exception
userName
- : user name of the UCS Director Server. This is a mandatory
parameter. Possible valuesare {"admin", "enduser"}java.lang.Exception
boolean userAPIDeleteCatalogItem(java.lang.String catalogItemName) throws java.lang.Exception
catalogItemName
- : name of the catalog. This is a mandatory parameter. Possible
valuesFor possible values, see example.java.lang.Exception
java.lang.String userAPIExportVDC(java.lang.String vdcName) throws java.lang.Exception
vdcName
- : name of the vDC that you want to export. This is a mandatory
parameter. Possible valuesFor possible values, see example.java.lang.Exception
VDC userAPIImportVDC(java.lang.String importedVDCString) throws java.lang.Exception
importedVDCString
- : Imported VDC. This is a mandatory parameter. Possible
values, see example.java.lang.Exception
int userAPIProvisionRequestWithPortGroup(APIProvisionParams apiProvisionParams) throws java.lang.Exception
apiProvisionParams
- : Contains VM information to be provision. This is a mandatory
parameter. For possible values, see example.java.lang.Exception
int userAPIVMWareProvisionRequest(java.lang.String catalogName, java.lang.String vdcName, java.lang.String vmName, java.lang.String comment, double vCpus, double memory, java.lang.String datastores, java.lang.String opNicPortGroup) throws java.lang.Exception
catalogName
- : Name of the catalog. This is a mandatory parameter. For
possible values, see example.vdcName
- : Name of the VDC. This is a mandatory parameter. For possible
values, see example.vmName
- : Name of VM that needs to be provisioned. For possible
values, see example.comment
- : Comments which is used for VM Labeling. This is an optional
parameter. For possible values, see example.vCpus
- : Number of CPU. This is a mandatory parameter.Possible
values{ 1,2,3,...}memory
- : Size of memory in GB. This is a mandatory parameter.Possible
values { "1",2",...}datastores
- : Number of VM disks. This is a mandatory parameter. For
possible values, see example.opNicPortGroup
- : VM networks.This is a mandatory parameter. For possible
values, see example.java.lang.Exception
int userAPIVMWareCloneVMProvisionRequest(java.lang.String vmID, java.lang.String vdcName, java.lang.String vmName, boolean useLinkedClone, java.lang.String snapshotKey, java.lang.String snapshotName, java.lang.String comment, double vCpus, double memory, java.lang.String chargeFrequency, java.lang.String datastores, java.lang.String opNicPortGroup, java.lang.String credentials, java.lang.String userID, java.lang.String password, boolean provisionDiskinSingleDatastore, java.lang.String vmappChargeFrequency, double activeVMCost, double inactiveVMCost) throws java.lang.Exception
vmID
- : ID of VM that needs to be cloned. This is a mandatory
parameter. For possible values, see example.vdcName
- : Name of the VDC. This is a mandatory parameter. For possible
values, see example.vmName
- : Name of VM that needs to be provisioned. For possible
values, see example.useLinkedClone
- : Set to true to use the linked clone feature. For possible
values, see example.snapshotKey
- : Snapshot key that needs to be used without creating a new
snapshot. For possible values, see example.snapshotName
- : Name of a new snapshot. This parameter is used to create a
new snapshot. For possible values, see example.comment
- : Comment that is set as the VM label. This is an optional
parameter. For possible values, see example.vCpus
- : Number of CPUs. This is a mandatory parameter. or possible
values, see example.memory
- : Size of memory in GB. For possible values, see example.chargeFrequency
- : Frequency of charge. Possible values { "Hourly" or
"Monthly"}datastores
- : Number of VM Disks. This is a mandatory parameter. For
possible values, see example.opNicPortGroup
- : VM networks. For possible values, see example.credentials
- : Credential parameter. Possible values {"Do not share" or
"Share after password reset" or "Share template credentials"}.userID
- : User ID for accessing the VM. This is an optional parameter.
For possible values, see example.password
- : Password for accessing the vmVM. This is an optional
parameter. For possible values, see example.provisionDiskinSingleDatastore
- : Set to true to provision all disks in a single datastore.vmappChargeFrequency
- : Frequency of VM app charge. Possible values { "Hourly" or
"Monthly"}activeVMCost
- : Cost of the active VM. This is an optional parameter. For
possible values, see example.inactiveVMCost
- : Cost of the inactive VM. This is an optional parameter. For
possible values, see example.java.lang.Exception
int userAPIVMWareMoveVMProvisionRequest(java.lang.String vmID, java.lang.String vdcName, java.lang.String credentials, java.lang.String userID, java.lang.String password, boolean provisionDiskinSingleDatastore, java.lang.String vmappChargeFrequency, double activeVMCost, double inactiveVMCost, java.lang.String comment, double vCpus, double memory, java.lang.String datastores, java.lang.String opNicPortGroup) throws java.lang.Exception
vmID
- : VM identifier. This is a mandatory parameter. For possible
values, see example.vdcName
- : VDCname. This is a mandatory parameter. For possible values,
see example.credentials
- : Contains VM credential. Possible values {"Do not share" or
"Share after password reset" or "Share template credentials"}userID
- : User ID for the VM. This is an optional parameter. For
possible values, see example.password
- : password for the VM. This is an optional parameter. For
possible values, see example.provisionDiskinSingleDatastore
- : True to provision all disks in a single datastore.vmappChargeFrequency
- : Frequency of VM app charge. For Possible values{ "Hourly" or
"Monthly"}activeVMCost
- : Cost of the active VM. This is an optional parameter. For
possible values, see example.inactiveVMCost
- : Cost of the inactive VM. This is an optional parameter. For
possible values, see example.comment
- : Comment set as the VM label. This is an optional parameter.
For possible values, see example.vCpus
- : Number of CPUs. This is a mandatory parameter.Possible
valuesFor possible values, see example.memory
- : Size of memory in GB. This is a mandatory parameter.Possible
values{ 1,2,3,....}datastores
- : number of VM Disks. This is a mandatory parameter. For
possible values, see example.opNicPortGroup
- : VM networks name. For possible values, see example.java.lang.Exception
APITabularReport userAPIGetTabularValues(java.lang.String type) throws java.lang.Exception
type
- : Tabular type. This is a mandatory parameter. Possible values
{"vm","groups"}java.lang.Exception
FormLOVPair[] userAPIGetLOVValues(java.lang.String type) throws java.lang.Exception
type
- : LOV type. This is a mandatory parameter. Possible
values{"vDC", "vm", "catalog" ,...}java.lang.Exception
java.lang.String userAPIGetRESTAccessKey(java.lang.String userName) throws java.lang.Exception
userName
- : Username. This is a mandatory parameter. Possible values
{"admin", "enduser"}.java.lang.Exception
boolean userAPIIsMspMode() throws java.lang.Exception
java.lang.Exception
void userLoinEvent(java.lang.String username)
void userLogOutEvent(java.lang.String username)
int userAPIHypervVMProvisioningWithVMNetwork(APIHypervProvisionParams apiHypervProvisionParams) throws java.lang.Exception
apiHypervProvisionParams
- : Contains HyperV provisioning information. This is a
mandatory parameter. For possible values, see example.java.lang.Exception
java.lang.String userAPIValidateWorkflowInput(java.lang.String validatorName, java.lang.String inputValue) throws java.lang.Exception
validatorName
- : valdator Name. This is a mandatory parameter. Possible
values {"Number ValIDator" ,"IP ValIDator"}inputValue
- : Input value. This is a mandatory parameter. Possible values{
non-empty string}java.lang.Exception
int userAPICreateGroup(APIGroup apiGroup) throws java.lang.Exception
apiGroup
- : Contains UCS Director group name. This is a mandatory
parameter. For possible values, see example.java.lang.Exception
java.util.List<APIGroup> userAPIGetGroups() throws java.lang.Exception
java.lang.Exception
java.util.List<APIGroup> userAPIGetGroupById(int groupId) throws java.lang.Exception
groupId
- : Is group ID. This is a mandatory parameter. Possible values
{ 1,2,3,4,...}java.lang.Exception
java.util.List<APIGroup> userAPIGetGroupByName(java.lang.String groupName) throws java.lang.Exception
groupName
- : Group Name. This is a mandatory parameter. Possible values{
"Default Group", "SDK", ...}java.lang.Exception
boolean userAPIUpdateGroup(APIGroup apiGroup) throws java.lang.Exception
apiGroup
- : Contains UCS Director group information. This is a mandatory
parameter. For possible values, see example.java.lang.Exception
boolean userAPIDeleteGroup(int groupID) throws java.lang.Exception
groupID
- : This is a mandatory parameter. Possible values { 1,2,3,4,
...}java.lang.Exception
APITabularReport userAPIFilterTabularReport(java.lang.String contextName, java.lang.String contextValue, java.lang.String reportID, java.lang.String columnLabel, java.lang.String columnValue) throws java.lang.Exception
contextName
- : context Name. This is a mandatory parameter. Possible values
{"1" , "0"}.contextValue
- : context value. This is a mandatory parameter. For Possible
values{"All Clouds" , "1" }.reportID
- : Report IDentification number. This is a mandatory parameter.
Possible values {"VMS-T0" ,"EVENTS-T0"}columnLabel
- : context Name. This is a mandatory parameter. Possible values
{"1" , "0"}.columnValue
- : This is an optional parameter. For possible values, see
example.java.lang.Exception
boolean userAPIUpdateUser(APIUser apiUser) throws java.lang.Exception
apiUser
- : Contains UCS Director login user information. This is a
mandatory parameter. For possible values, see example.java.lang.Exception
int userAPIServiceContainerCatalogRequest(APIServiceContainerCatalogParams apiCatalog) throws java.lang.Exception
apiCatalog
- : Contains ServicContaineCatalog information. This is a
mandatory parameter. For possible values, see example.java.lang.Exception
java.lang.String userAPIConfigureVMLeaseTime(java.lang.String vmIDStr, long dateTime) throws java.lang.Exception
vmIDStr
- : Is Virtual Machine(VM) ID. This is a mandatory parameter.
Possible values{ "1", "2", "3", ...}dateTime
- : is date and time value to configure VM lease time. This is a
mandatory parameter.For possible values, see example.java.lang.Exception
CustomDashboardSettings[] getCustomDashboardSettings() throws java.lang.Exception
java.lang.Exception
void updateUserLocaleMap(java.lang.String loginName) throws java.lang.Exception
java.lang.Exception
java.lang.String getDashletInfo() throws java.lang.Exception
java.lang.Exception
java.lang.String getEndUserDashBoardCatalogs() throws java.lang.Exception
java.lang.Exception
java.lang.String[] getMSPUserList(java.lang.String loginName) throws java.lang.Exception
java.lang.Exception
java.lang.String getEndUserDashBoardCatalogItems(java.lang.String folderName) throws java.lang.Exception
folderName
- java.lang.Exception
void persistApplicableVisibleReports(java.lang.String userName, int menuId, ReportContext context, ReportDefinition[] reportDefinition) throws java.lang.Exception
java.lang.Exception
java.lang.String[] getAllowedOperations() throws java.lang.Exception
java.lang.Exception
java.lang.String getMoResourceAsJson(java.lang.String resourcePath, java.lang.Object... accessArgs) throws java.lang.Exception
resourcePath
- MoResource PathaccessArgs
- This can be used to override the current user profile while retrieving the MoResources, when the method is executed by a Non-Admin user.
In order to retrieve the MoResources as Admin, the accessArgs[0] must be specified true.java.lang.Exception
java.lang.String createMoResource(java.lang.String resourcePath, java.lang.String jsonPayload, java.lang.Object... accessArgs) throws java.lang.Exception
resourcePath
- MoResource Pathpayload
- Resource Payload as JsonaccessArgs
- This can be used to override the current user profile while performing create operation for the MoResource, when the method is executed by a Non-Admin user.
In order to perform create operation for the MoResource as Admin, the accessArgs[0] must be specified true.java.lang.Exception
java.lang.String deleteMoResource(java.lang.String resourcePath, java.lang.String jsonPayload, java.lang.Object... accessArgs) throws java.lang.Exception
resourcePath
- MoResource Pathpayload
- Resource Payload as Json(not mandatory)accessArgs
- This can be used to override the current user profile while performing delete operation for the MoResource, when the method is executed by a Non-Admin user.
In order to perform delete operation for the MoResource as Admin, the accessArgs[0] must be specified true.java.lang.Exception
java.lang.String updateMoResource(java.lang.String resourcePath, java.lang.String payload, java.lang.Object... accessArgs) throws java.lang.Exception
resourcePath
- : MoResource Pathpayload
- : Resource Payload as JsonaccessArgs
- This can be used to override the current user profile while performing update operation for the MoResource, when the method is executed by a Non-Admin user.
In order to perform update operation for the MoResource as Admin, the accessArgs[0] must be specified true.java.lang.Exception
java.lang.String performOperationOnJSONPayload(java.lang.String operationName, java.lang.String jsonPayloadString, java.lang.Object... accessArgs) throws java.lang.Exception
operationName
- jsonPayloadString
- accessArgs
- This can be used to override the current user profile while invoking leagcy JSON REST APIs, when the method is executed by a Non-Admin user.
In order to invoke Leagcy JSON REST APIs as Admin, the accessArgs[0] must be specified true.java.lang.Exception
SearchableReport[] getSearchableReport() throws java.lang.Exception
java.lang.Exception
SearchableWorkflow[] getSearchableWorkflows() throws java.lang.Exception
java.lang.Exception
SessionManagement getSessionManagement() throws java.lang.Exception
java.lang.Exception
void persistApplicableVisibleManagedReports(java.lang.String userName, int menuId, ManagedReportDefinition[] reportDefinition) throws java.lang.Exception
java.lang.Exception
void persistLoginInfo(java.lang.String username, java.lang.String password, java.lang.String remoteHost, java.lang.String userAgent, boolean isLoginSuccess, java.lang.String comments, java.lang.String accessedOn, long loginTimestamp, java.lang.String clientType, boolean isMalicious, boolean isValidUser, java.lang.String requestURIForLoginHistory) throws java.lang.Exception
java.lang.Exception
void purgeLoginHistory(java.lang.String userName, java.lang.String userAccessLevel, long loginTimestamp) throws java.lang.Exception
java.lang.Exception
void persistMaxSessionNotification(java.lang.String userName, long occurenceTime, int limit, java.lang.String clientType) throws java.lang.Exception
java.lang.Exception
InvalidateSession getSessionDetailsRequestedForInvalidate(java.lang.String username)
void removeRequestForSessionClearance(java.lang.String username)
SystemDashboard[] getSystemDashboard() throws java.lang.Exception
java.lang.Exception