Nexus Dashboard Fabric Controller API, Release 12.2.2
Latest

API Changelog (SAN)

The following sections describe API changes in each release of Nexus Dashboard Fabric Controller SAN.

Release 12.2.2 (2024-07-29) Summary

For additional information about the release, see the Release Notes.

Breaking changes (10)

New (9)

Deprecated (0)

Updates (18)

Breaking changes

The following are changes to the API that may break an application or integration.

[Alarm Action]

  • POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/acknowledgealarms
    • API Operation Summary: Acknowledge Alarms
    • ⛔️ Breaking Change - added the new required request property 'alarmId'
    • ⛔️ Breaking Change - removed the request property 'actBy'
    • ⛔️ Breaking Change - removed the request property 'getAlarmId'
  • POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/clearalarms
    • API Operation Summary: Clear Alarms
    • ⛔️ Breaking Change - added the new required request property 'alarmId'
    • ⛔️ Breaking Change - removed the request property 'actBy'
    • ⛔️ Breaking Change - removed the request property 'getAlarmId'
  • POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/deletealarms
    • API Operation Summary: Delete Alarms list
    • ⛔️ Breaking Change - added the new required request property 'alarmId'
    • ⛔️ Breaking Change - removed the request property 'actBy'
    • ⛔️ Breaking Change - removed the request property 'getAlarmId'
  • POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/unacknowledgealarms
    • API Operation Summary: Unacknowledge Alarms
    • ⛔️ Breaking Change - added the new required request property 'alarmId'
    • ⛔️ Breaking Change - removed the request property 'actBy'
    • ⛔️ Breaking Change - removed the request property 'getAlarmId'

[Image Upload Service]

  • POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/imageupload/scp-upload
    • API Operation Summary: SCP upload
    • ⛔️ Breaking Change - api operation id 'scpImageUpload' removed and replaced with 'scpImageUpload_1'
  • POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/imageupload/sftp-upload
    • API Operation Summary: SFTP upload
    • ⛔️ Breaking Change - api operation id 'sftpImageUpload' removed and replaced with 'sftpImageUpload_1'

[Performance Health]

  • GET /appcenter/cisco/ndfc/api/v1/pm/health/updateHealthScores
    • API Operation Summary: Update Health Score
    • ⛔️ Breaking Change - Removed operation

[SAN Discovery Manager]

  • GET /appcenter/cisco/ndfc/api/v1/san-discovery/san/getFabricStatus
    • API Operation Summary: Get Fabric Status
    • ⛔️ Breaking Change - removed the media type '/' for the response with the status '200'

[SAN Inventory]

  • GET /appcenter/cisco/ndfc/api/v1/san-discovery/inventory/isSwitchSmartSANLicenseCheckedout
    • API Operation Summary: Is Switch Smart License Checkout
    • ⛔️ Breaking Change - Removed operation
  • GET /appcenter/cisco/ndfc/api/v1/san-discovery/inventory/isSwitchSmartSANLicenseEnabled
    • API Operation Summary: Is Switch Smart License Enabled
    • ⛔️ Breaking Change - Removed operation

New

The following operations are introduced with this release:

[Image Upload Service]

  • POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/imageupload/v2/scp-upload
    • New operation: SCP upload v2
  • POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/imageupload/v2/sftp-upload
    • New operation: SFTP upload v2

[Performance Statistics]

  • GET /appcenter/cisco/ndfc/api/v1/pm/stat/getAllPmOpticsData
    • New operation: Get all Optics Data including status. HEALTHY=0, WARNING=1, CRITICAL=2
  • GET /appcenter/cisco/ndfc/api/v1/pm/stat/getInterfacesPMDataBySwitch
    • New operation: Get Interfaces Peformance by switch ID
  • GET /appcenter/cisco/ndfc/api/v1/pm/stat/getOpticsDataByWwnAndIfIndex
    • New operation: Get Optics Data based on WWN and IfIndex.
  • GET /appcenter/cisco/ndfc/api/v1/pm/stat/getOpticsStatusCount
    • New operation: Get all Optics Status Count.

[SAN Config Drift]

  • POST /appcenter/cisco/ndfc/api/v1/san-config/config/drift/dailyScaleLimitJob
    • New operation: Run Scale Limit Job
  • POST /appcenter/cisco/ndfc/api/v1/san-config/config/drift/dailyZoneLockCollectionJob
    • New operation: Run Zone Lock Collection Job

[SAN Zone Manager]

  • GET /appcenter/cisco/ndfc/api/v1/san-config/WebZoneManager/getFabricZoneLocked
    • New operation: Get Zone Lock for fabric

Deprecated

The following operations and properties will be removed in future releases. Therefore, it is not recommended to use these resources.

Updates

