API Changelog (LAN)

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

Release 12.1.3 (2023-08-23)

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

What's New

GET /appcenter/cisco/ndfc/api/v1/configtemplate/rest/config/templates/export/{template}

Export Template

POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/imagemanagement/snapshot

Snapshot

POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/imageupload/sftp-upload

SFTP upload

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/all-attached-policies

Get all attached Policy details

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/image-policy-capability

Create Policy capabilities

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/imgMgmtPreDisableCheck

Image Management pre disable check

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/policy-exist/{policyname}

Check Policy exists

DELETE /appcenter/cisco/ndfc/api/v1/lan-discovery/alarms

Clear invalid alarms for link, module, fan and power supply

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/chngmgmt/autogenTicketId

Get Autogenerated Ticket Id

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/chngmgmt/tagSwitchesForDeployment

Bind Switches to Ticket

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/chngmgmt/tickets

Create Ticket

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/chngmgmt/tickets

Delete Ticket

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/chngmgmt/tickets/all

Get all Tickets

PUT /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/chngmgmt/tickets/approve-action

Approve/Deny Ticket

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/chngmgmt/tickets/audithistory/{ticketId}

Get Ticket audit history

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/chngmgmt/tickets/cancelActive

Cancel all Active tickets

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/chngmgmt/tickets/rollbacklastaction

Rollback last action for given Ticket

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/chngmgmt/tickets/rollbackticket

Rollback the given Ticket

PUT /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/chngmgmt/tickets/status

Submit Ticket for approval

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/chngmgmt/tickets/statusSummary

All Ticket Status Summary

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/chngmgmt/tickets/{ticketId}

Get Ticket details

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/chngmgmt/tickets/{ticketId}/config-deploy

Config deploy for Ticket

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/chngmgmt/tickets/{ticketId}/config-preview

Config preview for Ticket

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/config/switchRestore/{serialNum}

Restore Switch

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/config/{fabricName}/allBackupData

Get all the Fabric backups

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/config/{fabricName}/allBackupData/{serialNum}

Get Switch backups

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/config/{fabricName}/backup

Create Fabric backup

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/config/{fabricName}/backupData

Get backup version details

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/config/{fabricName}/deleteAllBackups

Delete all backups in a Fabric

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/config/{fabricName}/deleteBackup

Delete Fabric backup

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/config/{fabricName}/devicesForCCStatus

Restore preview for Fabrics of the following technologies: External and LAN Classic

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/config/{fabricName}/devicesForCCStatus/{serialNum}

Restore preview of a Switch

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/config/{fabricName}/easyPreview

Restore preview for Fabrics of the following technologies: VXLAN Fabric, eBGP VXLAN Fabric

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/config/{fabricName}/extPreview

Get diff for Switch

PUT /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/config/{fabricName}/goldenStatus

Update golden status of backup

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/config/{fabricName}/restore

Restore Fabric

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/dcnm-accessmode

Check access mode for NDFC

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/ifgroups/details

List Interface groups details

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/switch-asn/{serialNumber}

Get Switch ASN for eBGP Fabric case

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabric-name}/groups/{group-name}

Create Interface Group

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabric-name}/groups/{group-name}

Delete Interface group

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabric-name}/groups/{group-name}/netassoc

Create Network association

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabric-name}/groups/{group-name}/netassoc

Delete Network association

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabric-name}/ifassoc

Delete Interface association with Interface group

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabric-name}/ifgroup

List Interface groups

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabric-name}/ifgroup/{group-name}

Get Interface group details of Fabric and group name

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabric-name}/ifgroups/details

List Interface groups details for Fabric

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabric-name}/ifgroupwithType

List Interface groups for the given Fabric with type

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/config-diff/{switchId}

Get Switch config difference

PUT /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/inventory/discoveryIP

Change the discovery IP for the provided list of Switches

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/inventory/rediscover/{serialNumber}

Rediscover the Device

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/inventory/reload

Reload the Device

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/inventory/test-reachability

Check the Device(s) reachability

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/pendingConfig/{switchId}

Get pending config of Switch

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/sidebysidediff/{switchId}

Get Side by Side configuration difference

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/links/linkUUIDs

Delete Links

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/bulk-create

Create Policy for multiple Switches

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/policygroup/create

Policy group creation for the given serial numbers

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/policygroup/policyIds

Delete all the Policy groups for passed Policies IDs

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/policygroup/{policyId}

List the serial numbers for the given Policy group Policy id

PUT /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/policygroup/{policyId}

Update Policy group for given list of Switch serial numbers

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/ptiHistoryData/actions/{actionId}

Get PTI History for specified Change Control Action ID

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/shared/details/{policyId}

List the Policy details

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/switches/{serialNumber}/intent-interfaces

List Intent Interfaces for given Switch

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/switches/{serialNumber}/vpcintent-interfaces

List the Intent Interfaces of the given Switch and its Peer

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/switches/overview

Returns summary of all Switch Inventory details

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/switches/{fabricName}/overview

Returns summary of Fabric Switch Inventory details

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/globalInterface

Get Global Interfaces

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/globalInterface

Create Interface

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/globalInterface/bulk-importIntf

Bulk import Interface

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/globalInterface/defaultpolicy

Get default Policy

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/globalInterface/deploy

Deploy Interface

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/globalInterface/expInterfces

Export Interfaces

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/globalInterface/overlaypolicies/generatedconfig

Get overlay generated config

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/globalInterface/pti

Update Interface

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/globalInterface/pti/currentpolicy

Get current Policy

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/globalInterface/selectedInterfaces

Get vPC Interface details

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/globalInterface/underlaypolicies/combinedconfig

Get underlay generated config

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/interface/adminstatus/{shutOrNoshut}/onlySave

Update admin status

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/interface/detail/filter

Get Interface details

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/interface/fabricstatus

Get Fabric status

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/interface/markdelete

Delete Interface

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/interface/switches/list

List of VPC Peer Switches

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/inventory/neighborSwitches

List all neighbor Switches

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/inventory/setNeighborSwitchFabricId

Set neighbor Switch Fabric Id

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/lanConfig/getDefaultCredentials

Get default credentials

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/lanConfig/getLanSwitchCredentialsWithType

Get LAN Switch credentials

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/lanConfig/getRobotCredentials

Get robot credentials

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/lanConfig/globalCredentialType

Get global credential type

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/lanConfig/isLanCredentialsSet

Is LAN credentials set

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/lanConfig/isRobotSetByMe

Is robot set by me

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/lanConfig/validateCredentials

Validate credentials

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/oam/fabrics/{fabricName}/ht2htOAM

Host to Host OAM

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/oam/fabrics/{fabricName}/sw2swOAM

Switch to Switch OAM

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/allocate-id

Allocate id resource

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/allocate-resource

Allocate Resource

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/fabric/{fabricName}/pools

List Pools of the given Fabric

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/fabric/{fabricName}/pools/{poolName}

Retrieve the Pool data of the given Fabric & Pool

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/fabrics/{fabricName}

List resource usage

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/fabrics/{fabricName}/pool-names

List Pool names in the given Fabric

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/release-id

Release id Resource

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/reserve-id

Reserve Resource id for the given Entity

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/reserve-resource

Reserve Resource id for the given Entity and return Resource Manager database id

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/resources

Release Resources

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/subnet-ip-pool/allocate-resource

Allocate IP Resource

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/subnet-ip-pool/release-resource

Release IP/SUBNET Resource

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/subnet-ip/{fabricName}

Check the availability of SUBNET/IP usage

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/switch/{serialNumber}/pools

List Pools of the given Switch

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/switch/{serialNumber}/pools/{poolName}

Retrieve the Pool data of the given Switch & Pool

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/switchView/{serialNumber}

List Resource usage of given Switch

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/resource-manager/vlan/{fabricName}

Get free VLAN id

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/generateMulticastIp

Generate multicast IP

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/netinfo

Network information

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/vrfs/rmRelease

Release reserved RM entries

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/networks/deploy

Deploy Networks

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/networks/switches/history

Get deployment job details

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/bulk-create/networks

Create Networks in bulk

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/bulk-create/vrfs

Create bulk VRF

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/bulk-import/networks/attachments

Network attachment import in bulk

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/bulk-import/vrfs/attachments

Bulk import for VRF attachments

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/export/networks/attachments

Network attachment(s) export

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/bulk-delete/networks

Delete Network in bulk

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/bulk-delete/vrfs

Bulk delete for VRFs

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/generateMulticastIp

Generate multicast IP

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/netinfo

Network information

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/vrfinfo

VRF information

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/networks/deploy

Deploy Networks

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/networks/preview

Preview Networks

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/vrfs/deploy

Deploy/Undeploy VRFs

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/vrfs/switches/history

Get VRF deployment job details

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/vrfs/preview

Preview VRFs

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/topology

Get Topology

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/topology/fabrics/{fabricId}/networks-topology

Get Network Topology

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/topology/fabrics/{fabricId}/networks-topology/{networkName}

Get Device Topology for Network

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/topology/fabrics/{fabricId}/redirected-flows

Get redirected flow Topology

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/topology/fabrics/{fabricId}/redirected-flows/{flowName}

Get Topology for specific redirected flow

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/topology/fabrics/{fabricId}/vrfs-topology

Get VRF Topology

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/topology/fabrics/{fabricId}/vrfs-topology/{vrfName}

Get Device Topology for VRF

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/topology/layout/{id}

Get the Saved Layout

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/topology/layout/{id}

Save the Layout

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/topology/layout/{id}

Delete the Saved Layout

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/topology/topologydataforvmm

Get restricted Topology for the Node

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/topology/{serialNumber}

Get Topology for Node

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/vpcpair/alarms

vPC pair Alarms

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/vpcpair/check

Check whether to allow vPC pairing

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/vpcpair/check/mctless

Check if mctless

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/vpcpair/consistency

vPC consistency

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/vpcpair/health

vPC pair Health

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/vpcpair/inventory

vPC Inventory

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/vpcpair/module

vPC Module

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/vpcpair/policy

Get current config

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/vpcpair/recommendation

Recommendations for Device to form vPC pair with other Devices

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/vpcpair/topdown

vPC Topdown info

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/vpcpair/vpc_pair_name

Get vPC pair name

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/vpcpair/vpcpairinfo

vPC pair info

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/vpcpair/vxlan

vPC VXLAN info

POST /appcenter/cisco/ndfc/api/v1/pm/deleteAppGroupMembers

Delete Custom Port Group Members by Member ID List, e.g. 1100,1200,1300

GET /appcenter/cisco/ndfc/api/v1/pm/health/getFabrics4Enclosure

Get fabrics for an enclosure

GET /appcenter/cisco/ndfc/api/v1/pm/health/getSlowDrainData4Enclosure

Get Slow Drain Data for an enclosure in a fabric

GET /appcenter/cisco/ndfc/api/v1/pm/stat/getHostEnclList

get Hosts Enclosures

GET /appcenter/cisco/ndfc/api/v1/pm/stat/getTopCongestedDevices

Get Top 10 Congested Devices

GET /appcenter/cisco/ndfc/api/v1/pm/stat/getTopCongestedISL

Get Top 10 Congested ISLs

GET /appcenter/cisco/ndfc/api/v1/pm/stat/sanIslOrNpvlinkStat

Get San Isls or Npvlink by interfaceDbId

GET /appcenter/cisco/ndfc/api/v1/pm/stat/sanPmInterfaceChartData

Get SAN PM Interface Chart Data

PUT /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/vpcpair

Update vPC Pair

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/vpcpair

Delete vPC pair

What's Deleted

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/createextalarm

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/deregisterexternalpolicy

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/loaddefaultpolicyfile

Load default a Policy file

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/mockkafkaevent

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/registerexternalpolicy

POST /appcenter/cisco/ndfc/api/v1/configtemplate/rest/config/templates/jobs

Get Jobs list

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/ptiHistory/switches/{serialNumber}

Get the Pti History for the given switch

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/ptiHistory/switchesByFabric/{fabricName}

Get the Pti History for the switches under given fabric

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/extension-deploy

Deploy L3 Extension

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/extension-preview

