Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Enjoy members-only rewards and discounts
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Dell Financial Services Premier Sign In Partner Program Sign In
Contact Us

Your Dell.com Carts

Article Number: 000192029

CloudIQ: General Procedures to Onboard PowerSwitch Systems to CloudIQ

Summary: CloudIQ is a cloud-based application that leverages Machine Learning to proactively monitor and measure the overall health of the Dell Technologies infrastructure through intelligent, comprehensive, and predictive analytics. This article steps through the requirements to enable CloudIQ on Dell Networking PowerSwitch systems. ...

This article may have been automatically translated. If you have any feedback regarding its quality, please let us know using the form at the bottom of this page.

Article Content

Instructions

Onboarding Methods

OS10 and SONiC Enterprise devices can be onboarded to CloudIQ through the CloudIQ Collector. CloudIQ Collector is supported on PowerSwitch systems running OS10 10.5.3.0 or later and Enterprise SONiC version 4.1.x. CloudIQ Collector has been validated on OS10 Full Switch and SmartFabric Services modes.
 

Note: CloudIQ Collector has replaced the SupportAssist method of onboarding and collecting data for PowerSwitch systems. Customers currently using SupportAssist are advised to migrate to CloudIQ Collector.


Supported Devices

  • Enterprise SONiC 4.1.x

N3248PXE-ON
N3248X-ON
N3248TE-ON
E3248P-ON
E3248PXE-ON
S5248F-ON
S5296F-ON
S5448F-ON
S5232F-ON
S5224F-ON
S5212F-ON
Z9664F-ON
Z9264F-ON
Z9332F-ON
Z9432F-ON
 

  • OS10 10.5.3.0 or later

N3248TE-ON
S3048-ON
S4048T
S4112F-ON
S4112T-ON
S4128F-ON
S4128T-ON
S4148F-ON
S4148T-ON
S4148U
S5296F-ON
S5248F-ON
S5232F-ON
S5224F-ON
S5212F-ON
S5448F-ON
Z9100
Z9264F-ON
Z9332F-ON
Z9432F-ON
Z9664F-ON
E3224F-ON


Migrating from SupportAssist to CloudIQ Collector

Existing OS10 SupportAssist customers can migrate to CloudIQ Collector without losing their data in CloudIQ.

  1. Remove the SupportAssist configuration.
OS10# configure terminal
OS10(config)# eula-consent support-assist reject 
This action will disable Support Assist and erase all configured data. Do you want to proceed ?
[yes/no(default)]:yes
OS10(config)#

  1. Once the SupportAssist configuration has been removed in step 1, follow Section 1: Onboarding PowerSwitch systems using CloudIQ Collector.


Onboarding PowerSwitch systems using CloudIQ Collector

CloudIQ Collector
The collector is a small virtual machine distributed as a vApp that enables the collection of data for PowerSwitch, Connectrix, and VMware systems. For PowerSwitch, the CloudIQ Collector communicates with the individual switches using REST API. A single collector can be used for PowerSwitch, Connectrix, and VMware systems. You can set up an integrated gateway or a centralized gateway to connect to the Secure Remote Services server.

Centralized Gateway (Recommended) - CloudIQ Collector communicates with the Secure Remote Services Server by connecting to the Internet through the Secure Connect Gateway (installed independently of the CloudIQ Collector).

CloudIQ Collector Centrailized Gateway
Figure 1: Centralized Gateway

Integrated Gateway (Use if no Centralized gateway is installed) - CloudIQ Collector communicates with the Dell Secure Remote Services Server by connecting to the Internet through the integrated gateway embedded in the CloudIQ Collector.

CloudIQ Collector integrated gateway
Figure 2: Integrated Gateway


Prerequisites

The Customer:

  • PowerSwitch with OS10 10.5.3.0 or later, and Enterprise SONiC 4.1.x
  • Ability to deploy a VMware vApp virtual machine that acts as the data collector
  • An active ProSupport or higher contract
  • Completed customer registration at Dell Support Site (for each user)
  • Must open port 9443 for access between the CloudIQ Collector and the Secure Connect Gateway.
  • If the Secure Connect Gateway resides behind a firewall, open port 443 on the firewall for an outbound connection to the SupportAssist server 
    https://esrs3-core.emc.com

