Deployment

Platform requirements

The requirements that apply to every VCF Extension — VCF Operations version, Cloud Proxy, TLS, certificate handling and registry access — are defined once in Technical and Security Requirements.

This page describes only what is specific to VCF SAN Insight: the permissions required on the fabric switch, the connection to the device and the adapter fields.

Supported versions

ComponentMinimumVerified with
VMware Aria Operations (VCF Operations)8.10.0current 9.x release
Brocade Fabric OS9.29.2
Cisco NX-OS (MDS 9000)to be confirmed in the deployment cardto be confirmed in the deployment card

User permissions and connection requirements

CategoryDescription
Broadcom Brocade accountA dedicated read-only account on the switch. The account must be allowed to read the fabric, switch, port and zone configuration and the performance counters.
Cisco MDS accountA dedicated read-only account on the switch or director, allowed to use NX-API for the inventory and the interface counters.
One adapter per switchEach adapter instance connects to a single fabric switch. A fabric with several switches is covered by one adapter instance per switch, and the relationship model joins them into one fabric.
Cloud Proxy to switchHTTPS on port 443 from the Cloud Proxy belonging to the collector group to the management interface of the switch.
TLSThe certificate of the switch management interface is validated against the system trust store. Self-signed certificates are supported through the Skip TLS certificate validation parameter, intended for lab or explicitly accepted targets.

Installing the Management Pack

Pre-pull the adapter image

  1. SSH as root to the Cloud Proxies belonging to the collector group where the adapter is to run.
  2. Log in to the registry: docker login registry.indevops.com. Use the Harbor robot account designated for that deployment, provided by Indevops.
  3. Pull the image: docker pull <IMAGE NAME>. The image name is shown on the release page for the version being installed.

Install the PAK file

  1. Download the PAK file matching the pre-pulled adapter image.
  2. In VCF Operations go to Data Sources > Integrations > Repository > Add and upload the PAK file, selecting both Install the PAK file even if it is already installed and Ignore the PAK file signature checking.
  3. Complete the installation wizard.

Configure the adapter instance

  1. Go to Administration > Integrations > Repository, filter for INDEVOPS and select the VCF SAN Insight brick.
  2. Select ADD ACCOUNT.
  3. Fill in the credentials and the instance parameters below.

Adapter fields

Credentials

One credential type, SAN credentials, shared by both vendors.

FieldDefinition
UsernameAccount name on the fabric switch
PasswordPassword of that account

Instance parameters

FieldDefaultDefinition
Name—Unique name of the adapter instance
Description—Free-text description of the instance
VendorBrocadeProducer of the device this instance connects to: Brocade uses the Brocade REST API, Cisco MDS uses Cisco NX-API. Both share the same object model. Part of the instance identity.
API Host—Hostname or IP address of the management interface of the switch
API Port443Port of the management API
Credentials—Account used for collection, see above
Collector / Group—Collector group that runs the adapter; must contain a Cloud Proxy with the image pre-pulled
Skip TLS certificate validationfalseDisables certificate verification when connecting to the API. Insecure; keep false on production systems.
Collect Info eventsfalseWhether info level fabric events are collected
Collect Warning eventsfalseWhether warning level fabric events are collected
Collect Immediately eventsfalseWhether events flagged immediately are collected
Collect Critical eventsfalseWhether critical level fabric events are collected
Adapter Memory Limit (MB)1024Maximum memory the adapter container may use
Log LevelNormalLogging verbosity: Debug, Normal or Trace