How to change the Device life Cycle Status using Web Services in CA Performance Management (CAPM)

Products

• CA Performance Management
• Network Observability

Issue/Introduction

How can the Device lifecycle status be changed using the Performance Center Web Service?

This is the REST access option for NetOps Portal

Environment

DX NetOps CAPM all currently supported releases

Cause

You can change lifecyclestate using the NetOps Portal console GUI or using NetOps Portal REST webservice.

Resolution

Life cycle status is controlled by NetOps Portal, so you will have to use the NetOps Portal rest API to change the life cycle status.  

Note that when using DX Netops Portal Rest, you need to use the Portal ID of the device.

To access the NetOps Portal webservice REST documentation:

http://PC:8181/pc/center/rest 

https://PC:8182/pc/center/rest 

(replace PC with your pc hostname)

 

To access the list of devices to get their current state and itemID

http://PC:8181/pc/center/webservice/devices/

 

To access a single device's details:

http://PC:8181/pc/center/webservice/devices/{idName}/{idValue}  

For example:

http://PC:8181/pc/center/webservice/devices/deviceItemId/48712

 

To change the lifecyclestate:

Use a rest client to do a PUT request using the following:

http://PC:8181/pc/center/webservice/devices/deviceItemId/{idValue}/lifeCycleState/{newState}

Where you can select newState to be one of the following:

• ACTIVE
• RETIRED 
• MAINTENANCE

Additional Information

To run from the CLI using curl:

curl -v -u admin:admin -X PUT -H 'Content-Type: application/xml' http://PC:8181/pc/center/webservice/devices/deviceItemId/{idValue}/lifeCycleState/{newState}

…

curl -v -k -u admin:admin -X PUT -H 'Content-Type: application/xml' https://PC:8182/pc/center/webservice/devices/deviceItemId/{idValue}/lifeCycleState/{newState}

You can get the full list at:

http://<PC>:8181/pc/center/webservice/devices

Adjust port and protocol accordingly

See the following for additional Portal API services:

TechDocs : DX NetOps CAPM 24.3 : NetOps Portal REST Web Services

Note that the Data Sources Web Service can also be used to translate ids between the portal and the Data Sources such as the Data Aggregator.