Manuals / Brands / Computer Equipment / Software / HP / Computer Equipment / Software

HP Matrix Operating Environment Software addCms, quiesceCms, unquiesceCms, endCmsMaintenance, countRunningRequestsForCms

1 111

Download 111 pages, 1.4 Mb

endCmsMaintenance

	Name	endCmsMaintenance	Takes a CMS out of maintenance mode in a federated environment. This
			operation may be performed only by an infrastructure orchestration
			Administrator.

	Parameters	String cmsName	The fully-qualified domain name of the CMS to take out of maintenance
			mode.

	Returns	none

	Exceptions	InvalidParameterException

		IOSoapException

countRunningRequestsForCms

	Name	CountRunningRequestsFor	Counts the number of requests running on a CMS in maintenance mode.
		Cms	This operation may be performed only by an infrastructure orchestration
			Administrator.

	Parameters	String cmsName	The fully-qualified domain name of the CMS for which to count running
			requests.

	Returns	int numRunningRequests	The number of requests currently running on the specified CMS.

	Exceptions	InvalidParameterException

		IOSoapException

addCms

	Name	addCms	Notify infrastructure orchestration of a CMS added to the federation. This
			operation may be performed only by an infrastructure orchestration
			Administrator.

	Parameters	String cmsName	The fully-qualified domain name of the CMS added to the federation.

	Returns	none

	Exceptions	InvalidParameterException

		IOSoapException

quiesceCms

	Name	quiesceCms	Quiesces the CMS. This operation may be performed only by an
			infrastructure orchestration Administrator.

	Parameters	none

	Returns	none

	Exceptions	IOSoapException

unquiesceCms

	Name	unquiesceCms	Removes the CMS from the quiesced state. This operation may be
			performed only by an infrastructure orchestration Administrator.

	Parameters	none

38 Operations

Contents