The CloudIQ Collector:

  • Does not support IPv6
  • Must be running at least v1.11.0 (OS10) or v1.15.0 (SONiC 4.1.x)
  • Requires read-only access to VMware vCenters
Note: When installed, the CloudIQ Collector is configured with 1 vCPU, 8 GB RAM, and 10 GB hard disk.

For a video Outline of this process, see: Onboarding PowerSwitch Devices to CloudIQ Using CloudIQ Collector This hyperlink is taking you to a website outside of Dell Technologies.


Download CloudIQ Collector

The CloudIQ Collector can be downloaded from the Dell Support site or the CloudIQ UI.

Download from the Dell Support site:

  1. Log in to the Dell Support Page
  2. Search for CloudIQ Collector
  3. Download the latest CloudIQ Collector vApp

Download from CloudIQ UI:

  1. Log in to the CloudIQ user interface
  2. Select Admin > Collectors
  3. Select Download a Collector at the top of the screen
  4. Select Download Collector vApp

CloudIQ Collector Download Screen

Figure 3: Collector Download Screen


Deploying the CloudIQ Collector

  1. Log in to vCenter
  2. Select File > Deploy OVF Template
  3. Select Upload files on the Select an OVA template page in the Deploy OVF template window, browse to and select the OVA file, and then select Next.
  4. Enter the name of the VM and select the location where it will be installed on the Select a name and folder page, and then select Next.
  5. Select the Destination compute resource for this operation on the Select a compute resource page, and then select Next.
  6. Verify the template details on the Review details page, and then select Next.
  7. Read and select I accept all license agreements on the License agreements page, and then select Next.
  8. Select the Storage for the configuration on the Select storage page, and then select Next.
  9. Select a Destination network for each source network in the Select Networks page, and then select Next.
  10. In the Customized template page, enter the following information, and then select Next.
  • Hostname
  • IP Address in CIDR format (For example, XX.XX.XX.XX/24)
  • Default Gateway
  • DNS Server #1
  • DNS Server #2 (if applicable)
  • Search Domains (Multiple search domains are separated by spaces)
Note: Not entering the IP address in CIDR format allows the vApp to boot, but it is not reachable.
 
Deployment Screen
Figure 4: Deployment Screen
  1. Review the host information in the Ready to Complete page.
  2. If correct, select Finish to deploy the vApp.
  3. Once the vApp is fully deployed, close the Deployment Completed Successfully window and power on the VM.
Note: The first boot of the vApp takes several minutes to complete its initial deployment.


Configure the CloudIQ Collector

The CloudIQ Collector must be configured to be a gateway to send data securely back to Dell Technologies. 

Option 1 - Centralized Gateway (Recommended)
Option 2 - Integrated Gateway
 

Note: Only alphanumeric passwords are supported for any connection to the gateway.

Customers should verify that no special characters exist within their Dell support user account password used to configure the collector to the gateway. Once the connection is established, the customer may change the password back to something more secure. 
 
Note: For a centralized gateway, the customer must be running Secure Connect Gateway (SCG) version 5.12 or later. If an integrated gateway is installed, the version does not matter as the installation installs a compatible version.

Option 1: Configure the CloudIQ Collector to a Centralized Gateway
  1. Launch the Collector configuration by opening: 
https://<collector-hostname>
  1. Select Get Started.
  2. The recommendation is to select Configure an existing gateway to use an existing Secure Connect Gateway, and then select Next.
Note: For more information about gateways, see the latest Secure Connect Gateway document.
 

Get Started Screen

Figure 5: Get Started Screen

  1. On the Configure Secure Remote Services page, enter the following information, and then select Next.
  • Dell Customer Support Username
  • Dell Customer Support Password (no special characters)
  • Gateway Hostname or IP Address
  • Gateway port (9443 by default)

Configure Remote ServicesFigure 6: Configure Remote Services

 
Note: It is recommended to leave the "Gateway SSL certificate" cleared. Only select this if your Secure Remote Services Gateway uses certificates trusted by standard issuers, and then select Next.
 
  1. Create an administrator account for the Collector, and then select Next.

