Operation
post /eqm/prov/{groupId}/{neId}/{neType}
The field 'neType' is the type of Network Element.It can take values '1830pss-32' for 1830PHN , '1830pss-4' for 1830PSS-4, '1830pss-ocs' for 1830OCS .
For PHN NE Shelf provisioning, the following parameters are available to configure :
expectedEquipmentObjectType - UNV32, UNV32S, UNV16, UNV16II, UNV8, UNV96, UNV4, DCM, SFD40, SFD40B, SFD44, SFD44B, ITLU, ITLB, MSH8-FSM, MLFSB, PSC1-6
ShelfName - Name of the shelf
ShelfDescr - Shelf Description
ainsMode - Enable,Disable
expectedPFAmps - UNV32 : auto,20,30,50,60,70 ; UNV32S : auto,3X50 ; UNV16 : auto,20,35 ; UNV16II : auto,63
expectedPFAAmps - UNV8 : DC30,AC7 ; UNV4 : 3.7,4.1,8.5,20.6,NA
expectedPFBAmps - UNV8 : DC30,AC7 ; UNV4 : 3.7,4.1,8.5,20.6,NA
wavelengthTrackerEnabled - Yes
serviceState - IN_SERVICE
For OCS NE Shelf provisioning, the following parameters are available to configure :
expectedEquipmentObjectType - PSS64,PSS36
primaryState - IN_SERVICE,OUT_OF_SERVICE
appl - OCS
airflowappl - HP36LOWSUBR,HP36
asap - LBL-ASAPEQPT-ALL,LBL-ASAPEQPT-FerfAis,LBL-ASAPEQPT-None,LBL-ASAPEQPT-NotPrimary,LBL-ASAPEQPT-SYSDFLT
mtxsize - 960,1920,3840
For PHN NE Card provisioning, the following parameters are available to configure :
expectedEquipmentObjectType - Card name. Example 11DPM8
serviceState - IN_SERVICE,OUT_OF_SERVICE
cardMode - Card Mode . It is not a mandatory parameter.Required for some cards like 260SCX2. Example 100GEth
For OCS NE Card provisioning , the following parameters are available to configure :
expectedEquipmentObjectType - Card name. Example 10XANY10G
primaryState - IN_SERVICE,OUT_OF_SERVICE
ainsMode - AINS,NOWAIT
Asap - LBL-ASAPEQPT-ALL,LBL-ASAPEQPT-FerfAis,LBL-ASAPEQPT-None,LBL-ASAPEQPT-NotPrimary,LBL-ASAPEQPT-SYSDFLT
For PHN NE Port provisioning, the following parameters are available to configure :
signalType - Required signal type of the port. Example 10GbE
primaryState - Primary State of the port. Example IS
For OCS Module provisioning, the following parameters are available to configure :
expectedEquipmentObjectType - Module name. Example IR211G1AU
primaryState - IN_SERVICE,OUT_OF_SERVICE
asap - LBL-ASAPEQPT-ALL,LBL-ASAPEQPT-FerfAis,LBL-ASAPEQPT-None,LBL-ASAPEQPT-NotPrimary,LBL-ASAPEQPT-SYSDFLT
ainsMode - AINS,NOWAIT
clntsel - Client Selection Mode. Example OTU2
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neId | required | EML Network Element ID | --- |
groupId | required | EML Group ID | --- |
neType | required | Network Element Type | [1830pss-32, 1830pss-ocs, 1830pss-4] |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Provisioned Entity Data | ProvisionedEntity |
--- |
body2 | optional | Session | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Status
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
REST call: /eqm/prov/6601/10/1830pss-ocs Provisioned Entity Data: <ProvisionedEntity> <entityType>EQUIPMENT</entityType> <groupId>6601</groupId> <neId>10</neId> <entityName>SHELF-1-7</entityName> <parameterList> <parameter> <name>expectedEquipmentObjectType</name> <value>PSS36</value> </parameter> <parameter> <name>primaryState</name> <value>OUT_OF_SERVICE</value> </parameter> <parameter> <name>appl</name> <value>OCS</value> </parameter> <parameter> <name>airflowappl</name> <value>HP36</value> </parameter> <parameter> <name>asap</name> <value>LBL-ASAPEQPT-ALL</value> </parameter> <parameter> <name>mtxsize</name> <value>960</value> </parameter> </parameterList> </ProvisionedEntity>
Produces
application/xml
Example Response Data
<Status> <opStatus>SUCCESS</opStatus> <msg>CREATE SHELF-1-7</msg> </Status>
Tags
[ EQM ]
Operation
delete /eqm/prov/{groupId}/{neId}/{neType}/{entityType}/{aid}
The field 'neType' is the type of Network Element.It can take values '1830pss-32' for 1830PHN , '1830pss-4' for 1830PSS-4, '1830pss-ocs' for 1830OCS . The field 'entityType' is the entity type which can take value 'EQ'. The field 'aid' is the access identifier of the Equipment which can be obtained from the 'aid' field of the Equipment object from the call /eqm/Equipment/All/{grpID}/{neID}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
groupId | required | EML Group ID | --- |
neId | required | EML Network Element ID | --- |
neType | required | Network Element Type | [1830pss-32, 1830pss-ocs, 1830pss-4] |
entityType | required | Entity Type | [EQ] |
aid | required | Equipment Access Identifier | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Status
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
text/xml
Example Request Data
/eqm/prov/6601/11/1830pss-32/EQ/SHELF-6
Produces
application/xml
Example Response Data
<Status> <opStatus>SUCCESS</opStatus> <msg>DELETE SHELF-6</msg> </Status>
Tags
[ EQM ]
External Docs
Operation
put /eqm/prov/{groupId}/{neId}/{neType}
The field 'neType' is the type of Network Element.It can take values '1830pss-32' for 1830PHN, '1830pss-4' for 1830PSS-4, '1830pss-ocs' for 1830OCS .
For 1830PHN NE , signaltype on a port can be set through modify equipment.For 1830OCS NE, asap setting can be modified.
Some of the other equipment parameters which can be modified are primaryState, ainstimer, ShelfDescr, ShelfName etc.
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neId | required | EML Network Element ID | --- |
groupId | required | EML Group ID | --- |
neType | required | Network Element Type | [1830pss-32, 1830pss-ocs, 1830pss-4] |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Provisioned Entity Data | ProvisionedEntity |
--- |
body2 | optional | session1 | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Status
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
REST call: /eqm/prov/4401/3/1830pss-32 Provisioned Entity Data: <ProvisionedEntity> <entityType>EQUIPMENT</entityType> <groupId>4401</groupId> <neId>3</neId> <entityName>11STAR1-5-17-C1</entityName> <parameterList> <parameter> <name>primaryState</name> <value>IS</value> </parameter> <parameter> <name>signalType</name> <value>10GbE</value> </parameter> </parameterList> </ProvisionedEntity>
Produces
application/xml
Example Response Data
<Status> <opStatus>SUCCESS</opStatus> <msg>MODIFY </msg> </Status>
Tags
[ EQM ]
Operation
get /eqm/prov/Set/{groupId}/{neId}/{neType}
The field 'neType' is the type of Network Element.It can take values '1830pss-32' for 1830PHN, '1830pss-4' for 1830PSS-4, '1830pss-ocs' for 1830OCS .
For 1830PHN NE , signaltype on a port can be set through modify equipment.For 1830OCS NE, asap setting can be modified.
Some of the other equipment parameters which can be modified are primaryState, ainstimer, ShelfDescr, ShelfName etc.
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neId | required | EML Network Element ID | --- |
groupId | required | EML Group ID | --- |
neType | required | Network Element Type | [1830pss-32, 1830pss-ocs, 1830pss-4] |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Status
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
Tags
[ EQM ]
Operation
put /eqm/prov/loopBackDetails/{groupId}/{neId}/{neType}/{signalrate}
The field 'neType' is the type of Network Element.It can take values '1830pss-32' for 1830PHN, '1830pss-4' for 1830PSS-4, '1830pss-ocs' for 1830OCS .
For 1830PHN NE , signaltype on a port can be set through modify equipment.For 1830OCS NE, asap setting can be modified.
Some of the other equipment parameters which can be modified are primaryState, ainstimer, ShelfDescr, ShelfName etc.
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neId | required | EML Network Element ID | --- |
groupId | required | EML Group ID | --- |
neType | required | Network Element Type | [1830pss-32, 1830pss-ocs, 1830pss-4] |
signalrate | required | signalrate | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Provisioned Entity Data | ProvisionedEntity |
--- |
body2 | optional | session1 | HttpSession |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Status
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
Tags
[ EQM ]
HashMap«string,EntityParameter»
Name |
Type |
Description |
Enum |
---|
ProvisionedEntity
Name |
Type |
Description |
Enum |
---|---|---|---|
entityType | String string |
Entity Type | [EQUIPMENT, PORT] |
groupId | String string |
EML Group ID | --- |
neId | String string |
EML Network Element ID | --- |
entityName | String string |
Entity Name | --- |
paramList | array[EntityParameter] EntityParameter |
Parameter list for the equipment | --- |
paramListAsMap | HashMap«string,EntityParameter» HashMap«string,EntityParameter» |
--- | --- |