HP Matrix Operating Environment Software manual API and CLI Operations Reference Guide, Abstract

Page 1

HP CloudSystem Matrix/Matrix Operating Environment 7.1 Integration Interfaces

API and CLI Operations Reference Guide

Abstract

This document describes the rich set of Matrix OE’s infrastructure orchestration (IO) interfaces available to HP customers, partners, and integrators. These interfaces allow customers to integrate Matrix OE into their business and IT operations processes. Partners and Integrators can use the interfaces in combination with their own offerings to provide new, rich capabilities.

HP Part Number: 5900-2282

Published: October 2012

Edition: 6

Image 1

Contents Abstract API and CLI Operations Reference Guide7.1 7.1 Update 1Contents CMS Data Model Contents Example Usage ExceptionsSample Java Client Accessing the Chargeback Web Service InterfacesRequiredParameterException Part I Matrix API Introduction Integration interface overview New features in 7.1 UpdateIntroduction PowerCycleLogicalServers New featuresNew features in 7.1 QuiesceCms UnquiesceCms GetCmsQuiesceStatus EditLogicalServers RemoveLogicalServersLogicalServerGroupDetails LogicalServerInfoChargeback ServiceInfoRequestInfo TemplateInfoAccessing Wsdl Accessing the Web Service InterfacesCommand Line Interface SecurityImportTemplate OperationsExportTemplate List TemplateInfoListServices ServiceGetService CreateServiceDeactivateService DeleteServiceChangeServiceLease ActivateServicePowerOffService DeleteReplicaService PowerOnServiceRequest ListRequestsGetRequest GetRequestInfoSetRequestApprovalState ContinueRequestLogical Server Group CancelRequestGetLogicalServerGroup AddServersToLogicalServerGroupAddNewDiskToLogicalServerGroup AddDiskToLogicalServerGroupRawMappingTypeEnum SetLogicalServerGroupActiveServerCountDeactivateLogicalServers GetLogicalServerLogicalServerInfo LogicalServerDetailsPowerOnLogicalServers PowerOffLogicalServersActivateLogicalServers LogicalServerNotFound Exception Logical ServerEditLogicalServers PowerCycleLogicalServersRemoveLogicalServers ByteSizeEnumListServerPools Server PoolGetServerPool CreateServerPoolMoveServerToServerPool DeleteServerPoolAssignUsersToServerPool UnassignUsersFromServerPool ServerGetComputeServer GetVmHostSubnet SoftwareGetSanVolume ListSanVolumesListSanVolumeTemplates GetSanVolumeTemplateListOrganizations OrganizationGetOrganization AssignTemplateToOrganizationAssignServerToOrganization By a Service Provider AdministratorUnassignServerFromOrganization OrganizationName Returns None ExceptionsUnassignSubnetFromOrganization AssignSubnetToOrganizationAssignSoftwareToOrganization UnassignSoftwareFromOrganization BeginCmsMaintenanceSyncOrganizations CountRunningRequestsForCms EndCmsMaintenanceAddCms QuiesceCmsGetCmsQuiesceStatus LoadBalancerListLoadBalancers AddLoadBalancerRemoveLoadBalancer SetLoadBalancerPasswordAddLoadBalancerCertificate RemoveLoadBalancerCertificateLogicalLoadBalancer UnsetLoadBalancerPasswordCreateLogicalLoadBalancerGroup DeleteLogicalLoadBalancerGroupAddLogicalLoadBalancerGroupMember FirewallRuleGroupRemoveLogicalLoadBalancerGroupMember GetFirewallRuleGroupRemoveRuleFromFirewallRuleGroup AddRuleToFirewallRuleGroupSyncFirewallRuleGroups Name AddRuleToFirewallRuleAddFloatingIPAddress FloatingIPAddressMoveFloatingIPAddress RemoveFloatingIPAddressReleaseFloatingIPAddress ServerSnapshotListUnassociatedFloatingIPAddresses ListServerSnapshotsRevertServerSnapshot CreateServerSnapshotDeleteServerSnapshot Snapshot, recursively. Defaults to false Data Model Data ModelByteSizeEnum ByteSizeCidrIpRange CmsQuiesceStateCostFrequency CostCostFrequencyEnum CustomAddressAssignmentTypeAttributeCustomProcessorAttribute CustomStorageVolumeAttributeCustomSubnetBindingAttribute CustomTemplateAttributesDeploymentServiceType DeploymentServiceDeploymentServiceTypeEnum DrModeFirewallRuleGroupInfo FirewallRuleFirewallRuleGroupDetails ImageTypeIPTypeEnum IPTypeLeasePeriod LoadBalancerInfoLogicalFirewallRuleGroup LogicalDiskLogicalIPAddress LogicalLoadBalancerGroupDetails LogicalLoadBalancerDetailsLogicalLoadBalancerGroupInfo LogicalLoadBalancerGroupMemberLogicalLoadBalancerProtocolEnum LogicalLoadBalancerProtocolLogicalNetworkInterface LogicalServerDetailsLogicalServerGroupInfo ServiceEntityStatus statusLogicalServerInfo LogicalSubnet LogicalSoftwareMessageSeverityEnum MessageSeverityNatEntry NatTypePacketProtocolEnum PacketProtocolProcessorArchitecture ProcessorArchitectureEnumRequestHistoryItem RequestDetailsRequestHistoryItemLevel RequestHistoryItemLevelEnumRequestStatusEnum RequestStatusRequestType RequestTypeEnumSanVolumeState SanVolumeSanVolumeStateEnum ServerPool SanVolumeTemplateState cannot be determined IDs of the cloud capacity pools in the server poolServiceActionTrigger trigger ServiceActionServerPoolResourceNote ServerResourceServiceActionTriggerEnum ServiceActionTriggerServiceDetails ServiceEntityStatusSoftwareDiskDefinition ServiceInfoSoftwareType SoftwareTypeEnumStorageProvisioningTypeEnum StorageProvisioningTypeStorageType StorageTypeEnumVirtualizationType TemplateInfoVirtualizationTypeEnum VmHost VirtualSwitchVmHostDataStore WorkflowExceptions SanVolumeTemplateNotFoundException SanVolumeNotFoundExceptionServiceNotFoundException OrganizationNotFoundExceptionSubnetNotFoundException SoftwareNotFoundExceptionTemplateNotFoundException UserNotFoundExceptionPhysical Server Maintenance Example Physical Server Maintenance ExampleExample Usage Sample Code Sample Java ClientSample Java Client Sample Code Sample Java Client IOClientPasswordHandler.java Sample Java Client Add this code Sample VisualStudio/.NET/C# ClientString.Format0s, DateTime.Now Sample VisualStudio/.NET/C# ClientPage Part II Chargeback API Chargeback Soap API Chargeback Soap APIAccessing the Chargeback Web Service Interfaces Accessing the Chargeback Web Service InterfacesHttps//cms-ip-address55443/hpio/chargeback/soap/v1?wsdl Summary Usage Report OperationsDetailed Usage Report Aggregated Usage Report List ServiceFilterOne entry with consolidated data for the entire period ServiceUsagePage Data Model ServiceFilterAttribute enum ServiceFilterFilterConnector enum PeriodResourceUsageSummary ServiceInformationServerUsageSummary DiskUsageSummaryServiceUsageSummary ServiceUsagePageAggregateServiceUsage ServiceUsageDetailPageIpAddressUsageDetail DiskUsageDetailAuthorizationException AuthenticationExceptionChargebackDataBaseException ChargebackExceptionPeriodStartDateTooOldException PeriodStartDateGreaterThanEndDateExceptionRequiredParameterException PeriodStartDateGreaterThanEndDateExceptionSample Python Client Sample Python ClientPage Pageindex = Example 2 reports.pyPage Sample Python Client 101 Sample Python Client 103 Example 3 GUI.pySample Python Client 105 Example 4 reportsfile.py 107 Sample Chargeback Usage ReportReferences ReferencesSupport and other resources How to contact HPInformation to collect before contacting HP Information to collect before contacting HPHP authorized resellers Warranty informationDocumentation feedback Subscribing to security bulletinsDocumentation and support Related informationRelated information

