listAlarms

Category: Manage and query alarms/alerts in OpManager

Key parameters:

• deviceName: Device Name of the alarm. The device name can be taken from

• severity: Severity of the alarm. The severity could range anywhere fro

• category: Device category of the alarm

• alertType: alertType of the alarm. The alert type can be any of the fol

• fromTime: Start time for the custom time period range. It could be of

alarmProperties

Category: Manage and query alarms/alerts in OpManager

Key parameters:

• entity: Entity of the alarm

• deviceID: MOID of the alarm

addNotes

Category: Manage and query alarms/alerts in OpManager

Key parameters:

• entity*: Entity of the alarm

• notes*: Notes description to be added

• type: To mention whether single or multiple alarms are selected

acknowledgeAlarm

Category: Manage and query alarms/alerts in OpManager

Key parameters:

• entity*: Entity of the alarm

• type: To mention whether single or multiple alarms are selected

unAcknowledgeAlarm

Category: Manage and query alarms/alerts in OpManager

Key parameters:

• entity*: Entity of the alarm

• type: To mention whether single or multiple alarms are selected

clearAlarm

Category: Manage and query alarms/alerts in OpManager

Key parameters:

• entity*: Entity of the alarm

• type: To mention whether single alarm or multiple alarms are selec

deleteAlarm

Category: Manage and query alarms/alerts in OpManager

Key parameters:

• entity*: Entity of the alarm

• type: To mention whether single or multiple alarm is selected

getTopDevicesByAlarms

Category: Manage and query alarms/alerts in OpManager

Key parameters:

• eventType*: Event type of the alarm

getAnnotation

Category: Manage and query alarms/alerts in OpManager

Key parameters:

• entity*: Entity of the alarm

getPingResponse

Category: Manage and query network devices

Key parameters:

• deviceName*: Name of the device - Managed Entity name as seen in the URL

getTraceResponse

Category: Manage and query network devices

Key parameters:

• deviceName*: Name of the device - Managed Entity name as seen in the URL

getDownDevices

Category: Discover new devices on the network

getAvailabilityGraphData

Category: Manage and query network devices

Key parameters:

• name*: Name of the device or interface - Managed Entity name as see

• instance: Set instance=Interface if the Availability graph is requeste

• isFluidic*: Set value as TRUE by default (for internal purpose)

listDownTimeSchedules

updateDowntimeSchedule

Key parameters:

• operation: Edit will be sent by default (Edit).

• MS_INSTANCEID: Downtime scheduler ID.

• scheduleId: Downtime scheduler ID.

• scheduleName: Downtime scheduler name.

• status: Status will be set as Enabled by default.

getDowntimeSchedule

Key parameters:

• operation: Downtime scheduler name

setManaged

Category: Manage and query network devices

Key parameters:

• manage*: Enables monitoring of devices or interfaces if manage=true,

