Skip to main content
Outside service Partner
Hitachi Vantara Knowledge

Tenant Management Console


The Tenant Management Console is a tenant-specific web application that lets you manage tenants and namespaces. The Console shows you tenant and namespace status in real time, so you can effectively monitor activity and take action as needed.

Using the Console, you can modify tenant and namespace settings and perform compliance activities. Changes you make through the Console take effect immediately.

Access to the Tenant Management Console is available only through HTTP with SSL security (HTTPS).

Console access

To use the Tenant Management Console, you need either:

A user account defined in HCP (either locally authenticated or RADIUS authenticated).

If the tenant is configured to support Windows Active Directory (AD) authentication, an AD user account for a user that belongs to one or more AD groups for which corresponding group accounts are defined in HCP. In this book, such an Active Directory user account is referred to as a recognized AD user account.

The HCP user account or group accounts specify what you have permission to do in the Console. The menu options, pages, and panels you see in the Console depend on your permissions.

If an AD user belongs to multiple AD groups for which HCP group accounts exist, that user has all the permissions associated with all those group accounts.

For more information on user and group accounts, see About user and group accounts.

Console sessions

A Tenant Management Console session begins when you take one of these actions:

Log into the Console using an HCP user account or recognized AD user account.

Access a Console page while logged into Windows with a recognized AD user account. This is called single sign-on. With single sign-on, you don’t need to explicitly log into the Console.

For single sign-on to work, your web browser must be configured to support it. For more information on this, see Browser configuration for single sign-on with Active Directory.

A session ends when you log out. During a session, you can perform any actions for which you have permission.

During a session, if you don’t take any action for a certain amount of time, the Console displays the Idle Timeout page. If you explicitly logged into the session, the Console automatically logs you out and, when you click on any tab on the Idle Timeout page, displays the login page. If you started the session by using single sign-on, when you click on any tab, the Console displays the requested page. The exact amount of idle time allowed is configurable. For information on setting this value, see Changing user account and login settings.

If you’ve granted HCP system-level users administrative access to the tenant, they can access the Tenant Management Console directly from the HCP System Management Console. Doing so does not start a Tenant Management Console session. Rather, it continues the current System Management Console session, and the configured idle time for that Console applies.

For information on granting this access, see Enabling or disabling system-level administrative access.

HCP management API

HCP includes a RESTful HTTP interface to a subset of its administrative functions. Using this interface, called the management API, you can modify your tenant and create, modify, and delete namespaces, user and group accounts, and content classes for the tenant. Additionally, you can create, modify, and delete retention classes for the tenant's namespaces.

You use the Tenant Management Console to enable the management API at the tenant level. For the API to be available, however, it must also be enabled at the system level.

To use the management API, you need a user account that includes the applicable permissions for the actions you want to take.

If the tenant is configured to support Active Directory authentication, applications can also use recognized AD user accounts to access HCP through the management API. To do this, however, an application must use the SPNEGO protocol or the AD authentication header to negotiate the AD user authentication itself. For more information on SPNEGO, see http://tools.ietf.org/html/rfc4559. To provide credentials using the Active Directory authorization header, you use this format:

Authorization: ADAD-username:AD-password

For information on enabling the management API, see Controlling access to HCP through the management API. For information on using the HCP management API, see HCP Management API Reference.

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

Tenant Management Console URL


The URL for the Tenant Management Console has this format:

https://tenant-url-name.hcp-domain-name:8000

For example, to access the Tenant Management Console for the tenant named Finance in the HCP system with the domain name hcp‑ma.example.com, you would use this URL:

https://finance.hcp‑ma.example.com:8000

Using a hosts file

Typically, the HCP system uses DNS for system addressing. If this is not the case, you need to provide a mapping of the tenant hostname to an IP address for the HCP system.

You specify hostname mappings in the hosts file on the client. The location of this file depends on the client operating system:

On Windows, by default: c:\windows\system32\drivers\etc\hosts

On Unix: /etc/hosts

On Mac OS® X: /private/etc/host

Hostname mappings

Each entry in a hosts file maps one or more fully qualified hostnames to a single IP address. For example, if one of the IP addresses for the HCP system is 192.168.210.16, you would add this line to the hosts file on the client to enable access to the Tenant Management Console for the Finance tenant:

192.168.210.16 finance.hcp-ma.example.com

The following considerations apply to hosts file entries:

Each entry must appear on a separate line.

Multiple hostnames in a single line must be separated by white space. With some versions of Windows, these must be single spaces.

Each hostname can map to multiple IP addresses.

