Cisco DCNM REST API Guide, Release 10.1(x)

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

send

string

Seed switch for discovery

isV3

string

Is snmp V3: "true" or "false"

username

string

Snmp user name if v3, ignored if v2

password

string

Snmp v3 password or ignored if v2

v3protocol

string

Snmp v3 protocol

V3 MD5 only = "0"

V3 SHA only = "1"

V3 MD5_DES = "2"

V3 MD5_AES = "3"

V3 SHA_DES = "4"

V3 SHA_AES = "5"

community

string

Snmp v2 community string, ignored if snmp v3

inVsans

string

Included Vsan range for discovery.

exVsans

string

Excluded Vsan range for discovery.

globalEnableNpvDiscovery

string

Enable discovery to include NPV sw globally

"true" or "false"

ucsUsername

string

Ssh Username for UCS software, ignored if null or 0 length String

ucsPasswd

string

Ssh password for UCS sw, ignored if null or 0 length String

fmserver

string

Target DCNM server IP String where this fabric will be discovered by, this cannot be blank or null; even in the non-federation setup, the connected DCNM server IP string has to be provided.

CallResultDO

A

Result

CallResutlDO.getResultStatus() :

0 means success

Non-0 means failure and getResultMessage() will be the failure result

SeedIp

string

Seed switch for LAN CDP discovery by hops or switch ip list for LAN CDP discovery

"10.1.1.1" or "10.1.1.1-3"

isFWSM

string

Always "false"

isV3

string

Is snmp V3: "true" or "false"

username

string

Snmp user name if v3, ignored if v2

password

string

Snmp v3 password or ignored if v2

v3protocol

string

Snmp v3 protocol

V3 MD5 only = "0"

V3 SHA only = "1"

V3 MD5_DES = "2"

V3 MD5_AES = "3"

V3 SHA_DES = "4"

V3 SHA_AES = "5"

community

string

Snmp v2 community string, ignored if snmp v3

maxHop

string

Number of hops for LAN CDP Discovery if a single switch ip is provided in "seedIp" parameter, ignored if a switch list is provided in "seedIp" parameter

cdpTimeout

string

LAN CDP Discovery timeout, "3" for 3 sec and 3, 6, 9, 10, 20, 30 sec are provided on the GUI

rstDO

AdminShallowDiscoverNodeDO[]

Array of AdminShallowDiscoverNode Objects

Note for AdminShallowDiscoverNode-

reachable:boolean;

auth:boolean;

known:boolean;

valid:boolean;

selectable:boolean;

sysName:String;

ipaddr:String;

platform:String;

version:String;

lastChange:String;

hopCount:int;

deviceIndex:String;

statusReason:String;

SeedIp

string

switch ip list for LAN CDP discovery

"10.1.1.1" or "10.1.1.1-3"

Note: recommend picking the switch(s) from the output of /san/shallowLanDiscover where the node is reachable true and valid true

isFWSM

string

Always "false"

isV3

string

Is snmp V3: "true" or "false"

username

string

Snmp user name if v3, ignored if v2

password

string

Snmp v3 password or ignored if v2

v3protocol

string

Snmp v3 protocol

V3 MD5 only = "0"

V3 SHA only = "1"

V3 MD5_DES = "2"

V3 MD5_AES = "3"

V3 SHA_DES = "4"

V3 SHA_AES = "5"

community

string

Snmp v2 community string, ignored if snmp v3

maxHop

string

null

enablePwd

string

null

groupDbId

string

LAN Group DB Id, eg. "10" for 10

isDeepDiscovery

string

null

serverIpAddress

string

Target DCNM server IP String where this LAN device will be discovered by, this cannot be blank or null; even in the non-federation setup, the connected DCNM server IP string has to be provided.

isSingleDeviceTask

string

Always "true".

CallResultDO

A

Result

CallResutlDO.getResultStatus() :

0 means success

Non-0 means failure and getResultMessage() will be the failure result

smisWorker

SMISProviderWorkerDO

SMIS provider information

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;

CallResultDO

A

Result

CallResutlDO.getResultStatus() :

0 means success

Non-0 means failure and getResultMessage() will be the failure result

vcIP

string

Virtual Center Ip address

username

string

Virtual Center user name

password

string

Virtual Center password

serverIpaddress

string

Target DCNM server IP String where this Virtual Machine will be discovered by, this cannot be blank or null; even in the non-federation setup, the connected DCNM server IP string has to be provided.

CallResultDO

A

Result

CallResutlDO.getResultStatus() :

0 means success

Non-0 means failure and getResultMessage() will be the failure result