English

Manage SnapCenter Plug-in for VMware vSphere

Contributors netapp-madhulik Download PDF of this page

You need to use the SnapCenter Plug-in for VMware vSphere management GUI to update the virtual appliance configuration, which includes vCenter credentials, virtual appliance credentials, and time zones for backups.

Access the maintenance console

You can manage your application, system, and network configurations by using the maintenance console for SnapCenter Plug-in for VMware vSphere. You can change your administrator password, maintenance password, generate support bundles, and start remote diagnostics.

Before you begin

Before stopping and restarting the SnapCenter Plug-in for VMware vSphere service, you should suspend all schedules.

About this task
  • The defaults are “maint” as the username and “admin123” as the password to log in to the maintenance console for SnapCenter Plug-in for VMware vSphere.

    After deployment, modify the default login credentials.
  • You must set a password for the “diag” user while enabling remote diagnostics.

    To obtain the root user permission to execute the command, use the sudo <command>.

Steps
  1. From the VMware vSphere web client, select the VM where the SnapCenter VMware plug-in is located.

  2. Right-click the VM, then on the Summary tab of the virtual appliance click Launch Remote Console to open a maintenance console window.

    The logon defaults for the SnapCenter VMware plug-in maintenance console are as follows:

    Username: maint

    Password: admin123

    Error: Missing Graphic Image

  3. You can access the following maintenance console options:

    Category Available maintenance options

    1) Application Configuration

    Display virtual appliance summary
    Start or stop SnapCenter VMware plug-in service
    Change login username or password
    Change MySQL password
    Configure MySQL backup
    List MySQL backups
    Restore MySQL backup

    2) System Configuration

    Reboot or shutdown virtual machine
    Change 'maint' user password
    Change time zone
    Change NTP server
    Enable/Disable SSH Access
    Increase jail disk size (/jail)
    Upgrade
    Install VMware Tools

    3) Network Configuration

    Display or change IP address settings
    Display or change domain name search settings
    Display or change static routes
    Commit changes
    Ping a host

    4) Support and Diagnostics

    Generate support bundle
    Access diagnostic shell
    Enable remote diagnostic access
    Generate core dump bundle

Modify the time zone for backups

When you configure a backup schedule for a SnapCenter Plug-in for VMware vSphere resource group, the schedule is automatically set for the time zone in which SnapCenter VMware plug-in is deployed. You can modify that time zone by using the SnapCenter Plug-in for VMware vSphere management GUI.

Before you begin

You must know the IP address and the log in credentials for the SnapCenter Plug-in for VMware vSphere management GUI.

  • The IP address was displayed when the SnapCenter VMware plug-in was deployed.

  • Use the log in credentials provided during the deployment of the SnapCenter VMware plug-in or as later modified.

Steps
  1. Log in to the SnapCenter VMware plug-in management GUI.

  2. Click the Settings icon in the top toolbar.

    Error: Missing Graphic Image

  3. On the Settings page, in the Date and Time section, click Edit.

  4. Select the new time zone and click Save.

    The new time zone will be used for all backups performed by the SnapCenter VMware plug-in.

Modify the logon credentials for SnapCenter Plug-in for VMware vSphere

You can modify the logon credentials for the SnapCenter Plug-in for VMware vSphere management GUI.

Before you begin

You must know the IP address and the log on credentials for the SnapCenter Plug-in for VMware vSphere management GUI.

  • The IP address was displayed when the SnapCenter VMware plug-in was deployed.

  • Use the log in credentials provided during the deployment of the SnapCenter VMware plug-in or as later modified.

Steps
  1. Log in to the SnapCenter VMware plug-in management GUI.

  2. Click the Settings icon in the top toolbar.

    Error: Missing Graphic Image

  3. On the Settings page, in the User section, click Edit.

  4. Enter the new username or password and click Save.

    It might take several minutes before all the services come back up.

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

If you do not know the admin password for the SnapCenter Plug-in for VMware vSphere management GUI, you can set a new password from the maintenance console.

Before you begin