Create L3 Extension and generate preview

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/hasprimaryorsecondarynetworks

Check primary or secondary network

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/primarynetworks

List Primary Networks

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/servicenetworks/{network-name}

Delete Service Network

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/servicevrfs/{vrf-name}

Delete a Service VRF

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/networks/{network-name}/attachments

Get Network Attachments

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/networks/{network-name}/attachments

Attach Network

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/networks/{network-name}/deploy

Deploy Network

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/networks/{network-name}/preview

Preview Network

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/networks/{network-name}/switches/{serial-number}/history

Get Network Deployment History for a given network and switch

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/networks/{network-name}/switches/{serial-number}/ports

Get Switch info for the Network

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/servicevrfs/{vrf-name}

Delete a Service VRF

POST /appcenter/cisco/ndfc/api/v1/pm/setThresholdAndPMPolicies

Set Threshold and PM Policies

What's Changed

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/acknowledgealarms

Request:

New content type : application/json

Deleted content type : application/JSON

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/activatedeactivatepolicies

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/alarmbyid

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/alarmcount

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/alarmlist

Get Alarms List

Parameters:

Changed: reqParam in query

Alarm List Filter

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/bulknotify

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/clearalarms

Request:

New content type : application/json

Deleted content type : application/JSON

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/clearextalarm

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/clearsourcealarm

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/createpolicy

Request:

New content type : application/json

Deleted content type : application/JSON

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/deletealarms

Request:

New content type : application/json

Deleted content type : application/JSON

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/deleteallalarms

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

DELETE /appcenter/cisco/ndfc/api/v1/alarm/alarms/deletepolicy

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/deletesourcealarm

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/enabledisablealarm

Parameters:

Changed: enable in query

Enable/Disable

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/enabledisableextalarm

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/exportalarmstofile

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/exportpolicy

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/getalarmstate

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/getalarmstatistics

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/getallalarms

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/getcachedata

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/getextalarmstate

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/getswitchports

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/gettransientalarms

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/issaninstallmode

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/policiessummary

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/policydetails

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/policyinfo

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/processevent

Request:

New content type : application/json

Deleted content type : application/JSON

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/raisedalarmcategorycount

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/raisedalarmdevicecategorycount

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/raisedalarmlist

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/raisedalarmswitchcategorycount

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/recreatealarmmapping

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/reloadserverprops

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/scopealarmcategorycount

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/unacknowledgealarms

Request:

New content type : application/json

Deleted content type : application/JSON

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/alarm/alarms/updateeventsyslogpolicies

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/updatepolicy

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/uploadpolicyfile

Request:

New content type : application/json

Deleted content type : application/JSON

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/configtemplate/rest/config/templates

Get all Templates

Parameters:

Deleted: filterStr in query

Return Type:

Changed response : 200 OK

Response body give the success

Changed response : 400 Bad Request

Invalid message body

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 500 Internal Server Error

Other exceptions

DELETE /appcenter/cisco/ndfc/api/v1/configtemplate/rest/config/templates/delete/bulk

Delete Templates list

Request:

List of Template names in key value pairs. Payload is a dictionary with two keys: fabTemplate, name. fabTemplate : A list of Fabric Template names. name : A list of other Template names. Ex: {"fabTemplate":["fabTemplate1","fabTemplate2"],"name":["otherTemplate1","otherTemplate2"]}

Return Type:

Changed response : 200 OK

Response body give the success

Changed response : 400 Bad Request

Invalid message body

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/configtemplate/rest/config/templates/validate

Validates Template contents

Request:

Template content. Example of Template contents can be found at API description.

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 400 Bad Request

Invalid message body

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/configtemplate/rest/config/templates/{templateName}/defaultvalue

Get all the Template variables with their defaults

Parameters:

Changed: templateName in path

Name of the Template. Ex: Default_Network_Extension_Universal

Request:

Dictionary of the Template mandatory parameter key value pairs. Ex: {"vlanId": "100","segmentId" : "2000","nveId" : "1"}

Return Type:

Changed response : 200 OK

Response body gives the Template contents

Changed response : 400 Bad Request

Invalid message body

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/configtemplate/rest/config/templates/{templateName}/populate

Generate Template commands

Parameters:

Deleted: deviceIP in query

Changed: templateName in path

Name of the Template. Ex: Default_Network_Extension_Universal

Request:

Dictionary of the Template parameter key value pairs. Ex: {"vlanId": "100","segmentId" : "2000","nveId" : "1"}

Return Type:

Changed response : 200 OK

Response body "value" field has the generated configuration

Changed response : 400 Bad Request

Invalid message body

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/elastic-service/fabrics/{fabric-name}/service-nodes/{node-name}/peerings/{attached-fabric}/{peering-name}/deployments

Return Type:

Changed response : 400 Bad Request

Invalid Fabric or request payload

• Changed content type : application/json

  • Added property severity (string)

    Enum values:

    • Info
    • Warning
    • Error
    • Critical

  • Added property detail (string)

  • Added property extra (string)

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

POST /appcenter/cisco/ndfc/api/v1/elastic-service/fabrics/{fabric-name}/service-nodes/{node-name}/policies/{attached-fabric}/{policy-name}/deployments

Return Type:

Changed response : 400 Bad Request

Invalid Fabric or request payload

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

GET /appcenter/cisco/ndfc/api/v1/elastic-service/fabrics/{fabric-name}/service-nodes/{node-name}/{node-type}/policies/{attached-fabric}/{policy-name}/stats

Return Type:

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 400 Bad Request

Invalid query

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

DELETE /appcenter/cisco/ndfc/api/v1/elastic-service/fabrics/{fabric-name}/service-nodes/{node-name}/{node-type}/policies/{attached-fabric}/{policy-name}/stats

Parameters:

Added: change-control-ticket in query

Change control ticket

Return Type:

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 400 Bad Request

Invalid query

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

GET /appcenter/cisco/ndfc/api/v1/elastic-service/service-nodes

Return Type:

Changed response : 400 Bad Request

Invalid Fabric or request payload

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 200 OK

Service node is retrieved Successfully

• Changed content type : application/json

GET /appcenter/cisco/ndfc/api/v1/event/em/getAccounting

Parameters:

Changed: filter in query

Accounting logs filter

GET /appcenter/cisco/ndfc/api/v1/event/em/getEvent

Parameters:

Changed: filter in query

Event logs filter

GET /appcenter/cisco/ndfc/api/v1/event/em/getEventRegistrationSource

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/event/em/getEventRegistrationStatus

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/event/em/getEventSuppressors

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/config/delivery/deployerHistoryByFabric/{fabricName}

Parameters:

Changed: Range in header

This field is used to limit the listings of entries. Ex: 0-9 (It will display only the first 10 entries).

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Changed: filter in query

Filter field. Ex: entityType==SWITCH

Changed: sort in query

Sort field. Ex: entityName:ASC

Changed: serial-number in query

Switch serial number. Ex: FDO2338082P

Return Type:

New response : 200 OK

List the Device under the Fabric

New response : 401 Unauthorized

Unauthorized access to API

New response : 500 Internal Server Error

Other exception

Deleted response : **default **

successful operation

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics

List all the Fabrics

Return Type:

New response : 500 Internal Server Error

Other exception

Changed response : 200 OK

List of Fabrics

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/msd/fabric-associations

List the MSD Fabric association

Return Type:

Changed response : 500 Internal Server Error

Failed to get the member Fabric associations

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/msdAdd

MSD Fabric addition

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Request:

MSD Fabric name and child Fabric name (Name of the Fabric to be added to the MSD Fabric) in a name-value pair. Ex: {"destFabric":"MSDFabric","sourceFabric":"MyFabric"}

Return Type:

Changed response : 200 OK

Fabric added to MSD Fabric successfully

Changed response : 400 Bad Request

Invalid message body

Changed response : 403 Forbidden

Conflict in types

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/msdExit

MSD Fabric exit

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Request:

MSD Fabric name and child Fabric name (Name of the Fabric to be removed from the MSD Fabric) in a name-value pair. Ex: {"destFabric":"MSDFabric","sourceFabric":"MyFabric"}

Return Type:

Changed response : 400 Bad Request

Invalid message body

Changed response : 403 Forbidden

Conflict in types

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}

Fabric details

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Return Type:

New response : 500 Internal Server Error

Other exception

Changed response : 200 OK

Fetch the given Fabric details

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}

Delete Fabric

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Return Type:

Changed response : 500 Internal Server Error

Other exception

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/accessmode

Check Access Mode of Fabric

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

New response : 500 Internal Server Error

Other exception

Deleted response : 404 Not Found

Unauthorized access to API

Changed response : 200 OK

Fetch the accessmode of the Fabric

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/config-deploy

Fabric configuration deploy

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Changed: forceShowRun in query

ForceShowRun: If true, Config compliance try to fetch show run if anything changed in sh run. If false, then it compute diff from cached sh run on Config compliance. Ex: false

Changed: inclAllMSDSwitches in query

inclAllMSDSwitches (Include all MSD Switches): If true and if you pass MSD Fabric Name all of your child Fabric changes get deployed. If false, MSD's child Fabric changes not be deployed. Ex: false

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/config-deploy/{switchId}

Fabric configuration deploy of Fabric and Switch

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Changed: switchId in path

Serial number of the Switch. Ex: SAL18432P2T

Changed: forceShowRun in query

ForceShowRun: If true, Config compliance try to fetch show run if anything changed in sh run. If false, then it compute diff from cached sh run on Config compliance. Ex: false

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/config-preview

Configuration preview for the Fabric

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Changed: forceShowRun in query

ForceShowRun: If true, Config compliance fetch the latest running config from the Device.If false, then it use the cached version for computation. Example: true or false

Changed: showBrief in query

ShowBrief: If true, API provides line count of the pending config with values in entityList, runningConfig, expectedConfig. If false, detailed output is provided. Ex: true or false

Changed: inclAllMSDSwitches in query

inclAllMSDSwitches: If true and MSD fabricname is passed, all of the child Fabric Switches are included in the computation. If false, MSD's child Fabric Switches are not included. Example: true or false

Changed: shRunOptimization in query

shRunOptimization: If true, Config compliance checks for accounting log index change to ensure there is a change in running config, before attempting to fetch the Switch running config.If false, when Device running-config is needed to be obtained from Device by config-compliance, it will do so without any accounting log index check. Example: true or false

Return Type:

Changed response : 200 OK

Config preview successfull

Changed response : 500 Internal Server Error

Config preview could not be generated due to internal server error

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/config-preview/source/{sourceName}/{switchId}

Configuration preview for given Source, Switch(es) in the Fabric

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Changed: sourceName in path

Name of the Source (TELEMETRY_NIR-SOFTWARE, TELEMETRY_NIR-ANALYTICS, EPL, etc.). Ex: TELEMETRY_NIR-SOFTWARE

Changed: switchId in path

Serial number of the Switch. Ex: SAL18432P2T

Changed: forceShowRun in query

ForceShowRun : If true, Config compliance fetch the latest running config from the Device. If false, then it use the cached version for computation. Example: true or false

Changed: showBrief in query

ShowBrief: If true, API provides line count of the pending config with values in entityList, runningConfig, expectedConfig. If false, detailed output is provided. Example: true or false

Return Type:

Changed response : 500 Internal Server Error

Config preview could not be generated due to internal server error

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/config-preview/{switchId}

Configuration preview for Switch(es)

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Changed: switchId in path

Comma separated Switch serial numbers. Ex: SAL18432P2T,SAL1843ABCD

Changed: forceShowRun in query

forceShowRun: If true, Config compliance fetch the latest running config from the Device. If false, then it use the cached version for computation. Example: true or false

Changed: showBrief in query

ShowBrief: If true, API provides line count of the pending config with values in entityList, runningConfig, expectedConfig. If false, detailed output is provided. Example: true or false

Changed: recomputeMapEnable in query

RecomputeMapEnable: If true, existing compliance cache for specified Serial Numbers is cleared before computing pending configuration. If false, pending configuration is returned from compliance cache. Ex: false

Changed: shRunOptimization in query