• name*: Name of the device or interface. (Managed Entity name as see

• type: Set type as 'INTERFACE' if the managed entity is an interfac

• isInterface: This parameter will take effect only when the value 'INTERFA

getBusinessView

getBusinessDetailsView

Key parameters:

• bvName*: Name of the Business View (as shown in the URL of Business V

getWidgetData

Key parameters:

• widgetID*: The widget ID for which data is to be fetched.

• widgetName: The name of the widget.

• widgetType: The widget type.

getWidgetList

Category: Access dashboard widgets and data

Key parameters:

• dashboardName*: Name of the dashboard.

listDevices

Category: Manage and query network devices

Key parameters:

• isFluidic: Set value as 'true' by default.(for internal purpose)

• type: Fetches the list of devices that fall under the given Device

• category: Fetches the list of devices that fall under the given device

• app: Fetches the list of devices that have the given App in it an

• bvName: Fetches the list of devices that are under the given Busines

getDeviceInfo

Category: Manage and query network devices

Key parameters:

• deviceName/ipAddress/dnsName*: Either one of these three parameters can be used to retrieve

setDeviceInfo

Category: Manage and query network devices

Key parameters:

• deviceName/ipAddress/dnsName*: Either one of these three parameters can be used to update t

• values*: The JSON array containing metricName and metricValue for Har

getDeviceNotes

Category: Manage and query network devices

Key parameters:

• name*: Name of the device - Managed Entity name as seen in the URL

getInfrastructureDetailsView

Category: Discover new devices on the network

Key parameters:

• categoryName*: Name of the device category. [Example: Server, Desktop, etc]

getDeviceSummary

Category: Manage and query network devices

Key parameters:

• name*: Name of the device - Managed Entity name as seen in the URL

• isFluidic: Set value as TRUE by default. (for internal purpose)

• snapType: Type of the device snapshot. If the device is monitored only

• RouterID: Router ID of the device if the snapType is set as 'FlowDevic

getDeviceCompleteDetails

Key parameters:

• name*: Name of the device

listVirtualDevices

Category: Manage and query network devices

Key parameters:

• virtualDeviceType*: Type of virtual entity which you want to list. (Allowed valu

getVMWareHosts

Category: Manage and query network devices

Key parameters:

• name: Name of the vCenter device - Managed Entity name as seen in

getDataCenterDetails

Category: Manage and query network devices

Key parameters:

• moID: Unique ID for vCenter device - 'moID' property value in the

getClusterDetails

Category: Manage and query network devices

Key parameters:

• moID: Unique ID for vCenter device - 'moID' property value in the

getVMWareVMs

Category: Manage and query network devices

Key parameters:

• name: Name of the selected entity type - Managed Entity name as se

• type: Type of virtual entity which you want to list. (Allowed valu

getVMWareDataStores

Category: Manage and query network devices

Key parameters:

• name: Name of the selected entity type - Managed Entity name as se

• type: Type of virtual entity which you want to list. (Allowed valu

getNutanixVDisks

Category: Manage and query network devices

Key parameters:

• name: Name of the selected entity type - Managed Entity name as se

getNutanixDetails

Category: Manage and query network devices

Key parameters:

• deviceName: Name of the selected entity type - Managed Entity name as se

• entityType: Type of virtual entity which you want to list . Allowed valu

addServiceMonitor

Category: Discover new devices on the network

Key parameters:

• deviceName*: Hostname, FQDN name or IP Address of the device

• credentialName: Name of the credential used to access the device to fetch de

listProbes

listEvents

Key parameters:

• deviceName: Device name for which the events to be listed

• entity: Entity of the event

• period: Time period for which events should be listed

• severity: Severity of the alarm

• category: Device category of the alarm

addEvent

Key parameters:

• source*: Source device of of the alarm.

• severity*: Severity of the alarm. The severity could range anywhere fro

• message*: Message of the alarm.

• alarmCode*: Alarm code of the alarm.

• entity*: Unique Value for the generating Alarm

listAllLogicalGroups

getLogicalGroupInfo

Key parameters:

• groupName*: Name of the group with MOID appended in the suffix. such as

• period: Time for which the availability data is to be fetched.[Examp

• snapType: Group Snapshot type. [Example: LogicalGroup|LogicalIntfGroup

getLogicalGroupAlerts

Key parameters:

• groupName: Name of the group

listLogicalGroupMembers

Key parameters:

• groupName: Name of the Device/Interface Group having suffix as '- '. [E

addToGroup

Category: Manage and query network devices

Key parameters:

• groupName*: Name of the Device/Interface Group with MOID in the suffix.

• groupType*: Type of the group [Example: device|interface]

• selectedMembers*: Device name(s) supplied as a comma-separated string. Device

listInterfaces

Category: Manage and query network devices

Key parameters:

• isFluidic: Set value as 'true' by default (for internal purpose)

• rows: To fetch interface list in batches. This should be combinedl

• page: To fetch interface list in batches. This should be combinedl

• sortByColumn: Sorting interfaces list with columns [Example: inSpeed, disp

• sortByType: Defining ascending or descending sort of interfaces list [Ex

getInterfaceSummary

Category: Manage and query network devices

Key parameters:

• interfaceName*: ManagedObject name of the interface as seen in the URL of in

getIntfAtAGlanceReportDetails

Key parameters:

• InterfaceName*: Name of the interface - Managed Entity name as seen in the U

• period*: Period for which the interface data is required. [Example: t

• startDate: From Date. This parameter is applicable only if 'custom' tim

• endDate: To Date. This parameter is applicable only if 'custom' time

getIntfBWOutageReportDetails

Key parameters:

• interfaceName*: Name of the interface - Managed Entity name as seen in the U

• period*: Period for which the interface graph is required. [Example:

• startDate: From Date. This paramete is applicable only if 'custom' time

• endDate: To Date. This param is applicable only if 'custom' time is o

getInterfaces

Category: Manage and query network devices

Key parameters:

• name*: Name of the parent device - Managed Entity name of the paren

getInterfaceNotes

Category: Manage and query network devices

Key parameters:

• interfaceName*: Name of the interface - Managed Entity name as seen in the U

getInterfaceGraphs

Category: Manage and query network devices

Key parameters:

• interfaceName*: Name of the interface - Managed Entity name as seen in the U

• graphName: Name of the interface graph [Example: totalPackets|traffic|u

• isFluidic: Set as 'true' by default (for internal purpose)

• period: Period for which the interface graph is required. [Example:

• startDate: From Date. This parameter is applicable only if 'custom' tim

getDeviceAssociatedMonitors

Category: Manage and query network devices

Key parameters:

• name*: Name of the device

getPerformanceMonitors

Category: Manage and query network devices

Key parameters:

• deviceName*: Name of the device

• category*: Category of the device

• type*: Type of the device

getLastCollectedValues

Category: Manage and query network devices

Key parameters:

• deviceMOIDList*: MOID is the value of the 'moid' property in the listDevices

getPerformanceMonitorDetails

Category: Manage and query network devices

Key parameters:

• name*: Name of the device

• policyName*: Policy name of the performance monitor

• graphName*: Graph name of the performance monitor.

• checkNumeric*: true (or) false.

addPerformanceMonitors

Category: Manage and query network devices

Key parameters:

• name*: Name of the device

• selectedMonitors*: GraphID of the performance monitor(s) to be added (multiple

deletePerformanceMonitors

Category: Manage and query network devices

Key parameters:

• name*: Name of the device

• pollId*: pollId of the performance monitor (multiple values separated

TestMonitor

Category: Manage and query network devices

Key parameters:

• name*: Name of the device

• policyName*: Policy name of the monitor

• graphName*: Graph name of the monitor.

• instanceName: Instance name (only applicable for MSSQL monitors).

getAssociatedProcessMonitors

Category: Manage and query network devices

Key parameters:

• deviceName*: Name of the device

associateProcessMonitor

Category: Manage and query network devices

Key parameters:

• deviceName*: Name of the device.

• processId*: ID of the processes that need to be associated

getAssociatedServiceMonitors

Category: Manage and query network devices

Key parameters:

• name*: Name of the device

associateServiceMonitor

Key parameters:

• deviceName*: Name of the device for which the service to be associated. G

• serviceName*: Name of the service(s) (multiple values separated by commas)

getDeviceAssociatedWindowsServiceMonitors

Category: Manage and query network devices

Key parameters:

• name*: Name of the device

listURLMonitors

listAllDevicesSpecificURLs

listScriptMonitors

listNotificationProfiles

Key parameters:

• isGlobal: false - To list all the Device Specific Profiles

• profileFilter: All / Send Email / Send SMS / Send Modem SMS / Run System Co

• deviceName: Name of the device - To list all Global Proflies with device

associateNotificationProfiles

Key parameters:

• deviceName*: Name of the devices to be associated

• profiles*: ProfileID of the profiles to be associated.

updateNotificationProfileStatus

Key parameters:

• profileName*: Name of the profile which has to be enabled/disabled

• profileId*: ID of the profile which has to be enabled/disabled

• status*: enable or disable

• deviceName: Name of the device on which the Notification profile is crea

getNotificationProfileS

Category: Manage and query network devices

Key parameters:

• name*: Name of the device for which the profiles has to be listed

getReportsList

Key parameters:

• isFavouriteNeeded: Boolean value to show favourites reports or not.

• hideintegratedReports: Boolean value to show integrated reports or not.

• hideHardwareReport: Boolean value to show hardware report or not.

getReportsData

Key parameters:

• reportID: Unique ID for individual reports.

• viewAs: Format to view the resultant report data.

• time: The time period to fetch the report data.

• isExcludeDays: Boolean value to exclude days or not.

• excludedDays: The day to be excluded in report data.

listBusinessRules

addBusinessRules

Key parameters:

• description: Description about the business rule.

• businessRuleName: Name of the business hour rule.

• timeSettings: Time configuration from Monday to Sunday.

deleteBusinessRules

Key parameters:

• businessRuleId: ID of the business hour rule.

viewBusinessRules

Key parameters:

• businessRuleId: ID of the business hour rule.

updateBusinessRules

Key parameters:

• description: Description about the business rule.

• businessRuleName: Name of the business hour rule.

• timeSettings: Time configuration From Monday to Sunday.

• businessRuleId: ID of the business hour rule.

getReportData

Key parameters:

• deviceList: Device list to fetch the report data.

• monitorList: Monitor list to fetch the report data.

• timePeriod: Time period to fetch the report data.

• view: Viewing report in table/graph format.

• tableView: To show the report data in instance/Monitor wise.

listSubnets

Category: Manage and query network devices

getWirelessNetworkDetails

Key parameters:

• deviceName*: Name of the WLC device (Managed Entity name as seen in the U

getWirelessAPList

Key parameters:

• deviceName*: Name of the WLC device (Managed Entity name seen in the URL

getSSIDClientList

Key parameters:

• deviceName*: Name of the WLC device (Managed Entity name as seen in the U

getClientDetails

Key parameters:

• deviceName*: Name of the WLC device (Managed Entity name as seen in the U

• ssidName*: SSID name of the wireless network associated to WLC

getCategoryList

Category: Manage and query network devices