HP Matrix Operating Environment Software Accessing the Web Service Interfaces, Accessing Wsdl

Page 16

2 Accessing the Web Service Interfaces

Accessing WSDL

The Web Service Description Language or WSDL (See Reference [1]) definition of IO operations can be accessed from any installed IO system using a web browser. For example, if the software is installed on a server with an IP address of <cms-ip-address>, enter the following into the web browser to access the WSDL:

https://<cms-ip-address>:51443/hpio/controller/soap/v5?wsdl

The browser will show the formal XML definition of the Web Service Interface. The IO API is already available in the embedded Operations Orchestration when IO is installed.

Security

The IO Web Service is only accessible over HTTPS. The service uses WS-Security UsernameToken authentication in text form. A username and password of a registered IO user is required to access the Web Service Interface. A WS-Security timestamp header is also required.

Authorization

If the presented username/password belongs to a Windows user in the Service Provider Administrator role, the web services are able to view and act on all services. For username/passwords that belong to a Windows user in the Organization Administrator role, the web services can operate only on the services owned by that organization. For username/passwords that belong to Windows users in the Architect or User roles, the web services are only able to view or act on the services owned by that particular user.

The Activate Service operation (and others) specifies a list of server pools from which the servers will be allocated. The set of available pools is based on the assignments of the requesting user (not the service owner). For Administrator users, all pools except Maintenance and Unassigned are available.

Impersonation

An “Impersonation” feature allows an authenticated Administrator role user to perform an operation in the context of a specified requesting user. This behavior can be used in the implementation of enterprise service catalogs to initiate operations on behalf of enterprise users. Impersonation is achieved by including an HP-IO-Impersonate cookie in the HTTP message header. For example, if the request includes the HTTP header “Cookie: HP-IO-Impersonate=Steve”, the operation will be performed as though it were requested by Steve. A message is written to the audit log to record the impersonation event.

Command Line Interface

An IO installation includes an “ioexec” command line interface (CLI) to access the IO Web Service. The CLI may be useful for scripting web service invocations and for testing purposes when developing a web service client. The CLI operations and data model mirror the Web Service Interface. The CLI may be copied from an IO installation to a different system to operate on the CMS remotely. The “ioexec” command help provides specific usage details.

16 Accessing the Web Service Interfaces

