Operation
get /esmDiscovery/GetIsDiscoveryInProgress
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Boolean
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmDiscovery/GetIsSyncInProgress/{localTimeZoneOffset}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
localTimeZoneOffset | required | clientZoneOffset | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Boolean
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/esmDiscovery/GetIsSyncInProgress/{localTimeZoneOffset}
Produces
application/json
Example Response Data
true
External Docs
Operation
get /esmDiscovery/GetIsSyncOrDiscoveryInProgress/{localTimeZoneOffset}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
localTimeZoneOffset | required | clientZoneOffset | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Boolean
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
post /esmDiscovery/schedNetworkDiscovery
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | dataHolder | N_NetworkDiscoveryDataHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Lag Response Data Holder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<N_NetworkDiscoveryDataHolder> <reqId> <reqId>7</reqId> <clientName>testUser</clientName> </reqId> <scheduler> <jobName>NetworkDiscovery_Fri Jan 15 2016 13:45:35 IST</jobName> <jobDescription/> <username/> <trigger> <name>NetworkDiscovery_Fri Jan 15 2016 13:45:35 IST</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </N_NetworkDiscoveryDataHolder>
Produces
application/xml
Example Response Data
<N_NetworkDiscoveryRespHolder> <req> <clientName>testUser</clientName> <selectiveSyncViaPolling>false</selectiveSyncViaPolling> </req> <errorReason>null</errorReason> <errorCode>null</errorCode> <message>null</message> <cmdStatus>Success </cmdStatus> <opMsg>null</opMsg> <msgCode>NETWORK_DISCOVERY_SUCCESS_0001</msgCode> <parameters>null</parameters> <paramCount>0</paramCount> </N_NetworkDiscoveryRespHolder>
External Docs
ESMSchedulerDataModel
Name |
Type |
Description |
Enum |
---|---|---|---|
jobName | String string |
Job Name | --- |
jobDescription | String string |
Job description | --- |
username | String string |
User name | --- |
trigger | ESMSchedulerTriggerDataModel ESMSchedulerTriggerDataModel |
Job Trigger data model | --- |
Lag Response Data Holder
Name |
Type |
Description |
Enum |
---|---|---|---|
responseId | Response Header Model Response Header Model |
responseId | --- |
rsp | N_LagId N_LagId |
response | --- |
N_LagId
Name |
Type |
Description |
Enum |
---|---|---|---|
managementState | String string |
LAG management state | --- |
targetManagementState | String string |
--- | --- |
vsId | String string |
--- | --- |
lagId | String string |
Unique ID used to identify a LAG. | --- |
neName | String string |
NE name on which LAG is created. | --- |
packName | String string |
Pack name on the NE on which LAG is created. | --- |
adminState | String string |
Used to denote whether the LAG is active on NE or not. | --- |
lagSequence | Long long |
--- | --- |
jobTaskId | Long long |
--- | --- |
N_NetworkDiscoveryDataHolder
Name |
Type |
Description |
Enum |
---|---|---|---|
sessionId | String string |
--- | --- |
requestURI | String string |
--- | --- |
logReqId | String string |
--- | --- |
operator | String string |
--- | --- |
client | String string |
--- | --- |
reqId | EsmRequestHeaderMapper EsmRequestHeaderMapper |
--- | --- |
scheduler | ESMSchedulerDataModel ESMSchedulerDataModel |
--- | --- |
activate | Boolean boolean |
--- | --- |
Response Header Model
Name |
Type |
Description |
Enum |
---|---|---|---|
req | Request Header Request Header |
req | --- |
errorReason | String string |
errorReason | [Error reason] |
errorCode | String string |
--- | --- |
message | String string |
--- | --- |
cmdStatus | String string |
cmdStatus | [Success, Failure, Timed-Out, Unknown] |
opMsg | String string |
Operation message | --- |
msgCode | String string |
msgCode | [Message code] |
parameters | array[String] string |
--- | --- |
paramCount | Integer integer |
parameter count returned in the response | --- |
objectId | Integer integer |
Object Id | --- |
jobName | String string |
Job Name | --- |
objectType | Integer integer |
Job Object TYpe | --- |