shRunOptimization. If true, Config compliance checks for accounting log index change to ensure there is a change in running config, before attempting to fetch the Switch running config.If false, when Device running-config is needed to be obtained from device by config-compliance, it will do so without any accounting log index check. Example: true or false

Return Type:

Changed response : 200 OK

Config preview successful

Changed response : 500 Internal Server Error

Config preview could not be generated due to internal server error

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/config-save

Save Fabric configuration (Recalculate Config)

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Return Type:

Changed response : 200 OK

Configuration save process has triggered successfully

Changed response : 500 Internal Server Error

Failed to trigger the configuration save process

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/freezemode

Check access mode for Fabric

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Return Type:

Changed response : 200 OK

Fetch the freezemode of the Fabric

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/inventory/poap/dhcpscopes

List Inband POAP DHCP scopes for specified numbered (p2p) Fabric

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Return Type:

New response : 404 Not Found

Invalid Fabric

New response : 500 Internal Server Error

Other exception

Changed response : 200 OK

DHCP scopes retrieved successfully

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/inventory/switchesByFabric

List the Device(s) under the Fabric

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Return Type:

New response : 200 OK

Successfully list the Device under the Fabric

New response : 401 Unauthorized

Unauthorized access to API

New response : 404 Not Found

Invalid Fabric

New response : 500 Internal Server Error

Other exception

Deleted response : **default **

successful operation

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/swapSN/{oldSN}/{newSN}

Swap serial number for pre-provision case

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Changed: oldSN in path

Switch serial number of old Switch. Ex: SAL18432P2T

Changed: newSN in path

Switch serial number of new Switch. Ex: SAL12345Q1S

Return Type:

New response : 200 OK

Operation successfull

New response : 401 Unauthorized

Unauthorized access to API

New response : 500 Internal Server Error

Other exception

Deleted response : **default **

successful operation

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/switches/{serialNumber}

Remove Switch from the Fabric

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Added: force in query

Force delete of border role switches, even with overlay extensions present on the links

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Changed: serialNumber in path

Serial number of the Switch. Ex: SAL18432P2T

Return Type:

New response : 200 OK

Switch successfully removed from the Switch

New response : 401 Unauthorized

Unauthorized access to API

New response : 500 Internal Server Error

Failed to remove Switch from the Fabric

Deleted response : **default **

successful operation

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/switches/{serialNumber}/deploy-maintenance-mode

Deploy the maintenance mode or active PTI to the Switch

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Changed: serialNumber in path

Serial number of the Switch. Ex: 9CAIKI994D8

Return Type:

New response : 200 OK

Successfully deploy Switch to maintenance mode

New response : 401 Unauthorized

Unauthorized access to API

New response : 500 Internal Server Error

Failed to deploy Switch to maintenance mode

Deleted response : **default **

successful operation

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/switches/{serialNumber}/maintenance-mode

Enable maintenance mode

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Changed: serialNumber in path

Serial number of the Switch. Ex: SAL18432P2T

Return Type:

New response : 200 OK

Successfully enabled maintenance mode of the Switch

New response : 401 Unauthorized

Unauthorized access to API

New response : 500 Internal Server Error

Failed enabled maintenance mode of the Switch

Deleted response : **default **

successful operation

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/switches/{serialNumber}/maintenance-mode

Remove Switch from maintenance mode

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Changed: serialNumber in path

Serial number of the Switch. Ex: SAL18432P2T

Return Type:

New response : 200 OK

Successfully removed Switch from maintenance mode

New response : 401 Unauthorized

Unauthorized access to API

New response : 500 Internal Server Error

Failed to removed Switch from maintenance mode

Deleted response : **default **

successful operation

PUT /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/{templateName}

Update the given Fabric

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Changed: templateName in path

Name of the Fabric Template. Ex: Easy_Fabric

Request:

Name-Value pair(s) of the Fabric. Ex:{"FABRIC_TYPE":"Switch_Fabric","FABRIC_NAME":"MyFabric","BGP_AS":"67"}

Return Type:

Changed response : 500 Internal Server Error

Other exception

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/{templateName}

Create fabric with name-value pair(s)

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Changed: templateName in path

Name of the Fabric Template. Ex: Easy_Fabric

Request:

Name-Value pair(s) in key value format. Ex: {"BGP_AS": "67"}

Return Type:

Changed response : 200 OK

Fabric created successfully

Changed response : 500 Internal Server Error

Failed to create the Fabric with specific name-value pair(s)

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/links/fabrics/export/{fabricName}

Export all the Links in the Fabric with CSV format

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

It will return all the Links in the Fabric with csv format

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/links/fabrics/{fabricName}

List all the Links in the Fabric

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

New response : 404 Not Found

Invalid Fabric

Changed response : 200 OK

It will return all the Links in the Fabric

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/links/import

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Request:

CSV formated data

Return Type:

Changed response : 200 OK

Link(s) creation successful

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/links/logical-links/switch/{serialNumber}

List all the logical Links for the given Switch

Parameters:

Changed: serialNumber in path

Serial number of the Switch. Ex: SAL2008ZAXX

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

All logical Links

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/links/logical-links/{fabricName}

List all the logical Links for the given Fabric

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Changed: serialNumber in query

Serial number of the Switch. Ex: SAL2008ZAXX

Changed: swDBID in query

Switch database id. Ex: 1020

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

All logical Links

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/links/switch/{serialNumber}

List all the Links which connected to the Switch

Parameters:

Changed: serialNumber in path

Serial number of the Switch. Ex: SAL2008ZAXX

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

It will return all the Links for the Switch

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/deploy

Deploy Policies

Parameters:

Added: serialNumbers in query

Comma seperate Switch serial numbers to push the shared Policy. Ex: FDO212102PF,SAL1922FL2R

Request:

List of Policy Ids or Single Shared PolicyId. Ex: ["POLICY-1200","POLICY-1220"] or ["POLICY-GROUP-1200"]

Return Type:

New response : 200 OK

Successfully deployed the policies

New response : 400 Bad Request

Invalid inputs

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/key

Parameters:

Changed: type in query

Type of the key. Ex: DevicePair

Changed: paramOne in query

Refer note in API description.

Changed: paramTwo in query

Refer note in API description.

Changed: paramThree in query

Refer note in API description.

Changed: paramFour in query

Refer note in API description.

Return Type:

New response : 401 Unauthorized

Unauthorized access

Changed response : 200 OK

Successfully returned the generated key

Changed response : 500 Internal Server Error

Other exceptions

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/policyIds

Delete Policies for given Policy ids

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: policyIds in query

Policy ids separated by comma. Ex: POLICY-15910,POLICY-17710

Return Type:

New response : 200 OK

Successfully deleted the Policies for given Policy ids

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/ptiHistoryData/switchesByFabric/{fabricName}

Get PTI history data of the Switches under given Fabric

Parameters:

Changed: Range in header

This field is used to limit the listings of entries. Ex: 0-9 (It will display only first 10 entries)

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Changed: filter in query

Filter field. Ex: policyId==POLICY-28270

Changed: sort in query

Sort field. Ex: policyId:ASC

Changed: serial-number in query

Serial number of the Switch. Ex: FDO21332E6X

Return Type:

New response : 200 OK

Successfully retrieved th PTI history data for the Switches under given Fabric

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/switches/{serialNumber}

List Policies for a Switch

Parameters:

Changed: serialNumber in path

Serial number of the Switch. Ex: FDO21332E6X

Changed: source in query

Source of the policy. Source can be UNDERLAY, OVERLAY, LINK, Ethernet1/15, loopback0, LINK-UUID-202000,.... Ex: loopback0

Changed: responseType in query

Type of the response. Ex: TSV (Tab Separated Values)

Return Type:

New response : 200 OK

Successfully listed the Policies of given Switch

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

PUT /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/switches/{serialNumber}

Mark delete the Policies for given Switch

Parameters:

Changed: serialNumber in path

Serial number of the Switch. Ex: FDO21332E6X

Return Type:

New response : 200 OK

Successful marked delete Switch Policies for given Switch

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/switches/{serialNumber}

Delete Policies for given Switch

Parameters:

Changed: serialNumber in path

Serial number of the Switch. Ex: FDO21332E6X

Return Type:

New response : 200 OK

Successfully deleted the Policies for given Switch

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/switches/{serialNumber}/intent-config

Get Intent Config for given Switch

Parameters:

Changed: serialNumber in path

Serial number of the Switch. Ex: FDO21332E6X

Changed: include-delete in query

If include-delete is false then mark-deleted Policies included in the Intent Config, else not. Ex: false

Changed: include-policyid in query

If include-policyid is true then Policy id will get added as part of Intent Config, else not. Ex: false

Return Type:

New response : 200 OK

Successfully fetched the Intent Config for the given Switch

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/switches/{serialNumber}/{entityType}/{entityName}

List Policies for given Switch and Entity

Parameters:

Changed: serialNumber in path

Serial number of the Switch. Ex: 9UVHDAWVPHK

Changed: entityType in path

Type of the Entity. Ex: INTERFACE

Changed: entityName in path

Name of the Entity. Ex: Ethernet1/15

Changed: responseType in query

Type of the response. Ex: TSV (Tab Separated Values)

Return Type:

New response : 200 OK

Successfully listed the Policies foe given Switch and Entity

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

PUT /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/switches/{serialNumber}/{entityType}/{entityName}

Mark delete the Policies based on given Switch and Entity details

Parameters:

Changed: serialNumber in path

Serial number of the Switch. Ex: FDO21332E6X

Changed: entityType in path

Type of the Entity. Ex: INTERFACE

Changed: entityName in path

Name of the Entity.Ex: Ethernet1/15

Return Type:

New response : 200 OK

Successfully marked delete the Policies based on given Switch and Entity details

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/switches/{serialNumber}/{entityType}/{entityName}

Delete Policies for the given Switch and Entity details

Parameters:

Changed: serialNumber in path

Serial number of the Switch. Ex: FDO21332E6X

Changed: entityType in path

Type of the Entity. Ex: INTERFACE

Changed: entityName in path

Name of the Entity. Ex: Ethernet1/15

Return Type:

New response : 200 OK

Successfully deleted the Policy

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/{policyId}/intent-config

Get Intent Config for given Policy Id

Parameters:

Changed: policyId in path

Id of the Policy. Ex: POLICY-15910

Return Type:

New response : 200 OK

Successfully fetched the Intent Config for the given Policy Id

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

PUT /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/{policyId}/mark-delete

Mark delete the Policy based on given Policy Id

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: policyId in path

Id of the Policy. Ex: POLICY-41010

Return Type:

New response : 200 OK

Successfully marked delete the policy for given Policy Id

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/switches/{serialNumber}/fabric-name

To get the Fabric name for given Switch serial number

Parameters:

Changed: serialNumber in path

Switch serial number. Ex: SAL1922FL2R

Return Type:

Changed response : 200 OK

Successfully get the Fabric name

Changed response : 500 Internal Server Error

Invalid Switch/Other exception

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/switches/{serialNumber}/myip

To get the IP address as used by DCNM import, for given Switch serial number

Parameters:

Changed: serialNumber in path

Switch serial number. Ex: 9CAIKI994D8

Return Type:

Changed response : 200 OK

Successfully get the IP address

Changed response : 500 Internal Server Error

Invalid Switch/Other exception

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/interface/detail

Get detailed information of Interfaces

Parameters:

Changed: serialNumber in query

Serial number of the Switch. Ex: FDO23040Q85

Return Type:

Changed response : 200 OK

List of Interface and their details

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/interface/vpcpair_serial_number

Parameters:

Changed: serial_number in query

Serial number of the Switch. Ex: SAL2008ZAXX

Return Type:

Changed response : 500 Internal Server Error

The specified serial number is not part of a vPC Pair or any other internal server error

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/inventory/allswitches

List all the Devices in NDFC

Return Type:

New response : 200 OK

Successfully list all the Devices

New response : 400 Bad Request

Invalid query params

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/inventory/switches

Get all discovered Switches

Return Type:

New response : 200 OK

Successfully discovered Switches

New response : 400 Bad Request