Page 15 Page 17
Image 16
Page 15 Page 17
Contents API and CLI Operations Reference Guide Abstract7.1 Update 1 7.1Contents CMS Data Model Contents Exceptions Example UsageAccessing the Chargeback Web Service Interfaces Sample Java ClientRequiredParameterException Part I Matrix API Introduction Integration interface overview New features in 7.1 UpdateIntroduction PowerCycleLogicalServers New featuresNew features in 7.1 EditLogicalServers RemoveLogicalServers QuiesceCms UnquiesceCms GetCmsQuiesceStatusLogicalServerGroupDetails LogicalServerInfoServiceInfo ChargebackRequestInfo TemplateInfoAccessing the Web Service Interfaces Accessing WsdlCommand Line Interface SecurityOperations ImportTemplateExportTemplate List TemplateInfoService ListServicesGetService CreateServiceDeleteService DeactivateServiceChangeServiceLease ActivateServicePowerOffService PowerOnService DeleteReplicaServiceRequest ListRequestsGetRequestInfo GetRequestSetRequestApprovalState ContinueRequestCancelRequest Logical Server GroupGetLogicalServerGroup AddServersToLogicalServerGroupAddDiskToLogicalServerGroup AddNewDiskToLogicalServerGroupSetLogicalServerGroupActiveServerCount RawMappingTypeEnumGetLogicalServer DeactivateLogicalServersLogicalServerInfo LogicalServerDetailsPowerOffLogicalServers PowerOnLogicalServersActivateLogicalServers LogicalServerNotFound Exception Logical ServerPowerCycleLogicalServers EditLogicalServersRemoveLogicalServers ByteSizeEnumServer Pool ListServerPoolsGetServerPool CreateServerPoolMoveServerToServerPool DeleteServerPoolAssignUsersToServerPool Server UnassignUsersFromServerPoolGetComputeServer GetVmHostSoftware SubnetListSanVolumes GetSanVolumeListSanVolumeTemplates GetSanVolumeTemplateOrganization ListOrganizationsGetOrganization AssignTemplateToOrganizationBy a Service Provider Administrator AssignServerToOrganizationUnassignServerFromOrganization OrganizationName Returns None ExceptionsUnassignSubnetFromOrganization AssignSubnetToOrganizationAssignSoftwareToOrganization UnassignSoftwareFromOrganization BeginCmsMaintenanceSyncOrganizations EndCmsMaintenance CountRunningRequestsForCmsAddCms QuiesceCmsLoadBalancer GetCmsQuiesceStatusListLoadBalancers AddLoadBalancerSetLoadBalancerPassword RemoveLoadBalancerAddLoadBalancerCertificate RemoveLoadBalancerCertificateUnsetLoadBalancerPassword LogicalLoadBalancerCreateLogicalLoadBalancerGroup DeleteLogicalLoadBalancerGroupFirewallRuleGroup AddLogicalLoadBalancerGroupMemberRemoveLogicalLoadBalancerGroupMember GetFirewallRuleGroupAddRuleToFirewallRuleGroup RemoveRuleFromFirewallRuleGroupSyncFirewallRuleGroups Name AddRuleToFirewallRuleFloatingIPAddress AddFloatingIPAddressMoveFloatingIPAddress RemoveFloatingIPAddressServerSnapshot ReleaseFloatingIPAddressListUnassociatedFloatingIPAddresses ListServerSnapshotsRevertServerSnapshot CreateServerSnapshotDeleteServerSnapshot Snapshot, recursively. Defaults to false Data Model Data ModelByteSize ByteSizeEnumCidrIpRange CmsQuiesceStateCost CostFrequencyCostFrequencyEnum CustomAddressAssignmentTypeAttributeCustomStorageVolumeAttribute CustomProcessorAttributeCustomSubnetBindingAttribute CustomTemplateAttributesDeploymentService DeploymentServiceTypeDeploymentServiceTypeEnum DrModeFirewallRule FirewallRuleGroupInfoFirewallRuleGroupDetails ImageTypeIPType IPTypeEnumLeasePeriod LoadBalancerInfoLogicalFirewallRuleGroup LogicalDiskLogicalIPAddress LogicalLoadBalancerDetails LogicalLoadBalancerGroupDetailsLogicalLoadBalancerGroupInfo LogicalLoadBalancerGroupMemberLogicalLoadBalancerProtocol LogicalLoadBalancerProtocolEnumLogicalNetworkInterface LogicalServerDetailsLogicalServerGroupInfo ServiceEntityStatus statusLogicalServerInfo LogicalSoftware LogicalSubnetMessageSeverity MessageSeverityEnumNatEntry NatTypePacketProtocol PacketProtocolEnumProcessorArchitecture ProcessorArchitectureEnumRequestDetails RequestHistoryItemRequestHistoryItemLevel RequestHistoryItemLevelEnumRequestStatus RequestStatusEnumRequestType RequestTypeEnumSanVolumeState SanVolumeSanVolumeStateEnum SanVolumeTemplate ServerPoolState cannot be determined IDs of the cloud capacity pools in the server poolServiceAction ServiceActionTrigger triggerServerPoolResourceNote ServerResourceServiceActionTrigger ServiceActionTriggerEnumServiceDetails ServiceEntityStatusServiceInfo SoftwareDiskDefinitionSoftwareType SoftwareTypeEnumStorageProvisioningType StorageProvisioningTypeEnumStorageType StorageTypeEnumVirtualizationType TemplateInfoVirtualizationTypeEnum VirtualSwitch VmHostVmHostDataStore WorkflowExceptions SanVolumeNotFoundException SanVolumeTemplateNotFoundExceptionServiceNotFoundException OrganizationNotFoundExceptionSoftwareNotFoundException SubnetNotFoundExceptionTemplateNotFoundException 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 Sample VisualStudio/.NET/C# Client Add this codeSample VisualStudio/.NET/C# Client String.Format0s, DateTime.NowPage 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 ServiceFilter ServiceFilterAttribute enumFilterConnector enum PeriodServiceInformation ResourceUsageSummaryServerUsageSummary DiskUsageSummaryServiceUsagePage ServiceUsageSummaryAggregateServiceUsage ServiceUsageDetailPageDiskUsageDetail IpAddressUsageDetailAuthenticationException AuthorizationExceptionChargebackDataBaseException ChargebackExceptionPeriodStartDateGreaterThanEndDateException PeriodStartDateTooOldExceptionRequiredParameterException PeriodStartDateGreaterThanEndDateExceptionSample Python Client Sample Python ClientPage Example 2 reports.py Pageindex =Page Sample Python Client 101 Sample Python Client Example 3 GUI.py 103Sample Python Client 105 Example 4 reportsfile.py Sample Chargeback Usage Report 107References ReferencesHow to contact HP Support and other resourcesInformation to collect before contacting HP Information to collect before contacting HPWarranty information HP authorized resellersDocumentation 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.
Top Page Image Contents