You can include comments in a hosts file either on separate lines or following a mapping on the same line. Each comment must start with a number sign (#). Blank lines are ignored.

For the IP addresses for the HCP system, contact your HCP system administrator.

Hostname mapping considerations

An HCP system has multiple IP addresses. You can map the tenant hostname to more than one of these IP addresses in the hosts file. The way multiple mappings are used depends on the client platform. For information on how your client handles multiple mappings in a hosts file, see your client documentation.

If any of the IP addresses listed in the hosts file are unavailable, timeouts may occur when you use a hosts file to access the Tenant Management Console.

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

Logging in


Depending on the tenant configuration, you can log into the Tenant Management Console with a tenant-level user account or a recognized AD user account. For the user account to use when first logging into the Console for a new tenant, see Starter account.

To log into the Tenant Management Console:

1.Open a web browser.

2.In the address field, enter the URL for your Tenant Management Console.

NoteWebHelp.png

Note: If you inadvertently use http instead of https in the URL, the browser returns an error. Enter the URL again, this time using https.

One of these happens:

oIf all of these are true, you are automatically logged into the Tenant Management Console, and the tenant Overview page appears:

You are currently logged into Windows with a recognized AD user account.

The tenant is configured to support AD authentication.

Your web browser is configured to support single sign-on with AD. For information on this, see Browser configuration for single sign-on with Active Directory.

This is single sign-on. No further action is required.

oIf the tenant is configured to support AD authentication but any of the following apply, a message appears indicating that single sign-on was not possible:

Your web browser is not configured to support single sign-on.

You are not currently logged into Windows with a recognized AD user account.

You are not on a Windows computer.

In these cases, you need to click on Console login page in the message to display the Tenant Management Console login page.

oIf the tenant is not configured to support AD authentication, the Tenant Management Console login page appears.

NoteWebHelp.png

Note: The Tenant Management Console login page shows the specific version of the HCP release. Once you enter the Console, the version number appears at the bottom of each page.

3.In the Username field, type your username.

4.In the Password field, type your case-sensitive password.

When using an HCP user account, if you try to log in with an invalid password multiple times in a row, you are locked out of the Console. The exact number of times is configurable. For information on setting this value, see Changing user account and login settings.

NoteWebHelp.png

Note: AD can also be configured to disable user accounts after a given number of authentication attempts with an invalid password.

ImportantWebHelp.png

Important: You should change your password as soon as possible the first time you log into the Tenant Management Console.

5.If the tenant is configured to support AD authentication, take either of these actions in the Domain field:

oIf you’re using an HCP user account, select the domain name of the HCP system.

oIf you’re using a recognized AD user account, select the AD domain in which your user account is defined.

If HCP is not configured to support AD, the login page does not display the Domain field.

6.Click on Log In.

The Console displays the tenant Overview page or, if you’re using an HCP user account and are required to change your password, the Change Password page.

For information on the tenant Overview page, see About the tenant Overview page. For information on changing your password, Changing your password.

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

Using the Tenant Management Console


Tenant Management Console pages display information about the current tenant and its namespaces. Some pages also let you configure various aspects of the tenant and namespaces. (The current tenant is the one for which you’re currently logged into the Tenant Management Console.)

Console pages have menus and hyperlinks for navigation. Each page shows a horizontal menu at the top. Some of the menu options display a secondary menu when you hover over them. To navigate to a page, you click on the corresponding menu option.

You can also use shortcut keys to navigate to pages in the Tenant Management Console. Each link that has a shortcut key has the applicable letter underlined. To use the shortcut key, follow the convention for the browser you’re using.

Each page of the Tenant Management Console shows the username of the currently logged-in user in the upper right corner.

NoteWebHelp.png

Notes: 

If you’re an AD user and your username changes in AD while you’re using the Tenant Management Console, the Console may not reflect the new username until you log out and back in. If you’re currently using any other HCP interfaces, you need to log out of those as well.

While the HCP system is experiencing a heavy load, the Tenant Management Console may be slower to present certain information.

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

Refreshing pages


Tenant Management Console pages do not automatically refresh themselves while they remain open. To see the most recent values on a page, click again on the menu option that opens that page.

NoteWebHelp.png

Note: Using the browser reload button to refresh a page that lets you create or modify an entity causes the Console to resubmit values you previously entered on the page.

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

Submitting changes


Tenant Management Console pages and panels on which you can modify information have action buttons (such as Create Retention Class and Update Settings) that submit your changes. Action buttons make the changes on a page permanent. These changes take effect immediately.

You need to submit the changes you make before switching to a different page or panel. If you switch without submitting those changes, the Console does not retain them.

For some checkbox options, selecting or deselecting the checkbox causes that change to take effect immediately.

After you submit changes, the Console displays a message indicating whether HCP successfully made the changes. To hide the message, click on Dismiss in the message area.

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

Viewing HCP documentation


HCP documentation is available online in PDF format. To view a document from the Tenant Management Console:

1.In the top right corner of the Tenant Management Console window, hover over the documentation icon ( DocumentationControl.png ) to open a dropdown menu of the available documents.

2.In the dropdown menu, click on the document you want.

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

Changing your password


Depending on how your user account is set up, HCP may authenticate your username and password locally or remotely when you log in. If your account is set up for local authentication, you can change your password in the Tenant Management Console. When you change your password in this Console, it also changes for any other HCP interfaces to which your user account gives you access.

If your account is set up for remote authentication or if you use an AD user account to access the Console, you use a method outside HCP to change your password.

For information on local and remote authentication, see User authentication.

To change your locally authenticated password in the Tenant Management Console:

1.Log into the Tenant Management Console using your existing password.

2.In the top right corner of the Console window, click on Password.

3.On the Change Password page:

oIn the Existing Password field, type your current password.

oIn the New Password field, type your new password. Passwords can be up to 64 characters long, are case sensitive, and can contain any valid UTF-8 characters, including white space.

To be valid, a password must include at least one character from two of these three groups: alphabetic, numeric, and other.

The minimum length for passwords is tenant specific. Typically, it’s six or eight characters. For information on changing the minimum length for passwords, see Understanding the user account list.

When changing your password, you cannot reuse your current password.

oIn the Confirm New Password field, type your new password again.

4.Click on Update Password.

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

Logging out


To log out of the Tenant Management Console:

1.In the top right corner of the Console window, click on Log Out.

2.If you explicitly logged in, close the browser window to ensure that other users cannot go back into the Tenant Management Console using the credentials you used to log in.

TipWebHelp.png

Tip: For extra security, clear the browser cache before closing the window.

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