Before stopping and restarting the SnapCenter Plug-in for VMware vSphere service, you should suspend all schedules.

About this task

You must use the default “maint” as the username and “admin123” as the password to log in to the maintenance console of the SnapCenter VMware plug-in.

Steps
  1. From the VMware vSphere web client, select the VM where the SnapCenter VMware plug-in is located.

  2. Right-click the VM, then on the Summary tab of the virtual appliance click Launch Remote Console to open a maintenance console window.

    The logon defaults for the SnapCenter VMware plug-in maintenance console are as follows:

    Username: maint

    Password: admin123

    Error: Missing Graphic Image

  3. Enter “1” for Application Configuration.

  4. Enter “4” for Change username or password.

  5. Enter the new password.

    The SnapCenter VMware virtual appliance service is stopped and restarted.

Modify the vCenter logon credentials in SnapCenter Plug-in for VMware vSphere

You can modify the vCenter logon credentials that are configured in SnapCenter Plug-in for VMware vSphere. These settings are used by the plug-in to access vCenter.

Before you begin

You must know the IP address and the log on credentials for the SnapCenter Plug-in for VMware vSphere management GUI.

  • The IP address was displayed when the SnapCenter VMware plug-in was deployed.

  • Use the log in credentials provided during the deployment of the SnapCenter VMware plug-in or as later modified.

Steps
  1. Log in to the SnapCenter VMware plug-in management GUI.

  2. In the left navigation pane, click Configuration.

    Error: Missing Graphic Image

  3. On the Configuration page, in the vCenter section, click Edit.

  4. Enter the new username or password and then click Save.

    Do not modify the port number.

Modify the network settings

You can modify the network settings that are configured in SnapCenter Plug-in for VMware vSphere. These settings are used by the plug-in to access vCenter.

Before you begin

You must know the IP address and the log on credentials for the SnapCenter Plug-in for VMware vSphere management GUI.

  • The IP address was displayed when the SnapCenter VMware plug-in was deployed.

  • Use the log in credentials provided during the deployment of the SnapCenter VMware plug-in or as later modified.

Steps
  1. Log in to the SnapCenter VMware plug-in management GUI.

  2. Click the Settings icon in the top toolbar.

    Error: Missing Graphic Image

  3. On the Settings page, in the Network Settings section, click IPv4 or IPv6, and then click Edit.

    Enter the new information and click Save.

  4. If you are removing a network setting, do the following:

    • IPv4: In the IP Address field, enter 0.0.0.0 and then click Save.

    • IPv6: In the IP Address field: enter : :0 and then click Save.

If you are using both IPv4 and IPv6, you cannot remove both network settings. The remaining network must specify the DNS Servers and Search Domains fields.

Enable SSH for SnapCenter Plug-in for VMware vSphere

When the SnapCenter VMware plug-in is deployed, SSH is disabled by default.

Steps
  1. From the VMware vSphere web client, select the VM where the SnapCenter VMware plug-in is located.

  2. Right-click the VM, then on the Summary tab of the virtual appliance click Launch Remote Console to open a maintenance console window.

    The logon defaults for the SnapCenter VMware plug-in maintenance console are as follows:

    Username: maint

    Password: admin123

    Error: Missing Graphic Image

  3. From the Main Menu, select menu option 2) System Configuration.

  4. From the System Configuration Menu, select menu option 6) Enable SSH access and then enter “y” at the confirmation prompt.

  5. Wait for the message “Enabling SSH Access…” then press Enter to continue, and then enter X at the prompt to exit Maintenance Mode.

Create and import certificates

The SnapCenter VMware plug-in employs SSL encryption for secure communication with the client browser. While this does enable encrypted data across the wire, creating a new self-signed certificate, or using your own Certificate Authority (CA) infrastructure or a third party CA ensures that the certificate is unique for your environment. See the KB article: How to create and/or import an SSL certificate to VMware plug-in for SnapCenter.

Stop SnapCenter Plug-in for VMware vSphere when in linked mode