API and CLI Operations Reference Guide Abstract Page Contents Page Page Page Page Page Page Part I Matrix API 1 Introduction Integration interface overview New features in 7.1 Update New features in Page Chargeback 2 Accessing the Web Service Interfaces 3 Operations Version getVersion deleteTemplate Service listServices getService createService deleteService deactivateService activateService changeServiceLease powerOffService powerCycleService getRequestInfo getRequest setRequestApprovalState continueRequest cancelRequest Logical Server Group getLogicalServerGroup getLogicalServerGroup addServersToLogicalServerGroup addDiskToLogicalServerGroup addNewDiskToLogicalServerGroup setLogicalServerGroupActiveServerCount Logical Server findLogicalServer activateLogicalServers powerOffLogicalServers powerOnLogicalServers powerCycleLogicalServers editLogicalServers removeLogicalServers syncLogicalServers deleteServerPool moveServerToServerPool assignUsersToServerPool Server getComputeServer Software listSoftware Storage listSanVolumes Organization listOrganizations listOrganizations getOrganization assignTemplateToOrganization unassignTemplateFromOrganization assignServerToOrganization unassignServerFromOrganization assignSubnetToOrganization unassignSubnetFromOrganization assignSoftwareToOrganization unassignSoftwareFromOrganization syncOrganizations CMS beginCmsMaintenance endCmsMaintenance countRunningRequestsForCms addCms quiesceCms unquiesceCms LoadBalancer listLoadBalancers removeLoadBalancer addLoadBalancerCertificate removeLoadBalancerCertificate setLoadBalancerPassword unsetLoadBalancerPassword LogicalLoadBalancer createLogicalLoadBalancerGroup deleteLogicalLoadBalancerGroup addLogicalLoadBalancerGroupMember removeLogicalLoadBalancerGroupMember FirewallRuleGroup getFirewallRuleGroup addRuleToFirewallRuleGroup removeRuleFromFirewallRuleGroup syncFirewallRuleGroups FloatingIPAddress addFloatingIPAddress moveFloatingIPAddress removeFloatingIPAddress releaseFloatingIPAddress listUnassociatedFloatingIPAddresses listServerSnapshots createServerSnapshot revertServerSnapshot deleteServerSnapshot Page 4 Data Model ByteSize ByteSizeEnum Possible values: MB, GB, OTHER CidrIpRange CmsQuiesceState Cost CostFrequency CostFrequencyEnum Possible values: MONTH, WEEK, DAY, HOUR, UNSPECIFIED, OTHER CustomAddressAssignmentTypeAttribute CustomProcessorAttribute CustomStorageVolumeAttribute CustomSubnetBindingAttribute CustomTemplateAttributes DeployableSoftware DeploymentService DeploymentServiceType DeploymentServiceTypeEnum Possible values: RDP, SA, Ignite-UX,CUSTOM, OTHER DrMode FirewallRule FirewallRuleGroupInfo FirewallRuleGroupDetails Extends FirewallRuleGroupInfo ImageType IPType IPTypeEnum Possible values: IPV4, IPV6, UNSPECIFIED, OTHER LeasePeriod LoadBalancerInfo LogicalDisk LogicalFirewallRuleGroup LogicalIPAddress LogicalLoadBalancerDetails Extends LogicalLoadBalancerInfo LogicalLoadBalancerGroupDetails Extends LogicalLoadBalancerGroupInfo LogicalLoadBalancerGroupInfo LogicalLoadBalancerProtocol LogicalLoadBalancerProtocolEnum Possible values: TCP, HTTP, HTTPS, OTHER LogicalNetworkInterface LogicalServerDetails LogicalServerGroupInfo LogicalServerInfo LogicalSoftware LogicalSubnet MessageSeverity MessageSeverityEnum Possible values: CRITICAL, MAJOR, MINOR, WARNING, NORMAL, INFORMATIONAL, OTHER NatEntry NatType Organization PacketProtocol PacketProtocolEnum Possible values: TCP, UDP, ICMP, OTHER ProcessorArchitecture RequestDetails Extends RequestInfo RequestHistoryItem RequestHistoryItemLevel RequestHistoryItemLevelEnum RequestStatus RequestStatusEnum RequestType RequestTypeEnum SanVolume SanVolumeState SanVolumeStateEnum SanVolumeTemplate ServerPool ServerPoolResourceNote ServerResource ServiceAction ServiceActionTrigger ServiceActionTriggerEnum Possible values: SERVICE_BEGIN, SERVICE_END, OTHER ServiceDetails Extends ServiceInfo ServiceInfo SoftwareDiskDefinition SoftwareType SoftwareTypeEnum Possible values: IMAGE, VM_TEMPLATE, UNSPECIFIED, CLOUD_IMAGE, OTHER StorageProvisioningType StorageProvisioningTypeEnum Possible values: THICK, THIN, UNSPECIFIED, OTHER StorageType StorageTypeEnum TemplateInfo VirtualizationType VirtualizationTypeEnum VirtualSwitch VmHost VmHostDataStore Workflow WwnConnection 5 Exceptions OrganizationNotFoundException A specified organization name was not recognized RequestNotFoundException A specified request ID was not recognized SanVolumeNotFoundException SoftwareNotFoundException A specified software ID was not recognized SubnetNotFoundException A specified subnet ID was not recognized TemplateNotFoundException 6 Example Usage 7 Sample Java Client Page Page IOClientPasswordHandler.java: TrustAllX509TrustManager.java: Page 8 Sample VisualStudio/.NET/C# Client •Open the app.config file and find the endpoint tag inside client tag: •Insert this content inside the endpoint tag from the previous step: Page Part II Chargeback API 9 Introduction 10 Accessing the Chargeback Web Service Interfaces 11 Operations Aggregated Usage Report getAggregatedServiceUsage 12 Data model Period Represents the period of time of the data to be returned PeriodType enum Possible values: PERIOD, DAILY ServiceFilter ServiceInformation Represents descriptive information of a service ResourceUsageSummary ServerUsageSummary DiskUsageSummary ServiceUsagePage ServiceUsageSummary AggregateServiceUsage ServiceUsageDetailPage ServiceUsageDetail DiskUsageDetail IpAddressUsageDetail 13 Exceptions PeriodStartDateGreaterThanEndDateException Start date is a date newer than end date PeriodStartDateTooOldException Start date is older than 365 days from the current date RequiredParameterException 14 Sample Python Client Example 1 connection.py Example 2 reports.py Page Page Page Page Example 3 GUI.py Page Page Example 4 reports_file.py 15 Sample Chargeback Usage Report AReferences B Support and other resources Warranty information HP authorized resellers For the name of the nearest HP authorized reseller, see the following sources: In the United States, see the HP U.S. service locator web site: http://www.hp.com/service_locator Related information Documentation and support Matrix infrastructure orchestration documentation