Manage Device Life Cycles Using the Devices Web Service

A monitored device's life cycle state defines the monitoring behavior for the device. This defines when a device is active, retired, or in maintenance.
A monitored device's life cycle state defines the monitoring behavior for the device, such as whether the device is active, retired, or in maintenance. Components inherit the life cycle state of the associated device. You can define the usage state of SNMP and ICMP devices by managing the life cycle.
You can manage the device life cycle state using the
NetOps Portal
API (using the
devices
endpoint) or using
NetOps Portal
. This article describes how to manage the state using the
NetOps Portal
API.
For more information about how to manage the state using
NetOps Portal
, see Manage Device Life Cycles.
In environments where
DX NetOps Spectrum
manages the life cycle state, manage the state using the
DX NetOps Spectrum
REST API instead of this REST API.
For more information, see the
DX NetOps Spectrum
documentation
.
You cannot manage the life cycle state of
DX NetOps Mediation Manager
devices.
To update the device life cycle state for a single monitored device, issue a PUT request to the
devices
endpoint for the
NetOps Portal
API:
http://<
PC_host>
:8181/pc/center/webservice/devices/
{<idName>}
/
{<idValue>}
/lifeCycleState/
{<newState>}
  • {idName}
    Specify one of the property name values that the
    get id names
    method of the
    devices
    endpoint returns.
  • {idValue}
    Specify a value for the property that is denoted by
    idName
    .
  • {newState}
    Specify in ALL CAPS one of the following life cycle states:
    • ACTIVE
      Specifies the normal operating status of a device.
    • RETIRED
      Specifies that the device is no longer in use and that no monitoring occurs. This state disables polling, threshold monitoring, notifications, and change detection.
      DX NetOps Performance Management
      does not update the SNMP Profile or change the hostname.
      In this state, virtual devices (Virtual Machine or ESX) discovered with systemEdge are not polled for its vCenter statistics.
    • MAINTENANCE
      Specifies that the device is temporarily under maintenance. You can configure the behavior of this state.
      In this state,
      DX NetOps Performance Management
      does not update the device during discovery or rediscovery.