If you stop the SnapCenter VMware plug-in service in a vCenter that is in Linked Mode, resource groups are not available in all the linked vCenters, even when the SnapCenter VMware plug-in service is running in the other linked vCenters.

You must unregister the SnapCenter VMware plug-in extensions manually.

Steps
  1. On the linked vCenter that has the SnapCenter VMware plug-in service stopped, navigate to the Managed Object Reference (MOB) manager.

  2. In the Properties option, select Extension Manager to display a list of the registered extensions.

  3. Unregister the extensions com.netapp.scvm.webclient and com.netapp.aegis.

Disable and enable SnapCenter Plug-in for VMware vSphere

If you no longer need the SnapCenter data protection features, you must change the configuration of the SnapCenter VMware plug-in. For example, if you deployed the plug-in in a test environment, you might need to disable the SnapCenter features in that environment and enable them in a production environment.

Before you begin
  • You must have administrator privileges.

  • Make sure that no SnapCenter jobs are running.

About this task

When you disable the SnapCenter VMware plug-in, all resource groups are suspended and the plug-in is unregistered as an extension in vCenter.

When you enable the SnapCenter VMware plug-in, the plug-in is registered as an extension in vCenter, all resource groups are in production mode, and all schedules are enabled.

Steps
  1. Optional: Back up the SnapCenter VMware plug-in MySQL repository in case you want to restore it to a new virtual appliance.

  2. Log in to the SnapCenter VMware plug-in management GUI using the format https://<OVA-IP-address>:8080.

    The IP of the SnapCenter VMware plug-in is displayed when you deploy the plug-in.

  3. Click Configuration in the left navigation pane, and then unselect the Service option in the Plug-in Details section to disable the plug-in.

  4. Confirm your choice.

    • If you only used the SnapCenter VMware plug-in to perform VM consistent backups

      The plug-in is disabled, and no further action is required.

    • If you used the SnapCenter VMware plug-in to perform application-consistent backups

      The plug-in is disabled and further cleanup is required.

      1. Log in to VMware vSphere.

      2. In the left navigator screen, right-click the instance of the SnapCenter VMware plug-in (the name of the .ova file` `that was used when the virtual appliance was deployed) and select Delete from Disk.

      3. Log in to SnapCenter and remove the vSphere host.

Remove SnapCenter Plug-in for VMware vSphere

If you no longer need to use the SnapCenter data protection features, you must disable the SnapCenter VMware plug-in to unregister it from vCenter, then remove the SnapCenter VMware plug-in from vCenter, and then manually delete leftover files.

Before you begin
  • You must have administrator privileges.

  • Make sure that no SnapCenter jobs are running.

Steps
  1. Log in to the SnapCenter VMware plug-in management GUI using the format https://<OVA-IP-address>:8080.

    The IP of the SnapCenter VMware plug-in is displayed when you deploy the plug-in.

  2. Click Configuration in the left navigation pane, and then unselect the Service option in the Plug-in Details section to disable the plug-in.

  3. Log in to VMware vSphere.

  4. In the left navigator screen, right-click the instance of the SnapCenter VMware plug-in (the name of the .ova file that was used when the virtual appliance was deployed) and select Delete from Disk.

  5. Manually delete the following files in the pickup folder of the vCenter server:

    vsc-httpclient3-security.jar
    scv-api-model.jar
    scvm_webui_service.jar
    scvm_webui_ui.war
    gson-2.5.jar

  6. If you used the SnapCenter VMware plug-in to support other SnapCenter plug-ins for application-consistent backups, log in to SnapCenter and remove the vSphere host.

After you finish

The virtual appliance is still deployed but the SnapCenter VMware plug-in is removed.

After removing the host VM for the SnapCenter VMware plug-in, the plug-in might remain listed in vCenter until the local vCenter cache is refreshed. However, because the plug-in was removed, no SnapCenter VMware vSphere operations can be performed on that host. If you want to refresh the local vCenter cache, first make sure the appliance is in a Disabled state on the SnapCenter VMware plug-in Configuration page, and then restart the vCenter web client service.