SnapCenter Plug-in for VMware vSphere 6 Manuals ( CA08871-405 )

SnapCenter Plug-in for VMware vSphere 6.0 docs

Concepts

Product overview

Overview of the different SnapCenter GUIs

Licensing

Role-Based Access Control (RBAC)

Types of RBAC for SnapCenter Plug-in for VMware vSphere users

ONTAP RBAC features in SnapCenter Plug-in for VMware vSphere

Predefined roles packaged with SnapCenter Plug-in for VMware vSphere

How to configure ONTAP RBAC for SnapCenter Plug-in for VMware vSphere

Get started

Deployment Overview

Deployment workflow for new users

Deployment workflow for existing users

Requirements for deploying SCV

Deployment planning and requirements

ONTAP privileges required

Minimum vCenter privileges required

Download the Open Virtual Appliance (OVA)

Deploy SnapCenter Plug-in for VMware vSphere

Post deployment required operations and issues

Log in to the SnapCenter VMware vSphere client

Quick start

Overview

Deploy SnapCenter Plug-in for VMware vSphere

Add storage

Create backup policies

Create resource groups

Monitor and report

View status information

Monitor jobs

Download job logs

Access reports

Generate a support bundle from SnapCenter Plug-in for VMware vSphere GUI

Generate a support bundle from the maintenance console

Audit logs

Manage storage

Add storage

Manage storage VMs - modify, rename, remove

Modify the configured storage timeout

Protect data

Data protection workflow

View backups

Create backup policies

Create resource groups

Prescripts and postscripts

Add a single VM or datastore to a resource group

Add multiple VMs and datastores to a resource group

Rename storage

Back up resource groups on demand

Back up the MySQL database

Manage resource groups - suspend, resume, modify, delete

Manage policies - detach, modify, delete

Manage backups - rename, delete

Mount and unmount datastores

Mount a backup

Unmount a backup

Restore backups

Overview

How restore operations are performed

Search for backups

Restore VMs from backups

Restore deleted VMs from backups

Restore VMDKs from backups

Restore the most recent backup of the MySQL database

Restore a specific backup of the MySQL database

Attach and detach VMDKs

Attach VMDKs to a VM or vVol VM

Detach a virtual disk

Restore guest files and folders

Workflow, prerequisites, and limitations

Restore guest files and folders from VMDKs

Set up proxy VMs for restore operations

Configure credentials for VM guest file restores

Extend the time of a guest file restore session

Guest file restore scenarios you might encounter

Manage SnapCenter Plug-in for VMware vSphere appliance

Restart the VMware vSphere client service

Access the maintenance console

Modify the SnapCenter Plug-in for VMware vSphere password from the maintenance console

Create and import certificates

Unregister SnapCenter Plug-in for VMware vSphere from vCenter

Disable and enable SnapCenter Plug-in for VMware vSphere

Remove SnapCenter Plug-in for VMware vSphere

Manage your configuration

Modify time zones

Modify logon credentials

Modify vCenter logon credentials

Modify network settings

Modify configuration default values

Create the scbr.override file

Configuration properties you can override

Enable SSH

REST APIs

Overview

Access REST APIs using the Swagger API web page

REST API workflows to add and modify storage VMs

REST API workflows to create and modify resource groups

REST API workflow to back up on demand

REST API workflow to restore VMs

REST API workflow to restore deleted VMs

REST API workflow to restore VMDKs

REST API workflows to attach and detach VMDKs

REST API workflows to mount and unmount datastores

REST APIs to download jobs and generate reports

REST APIs workflows to modify built-in schedules

REST API to mark stuck jobs as failed

REST APIs to generate audit logs

Upgrade

Upgrade from an earlier release of SnapCenter Plug-in for VMware vSphere

Upgrade to a new patch of the same release

Information not displayed after upgrading to a new patch of the same release

to Japanese version

Access REST APIs using the Swagger API web page

REST APIs are exposed through the Swagger web page. You can access the Swagger web page to display either the SnapCenter Server or the SnapCenter Plug-in for VMware vSphere REST APIs, as well as to manually issue an API call. Use SnapCenter Plug-in for VMware vSphere REST APIs to perform operations on VMs and datastores.

The plug-in has different Swagger web pages from the SnapCenter Server Swagger web pages.

Before you begin

For SnapCenter Plug-in for VMware vSphere REST APIs, you must know either the IP address or the host name of SnapCenter Plug-in for VMware vSphere.

The plug-in only supports REST APIs for the purpose of integrating with third party applications and does not support PowerShell cmdlets or a CLI.
Steps

  1. From a browser, enter the URL to access the plug-in Swagger web page:

    https://<SCV_IP>:8144/api/swagger-ui/index.html

    Do not use the following characters in the REST API URL: +, . , %, and &.
    Example

    Access SnapCenter Plug-in for VMware vSphere REST APIs:

    https://<SCV_IP>:8144/api/swagger-ui/index.html

    https://OVAhost:8144/api/swagger-ui/index.html

    Log in use the vCenter authentication mechanism to generate the token.

  2. Click an API resource type to display the APIs in that resource type.

Top of Page