ViPR 2.1 - Add Network Systems (Fabric Managers) and SAN Networks to ViPR using the ViPR REST API

Table of Contents

Overview

This article provides the ViPR support requirements, and prerequisite information to prepare SAN (Brocade and Cisco) switches for ViPR integration using the ViPR REST API. Also includes the steps to add and configure the Fibre Channel (FC) networks in ViPR using the REST API.

A network system for:
  • Cisco = MDS switch
  • Brocade = CMCNE
When you add a SAN switch to ViPR, ViPR discovers and registers the Fibre Channel networks (Brocade Fabrics or Cisco VSANs). Through discovery of the SAN topology, ViPR can identify which hosts and storage systems that were added to ViPR, are connected through the same fibre channel network. This allows ViPR to automatically build the connectivity between the hosts and storage systems when you provision a service, such as creating a block volume for a host.

After the network system is added and discovered, it is re-discovered periodically. ViPR continues to update its networks as host and storage system ports are added and removed. Once a network system is discovered, ViPR creates and removes SAN zones when block volumes are exported/unexported. If that is not the intended behavior, then set the auto-zoning flag false in the virtual array associated with this network.

This article is part of a series

You can add Brocade and Cisco switches to ViPR at anytime. If, however, you are setting up the ViPR Controller virtual data center for the first time, before you continue to provision storage, complete the following steps.
  1. Authenticate with the ViPR REST API
  2. Add physical assets to ViPR:
  3. Create ViPR virtual assets:
    1. Create and configure a virtual array
    2. Create virtual pools:

Back to Top

Add a network system (fabric manager)

Before you begin

Authenticate with the ViPR REST API as a System Administrator.

Depending on the type of switch you are adding, you will need the following information:

Type Required Information
Brocade
Cisco

The EMC ViPR REST API Reference provides a description and complete list of parameters for the REST API methods used in this article.

The following steps describe how to add Brocade and Cisco switches to ViPR using the REST API.

Procedure

  1. Add a network system (fabric manager) using POST /vdc/network-systems.
    The request returns a task.
    In this example, a Brocade switch is being added to ViPR.
    Request
    POST https://<ViPR_VIP>:4443/vdc/network-systems
    
    Content-Type: application/xml
    X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
    
    <network_system_create>
         <name>br_switch_east</name>
         <system_type>brocade</system_type>
         <smis_provider_ip>10.247.99.250</smis_provider_ip>
         <smis_port_number>5989</smis_port_number>
         <smis_user_name>administrator</smis_user_name>
         <smis_password>password</smis_password>
         <smis_use_ssl>false</smis_use_ssl>    
    </network_system_create>
    Response
    HTTP 202 Accepted
    Content-Type: application/xml
    
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <task>
        <associated_resources/>
        <description>DISCOVER_NETWORK_SYSTEM</description>
        <op_id>dc005a4e-d1ed-4ec6-836c-75c1468e4801</op_id>
        <resource>
            <id>urn:storageos:NetworkSystem:e80351f5-9769-4c71-9c48-5acf76c83775:vdc1</id>
            <link rel="self" href="/vdc/network-systems/urn:storageos:NetworkSystem:e80351f5-9769-4c71-9c48-5acf76c83775:vdc1"/>
            <name>br_switch_east</name>
        </resource>
        <link rel="self" href="/vdc/network-systems/urn:storageos:NetworkSystem:e80351f5-9769-4c71-9c48-5acf76c83775:vdc1/tasks/dc005a4e-d1ed-4ec6-836c-75c1468e4801"/>
        <state>pending</state>
    </task>
    ViPR discovers, and registers the fabric manager and the associated networks.
  2. Query the discover network system task URI until the message attribute of the task is Operation completed successfully.
    Request
    GET https://<ViPR_VIP>:4443/vdc/network-systems/urn:storageos:NetworkSystem:e80351f5-9769-4c71-9c48-5acf76c83775:vdc1/tasks/dc005a4e-d1ed-4ec6-836c-75c1468e4801
    Content-Type: application/xml
    X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
    Response
    HTTP 200 OK
    Content-Type: application/xml
    
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <task>
        <associated_resources/>
        <description>DISCOVER_NETWORK_SYSTEM</description>
        <end_time>1409933036781</end_time>
        <message>Operation completed successfully</message>
        <op_id>dc005a4e-d1ed-4ec6-836c-75c1468e4801</op_id>
        <resource>
            <id>urn:storageos:NetworkSystem:e80351f5-9769-4c71-9c48-5acf76c83775:vdc1</id>
            <link rel="self" href="/vdc/network-systems/urn:storageos:NetworkSystem:e80351f5-9769-4c71-9c48-5acf76c83775:vdc1"/>
            <name>br_switch_east</name>
        </resource>
        <link rel="self" href="/vdc/network-systems/urn:storageos:NetworkSystem:e80351f5-9769-4c71-9c48-5acf76c83775:vdc1/tasks/dc005a4e-d1ed-4ec6-836c-75c1468e4801"/>
        <start_time>1409933036304</start_time>
        <state>ready</state>
    </task>
Back to Top

Manually creating and updating networks in ViPR

Manually add storage ports, and host ports to the Fibre Channel network (Brocade Fabrics and Cisco VSANs) to define the connectivity ViPR will use when storage is provisioned to the hosts. When ports are not assigned to the Fibre Channel network, ViPR will automatically assign the ports when the storage is provisioned to the hosts.

  • Only system administrators can assign storage and host ports to Fibre Channel networks.
  • Fibre Channel networks are automatically added, discovered, and registered in ViPR when the associated Brocade or Cisco switch is added to ViPR using the POST /vdc/network-systems REST API call.
  • Storage ports, host ports, or both can be defined for the Fibre Channel network by adding or removing network endpoints, using PUT /vdc/networks/{Network_URN}.
The table list some of the important REST API calls for managing the storage and host ports, and the Fibre Channel network.
Back to Top

Important REST API calls for managing network systems (fabric managers)

The table lists some of the important REST API calls for managing network systems (fabric managers).

Back to Top