Invalid query params

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/l4l7-service/fabrics/{fabric-name}/servicenetworks

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Return Type:

Changed response : 200 OK

List all the Service Networks details under the selected Fabric

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/lanConfig/deleteCredentials

Delete credentials

Request:

Changed content type : application/x-www-form-urlencoded

• Changed property switchIds (array)

  Database ids of Switches (Check and get the 'switchDbID' from the API : '/appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/fab1/inventory/switchesByFabric').

Return Type:

Changed response : 200 OK

Operation successful

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/lanConfig/deleteDefaultCredentials

Delete default credentials

Return Type:

Changed response : 200 OK

Operation successful

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/lanConfig/deleteRobotDefaultCredentials

Delete robot credentials

Return Type:

Changed response : 200 OK

Operation successful

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/lanConfig/saveDefaultCredentials

Save LAN default credentials

Request:

Changed content type : application/x-www-form-urlencoded

• Deleted property privProtocol (string)

  privProtocol

• Changed property username (string)

  User Name. Ex: MyUser

• Changed property password (string)

  Password. Ex: My@Passw0rd

Return Type:

Changed response : 200 OK

Operation successful

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/lanConfig/saveRobotCredentials

Save robot credentials

Request:

Changed content type : application/x-www-form-urlencoded

• Deleted property privProtocol (string)

  privProtocol

• Changed property username (string)

  User Name. Ex: MyUser

• Changed property password (string)

  Password. Ex: My@Passw0rd

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/lanConfig/saveSwitchCredentials

Save Switch credentials

Request:

Changed content type : application/x-www-form-urlencoded

• Deleted property v3protocol (string)

• Changed property switchIds (array)

  Database id's of Switches (Check and the get 'switchDbID' from the API : '/appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/fab1/inventory/switchesByFabric').

• Changed property username (string)

  User Name. Ex: MyUser

• Changed property password (string)

  Password. Ex: MyPassw0rd

Return Type:

Changed response : 200 OK

Operation successful

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/bulk-import/networks

Network creation bulk import

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabric-name in query

Name of the Fabric. Ex: MyFabric

Request:

CSV format data.

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Network creation successful

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/bulk-import/networks/attachments

Network attachment import in bulk

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabric-name in query

Name of the Fabric. Ex: MyFabric

Request:

CSV format data.

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Successful data imported

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/bulk-import/vrfs

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabric-name in query

Name of the Fabric. Ex: MyFabric

Request:

CSV format data. Example data can be found at API description.

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

VRF creation successful

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/bulk-import/vrfs/attachments

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabric-name in query

Name of the Fabric. Ex: MyFabric

Request:

CSV format data.

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

VRF creation successful

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/export/networks/attachments

Network attachment(s) export

Request:

Switch Serial Number(s) and Network name(s) in JSON format. Ex: {"FDO2020095D":"MyNetwork_30000"}

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns the attachment data in export format

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/export/vrfs/attachments

Export VRF attachments

Request:

Switch serial number and VRF name in JSON format. Ex: {"FDO2020095D":"MyVRF_50000,MyVRF_50001"}

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid Fabric or VRF

Changed response : 500 Internal Server Error

Other exceptions

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/bulk-delete/networks

Delete Networks in bulk

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: network-names in query

Comma separated Network names. Ex: MyNetwork_30000,MyNetwork_30001

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Networks deletion successful

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/bulk-delete/vrfs

Bulk delete for VRFs

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: vrf-names in query

Comma separated VRFs names. Ex: MyVRF_50000,MyVRF_50001

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

VRF deletion successful

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/networks/preview

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: network-names in query

Comma separated Network names. Ex: MyNetwork_30000,MyNetwork_30001

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns the preview config for the pending (un)deploy for the Networks

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/networks/switches

Get Switches info for the Networks

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: network-names in query

Comma separated Network names. Ex: MyNetwork_30000,MyNetwork_30001

Changed: serial-numbers in query

Comma separated Switch serial numbers. Ex: FDO2020095D,FDO2020021D

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns all the Switches info of Networks under selected Fabric

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/networks/switches/history

Get Network deployment history

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: network-names in query

Comma separated Network names. Ex: MyNetwork_30000,MyNetwork_30001

Changed: serial-numbers in query

Comma separated Switch serial numbers. Ex: FDO2020095D,FDO2020021D

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns the Network & VRF history of the Switch

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/networks/{network-name}/deploy

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: network-name in path

Name of the Network. Ex: MyNetwork_30000

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

(Un)deployed the config for the Network

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/networks/{network-name}/preview

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: network-name in path

Name of the Network. Ex: MyNetwork_30000

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns the config for the pending (un)deploy for the Network

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/networks/{network-name}/status

Get Network status details

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: network-name in path

Comma separated Network names. Ex: MyNetwork_30000,MyNetwork_30001

Changed: serialNumber in query

Comma separated Switch serial numbers.Ex: FDO2020095D,FDO2020021D

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns all the status of Network under selected Fabric

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/networks/{network-name}/switches/{serial-number}/history

Get Network deployment history for a given Network and Switch

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: network-name in path

Name of the Network. Ex: MyNetwork_30000

Changed: serial-number in path

Switch serial number. Ex: FDO2020095D

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns the (un)deployed details of the Switch

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/networks/{network-name}/switches/{serial-number}/ports

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: network-name in path

Name of the Network. Ex: MyNetwork_30000

Changed: serial-number in path

Switch serial number. Ex: FDO2020095D

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns all the status of Networks under selected Fabric

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/vrfinfo

VRF information

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns the details required to create a new VRF

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/vrfs/preview

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: vrf-names in query

Comma separated VRF names. Ex: MyVRF_50000,MyVRF_50001

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns the config for the pending (un)deploy for the VRF

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/vrfs/switches

Get Switch details by VRF

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: vrf-names in query

Comma separated VRF names. Ex: MyVRF_50000,MyVRF_50001

Changed: serial-numbers in query

Comma separated Switch serial numbers. Ex: FDO2020095D,FDO2020021D

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Successfully get the Switch details by VRF

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{fabric-name}/vrfs/switches/history

Get VRF deployment history

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: vrf-names in query

Comma separated VRF names. Ex: MyVRF_50000,MyVRF_50001

Changed: serial-numbers in query

Comma separated Switch serial numbers. Ex: FDO2020095D,FDO2020021D

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns the VRF history of the Switch

Changed response : 400 Bad Request

Invalid Fabric or VRF or Serial number

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/networks/preview

Parameters:

Changed: networkentity in query

Switch serial number and Network name in JSON format. Ex: {"FDO25031SY4":"MyNetwork_30000,MyNetwork_30001"}

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns the preview config for the pending (un)deploy for the Networks

Changed response : 500 Internal Server Error

Other exceptions.

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/bulk-import/networks

Network creation bulk import

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabric-name in query

Name of the Fabric. Ex: MyFabric

Request:

CSV format data.

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Network creation successful

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/bulk-import/vrfs

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Request:

CSV format data. Example data can be found at API description.

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

VRF creation successful

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/networks/preview

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: network-names in query

Comma separated Network names. Ex: MyNetwork_30000,MyNetwork_30001

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns the preview config for the pending (un)deploy for the Networks

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/networks/switches

Get Switches info for the Networks

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: network-names in query

Comma separated Network names. Ex: MyNetwork_30000,MyNetwork_30001

Changed: serial-numbers in query

Comma separated Switch serial numbers. Ex: FDO2020095D,FDO2020021D

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns all the Switches info of networks under selected Fabric

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/networks/switches/history

Get Network deployment history

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: network-names in query

Comma separated Network names. Ex: MyNetwork_30000,MyNetwork_30001

Changed: serial-numbers in query

Comma separated Switch serial numbers. Ex: FDO2020095D,FDO2020021D

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid Fabric or Network or Switch serial number

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/networks/{network-name}/status

Get Network status details

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: network-name in path

Comma separated Network names. Ex: MyNetwork_30000,MyNetwork_30001

Changed: serialNumber in query

Comma separated Switch serial numbers.Ex: FDO2020095D,FDO2020021D

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns all the status of Network under selected Fabric

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/servicenetworks/{network-name}

Delete service Network

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: network-name in path

Name of the Network. Ex: MyNetwork_30000

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Network deletion successful

Changed response : 400 Bad Request

Invalid Fabric or Network

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/vrfs/preview

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: vrf-names in query

Comma separated VRF names. Ex: MyVRF_50000,MyVRF_50001

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns the configuration for the pending (un)deploy for the VRF

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/vrfs/switches

Get Switch details by VRF

Parameters:

Changed: fabric-name in path

Name of the Fabric. Ex: MyFabric

Changed: vrf-names in query

Comma separated VRF names. Ex: MyVRF_50000,MyVRF_50001

Changed: serial-numbers in query

Comma separated swith serial numbers. Ex: FDO2020095D,FDO2020021D

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Getting the Switch details by VRF is successful

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/v2/fabrics/{fabric-name}/vrfs/switches/history

Get VRF deployment history

Parameters:

Changed: fabric-name in path

Name of the fabric. Ex: MyFabric

Changed: vrf-names in query

Comma separated VRF names. Ex: MyVRF_50000,MyVRF_50001

Changed: serial-numbers in query

Comma separated switch serial numbers. Ex: FDO2020095D,FDO2020021D

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns the VRF history of the Switch

Changed response : 400 Bad Request

Invalid Fabric or VRF or Switch serial number

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/vrfs/deploy

Deploy/Undeploy VRFs

Request:

Switch serial number and VRF name in JSON format. Ex :{"FDO2020095D":"MyVRF_50000"}

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

(Un)deployed the config for the VRFs

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/vrfs/switch-info

Parameters:

Changed: switch-sn in query

Switch serial number and VRF name in JSON format. Eg :{"FDO2020095D":"MyVRF_50000"}

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Returns the Switch information

Changed response : 400 Bad Request

Invalid Fabric or VRF

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/pm/getPMStatus

Get PM Status

GET /appcenter/cisco/ndfc/api/v1/pm/health/getSlowDrainData

Parameters:

Added: encId in query

GET /appcenter/cisco/ndfc/api/v1/pm/stat/OpticsStat

Parameters:

Added: encId in query

GET /appcenter/cisco/ndfc/api/v1/pm/stat/SanGigEStat

Parameters:

Added: interfaceDbId in query

GET /appcenter/cisco/ndfc/api/v1/pm/stat/endportEnclosureStat

Parameters:

Added: interfaceDbId in query

POST /appcenter/cisco/ndfc/api/v1/pmn/natrules

Return Type:

Changed response : 200 OK

Example Response Body:

{"id": NAT_RULE_DB_ID,

"switchIp": "SWITCH_IP", "vrf": "VRF", "mode": "Ingress/Egress or N/A", "preTranslationGroup":"PRE_TRANSLATION_GROUP", "postTranslationGroup":"POST_TRANSLATION_GROUP", "preTranslationSource":"PRE_TRANSLATION_SOURCE", "postTranslationSource":"POST_TRANSLATION_SOURCE", "groupMask":GROUP_MASK, "sourceMask":SOURCE_MASK, "sourcePort":POST_TRANSLATION_SOURCE_PORT, "destinationPort":POST_TRANSLATION_DESTINATION_PORT, "createdBy": "USER_NAME", "deploymentStatus": "DEPLOYMENT_STATUS", "deploymentAction": "DEPLOYMENT_ACTION", "deploymentFailedReason": "DEPLOYMENT_FAILED_REASON", "lastUpdatedTime": "LAST_UPDATED_TIMESTAMP", "lastUpdatedAsString": "LAST_UPDATED_TIME_AS_STRING"}

GET /appcenter/cisco/ndfc/api/v1/pmn/rtp/pathtrace/fabrics/{fabric-name}/vrf/{vrf}/source/{source}/group/{group}

Parameters:

Added: receiverSwitch in query

GET /appcenter/cisco/ndfc/api/v1/pmn/switches/{switchNameOrIP}/nategressifmaps

Return Type:

Changed response : 200 OK

Returns the Multicast NAT Recirc Mappings list. Example Body:

[{"egressIfMapId": EGRESS_INTERFACE_MAPPPINGS_ID,

"switchIp": "SWITCH_IP", {"vrf": "VRF_NAME","egressInterfaces":[ "EGRESS_INTERFACE_NAME1", "EGRESS_INTERFACE_NAME2", ...], "destinationPrefix":"DESTINATION/PREFIX", "mapInterface":"MAP_INTERFACE_NAME", "maxReplications":MAX_REPLICATIONS, "createdBy": "USER_NAME", "deploymentStatus": "DEPLOYMENT_STATUS", "deploymentAction": "DEPLOYMENT_ACTION", "deploymentFailedReason": "DEPLOYMENT_FAILED_REASON", "lastUpdatedTime": "LAST_UPDATED_TIMESTAMP", "lastUpdatedAsString": "LAST_UPDATED_TIME_AS_STRING"} ]

DELETE /appcenter/cisco/ndfc/api/v1/pmn/switches/{switchNameOrIP}/nategressifmaps

Request:

Changed content type : application/json

GET /appcenter/cisco/ndfc/api/v1/pmn/switches/{switchNameOrIP}/natmodes

Return Type:

Changed response : 200 OK

Returns the NAT modes list. Example Body:

[{"id": NAT_MODE_ID,

"switchIp": "SWITCH_IP", "vrf": "VRF", "mode": "Ingress/Egress", "group":"MULTICAST_IP", "mask":MASK, "createdBy": "USER_NAME", "deploymentStatus": "DEPLOYMENT_STATUS", "deploymentAction": "DEPLOYMENT_ACTION", "deploymentFailedReason": "DEPLOYMENT_FAILED_REASON", "lastUpdatedTime": "LAST_UPDATED_TIMESTAMP", "lastUpdatedAsString": "LAST_UPDATED_TIME_AS_STRING"} ]

GET /appcenter/cisco/ndfc/api/v1/pmn/switches/{switchNameOrIP}/natrules

Return Type:

Changed response : 200 OK

Returns the NAT rules list. Example Body:

[{"id": NAT_RULE_DB_ID,

"switchIp": "SWITCH_IP", "vrf": "VRF", "mode": "Ingress/Egress or N/A", "preTranslationGroup":"PRE_TRANSLATION_GROUP", "postTranslationGroup":"POST_TRANSLATION_GROUP", "preTranslationSource":"PRE_TRANSLATION_SOURCE", "postTranslationSource":"POST_TRANSLATION_SOURCE", "groupMask":GROUP_MASK, "sourceMask":SOURCE_MASK, "sourcePort":POST_TRANSLATION_SOURCE_PORT, "destinationPort":POST_TRANSLATION_DESTINATION_PORT, "staticOif":STATIC_OIF, "createdBy": "USER_NAME", "deploymentStatus": "DEPLOYMENT_STATUS", "deploymentAction": "DEPLOYMENT_ACTION", "deploymentFailedReason": "DEPLOYMENT_FAILED_REASON", "lastUpdatedTime": "LAST_UPDATED_TIMESTAMP", "lastUpdatedAsString": "LAST_UPDATED_TIME_AS_STRING"} ]

GET /appcenter/cisco/ndfc/api/v1/pmn/switches/{switchNameOrIP}/vrfs/{vrf}/groups/{group}/masks/{mask}/modes/{mode}/natmodes

Return Type:

Changed response : 200 OK

Returns the NAT mode object. Example Body:

{"id": NAT_MODE_ID,

"switchIp": "SWITCH_IP", "vrf": "VRF", "mode": "Ingress/Egress", "group":"MULTICAST_IP", "mask":MASK, "createdBy": "USER_NAME", "deploymentStatus": "DEPLOYMENT_STATUS", "deploymentAction": "DEPLOYMENT_ACTION", "deploymentFailedReason": "DEPLOYMENT_FAILED_REASON", "lastUpdatedTime": "LAST_UPDATED_TIMESTAMP", "lastUpdatedAsString": "LAST_UPDATED_TIME_AS_STRING"}

GET /appcenter/cisco/ndfc/api/v1/pmn/switches/{switchNameOrIP}/vrfs/{vrf}/modes/{mode}/preTranslationGroups/{preTranslationGroup}/postTranslationGroups/{postTranslationGroup}/preTranslationSources/{preTranslationSource}/postTranslationSources/{postTranslationSource}/groupMasks/{groupMask}/sourceMasks/{sourceMask}/sourcePorts/{sourcePort}/destinationPorts/{destinationPort}/staticOifs/{staticOif}/natrules

Return Type:

Changed response : 200 OK

Returns the NAT Rule object. Example Body:

{"id": NAT_RULE_DB_ID,

"switchIp": "SWITCH_IP", "vrf": "VRF", "mode": "Ingress/Egress or N/A", "preTranslationGroup":"PRE_TRANSLATION_GROUP", "postTranslationGroup":"POST_TRANSLATION_GROUP", "preTranslationSource":"PRE_TRANSLATION_SOURCE", "postTranslationSource":"POST_TRANSLATION_SOURCE", "groupMask":GROUP_MASK, "sourceMask":SOURCE_MASK, "sourcePort":POST_TRANSLATION_SOURCE_PORT, "destinationPort":POST_TRANSLATION_DESTINATION_PORT, "staticOif":STATIC_OIF, "createdBy": "USER_NAME", "deploymentStatus": "DEPLOYMENT_STATUS", "deploymentAction": "DEPLOYMENT_ACTION", "deploymentFailedReason": "DEPLOYMENT_FAILED_REASON", "lastUpdatedTime": "LAST_UPDATED_TIMESTAMP", "lastUpdatedAsString": "LAST_UPDATED_TIME_AS_STRING"}

POST /appcenter/cisco/ndfc/api/v1/alarm/alarms/createinsightalarm

Return Type:

Changed response : 200 OK

OK

• New content type : application/json

• Deleted content type : application/JSON

POST /appcenter/cisco/ndfc/api/v1/configtemplate/rest/config/templates/template

Create Template

Parameters:

Changed: templateName in query

Name of the Template. Ex . Easy_Fabric_Classic

Request:

Complete Template contents. Example can be found at API description.

Changed content type : application/json

New required properties:

• content

• Deleted property templatename (string)

• Changed property content (string)

  Content of the Template.

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 400 Bad Request

Invalid message body

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/configtemplate/rest/config/templates/{templateName}

Get Template contents

Parameters:

Deleted: populate in query

Populate.

Changed: templateName in path

Name of the Template. Ex . Easy_Fabric_Classic

Return Type:

Changed response : 200 OK

Response body gives the Template contents

Changed response : 400 Bad Request

Invalid message body

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 500 Internal Server Error

Other exceptions

DELETE /appcenter/cisco/ndfc/api/v1/configtemplate/rest/config/templates/{templateName}

Delete Template

Parameters:

Changed: templateName in path

Name of the Template. Ex: Default_Network_Extension_Universal

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 400 Bad Request

Invalid message body

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 500 Internal Server Error

Other exceptions

PUT /appcenter/cisco/ndfc/api/v1/configtemplate/rest/config/templates/{templateName}

Modify Template

Parameters:

Changed: templateName in path

Name of the Template. Ex: Default_Network_Extension_Universal

Request:

Please check example for sample request.

Changed content type : application/json

New required properties:

• content

• Deleted property id (string)

• Changed property content (string)

  Content of the Template.

Return Type:

Changed response : 200 OK

Response body give the success

Changed response : 400 Bad Request

Invalid message body

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 500 Internal Server Error

Other exceptions

DELETE /appcenter/cisco/ndfc/api/v1/elastic-service/audit-logs

Parameters:

Added: change-control-ticket in query

Change control ticket

Return Type:

Changed response : 400 Bad Request

Invalid Fabric or request payload

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 200 OK

Audit logs with the matched criteria are deleted Successfully

• Deleted content type : application/json

GET /appcenter/cisco/ndfc/api/v1/elastic-service/audit-logs

Return Type:

Changed response : 400 Bad Request

Invalid Fabric or request payload

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 200 OK

Audit logs are retrieved Successfully

• Changed content type : application/json

  Changed items (object):

  • Added property changeControlTicket (string)

GET /appcenter/cisco/ndfc/api/v1/elastic-service/fabrics/{fabric-name}/service-nodes

Return Type:

Changed response : 400 Bad Request

Invalid Fabric or request payload

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

POST /appcenter/cisco/ndfc/api/v1/elastic-service/fabrics/{fabric-name}/service-nodes

Parameters:

Added: change-control-ticket in query

Change control ticket

Request:

Service node data

Return Type:

Changed response : 400 Bad Request

Invalid Fabric or request payload

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

DELETE /appcenter/cisco/ndfc/api/v1/elastic-service/fabrics/{fabric-name}/service-nodes/{node-name}

Parameters:

Added: change-control-ticket in query

Change control ticket

Return Type:

Changed response : 400 Bad Request

Invalid Fabric or request payload

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 200 OK

Service node is deleted Successfully

• Deleted content type : application/json

GET /appcenter/cisco/ndfc/api/v1/elastic-service/fabrics/{fabric-name}/service-nodes/{node-name}

Return Type:

Changed response : 400 Bad Request

Invalid Fabric or request payload

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

PUT /appcenter/cisco/ndfc/api/v1/elastic-service/fabrics/{fabric-name}/service-nodes/{node-name}

Parameters:

Added: change-control-ticket in query

Change control ticket

Request:

Service node data

Return Type:

Changed response : 400 Bad Request

Invalid Fabric or request payload

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

DELETE /appcenter/cisco/ndfc/api/v1/elastic-service/fabrics/{fabric-name}/service-nodes/{node-name}/peerings/{attached-fabric}/attachments

Parameters:

Added: change-control-ticket in query

Change control ticket

Return Type:

Changed response : 200 OK

VRF and service network are detached Successfully

• Deleted content type : application/json

Changed response : 400 Bad Request

Invalid Fabric or request payload

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

POST /appcenter/cisco/ndfc/api/v1/elastic-service/fabrics/{fabric-name}/service-nodes/{node-name}/peerings/{attached-fabric}/attachments

Parameters:

Added: change-control-ticket in query

Change control ticket

Request:

Names of the route peering

Changed content type : application/json

Return Type:

Changed response : 400 Bad Request

Invalid Fabric or request payload

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

POST /appcenter/cisco/ndfc/api/v1/elastic-service/fabrics/{fabric-name}/service-nodes/{node-name}/peerings/{attached-fabric}/deployments

Request:

Names of the route peering

Changed content type : application/json

DELETE /appcenter/cisco/ndfc/api/v1/elastic-service/fabrics/{fabric-name}/service-nodes/{node-name}/policies/{attached-fabric}/attachments

Parameters:

Added: change-control-ticket in query

Change control ticket

Return Type:

Changed response : 400 Bad Request

Invalid Fabric or request payload

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 200 OK

VRF and service network are attached Successfully

• Deleted content type : application/json

POST /appcenter/cisco/ndfc/api/v1/elastic-service/fabrics/{fabric-name}/service-nodes/{node-name}/policies/{attached-fabric}/attachments

Parameters:

Added: change-control-ticket in query

Change control ticket

Request:

Names of the serivce policies

Changed content type : application/json

Return Type:

Changed response : 400 Bad Request

Invalid Fabric or request payload

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

POST /appcenter/cisco/ndfc/api/v1/elastic-service/fabrics/{fabric-name}/service-nodes/{node-name}/policies/{attached-fabric}/deployments

Request:

Names of the serivce policies

Changed content type : application/json

Return Type:

Changed response : 400 Bad Request

Invalid Fabric or request payload

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

Changed response : 500 Internal Server Error

Other Exceptions

• Changed content type : application/json

  • Added property severity (string)

  • Added property detail (string)

  • Added property extra (string)

GET /appcenter/cisco/ndfc/api/v1/eplui/getHistoricDataDownload

Parameters:

Changed: status in query

Records to download

POST /appcenter/cisco/ndfc/api/v1/imagemanagement/imageupload/smart-image-upload

Upload Images

Request:

Changed content type : application/json

• Changed property file (string)

  Select the file to upload.

Return Type:

Changed response : 500 Internal Server Error

Other exceptions

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/poap/servers

Local Repositories

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/discovery/bootflash-discovery

Parameters:

Changed: serialNumber in query

Serial number of the Device. Ex: FDO2338082P

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/discovery/discovery

Rediscover Switch contents

Parameters:

Changed: serialNumber in query

Serial number of the Device. Ex: FDO2338082P

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/discovery/package-discovery

Parameters:

Changed: serialNumber in query

Serial number of the Device. Ex: FDO2338082P

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/imagehistory/history

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/imagehistory/history/{id}

History details

Parameters:

Changed: id in path

History Id. Ex: 35

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/imagemgnt/bootFlash/bootflash-info

Parameters:

Changed: serialNumber in query

Serial number of the Device. Ex: FDO23040Q5U

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/imagereports/get-report-name

Report name

Request:

Changed content type : application/json

New required properties:

• serialnumbers
• templatename

• Changed property serialnumbers (array)

  List of Switch serial numbers. Ex: [FDO2338082P, FDO2568028P]

  Changed items (string): > List of Switch serial numbers. Ex: [FDO2338082P, FDO2568028P]

• Changed property templatename (string)

  Name of the Template. Ex: issu_vpc_check

  Added enum value:

  • issu_vpc_check, custom_swift_issu

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/imageupload/scp-upload

Request:

Changed content type : application/json

New required properties:

• filePath
• password
• server
• userName

• Deleted property acceptHostkey (boolean)

• Changed property server (string)

  Host or IP address of the SCP/SFTP server. Ex: 10.127.112.36

• Changed property filePath (string)

  File path. Ex: /root/my/file/path/snmp-2.0.1.0-9.3.2.src.rpm

• Changed property userName (string)

  User name (Credential for accessing server) . Ex: myuser

• Changed property password (string)

  Password (Credential for accessing server) . Ex: mypassword

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/imageupload/uploaded-images-table

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/packagemgnt/getpackagelist

RPM/SMU Packages

Parameters:

Changed: fabric in query

Name of the Fabric. Ex: MyFabric

Changed: switchName in query

Filter with Host name. Ex: N9k-244-gx

Changed: nxosVersion in query

Filter with Release version. Ex: 9.3(7)

Changed: pkgName in query

Filter with RPM/SMU Package name. Ex: snmp-2.0.1.0-9.3.2.src.rpm

Changed: serialNumber in query

Filter with serial number of Device. Ex: FDO2338082P

Changed: pkgVersion in query

Filter with RPM/SMU release version. Ex: 10.2.2

Changed: pkgType in query

Filter with Package type (Base, nonBase or Patch). Ex: Base

Changed: pkgStatus in query

Filter with Package Status (Active or Inactive). Ex: Active

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/packagemgnt/issu

Parameters:

Changed: epld in query

EPLD. Ex: true or false

Changed: rpm in query

RPM Ex: true or false

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/packagemgnt/uploaded-packages

Parameters:

Changed: platform in query

Switch/Device platform. Ex: N9K

Changed: version in query

Release version of Switch/Device. Ex: 9.3(7)

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/packagemgnt/{fabricId}/issu

List the Device(s) for ISSU

Parameters:

Changed: fabricId in path

Fabric id. Ex: 2

Changed: epld in query

EPLD. Ex: true or false

Changed: rpm in query

RPM. Ex: true or false

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/attached-policies

Get attached Policies

Parameters:

Changed: serialNumber in query

Comma separated Switch serial numbers. Ex: FDO2338082P,FDO2338064F

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

DELETE /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/detach-policy

Detach Policy

Parameters:

Changed: serialNumber in query

Comma separated Switch serial numbers. Ex: FDO2338082P,FDO2338064F

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/edit-policy

Request:

Changed content type : application/json

New required properties:

• nxosVersion
• platform
• policyName
• policyType

• Changed property policyName (string)

  Name of the Policy. Ex: MyPolicy

• Changed property policyType (string)

  Type of the Policy Source. Ex: PLATFORM

• Changed property nxosVersion (string)

  64-bit System images, NXOS Version generated with combination of Image name, Release version and Image type of the Image. Ex: nxos64-cs.10.3.1.F.bin, NXOS Version: 10.3.1_nxos64-cs_64bit. Other System images, NXOS Version generated with combination of Image name and Release version of the Image. Ex: nxos-cs.10.3.1.F.bin, NXOS Version: 10.3.1_nxos-cs. For SMU's, NXOS Version is Release version. Ex: snmp-2.0.1.0-10.3.1.src.rpm, NXOS Version: 10.3.1

• Changed property packageName (string)

  Name of the Package. Ex: snmp-2.0.1.0-9.3.2.src.rpm

• Changed property platform (string)

  Platform of the Device. It can be - N9K, N7K, N77, N6K, N5K. Ex: N9K

• Changed property policyDescr (string)

  Description of the Policy. Ex: Policy notes

• Changed property epldImgName (string)

  EPLD Image name. Ex: n9000-epld.10.3.2.F.img

• Changed property rpmimages (string)

  RPM Image name. Ex: bgp-2.0.0.0-9.2.3.lib32_n9000

• Changed property agnostic (boolean)

  Agnostic (Independent of Images). Ex: false

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/edit-policy-get/{policyname}

Get Policy details

Parameters:

Changed: policyname in path

Name of the Policy. Ex: MyPolicy

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/epld/{platform}

EPLD Images

Parameters:

Changed: platform in path

Platform of the Switch. Ex: N9K

Return Type:

New response : 400 Bad Request

Invalid message body

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Response body give the success or failure message

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/image-policy/{policyname}

Policy details

Parameters:

Changed: policyname in path

Name of the Policy. Ex: MyPolicy

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/nxos/{platform}

NXOS version Images

Parameters:

Changed: platform in path

Platform of the Switch. It can be - N9K, N7K, N77, N6K, N5K. Ex: N5K

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/packages/{platform}

List Packages

Parameters:

Changed: platform in path

Platform of the Switch. It can be - N9K, N7K, N77, N6K, N5K. Ex: N7K

Changed: nxosversion in query

NXOS version of Image. Ex: 9.3.2

Changed: agnostic in query

Agnostic (Independent of versions). Ex: false

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/platform-policies

Get Platform Policies

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/platform-policy

Create Image Management Policy

Request:

Changed content type : application/json

New required properties:

• nxosVersion
• platform
• policyName
• policyType

• Changed property policyName (string)

  Name of the Policy. Ex: MyPolicy

• Changed property policyType (string)

  Type of the Policy Source. Ex: PLATFORM

• Changed property nxosVersion (string)

  64-bit System images, NXOS Version generated with combination of Image name, Release version and Image type of the Image. Ex: nxos64-cs.10.3.1.F.bin, NXOS Version: 10.3.1_nxos64-cs_64bit. Other System images, NXOS Version generated with combination of Image name and Release version of the Image. Ex: nxos-cs.10.3.1.F.bin, NXOS Version: 10.3.1_nxos-cs. For SMU's, NXOS Version is Release version. Ex: snmp-2.0.1.0-10.3.1.src.rpm, NXOS Version: 10.3.1

• Changed property packageName (string)

  Name of the Package. Ex: snmp-2.0.1.0-9.3.2.src.rpm

• Changed property platform (string)

  Platform of the Device. It can be - N9K, N7K, N77, N6K, N5K. Ex: N9K

• Changed property policyDescr (string)

  Description of the Policy. Ex: Policy notes

• Changed property epldImgName (string)

  EPLD Image name. Ex: n9000-epld.10.3.2.F.img

• Changed property rpmimages (string)

  RPM Image name. Ex: bgp-2.0.0.0-9.2.3.lib32_n9000

• Changed property agnostic (boolean)

  Agnostic (Independent of Images). Ex: false

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/platforms

Image Platforms

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Response body give the success or failure message

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/policies

List Policies

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

DELETE /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/policy

Delete Image Management Policy

Request:

Changed content type : application/json

• Changed property policyNames (array)

  Policy names. Ex: MyPolicy,MyImagePolicy Example payload in JSON: {"policyNames":["MyPolicy", "MyImagePolicy"]}

  Changed items (string): > Policy names. Ex: MyPolicy,MyImagePolicy > Example payload in JSON: {"policyNames":["MyPolicy", "MyImagePolicy"]}

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/policymgnt/recalculate-compliance

Image recompliance check

Parameters:

Changed: serialNumber in query

Serial number of the Switch. Ex: FDO2338082P

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/stagingmanagement/change-device-mode

Change Device mode

Request:

Changed content type : application/json

New required properties:

• deployLater
• deployNow
• mode
• serialList

• Changed property serialList (array)

  Serial number of the Device. Ex:["FDO2338082P", "FDO231212T6"]

  Changed items (string): > Serial number of the Device. Ex:["FDO2338082P", "FDO231212T6"]

• Changed property mode (string)

  Mode Type. Ex: Normal

• Changed property deployNow (boolean)

  Is deploy now. Ex: true

• Changed property deployLater (boolean)

  Is deploy later. Ex: false

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/stagingmanagement/change-group

Change Upgrade group

Request:

Changed content type : application/json

New required properties:

• created
• groupName
• serialnums

• Changed property serialnums (array)

  List of Switch serial numbers. Ex: FDO2338082P,FDO6745231P

  Changed items (string): > List of Switch serial numbers. Ex: FDO2338082P,FDO6745231P

• Changed property groupName (string)

  Name of the Group. Ex: allspines

• Changed property warningStatus (string)

  Warning status.

• Changed property created (boolean)

  Is created. Ex: true

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/stagingmanagement/create-group

Create Upgrade group

Request:

Changed content type : application/json

New required properties:

• groupName

• Changed property groupName (string)

  Name of the Group. Ex: allspines

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/stagingmanagement/groups

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/stagingmanagement/reason-description/{serialNumber}/{policyName}

Parameters:

Changed: serialNumber in path

Serial number of the Switch. Ex: FDO2338082P

Changed: policyName in path

Attached policy name. Ex: MyImagePolicy

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/stagingmanagement/stage-image

Request:

Changed content type : application/json

New required properties:

• serialNumbers

• Added property serialNumbers (array)

  List of Device serial numbers. Ex: ["FDO2338082P","FDO2765286P"]

  Items (string): > List of Device serial numbers. Ex: ["FDO2338082P","FDO2765286P"]

• Deleted property sereialNum (array)

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/imagemanagement/rest/stagingmanagement/validate-image

Request:

Changed content type : application/json

New required properties:

• nonDisruptive
• serialNum

• Changed property serialNum (array)

  Serial number of the Devices. Ex: ["FDO21332E6X","FDO21351QGE"]

  Changed items (string): > Serial number of the Devices. Ex: ["FDO21332E6X","FDO21351QGE"]

• Changed property nonDisruptive (string)

  Non Disruptive. Ex: true or false

Return Type:

Changed response : 200 OK

Response body give the success or failure message

Changed response : 401 Unauthorized

Unauthorized access to API

Changed response : 400 Bad Request

Invalid message body

Changed response : 500 Internal Server Error

Other exceptions

PUT /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/fabricfreezeMode

Update access mode of Fabric

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Request:

FreezeMode :If true, specified Fabric deploy option is disabled / freezed. If false, deployment is enabled / unfreezed. Ex: {"readOnly":false} or {"readOnly":true}

Changed content type : application/json

New required properties:

• readOnly

• Changed property readOnly (boolean)

  Freeze mode: If true, specified Fabric deploy option is disabled / freezed. If false, deployment is enabled / unfreezed

Return Type:

New response : 400 Bad Request

Invalid Fabric

New response : 401 Unauthorized

Invalid Fabric

New response : 500 Internal Server Error

Other exception

Changed response : 200 OK

Updated the accessmode of the Fabric

Changed response : 404 Not Found

Updating the accessMode failed to the Fabric

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/inventory/poap

List the bootstrap Device(s)

Parameters:

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Return Type:

New response : 200 OK

List all the bootstrap Device

New response : 401 Unauthorized

Unauthorized access to API

New response : 404 Not Found

Invalid Fabric

New response : 500 Internal Server Error

Other exception

Deleted response : **default **

successful operation

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/inventory/poap

Create POAP definition for the bootstrap Device(s)

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Request:

List of bootstrap device.

Changed content type : application/json

Changed items (object):

• Deleted property discoveryAuthProtocol (integer)

  Discovery AuthProtocol

• Deleted property publicKey (string)

  Public Key

• Deleted property fingerprint (string)

  Fingerprint

• Changed property serialNumber (string)

  Serial number of the Device. Ex: FDO23040Q85

• Changed property model (string)

  Model of the Device. Ex: N9K-C93180LC-EX

• Changed property version (string)

  OS version of the Device. Ex: 9.2(1)

• Changed property hostname (string)

  Hostname. Ex: MyHost

• Changed property ipAddress (string)

  IP Address. Ex: 10.10.10.1

• Changed property password (string)

  Password. Ex: MyPassword

• Changed property discoveryUsername (string)

  Discovery username. Ex: MyUser

• Changed property discoveryPassword (string)

  Discovery password. Ex: Discoverypassword

• Changed property data (string)

  Data. Ex: {"modulesModel": ["N9K-C93180LC-EX"], "gateway": "10.1.1.1/24","breakout": "interface breakout module 1 port 1-4 map 10g-4x","portMode": "hardware profile portmode 48x25G + 2x100G + 4x40G"}

• Changed property reAdd (boolean)

  reAdd. If Switch is already in the Fabric then reAdd = true else false. Ex. false

• Changed property imagePolicy (string)

  Image Policy. If image policy is passed in the request then it should be present in the image management.

• Changed property dhcpBootstrapIP (string)

  DHCP BootstrapIP. This is manadatory for inband POAP. Ex: 172.16.20.100

• Changed property role (string)

  Role. This is manadatory for inband POAP. Ex: Border Gateway

Return Type:

New response : 200 OK

Config is successfully generated for all the Device(s)

New response : 401 Unauthorized

Unauthorized access to API

New response : 404 Not Found

Invalid Fabric

New response : 500 Internal Server Error

Other exception

Deleted response : **default **

successful operation

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/rma

RMA change for Switch

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: fabricName in path

Name of the Fabric. Ex: MyFabric

Request:

RMA Device details. This has details of old and new Switches.

Changed content type : application/json

New required properties:

• discoveryPassword
• discoveryUsername
• hostname
• imagePolicy
• ipAddress
• model
• newSerialNumber
• oldSerialNumber
• password
• publicKey
• version

• Deleted property discoveryAuthProtocol (integer)

  Discovery AuthProtocol

• Deleted property fingerprint (string)

• Changed property oldSerialNumber (string)

  Old Switch serial Number. Ex: FDO20212311U

• Changed property newSerialNumber (string)

  New Switch serial Number. Ex: FDO12312356J

• Changed property model (string)

  Switch model. Ex: N7K

• Changed property version (string)

  Switch version. Ex: OS1

• Changed property hostname (string)

  Name of the Host. Ex: MyHost

• Changed property ipAddress (string)

  IP Address. Ex: 10.10.10.1

• Changed property publicKey (string)

  User public key used for encrypting the data. Ex: MyPublicKey

• Changed property imagePolicy (string)

  Image Policy. Ex: MyImagePolicy

• Changed property password (string)

  Password. Ex: password

• Changed property discoveryUsername (string)

  Discovery Username. Ex: MyUserName

• Changed property discoveryPassword (string)

  Discovery Password. Ex: MyPassword

• Changed property data (string)

  Data. Ex: {"modulesModel": ["N9K-C93180LC-EX"], "gateway": "10.1.1.1/24","breakout": "interface breakout module 1 port 1-4 map 10g-4x","portMode": "hardware profile portmode 48x25G + 2x100G + 4x40G"}'

• Changed property reAdd (boolean)

  reAdd. Ex: false

Return Type:

New response : 200 OK

Successfully done RMA for the Switch

New response : 401 Unauthorized

Unauthorized access to API

New response : 500 Internal Server Error

Failed to do RMA for the Switch

Deleted response : **default **

successful operation

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/links

List all the Links

Parameters:

Changed: switch1Sn in query

Serial number of the 1st Switch. Ex: SAL2008ZAXX

Changed: switch1IfName in query

Interface name of the 1st Switch. Ex: Ethernet1/2

Changed: switch2Sn in query

Serial number of the 2nd Switch. Ex: SAL2007ZAXX

Changed: switch2IfName in query

Interface name of the 2nd Switch. Ex: Ethernet1/6

Return Type:

New response : 400 Bad Request

Failed to get the Links

Changed response : 200 OK

It will return all the Links

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/links

Create Link

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Request:

Link creation request.

Changed content type : application/json

New required properties:

• destinationDevice
• destinationFabric
• destinationInterface
• destinationSwitchName
• linkType
• nvPairs
• sourceDevice
• sourceFabric
• sourceInterface
• sourceSwitchName
• templateName

• Changed property linkUUID (string)

  LinkUUID number of the Device.
  This field is manadatory only at the time of edit Link. Ex: LINK-UUID-12345

• Changed property linkType (string)

  Type of the Link. Ex: Intra-Fabric or Inter-Fabric

• Changed property sourceFabric (string)

  Name of the source Fabric. Ex: MyFabric1

• Changed property destinationFabric (string)

  Name of the destination Fabric. Ex: MyFabric1

• Changed property sourceDevice (string)

  Serial number of the source Switch. Ex: FDO21351QGE

• Changed property destinationDevice (string)

  Serial number of the destination Switch. Ex: FOC2326364P

• Changed property sourceSwitchName (string)

  Name of the source Device. Ex: mini-spine1

• Changed property destinationSwitchName (string)

  Name of the destination Device. Ex: n3k-82

• Changed property sourceInterface (string)

  Name of the source Interface. Ex: Ethernet1/15/3

• Changed property destinationInterface (string)

  Name of the destination Interface. Ex: Ethernet1/47

• Changed property templateName (string)

  Template names for Intra-Fabric: int_intra_fabric_ipv6_link_local, int_intra_fabric_num_link,
  int_intra_fabric_unnum_link, int_intra_vpc_peer_keep_alive_link,
  int_pre_provision_intra_fabric_link, ios_xe_int_intra_fabric_num_link
  Inter-Fabric: ext_fabric_setup

• Changed property nvPairs (object)

  It is the name-value pair data which depends on the template selected for creating Links.
  Example of 'int_intra_fabric_num_link' name-value pair(s):
  {"PEER1_IP":"10.4.0.61","PEER2_IP":"10.4.0.62","PEER1_V6IP":"","PEER2_V6IP":""......}

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Link creation successful

Changed response : 500 Internal Server Error

Other exceptions

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/links/{linkUUID}

Get the Link for linkUUID

Parameters:

Changed: linkUUID in path

LinkUUID number of the Device. Ex: LINK-UUID-12345

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

It will return the Link for the linkUUID

Changed response : 500 Internal Server Error

Other exceptions

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/links/{linkUUID}

Delete Link

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: linkUUID in path

LinkUUID number of the Device. Ex: LINK-UUID-12345

Changed: isLogicalLink in query

Is the Link is a logical Link, if yes, pass true, else pass false. Ex: false

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Link deletion successful

Changed response : 404 Not Found

Link does not exist

Changed response : 500 Internal Server Error

Other exceptions

PUT /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/links/{linkUUID}

Update Link

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: linkUUID in path

LinkUUID number of the Device. Ex: LINK-UUID-12345

Request:

Update Link request.

Changed content type : application/json

New required properties:

• destinationDevice
• destinationFabric
• destinationInterface
• destinationSwitchName
• linkType
• nvPairs
• sourceDevice
• sourceFabric
• sourceInterface
• sourceSwitchName
• templateName

• Changed property linkUUID (string)

  LinkUUID number of the Device.
  This field is manadatory only at the time of edit Link. Ex: LINK-UUID-12345

• Changed property linkType (string)

  Type of the Link. Ex: Intra-Fabric or Inter-Fabric

• Changed property sourceFabric (string)

  Name of the source Fabric. Ex: MyFabric1

• Changed property destinationFabric (string)

  Name of the destination Fabric. Ex: MyFabric1

• Changed property sourceDevice (string)

  Serial number of the source Switch. Ex: FDO21351QGE

• Changed property destinationDevice (string)

  Serial number of the destination Switch. Ex: FOC2326364P

• Changed property sourceSwitchName (string)

  Name of the source Device. Ex: mini-spine1

• Changed property destinationSwitchName (string)

  Name of the destination Device. Ex: n3k-82

• Changed property sourceInterface (string)

  Name of the source Interface. Ex: Ethernet1/15/3

• Changed property destinationInterface (string)

  Name of the destination Interface. Ex: Ethernet1/47

• Changed property templateName (string)

  Template names for Intra-Fabric: int_intra_fabric_ipv6_link_local, int_intra_fabric_num_link,
  int_intra_fabric_unnum_link, int_intra_vpc_peer_keep_alive_link,
  int_pre_provision_intra_fabric_link, ios_xe_int_intra_fabric_num_link
  Inter-Fabric: ext_fabric_setup

• Changed property nvPairs (object)

  It is the name-value pair data which depends on the template selected for creating Links.
  Example of 'int_intra_fabric_num_link' name-value pair(s):
  {"PEER1_IP":"10.4.0.61","PEER2_IP":"10.4.0.62","PEER1_V6IP":"","PEER2_V6IP":""......}

Return Type:

New response : 401 Unauthorized

Unauthorized access to API

Changed response : 200 OK

Link update successful

Changed response : 400 Bad Request

Invalid details

Changed response : 500 Internal Server Error

Other exceptions

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies

Create a Policy

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Request:

Changed content type : application/json

• Deleted property id (integer)

• Deleted property generatedConfig (string)

• Deleted property status (string)

• Deleted property statusOn (string)

• Deleted property createdOn (string)

• Deleted property modifiedOn (string)

• Deleted property sortIndex (integer)

• Deleted property hierarchicalKey (string)

• Changed property policyId (string)

  Id of the Policy. Ex: POLICY-28270

• Changed property description (string)

  Description of the Policy. Ex: Policy description

• Changed property serialNumber (string)

  Serial number of the Switch. Ex: FDO21332E6X

• Changed property switchName (string)

  Name of the Switch. Ex: Swich-88

• Changed property ipAddress (string)

  IP address of the Switch. Ex: 172.23.244.85

• Changed property entityType (string)

  Type of the Entity. Ex: INTERFACE

  Added enum values:

  • INTERFACE
  • SWITCH
  • Config_Profile

• Changed property entityName (string)

  Name of the Entity. Ex: Ethernet1/15

• Changed property templateName (string)

  Name of the Template. Ex: Ext_VRF_Lite_Routed

• Changed property templateContentType (string)

  Template Content Type. Ex: TEMPLATE_CLI

• Changed property nvPairs (object)

  It is the Name Value Pair data which depends on the template selected for creating links. Ex: {IF_NAME: "eth1", VRF_NAME: "", IP_MASK: "4.4.4.4/24",....}

• Changed property autoGenerated (boolean)

  If autoGenerated is true then the policy is auto generated else the policy is created by user manually. Ex: false

• Changed property deleted (boolean)

  If deleted is false then the Policy is active else the Policy is marked for deletion and the Policy will be deleted in next CC cycle after the related configuration clis are removed from the Switch. Ex: false

• Changed property source (string)

  Source of the Policy. Source can be UNDERLAY, OVERLAY, LINK, Ethernet1/15, loopback0, LINK-UUID-202000,.... Ex: UNDERLAY

• Changed property priority (integer)

  Priority of the Policy. Ex: 452

• Changed property secondaryEntityType (string)

  Type of the secondary Entity. Ex: Config_Profile

  Added enum values:

  • INTERFACE
  • SWITCH
  • Config_Profile

• Changed property secondaryEntityName (string)

  Name of the secondary Entity. Ex: MyNetwork_30000

Return Type:

New response : 200 OK

Policy created successfully

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/switches

List Policies for multiple Switches

Parameters:

Changed: serialNumber in query

Switch serial numbers separated by comma. Ex: FDO21332E6X,FDO21332F8Y

Changed: source in query

Source of the Policy. Source can be UNDERLAY, OVERLAY, LINK, Ethernet1/15, loopback0, LINK-UUID-202000,.... Ex: UNDERLAY

Changed: responseType in query

Type of the response. Ex: TSV (Tab Separated Values)

Return Type:

New response : 200 OK

Successfully listed the Policies of given Switches

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/switches

Delete Policies of given Source in all Switches

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: serialNumbers in query

Switch serial numbers separated by comma. Ex: FDO21332E6X, FDO21332F8Y

Changed: source in query

Source of the Policy. Source can be UNDERLAY, OVERLAY, LINK, Ethernet1/15, loopback0, LINK-UUID-202000,.... Ex: OVERLAY

Return Type:

New response : 200 OK

Successfully deleted the Policies for given source in all Switches

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

PUT /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/switches

Update Policies of given Source in all Swithes

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: serialNumbers in query

Switch serial numbers separated by comma. Ex: FDO21332E6X, FDO21332F8Y

Changed: source in query

Source of the Policy. Source can be UNDERLAY, OVERLAY, LINK, Ethernet1/15, loopback0, LINK-UUID-202000,.... Ex: UNDERLAY

Request:

Changed content type : application/json

• Deleted property id (integer)

• Deleted property generatedConfig (string)

• Deleted property status (string)

• Deleted property statusOn (string)

• Deleted property createdOn (string)

• Deleted property modifiedOn (string)

• Deleted property sortIndex (integer)

• Deleted property hierarchicalKey (string)

• Changed property policyId (string)

  Id of the Policy. Ex: POLICY-28270

• Changed property description (string)

  Description of the Policy. Ex: Policy description

• Changed property serialNumber (string)

  Serial number of the Switch. Ex: FDO21332E6X

• Changed property switchName (string)

  Name of the Switch. Ex: Swich-88

• Changed property ipAddress (string)

  IP address of the Switch. Ex: 172.23.244.85

• Changed property entityType (string)

  Type of the Entity. Ex: INTERFACE

  Added enum values:

  • INTERFACE
  • SWITCH
  • Config_Profile

• Changed property entityName (string)

  Name of the Entity. Ex: Ethernet1/15

• Changed property templateName (string)

  Name of the Template. Ex: Ext_VRF_Lite_Routed

• Changed property templateContentType (string)

  Template Content Type. Ex: TEMPLATE_CLI

• Changed property nvPairs (object)

  It is the Name Value Pair data which depends on the template selected for creating links. Ex: {IF_NAME: "eth1", VRF_NAME: "", IP_MASK: "4.4.4.4/24",....}

• Changed property autoGenerated (boolean)

  If autoGenerated is true then the policy is auto generated else the policy is created by user manually. Ex: false

• Changed property deleted (boolean)

  If deleted is false then the Policy is active else the Policy is marked for deletion and the Policy will be deleted in next CC cycle after the related configuration clis are removed from the Switch. Ex: false

• Changed property source (string)

  Source of the Policy. Source can be UNDERLAY, OVERLAY, LINK, Ethernet1/15, loopback0, LINK-UUID-202000,.... Ex: UNDERLAY

• Changed property priority (integer)

  Priority of the Policy. Ex: 452

• Changed property secondaryEntityType (string)

  Type of the secondary Entity. Ex: Config_Profile

  Added enum values:

  • INTERFACE
  • SWITCH
  • Config_Profile

• Changed property secondaryEntityName (string)

  Name of the secondary Entity. Ex: MyNetwork_30000

Return Type:

New response : 200 OK

Successfully updated the Policies of given source in all Swithes

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

POST /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/switches

Bulk Policy create for the given Switches & Source

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: serialNumbers in query

Switch serial numbers separated by comma. Ex: FDO21332E6X,FDO21332F8Y

Changed: source in query

Source of the Policy. Source can be UNDERLAY, OVERLAY, LINK, Ethernet1/15, loopback0, LINK-UUID-202000,.... Ex: UNDERLAY

Request:

Changed content type : application/json

• Deleted property id (integer)

• Deleted property generatedConfig (string)

• Deleted property status (string)

• Deleted property statusOn (string)

• Deleted property createdOn (string)

• Deleted property modifiedOn (string)

• Deleted property sortIndex (integer)

• Deleted property hierarchicalKey (string)

• Changed property policyId (string)

  Id of the Policy. Ex: POLICY-28270

• Changed property description (string)

  Description of the Policy. Ex: Policy description

• Changed property serialNumber (string)

  Serial number of the Switch. Ex: FDO21332E6X

• Changed property switchName (string)

  Name of the Switch. Ex: Swich-88

• Changed property ipAddress (string)

  IP address of the Switch. Ex: 172.23.244.85

• Changed property entityType (string)

  Type of the Entity. Ex: INTERFACE

  Added enum values:

  • INTERFACE
  • SWITCH
  • Config_Profile

• Changed property entityName (string)

  Name of the Entity. Ex: Ethernet1/15

• Changed property templateName (string)

  Name of the Template. Ex: Ext_VRF_Lite_Routed

• Changed property templateContentType (string)

  Template Content Type. Ex: TEMPLATE_CLI

• Changed property nvPairs (object)

  It is the Name Value Pair data which depends on the template selected for creating links. Ex: {IF_NAME: "eth1", VRF_NAME: "", IP_MASK: "4.4.4.4/24",....}

• Changed property autoGenerated (boolean)

  If autoGenerated is true then the policy is auto generated else the policy is created by user manually. Ex: false

• Changed property deleted (boolean)

  If deleted is false then the Policy is active else the Policy is marked for deletion and the Policy will be deleted in next CC cycle after the related configuration clis are removed from the Switch. Ex: false

• Changed property source (string)

  Source of the Policy. Source can be UNDERLAY, OVERLAY, LINK, Ethernet1/15, loopback0, LINK-UUID-202000,.... Ex: UNDERLAY

• Changed property priority (integer)

  Priority of the Policy. Ex: 452

• Changed property secondaryEntityType (string)

  Type of the secondary Entity. Ex: Config_Profile

  Added enum values:

  • INTERFACE
  • SWITCH
  • Config_Profile

• Changed property secondaryEntityName (string)

  Name of the secondary Entity. Ex: MyNetwork_30000

Return Type:

New response : 200 OK

Policies created successfully

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

PUT /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/{policyIds}/bulk

Update Policy in bulk

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: policyIds in path

Policy Ids separated by comma. Ex: POLICY-28270, POLICY-48480

Request:

Changed content type : application/json

Changed items (object):

• Deleted property id (integer)

• Deleted property generatedConfig (string)

• Deleted property status (string)

• Deleted property statusOn (string)

• Deleted property createdOn (string)

• Deleted property modifiedOn (string)

• Deleted property sortIndex (integer)

• Deleted property hierarchicalKey (string)

• Changed property policyId (string)

  Id of the Policy. Ex: POLICY-28270

• Changed property description (string)

  Description of the Policy. Ex: Policy description

• Changed property serialNumber (string)

  Serial number of the Switch. Ex: FDO21332E6X

• Changed property switchName (string)

  Name of the Switch. Ex: Swich-88

• Changed property ipAddress (string)

  IP address of the Switch. Ex: 172.23.244.85

• Changed property entityType (string)

  Type of the Entity. Ex: INTERFACE

  Added enum values:

  • INTERFACE
  • SWITCH
  • Config_Profile

• Changed property entityName (string)

  Name of the Entity. Ex: Ethernet1/15

• Changed property templateName (string)

  Name of the Template. Ex: Ext_VRF_Lite_Routed

• Changed property templateContentType (string)

  Template Content Type. Ex: TEMPLATE_CLI

• Changed property nvPairs (object)

  It is the Name Value Pair data which depends on the template selected for creating links. Ex: {IF_NAME: "eth1", VRF_NAME: "", IP_MASK: "4.4.4.4/24",....}

• Changed property autoGenerated (boolean)

  If autoGenerated is true then the policy is auto generated else the policy is created by user manually. Ex: false

• Changed property deleted (boolean)

  If deleted is false then the Policy is active else the Policy is marked for deletion and the Policy will be deleted in next CC cycle after the related configuration clis are removed from the Switch. Ex: false

• Changed property source (string)

  Source of the Policy. Source can be UNDERLAY, OVERLAY, LINK, Ethernet1/15, loopback0, LINK-UUID-202000,.... Ex: UNDERLAY

• Changed property priority (integer)

  Priority of the Policy. Ex: 452

• Changed property secondaryEntityType (string)

  Type of the secondary Entity. Ex: Config_Profile

  Added enum values:

  • INTERFACE
  • SWITCH
  • Config_Profile

• Changed property secondaryEntityName (string)

  Name of the secondary Entity. Ex: MyNetwork_30000

Return Type:

New response : 200 OK

Policies updated successfully

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/{policyId}

Get Policy

Parameters:

Changed: policyId in path

Id of the Policy. Ex: POLICY-15910

Return Type:

New response : 200 OK

Successfully listed the Policy details

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

DELETE /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/{policyId}

Delete Policy

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: policyId in path

Id of the Policy. Ex: POLICY-41010

Return Type:

New response : 200 OK

Successfully deleted the Policy for given Policy id

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

PUT /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/{policyId}

Update Policy

Parameters:

Added: ticketId in query

Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234

Changed: policyId in path

Id of the Policy. Ex: POLICY-28270

Request:

Changed content type : application/json

• Deleted property id (integer)

• Deleted property generatedConfig (string)

• Deleted property status (string)

• Deleted property statusOn (string)

• Deleted property createdOn (string)

• Deleted property modifiedOn (string)

• Deleted property sortIndex (integer)

• Deleted property hierarchicalKey (string)

• Changed property policyId (string)

  Id of the Policy. Ex: POLICY-28270

• Changed property description (string)

  Description of the Policy. Ex: Policy description

• Changed property serialNumber (string)

  Serial number of the Switch. Ex: FDO21332E6X

• Changed property switchName (string)

  Name of the Switch. Ex: Swich-88

• Changed property ipAddress (string)

  IP address of the Switch. Ex: 172.23.244.85

• Changed property entityType (string)

  Type of the Entity. Ex: INTERFACE

  Added enum values:

  • INTERFACE
  • SWITCH
  • Config_Profile

• Changed property entityName (string)

  Name of the Entity. Ex: Ethernet1/15

• Changed property templateName (string)

  Name of the Template. Ex: Ext_VRF_Lite_Routed

• Changed property templateContentType (string)

  Template Content Type. Ex: TEMPLATE_CLI

• Changed property nvPairs (object)

  It is the Name Value Pair data which depends on the template selected for creating links. Ex: {IF_NAME: "eth1", VRF_NAME: "", IP_MASK: "4.4.4.4/24",....}

• Changed property autoGenerated (boolean)

  If autoGenerated is true then the policy is auto generated else the policy is created by user manually. Ex: false

• Changed property deleted (boolean)

  If deleted is false then the Policy is active else the Policy is marked for deletion and the Policy will be deleted in next CC cycle after the related configuration clis are removed from the Switch. Ex: false

• Changed property source (string)

  Source of the Policy. Source can be UNDERLAY, OVERLAY, LINK, Ethernet1/15, loopback0, LINK-UUID-202000,.... Ex: UNDERLAY

• Changed property priority (integer)

  Priority of the Policy. Ex: 452

• Changed property secondaryEntityType (string)

  Type of the secondary Entity. Ex: Config_Profile

  Added enum values:

  • INTERFACE
  • SWITCH
  • Config_Profile

• Changed property secondaryEntityName (string)

  Name of the secondary Entity. Ex: MyNetwork_30000

Return Type:

New response : 200 OK

Policy updated successfully

New response : 401 Unauthorized

Unauthorized access

New response : 500 Internal Server Error

Other exceptions

Deleted response : **default **

successful operation

GET /appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/switches/roles

List the role of all (or) given Switches