Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

What you can do with the management API


The HCP management API lets you work with tenants, namespaces, networks, retention classes, content classes, system-level user accounts, tenant-level user and group accounts, replication, erasure coding, HCP licenses, and the HCP internal logs.

For tenants, you can:

Create or modify HCP tenants or the default tenant

Delete HCP tenants

Retrieve information about a single tenant

Retrieve a list of all tenants

Set default properties for namespaces created for an HCP tenant

Retrieve statistics about the content of the namespaces owned by a tenant

Generate a chargeback report for an HCP tenant

For namespaces, you can:

Create HCP namespaces

Modify namespaces

Delete HCP namespaces

Retrieve information about a single namespace

Retrieve a list of all the namespaces owned by a tenant

Retrieve statistics about the content of a namespace

Generate a chargeback report for an HCP namespace

Reset the indexing checkpoint for a namespace

For networks, you can change the downstream DNS settings.

For retention classes, you can:

Create, modify, and delete retention classes for a namespace

Retrieve information about a single retention class

Retrieve a list of all the retention classes defined for a namespace

For content classes, you can:

Create, modify, and delete content classes for a tenant

Retrieve information about a single content class

Retrieve a list of all the content classes defined for a tenant

For locally authenticated system-level user accounts, you can change the password for a single user account.

For HCP tenant-level user accounts, you can:

Create, modify, and delete user accounts

Retrieve information about a single user account

Retrieve a list of all the user accounts defined for a tenant

Reset the passwords of all locally authenticated user accounts with the security role

For HCP tenant-level group accounts, you can:

Create, modify, and delete group accounts

Retrieve information about a single group account

Retrieve a list of all the group accounts defined for a tenant

Create a new group account with the security role or give the security role to an existing group account

For replication, you can:

Create, modify, and delete replication links

Specify link content

Retrieve a list of all links in which the HCP system participates

Monitor replication progress at the link level and the tenant level

Schedule, suspend, and resume activity on links

Pause and resume replication of individual tenants

Shut down and reestablish all links

Fail over, restore, and failback links

Set the replication network

Enable DNS failover

Enable automatic sharing of domains and SSL server certificates

Specify whether tenant and namespace replication status is displayed in the Tenant Management Console for HCP tenants

For erasure coding topologies, you can:

Create, modify, retire, and delete erasure coding topologies

Retrieve a list of the replication links that may be eligible for use in an erasure coding topology

Retrieve a list of tenants that are eligible to be included in an erasure coding topology

Retrieve a list of tenants that are not eligible to be included in an erasure coding topology due to name or link conflicts

Add tenants to and remove tenants from an erasure coding topology

Retrieve a list of the tenants included in an erasure coding topology

Retrieve information about an erasure coding topology, including status information

Retrieve a list of erasure coding topologies

For HCP licenses, you can:

Retrieve the current storage license

Retrieve a list of all storage licenses that have been applied to the HCP system

Upload a new storage license

For the HCP internal logs, you can:

Download the logs

Check the status of a log download operation

For details on the activities supported by the management API, see Resources.

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.

 

  • Was this article helpful?