HCP System Management Help


XML

In an XML request or response body:

Property names are element names. Property values are element values. For example, the element that corresponds to the softQuota property with a value of 85 is:

<softQuota>85</softQuota>

The name of the root element for a request that involves a single resource is the data type of that resource. For example, for this URL, which identifies a single tenant named Finance, the root element is tenant:

https://admin.hcp.example.com:9090/mapi/tenants/finance

The name of the root element for a request for a list of resources is the term used to identify those resources in the URL. For example, for this URL, the root element is tenants:

https://admin.hcp.example.com:9090/mapi/tenants

In a list of resources, each resource is the value of an element whose name is the name of the property used to identify the resource. For example, the response body for a request for the tenants defined in an HCP system might include this:

<tenants>
    <name>Default</name>
    <name>Finance</name>
    <name>HR</name>
    <name>Sales</name>
    <name>Marketing</name>
</tenants>

Here’s a request for complete information about the Finance tenant to be returned in XML format:

curl -k -i -H "Accept: application/xml"
    -H "Authorization: HCP m9sZXM=:04EC9F614D89FF5C7126D32ACB448382"
    "https://admin.hcp.example.com:9090/mapi/tenants/finance?verbose=true
  &prettyprint"

Assuming that the tenant has granted system-level users administrative access to itself, here’s the XML response body you get when you make the request using a system-level user account that includes the administrator role:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<tenant>
   <administrationAllowed>true</administrationAllowed>
   <authenticationTypes>
       <authenticationType>LOCAL</authenticationType>
       <authenticationType>EXTERNAL</authenticationType>
    </authenticationTypes>
    <complianceConfigurationEnabled>true</complianceConfigurationEnabled>
    <creationTime>2012-02-09T09:11:17-0500</creationTime>
    <dataNetwork>net127</dataNetwork>
    <fullyQualifiedName>finance.hcp.example.com</fullyQualifiedName>
    <hardQuota>100 GB</hardQuota>
    <managementNetwork>net004</managementNetwork>
    <maxNamespacesPerUser>5</maxNamespacesPerUser>
    <name>Finance</name>
    <namespaceQuota>5</namespaceQuota>
    <replicationConfigurationEnabled>true</replicationConfigurationEnabled>
    <snmpLoggingEnabled>false</snmpLoggingEnabled>
    <searchConfigurationEnabled>true</searchConfigurationEnabled>
    <servicePlan>Short-Term-Activity</servicePlan>
    <servicePlanSelectionEnabled>false</servicePlanSelectionEnabled>
    <softQuota>90</softQuota>
    <syslogLoggingEnabled>true</syslogLoggingEnabled>
    <systemVisibleDescription>Created for the Finance department at Example
         Company by P.D. Grey on 2/9/2012.</systemVisibleDescription>
    <tags>
         <tag>Example Company</tag>
         <tag>pdgrey</tag>
    </tags>
    <tenantVisibleDescription>Please see Lee Green for any questions about this
        tenant and its namespaces.</tenantVisibleDescription>
    <id>4420f62f-3f63-43ab-a3cd-0bcf1f399daf</id>
    <versioningConfigurationEnabled>true</versioningConfigurationEnabled>
</tenant>

For the XML schema used by the management API, see Management API XML schema.

© 2017 Hitachi Vantara Corporation. All rights reserved.