Create Administrator

Figure 7: Create Administrator

 
Note: This user account is used to access the CloudIQ Collector user interface.
 
  1. If required, select Yes, Configure to configure Active Directory users for the Collector. Otherwise, select No, Skip, and Finish.

CloudIQ Collector Active Directory

Figure 8: Active Directory

  1. Upon successful completion of the Collector configuration, select Continue to CloudIQ Collector Management UI.
  2. Log in to the CloudIQ Collector UI using the credentials configured in step 5 - admin and password.

Option 2: Configure the CloudIQ Collector to an Integrated Gateway
  1. Select Deploy a new integrated gateway for this collector and then select Next.
  2. If you use a proxy server to connect to Secure Remote Services, select Yes, Configure, then enter the proxy information, and select OK. Otherwise, select No, and then Skip.
  3. Enter the Secure Remote Services Authentication information, and then select Next.
Note: This is your Dell Customer Support username and password. (no special characters)
  1. Select Request Access Code and an access code is sent to the email address that is registered with Dell Support. The access code is good for 30 minutes after it is sent.
  2. Enter the access code and select Validate Code.
  3. Select the appropriate Site ID in the Site ID Selection drop-down.
  4. Select Next. The Secure Remote Services Gateway is now provisioned. This process takes several minutes.
  5. Return to Step 5 in Option 1: Configure the CloudIQ Collector to a Centralized Gateway section.


Adding PowerSwitch to CloudIQ Collector

Note: It is recommended to add no more than a maximum combination of 128 physical switches.
  1. Ensure that the switches are properly configured before attempting to discover them with the CloudIQ 
Collector
  • SONiC
RESTCONF API is enabled by default. Therefore, you do not have to run any commands.
  • OS10
  1. Enable the RESTCONF API service only on the switches operating in full switch mode. 
    1. To verify the mode
OS10# show switch-operating-mode
Switch-Operating-Mode : Full Switch Mode
  1. Enter the configuration mode
OS10# configure terminal
OS10(config)#
  1. Enable the RESTCONF API 
OS10(config)# rest api restconf
OS10(config)# exit
  1. RESTCONF API service is enabled by default on switches operating in SmartFabric Services mode.
    1. To verify the mode
OS10# show switch-operating-mode
Switch-Operating-Mode : SmartFabric Mode
Note: Rest API RESTCONF is not seen in the running configuration in SmartFabric Services mode, as RESTCONF API Service is enabled by default.
 
  1. Create a rest user account for CloudIQ Collector with appropriate privileges (Recommended).
  • SONiC
The role operator provides access to EXEC mode to view the current configuration. An operator cannot modify configuration settings on a switch. 
sonic(config)# username <username> password <password> role operator
  • OS10
The role netoperator provides access to EXEC mode to view the current configuration with limited access.

A network operator cannot modify any configuration setting on a switch. 
OS10(config)# username <username> password <password> role netoperator
  1. Select PowerSwitch from the left side menu.
CloudIQ Collector Add Power Switch
Figure 9: Add PowerSwitch
  1. Select the Add PowerSwitch button to configure access to switches individually.
  2. Enter the switch details and select Validate and Add
Add Powerswitch 1
Add PowerSwitch 2

Figure 10: PowerSwitch Details


Note: After adding a PowerSwitch, it may take up to 24 hours for all system data to appear in CloudIQ.

Article Properties

Affected Product
CloudIQ, CloudIQ, CloudIQ for PowerSwitch, Enterprise SONiC Distribution, PowerSwitch E3200-ON Series, Dell EMC Networking N3200-ON, PowerSwitch S5212F-ON, PowerSwitch S5224F-ON, PowerSwitch S5232F-ON, PowerSwitch S5248F-ON, PowerSwitch S5296F-ON , PowerSwitch S5448F-ON, PowerSwitch Z9100-ON, PowerSwitch Z9264F-ON, PowerSwitch Z9332F-ON, PowerSwitch Z9432F-ON, PowerSwitch Z9664F-ON, SmartFabric OS10 Software ...
Last Published Date

23 Apr 2024

Version

48

Article Type

How To

Back to Top