Inventory

The following are the Inventory REST APIs:

Status

The following table details the API Response code, status and, the HTTPS methods.

Status Code
Status
API's HTTPS Method or
HTTPS Method

200

OK

GET

202

Accepted

POST

PUT

DELETE

400

Bad Request

GET

POST

PUT

DELETE

401

Unauthorized

GET

POST

PUT

DELETE

403

Forbidden

GET

POST

PUT

DELETE

404

Not Found

GET

POST

PUT

DELETE

405

Method Not Allowed

GET

POST

PUT

DELETE

500

Internal Server Error

GET

POST

PUT

DELETE

Get Fabrics

Resource Name

/san/getFabricWithSnmpCredentail_fromDB

Description

Enables to discover fabrics.

https Method

GET

URL

https://dcnm-ip/fm/fmrest/san/getFabricWithSnmpCredentail_fromDB

Parameter

Parameter
Type
Description

NA

NA

NA

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

Rst.toJSONString()

A

Array of DBEntryDO Objects

Get Switches

Resource Name

/inventory/switches

Description

Get all discovered SAN switches

https Method

GET

URL

https://dcnm-ip/fm/fmrest/inventory/switches

Parameter

Parameter
Type
Description

NA

NA

NA

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

ServerResponse

Array of SwitchDO objects

Get all End Ports

Resource Name

/inventory/endports

Description

Get all end ports

https Method

GET

URL

https://dcnm-ip/fm/fmrest/statistics/endports

Parameter

Parameter
Type
Description

NA

NA

NA

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

ServerResponse

List of all EndPortDO objects

Get all End Ports Performance

Resource Name

/statistics/endportStat

Description

Get all end ports counters

https Method

GET

URL

https://dcnm-ip/fm/fmrest/statistics/endportStat

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

ServerResponse

List of all StatisticsDataDO objects

Get all San Ethernet Ports

Resource Name

/statistics/SanGigEStat

Description

Get all Ethernet ports under SAN

https Method

GET

URL

https://dcnm-ip/fm/fmrest/statistics/SanGigEStat

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

ServerResponse

List of all StatisticsDataDO objects

Get San Isls

Resource Name

/statistics/sanIslStat

Description

Get all Isls

https Method

GET

URL

https://dcnm-ip/fm/fmrest/statistics/sanIslStat

Parameter

Parameter
Type
Description

NA

NA

NA

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

ServerResponse

List of all StatisticsDataDO objects

Get Modules

Resource Name

/inventory/modules

Description

Get all modules

https Method

GET

URL

https://dcnm-ip/fm/fmrest/inventory/modules

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

ServerResponse

List of all DBEntryDO objects

Get VSANs

Resource Name

/inventory/vsans

Description

Get all VSANs.

https Method

GET

URL

https://dcnm-ip/fm/fmrest/inventory/vsans

Parameter

Parameter
Type
Description

NA

NA

NA

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

ServerResponse

List of all VsanDO Objects

Get Licenses

Resource Name

/inventory/licenses

Description

Enables you to get all licenses

https Method

GET

URL

https://dcnm-ip/fm/fmrest/inventory/licenses

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

License

A

List of all License Objects

Get Host/Storage Enclosed List

Resource Name

/statistics/portGroupStat

Description

Get the Host's enclosure List or Storage Enclosure list

https Method

GET

URL

https://dcnm-ip/fm/fmrest/statistics/portGroupStat

Parameter

Parameter
Type
Description

type

string

Type of the object

Host: type=Host%20Enclosures

Storage: type=Storage%20Enclosures

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

ServerResponse

List of StatisticsDataDO objects

Get Port Groups

Resource Name

/statistics/portGroupStat

Description

Get the group groups

https Method

GET

URL

https://dcnm-ip/fm/fmrest/statistics/portGroupStat

Parameter

Parameter
Type
Description

type

string

Type of the object

type=Port%20Groups

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

ServerResponse

List of StatisticsDataDO objects

Get Regular Zones

Resource Name

/inventory/zones

Description

Get the regular zones

https Method

GET

URL

https://dcnm-ip/fm/fmrest/inventory/zones

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

ServerResponse

List of ZoneDO objects

Get all Lan ISL

Resource Name

/statistics/lanIslstat

Description

Get all ISLs under LAN

https Method

GET

URL

https://dcnm-ip/fm/fmrest/statistics/lanIslstat

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

ServerResponse

List of all StatisticsDataDO objects

Get all LAN Ethernet Ports

Resource Name

/statistics/LanEthernetStat

Description

Get all Ethernet ports under LAN

https Method

GET

URL

https://dcnm-ip/fm/fmrest/statistics/LanEthernetStat

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

ServerResponse

List of StatisticsDataDO objects

Get LAN Devices

Resource Name

/san/getEthSwitchAll

Description

Enables you to discover LAN devices

https Method

GET

URL

https://dcnm-ip/fm/fmrest/san/getEthSwitchAll

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

string

DBEntryDO.toJSONString()

Get Storage Providers

Resource Name

/storage/getSmisProviders

Description

Get all discovered SMIS Storage providers

https Method

GET

URL

https://dcnm-ip/fm/fmrest/storage/getSmisProviders

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

Rst

string

SMISProviderListDO.toJSONString(),

SMISProvderListDO object which is an array of SMISProviderDO.

SMISProviderDO is

dbId:long;

provId:int;

fmServer:String;

ns:String;

interopns:String;

url:String;

username:String;

port:int;

secure:boolean;

vendor:String;

select:String;

status:String;

managedstatus:String;

lastUpdated:String;

version:String;

Get Storage Providers worker status

Resource Name

/storage/getWorkerStatus

Description

Get all discovered SMIS Storage worker status

https Method

GET

URL

https://dcnm-ip/fm/fmrest/storage/getWorkerStatus

Parameter

Parameter
Type
Description

smisWorker

SMISProviderWorkerDO

A array of SMIS provider.

SMISProviderWorkerDO -

providerList:SMISProviderDO[],

password:String,

fmserver:String.

Note SMISProviderDO is

dbId:long;

provId:int;

fmServer:String;

ns:String;

interopns:String;

url:String;

username:String;

port:int;

secure:boolean;

vendor:String;

select:String;

status:String;

managedstatus:String;

lastUpdated:String;

version:String;

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

Rst.toJSONString()

string

SMISProviderListDO.toJSONString(),

SMISProvderListDO object which is an array of SMISProviderDO.

SMISProviderDO is

dbId:long;

provId:int;

fmServer:String;

ns:String;

interopns:String;

url:String;

username:String;

port:int;

secure:boolean;

vendor:String;

select:String;

status:String;

managedstatus:String;

lastUpdated:String;

version:String;

Get Virtual Centers

Resource Name

/san/getVirtualCenters

Description

Get all discovered Virtual Centers

https Method

GET

URL

https://dcnm-ip/fm/fmrest/san/getVirtualCenters

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

string

DBEntryDO.toJSONString()

Get FC Flows

Resource Name

/Statistics/fcflowsStat

Description

Get the FC Flows.

https Method

GET

URL

https://dcnm-ip/fm/rest/Statistics/portGroupStat

Parameter

Parameter
Type
Description

type

String

Type for Port Groups

type=Port Groups

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

 

ServerResponse

List of StatisticsDataDO objects