Operation
post /esmService/policy/modifyPolicyRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | N_ServicePolicyInstHolderPostMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_PolicyInstResponseHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/policy/overridePolicyRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | PortPolicyServiceDataReqHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_PortPolicyIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/policy/planPolicyRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | N_PolicyInstHolderPostMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_PolicyInstResponseHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/policy/policyOverrideImpactOnService/{localTimeZoneOffset}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| localTimeZoneOffset | required | clientZoneOffset | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | N_PortPolicyIdMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
PortPolicyServiceDataRespHolderMapper
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/policy/portPolicyValidateRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | N_PortPolicyIdHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_PortPolicyIdRespHolderList
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/policy/scheduleDeployMultiPortPolicyRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | N_MultiPortPolicyInstHolderPostMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_MultiPortPolicyRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/policy/scheduleDeployPolicyRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | N_PolicyInstHolderPostMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_PolicyInstResponseHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
N_AccessEgressPolicy
Name |
Type |
Description |
Enum |
|---|---|---|---|
| policyType | String string |
--- | --- |
| additionalInfo | Object object |
--- | --- |
| accessEgressData | Object object |
--- | --- |
| queueData | array[N_QueueData] N_QueueData |
--- | --- |
| accessEgressFCData | array[N_FCData] N_FCData |
--- | --- |
| remarkingpolicyInstMapper | N_PolicyInstPostMapper N_PolicyInstPostMapper |
--- | --- |
| remarkingpolicyInst | N_PolicyInst N_PolicyInst |
--- | --- |
N_AccessIngressPolicy
Name |
Type |
Description |
Enum |
|---|---|---|---|
| policyType | String string |
--- | --- |
| additionalInfo | Object object |
--- | --- |
| changedParam | array[String] string |
--- | --- |
| accessIngresData | Object object |
--- | --- |
| accessIngressMatchCriterion | array[N_TrafficMatchData] N_TrafficMatchData |
--- | --- |
| accessIngressMeter | array[N_MeteringData] N_MeteringData |
--- | --- |
| accessCosMeter | array[N_CosMeterData] N_CosMeterData |
--- | --- |
N_EgressQueuePolicy
Name |
Type |
Description |
Enum |
|---|---|---|---|
| policyType | String string |
--- | --- |
| additionalInfo | Object object |
--- | --- |
| queueData | array[N_SlopingQueueData] N_SlopingQueueData |
--- | --- |
N_EthportMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| tpID | Integer integer |
--- | --- |
| mclagId | Integer integer |
--- | --- |
| endpointType | String string |
--- | --- |
| accessSVLANEnabled | Boolean boolean |
--- | --- |
| shgId | Long long |
--- | --- |
| shgName | String string |
--- | --- |
| neName | String string |
--- | --- |
| portName | String string |
--- | --- |
| accessCVLANEnabled | Boolean boolean |
--- | --- |
| accessSVLAN | String string |
--- | --- |
| vsId | Integer integer |
--- | --- |
| portType | String string |
--- | --- |
| hubAndSpoke | String string |
--- | --- |
| fragmentType | Integer integer |
--- | --- |
| accessCVLAN | String string |
--- | --- |
| portRole | String string |
--- | --- |
| shgDescription | String string |
--- | --- |
N_MultiPortPolicyInstHolderPostMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| reqId | RequestHeader RequestHeader |
--- | --- |
| resId | ResponseHeader ResponseHeader |
--- | --- |
| cmdStatus | String string |
--- | --- |
| message | String string |
--- | --- |
| req | N_MultiPortPolicyInstPostMapper N_MultiPortPolicyInstPostMapper |
--- | --- |
| scheduler | SchedReqMapper SchedReqMapper |
--- | --- |
| activate | Boolean boolean |
--- | --- |
N_MultiPortPolicyInstPostMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| policyID | Long long |
--- | --- |
| policyName | String string |
--- | --- |
| policyPath | String string |
--- | --- |
| policyDescription | String string |
--- | --- |
| bestPractice | Boolean boolean |
--- | --- |
| policyType | String string |
--- | --- |
| servicePolicyType | Integer integer |
--- | --- |
| portList | array[N_PortOrInterfaceData] N_PortOrInterfaceData |
--- | --- |
N_MultiPortPolicyRespHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| responseId | ResponseHeader ResponseHeader |
--- | --- |
N_NetworkEgressData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| networkEgressData | Object object |
--- | --- |
| remarkingpolicyInstMapper | N_PolicyInstPostMapper N_PolicyInstPostMapper |
--- | --- |
| remarkingpolicyInst | N_PolicyInst N_PolicyInst |
--- | --- |
| networkEgressFCData | array[N_FCData] N_FCData |
--- | --- |
N_NetworkIngressData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| networkIngressData | Object object |
--- | --- |
| changedParam | array[String] string |
--- | --- |
| mplsLspExpPolicyInstMapper | N_PolicyInstPostMapper N_PolicyInstPostMapper |
--- | --- |
| mplsLspExppolicyInst | N_PolicyInst N_PolicyInst |
--- | --- |
| networkIngressFCData | array[N_FCData] N_FCData |
--- | --- |
| networkIngressMeter | array[N_MeteringData] N_MeteringData |
--- | --- |
| networkCosMeter | array[N_CosMeterData] N_CosMeterData |
--- | --- |
N_NetworkQoSPolicy
Name |
Type |
Description |
Enum |
|---|---|---|---|
| policyType | String string |
--- | --- |
| additionalInfo | Object object |
--- | --- |
| networkIngressParams | N_NetworkIngressData N_NetworkIngressData |
--- | --- |
| networkEgressParams | N_NetworkEgressData N_NetworkEgressData |
--- | --- |
| changedParam | array[String] string |
--- | --- |
N_NetworkQueuePolicy
Name |
Type |
Description |
Enum |
|---|---|---|---|
| policyType | String string |
--- | --- |
| additionalInfo | Object object |
--- | --- |
| queueData | array[N_QueueData] N_QueueData |
--- | --- |
N_PolicyId
Name |
Type |
Description |
Enum |
|---|---|---|---|
| bestPractice | Boolean boolean |
--- | --- |
| templateType | Integer integer |
--- | --- |
| cirPirUnitReqd | Boolean boolean |
--- | --- |
| jobTaskId | Long long |
--- | --- |
| policyId | Long long |
--- | --- |
| policyName | String string |
--- | --- |
| policyScope | Integer integer |
--- | --- |
| policyType | String string |
--- | --- |
| nServiceHandle | String string |
--- | --- |
N_PolicyInst
Name |
Type |
Description |
Enum |
|---|---|---|---|
| oldPolicyId | Integer integer |
--- | --- |
| tpid | Integer integer |
--- | --- |
| cirPirAdminUnitReqd | Boolean boolean |
--- | --- |
| policyName | String string |
--- | --- |
| servicePolicyType | Integer integer |
--- | --- |
| author | String string |
--- | --- |
| policyScope | Integer integer |
--- | --- |
| policyList | array[N_AbstractPolicy] N_AbstractPolicy |
--- | --- |
| handle | Integer integer |
--- | --- |
| policyPath | String string |
--- | --- |
| policyDescription | String string |
--- | --- |
| bestPractice | Boolean boolean |
--- | --- |
| internalPolicy | Boolean boolean |
--- | --- |
| changedParams | array[String] string |
--- | --- |
| policyRecordType | Integer integer |
--- | --- |
| policyID | Long long |
--- | --- |
| policyType | String string |
--- | --- |
| additionalInfo | Object object |
--- | --- |
| state | String string |
--- | --- |
| interfaceId | Integer integer |
--- | --- |
| policyModified | Boolean boolean |
--- | --- |
| policyChanged | Boolean boolean |
--- | --- |
N_PolicyInstHolderPostMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| reqId | RequestHeader RequestHeader |
--- | --- |
| resId | ResponseHeader ResponseHeader |
--- | --- |
| cmdStatus | String string |
--- | --- |
| message | String string |
--- | --- |
| req | N_PolicyInstPostMapper N_PolicyInstPostMapper |
--- | --- |
| scheduler | SchedReqMapper SchedReqMapper |
--- | --- |
| activate | Boolean boolean |
--- | --- |
N_PolicyInstPostMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| policyID | Long long |
--- | --- |
| policyName | String string |
--- | --- |
| policyPath | String string |
--- | --- |
| policyDescription | String string |
--- | --- |
| bestPractice | Boolean boolean |
--- | --- |
| policyType | String string |
--- | --- |
| state | String string |
--- | --- |
| author | String string |
--- | --- |
| servicePolicyType | Integer integer |
--- | --- |
| tpid | Integer integer |
--- | --- |
| interfaceId | Integer integer |
--- | --- |
| tpNativeName | String string |
--- | --- |
| neName | String string |
--- | --- |
| interfaceName | String string |
--- | --- |
| accessIngressPolicy | N_AccessIngressPolicy N_AccessIngressPolicy |
--- | --- |
| accessEgressPolicy | N_AccessEgressPolicy N_AccessEgressPolicy |
--- | --- |
| networkQoSPolicy | N_NetworkQoSPolicy N_NetworkQoSPolicy |
--- | --- |
| networkQueuePolicy | N_NetworkQueuePolicy N_NetworkQueuePolicy |
--- | --- |
| egressPortSchedulerPolicy | N_EgressPortSchedulerPolicy N_EgressPortSchedulerPolicy |
--- | --- |
| egressQueueSlopingPolicy | N_EgressQueuePolicy N_EgressQueuePolicy |
--- | --- |
| remarkingPolicy | N_RemarkingPolicy N_RemarkingPolicy |
--- | --- |
| mplsLspExpData | N_MplsLspExpData N_MplsLspExpData |
--- | --- |
| additionalInfo | Object object |
--- | --- |
| policyModified | Boolean boolean |
--- | --- |
| policyChanged | Boolean boolean |
--- | --- |
N_PolicyInstResponseHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| reqId | ResponseHeader ResponseHeader |
--- | --- |
| message | String string |
--- | --- |
| res | N_PolicyInst N_PolicyInst |
--- | --- |
N_PortPolicydeployedIdMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| port | N_EthportMapper N_EthportMapper |
--- | --- |
| policyId | N_PolicyId N_PolicyId |
--- | --- |
| policyDeployed | N_PolicyId N_PolicyId |
--- | --- |
| activate | Boolean boolean |
--- | --- |
N_PortPolicyIdHolderMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| req | RequestHeader RequestHeader |
--- | --- |
| portQos | array[N_PortPolicyIdMapper] N_PortPolicyIdMapper |
--- | --- |
| activate | Boolean boolean |
--- | --- |
N_PortPolicyIdMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| port | N_EthportMapper N_EthportMapper |
--- | --- |
| policyId | N_PolicyId N_PolicyId |
--- | --- |
| activate | Boolean boolean |
--- | --- |
N_PortPolicyIdRespHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| resId | ResponseHeader ResponseHeader |
--- | --- |
| portPolicy | N_PortPolicyIdMapper N_PortPolicyIdMapper |
--- | --- |
N_PortPolicyIdRespHolderList
Name |
Type |
Description |
Enum |
|---|---|---|---|
| resId | ResponseHeader ResponseHeader |
--- | --- |
| response | array[N_PortPolicyIdMapper] N_PortPolicyIdMapper |
--- | --- |
N_ServicePolicyInstHolderPostMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| reqId | RequestHeader RequestHeader |
--- | --- |
| cmdStatus | String string |
--- | --- |
| req | N_PolicyInstPostMapper N_PolicyInstPostMapper |
--- | --- |
| nServiceIdPostMapper | N_ServiceIdPostMapper N_ServiceIdPostMapper |
--- | --- |
| activate | Boolean boolean |
--- | --- |
PortPolicyServiceDataReqHolderMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| req | RequestHeader RequestHeader |
--- | --- |
| portPolicy | N_PortPolicydeployedIdMapper N_PortPolicydeployedIdMapper |
--- | --- |
| svcMapperDataList | array[ServiceUIData] ServiceUIData |
--- | --- |
| activate | Boolean boolean |
--- | --- |
PortPolicyServiceDataRespHolderMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| response | ResponseHeader ResponseHeader |
--- | --- |
| portPolicy | N_PortPolicyIdMapper N_PortPolicyIdMapper |
--- | --- |
| svcMapperDataList | array[ServiceUIData] ServiceUIData |
--- | --- |
ResponseHeader
Name |
Type |
Description |
Enum |
|---|---|---|---|
| req | RequestHeader RequestHeader |
--- | --- |
| errorReason | String string |
--- | --- |
| errorCode | String string |
--- | --- |
| message | String string |
--- | --- |
| cmdStatus | String string |
--- | --- |
| opMsg | String string |
--- | --- |
| msgCode | String string |
--- | --- |
| parameters | array[String] string |
--- | --- |
| paramCount | Integer integer |
--- | --- |
| objectId | Integer integer |
--- | --- |
| jobName | String string |
--- | --- |
| objectType | Integer integer |
--- | --- |
SchedReqMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| jobName | String string |
--- | --- |
| jobDescription | String string |
--- | --- |
| username | String string |
--- | --- |
| trigger | SchedTriggerMapper SchedTriggerMapper |
--- | --- |
ServiceUIData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| serviceId | Long long |
--- | --- |
| serviceName | String string |
--- | --- |
| serviceDescr | String string |
--- | --- |
| serviceType | String string |
--- | --- |
| customerName | String string |
--- | --- |
| managementState | String string |
--- | --- |
| operationState | String string |
--- | --- |
| serviceState | String string |
--- | --- |
| createTime | Date DateTime |
--- | --- |
| lastUpdatedTime | Date DateTime |
--- | --- |
| scheduleTime | Date DateTime |
--- | --- |
| author | String string |
--- | --- |
| description | String string |
--- | --- |
| cvlan | String string |
--- | --- |
| svlan | String string |
--- | --- |
| reserveResource | String string |
--- | --- |
| preProvCLICommand | String string |
--- | --- |
| postProvCLICommand | String string |
--- | --- |
| templateID | Long long |
--- | --- |
| templateDeleteFlag | Integer integer |
--- | --- |
| alarmSeverity | String string |
--- | --- |
| alarmToolTip1 | String string |
--- | --- |
| alarmToolTip2 | String string |
--- | --- |
| alarmToolTip3 | String string |
--- | --- |
| alarmToolTip4 | String string |
--- | --- |
| alarmToolTip5 | String string |
--- | --- |
| toolTipCount | Integer integer |
--- | --- |
| mdFormat | String string |
--- | --- |
| mdLevel | Integer integer |
--- | --- |
| maFormat | String string |
--- | --- |
| maName | String string |
--- | --- |
| ccmInterval | String string |
--- | --- |
| direction | Boolean boolean |
--- | --- |
| active | Boolean boolean |
--- | --- |
| ccmEnable | Boolean boolean |
--- | --- |
| enable | Boolean boolean |
--- | --- |
| aisLevel | array[Integer] integer |
--- | --- |
| controlMepEnabled | Boolean boolean |
--- | --- |
| ccmPriority | Integer integer |
--- | --- |
| aisPriority | Integer integer |
--- | --- |
| aisInterval | Integer integer |
--- | --- |
| interfaceType | String string |
--- | --- |
| lowestPriorityDefect | String string |
--- | --- |
| oamConfigured | Boolean boolean |
--- | --- |
| oamConfiguredStr | String string |
--- | --- |
| tdmPluggableConfiguredStr | String string |
--- | --- |
| remark | String string |
--- | --- |
| pmState | Integer integer |
--- | --- |
| pmStateStr | String string |
--- | --- |
| pmstartTime | Date DateTime |
--- | --- |
| pmendTime | Date DateTime |
--- | --- |
| llf | Boolean boolean |
--- | --- |
| l2pt | Boolean boolean |
--- | --- |
| lacp | Boolean boolean |
--- | --- |
| l2cp | Boolean boolean |
--- | --- |
| vlanRangeEnabled | Boolean boolean |
--- | --- |
| mipValue | String string |
--- | --- |
| protectionConfigured | Boolean boolean |
--- | --- |
| switchState | String string |
--- | --- |
| proConfd | String string |
--- | --- |
| pwStatusSignalEnabled | String string |
--- | --- |
| pwControlChannelEnabled | String string |
--- | --- |
| pwAcknowledgementEnabled | String string |
--- | --- |
| epStandbySignallingMaster | String string |
--- | --- |
| epStandbySignallingSlave | String string |
--- | --- |
| pwRefreshTimer | Long long |
--- | --- |
| pwRequestTimer | Long long |
--- | --- |
| pwRetryTimer | Long long |
--- | --- |
| pwTimeoutMultiplier | Long long |
--- | --- |
| epRevertTimer | Long long |
--- | --- |
| epActiveHoldDelay | Long long |
--- | --- |
| policyId | String string |
--- | --- |
| policyName | String string |
--- | --- |
| ringHubName | String string |
--- | --- |
| trunkSvlanId | String string |
--- | --- |
| branchSvlanId | String string |
--- | --- |
| eTreeType | String string |
--- | --- |
| repProf15m | String string |
--- | --- |
| repProf24h | String string |
--- | --- |
| tcaProfName | String string |
--- | --- |
| defaultPort | Boolean boolean |
--- | --- |
| defaultNode | Boolean boolean |
--- | --- |
| fragmentType | String string |
--- | --- |
| ntwktechnology | String string |
--- | --- |
| vlanRangeType | String string |
--- | --- |
| frameTagType | String string |
--- | --- |
| alarmStatus | String string |
--- | --- |
| serverAlarmStatus | String string |
--- | --- |
| notificationTime | Long long |
--- | --- |
| id | String string |
--- | --- |
| key | String string |
--- | --- |
| className | String string |
--- | --- |
| cacCheck | Boolean boolean |
--- | --- |
| asymmetricTree | Boolean boolean |
--- | --- |
| mclagEndpoint | Boolean boolean |
--- | --- |
| pmStartTime | Date DateTime |
--- | --- |
| pmEndTime | Date DateTime |
--- | --- |
| hubInst | nHubInst nHubInst |
--- | --- |
| mdlevel | Integer integer |
--- | --- |
| vneInvolved | Boolean boolean |
--- | --- |
| singleCardService | Boolean boolean |
--- | --- |