Related manuals

Manual 79 pages 57.42 Kb

Manual 12 pages 7.25 Kb

Matrix Operating Environment Software specifications

HP Matrix Operating Environment (MOE) is an innovative software platform designed to deliver efficient management and orchestration of IT resources across physical, virtual, and cloud infrastructures. It provides a comprehensive solution for organizations that require a robust and flexible environment to manage their IT operations seamlessly.

One of the main features of HP MOE is its ability to optimize resource utilization by automating the provisioning and management of infrastructure components. This includes the ability to rapidly deploy servers, storage, and networking resources in a manner that meets the dynamic needs of modern businesses. This automation significantly reduces the time and effort required for manual configurations, enabling IT teams to focus on strategic initiatives rather than routine tasks.

The software offers a unified management interface that provides visibility into the entire IT environment. Users can monitor performance metrics, track resource allocation, and manage workflows through a single dashboard. This centralized control not only simplifies operations but also enhances decision-making capabilities by providing real-time insights into system health and performance.

Another critical characteristic of HP MOE is its support for both physical and virtual resources. The platform is designed to seamlessly integrate with existing infrastructure, making it easier for organizations to adopt virtualization and hybrid cloud strategies. Its compatibility with industry-standard hypervisors allows businesses to leverage their current investments while taking advantage of the benefits of virtualization.

HP MOE incorporates advanced technologies such as automation scripts, APIs, and tools for workload balancing. This technological backbone enables organizations to implement elasticity in their environments, allowing them to scale resources up or down based on demand. The software also supports a service-oriented architecture, facilitating integration with other enterprise applications and systems.

Security is a top priority in the design of HP MOE. The software provides robust security features that ensure data integrity and protect against unauthorized access. This includes role-based access controls, encryption, and compliance reporting, all of which contribute to a secure operating environment.

In summary, HP Matrix Operating Environment Software is a powerful solution that addresses the complexities of managing modern IT resources. Its key features include automation, unified management, support for physical and virtual environments, and strong security measures. With its ability to enhance efficiency and streamline operations, HP MOE is an essential tool for organizations looking to stay competitive in an increasingly digital landscape.