[Alarm Action]

  • POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/acknowledgealarms
    • API Operation Summary: Acknowledge Alarms
    • ⛔️ Breaking Change -added the new required request property 'alarmId'
    • ⛔️ Breaking Change -removed the request property 'actBy'
    • ⛔️ Breaking Change -removed the request property 'getAlarmId'
  • POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/clearalarms
    • API Operation Summary: Clear Alarms
    • ⛔️ Breaking Change -added the new required request property 'alarmId'
    • ⛔️ Breaking Change -removed the request property 'actBy'
    • ⛔️ Breaking Change -removed the request property 'getAlarmId'
  • POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/deletealarms
    • API Operation Summary: Delete Alarms list
    • ⛔️ Breaking Change -added the new required request property 'alarmId'
    • ⛔️ Breaking Change -removed the request property 'actBy'
    • ⛔️ Breaking Change -removed the request property 'getAlarmId'
  • POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/processevent
    • added the new optional request property 'prediction'
    • added the new 'FCNS_LIMIT' enum value to the request property 'eventType'
    • added the new 'FLOGI_LIMIT' enum value to the request property 'eventType'
    • added the new 'ZONE_LIMIT' enum value to the request property 'eventType'
  • POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/unacknowledgealarms
    • API Operation Summary: Unacknowledge Alarms
    • ⛔️ Breaking Change -added the new required request property 'alarmId'
    • ⛔️ Breaking Change -removed the request property 'actBy'
    • ⛔️ Breaking Change -removed the request property 'getAlarmId'

[Alarm Policy]

  • POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/createpolicy
    • API Operation Summary: Create Policy
    • added the new optional request property 'fcnsLimitRows'
    • added the new optional request property 'flogiLimitRows'
    • added the new optional request property 'zoneLimitRows'

[Image Upload Service]

  • POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/imageupload/scp-upload
    • API Operation Summary: SCP upload
    • ⛔️ Breaking Change -api operation id 'scpImageUpload' removed and replaced with 'scpImageUpload_1'
    • added the new optional request property 'acceptHostkey'
  • POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/imageupload/sftp-upload
    • API Operation Summary: SFTP upload
    • ⛔️ Breaking Change -api operation id 'sftpImageUpload' removed and replaced with 'sftpImageUpload_1'
    • added the new optional request property 'acceptHostkey'

[SAN Discovery Manager]

  • GET /appcenter/cisco/ndfc/api/v1/san-discovery/san/findEnclosureByPK
    • API Operation Summary: Find Enclosure by Enclosure PK
    • added the optional property 'rxUsage' to the response with the '200' status
    • added the optional property 'txUsage' to the response with the '200' status
    • added the optional property 'vmList/items/netRxAvgOverBw' to the response with the '200' status
    • added the optional property 'vmList/items/netTxAvgOverBw' to the response with the '200' status
    • added the optional property 'vmList/items/vmList' to the response with the '200' status
  • GET /appcenter/cisco/ndfc/api/v1/san-discovery/san/findEnclosureByPortWwn
    • API Operation Summary: Find Enclosure by Port WWN
    • added the optional property 'rxUsage' to the response with the '200' status
    • added the optional property 'txUsage' to the response with the '200' status
    • added the optional property 'vmList/items/netRxAvgOverBw' to the response with the '200' status
    • added the optional property 'vmList/items/netTxAvgOverBw' to the response with the '200' status
    • added the optional property 'vmList/items/vmList' to the response with the '200' status
  • GET /appcenter/cisco/ndfc/api/v1/san-discovery/san/findSwitchByIP
    • API Operation Summary: Find Switch By Switch IP
    • added the optional property 'fexMap' to the response with the '200' status
  • GET /appcenter/cisco/ndfc/api/v1/san-discovery/san/findSwitchByPK
    • API Operation Summary: Find Switch by Switch PK
    • added the optional property 'fexMap' to the response with the '200' status
  • GET /appcenter/cisco/ndfc/api/v1/san-discovery/san/getDetailsBySwitch
    • API Operation Summary: Get Switch Details
    • added the optional property 'fexMap' to the response with the '200' status
  • GET /appcenter/cisco/ndfc/api/v1/san-discovery/san/getFabricStatus
    • API Operation Summary: Get Fabric Status
    • ⛔️ Breaking Change -removed the media type '/' for the response with the status '200'
    • added the media type 'application/json' for the response with the status '200'
    • added the non-success response with the status '400'
    • added the non-success response with the status '401'
    • added the non-success response with the status '500'

[SAN Inventory]

  • GET /appcenter/cisco/ndfc/api/v1/san-discovery/inventory/getVHostDetail
    • API Operation Summary: Get VHost Details
    • added the optional property 'netRxAvgOverBw' to the response with the '200' status
    • added the optional property 'netTxAvgOverBw' to the response with the '200' status
    • added the optional property 'vmList' to the response with the '200' status

[SAN Migration]

  • GET /appcenter/cisco/ndfc/api/v1/san-config/sanMigration/getSwitches
    • API Operation Summary: Find MDS switches for Brocade SNMP/NTP/Syslog config
    • added the optional property '/items/fexMap' to the response with the '200' status

[SAN TechSupport]

  • GET /appcenter/cisco/ndfc/api/v1/san-config/techSupport/sanSwList
    • API Operation Summary: san sw list
    • added the optional property '/items/fexMap' to the response with the '200' status

[VHost Details]

  • GET /appcenter/cisco/ndfc/api/v1/vmm/inventory/getVHostDetail
    • API Operation Summary: Get vHost Detail
    • added the optional property 'netRxAvgOverBw' to the response with the '200' status
    • added the optional property 'netTxAvgOverBw' to the response with the '200' status
    • added the optional property 'vmList' to the response with the '200' status
Next