Dell EMC OpenManage Enterprise 3.9 RESTful API Guide

PDF

POST method for forwarder settings

This method adds or modifies the Forwarder Settings.

Description: Adds or modifies the Forwarder Settings.

Privilege: APPLIANCE_SETUP

HTTP response codes: 201, 401, 404, 500.

Example request body

{
"Id": "1",
"Enabled": "true",
"ForwarderConfigurations":[
{"ConfigurationName":"CollectorName","ConfigurationValue":"Austin Data Center"},
{"ConfigurationName":"EnableCyberSecurity","ConfigurationValue":"true"}
],
"DataSyncConfigurations":[
{"Id": "1" ,"DeviceTypes":[2000,1000],"GroupIds":[1020,1031,1010,1023,1009,500]},
{"Id": "2", "DeviceTypes":[2000,1000],"GroupIds":[1020,1031,1010,1023,1009,500],"AlertSeverityTypes":[1,2,4,8,16]},
{"Id": "3", "DeviceTypes":[2000,1000],"GroupIds":[1020,1031,1010,1023,1009,500]},
{"Id": "4", "DeviceTypes":[2000,1000],"GroupIds":[1020,1031,1010,1023,1009,500]}
]
}


Qualifiers	Name	Type	Description/Values
IN, REQ	Id	Unit8	ID shall uniquely represent a Forwarding Service forwarder id in OME.
IN (Conditional)	Enabled	boolean	This value reflects whether the given forwarder should be enabled or disabled.
IN (Conditional)	ForwarderConfigurations	String[]	This structure contains array of ConfigurationName and ConfigurationValue which are generic in nature
IN (Conditional)	ForwarderConfigurations. ConfigurationName	String	Represents Configuration Name corresponding to forwarder . Ex: {"ConfigurationName":"CollectorName","ConfigurationValue":"Austin Data Center"}, {"ConfigurationName":"EnableCyberSecurity","ConfigurationValue":"true"}
IN (Conditional)	ForwarderConfigurations. ConfigurationValue	String	Represents Configuration Value corresponding to forwarder and Configuration Name. Ex: {"ConfigurationName":"CollectorName","ConfigurationValue":"Austin Data Center"}, {"ConfigurationName":"EnableCyberSecurity","ConfigurationValue":"false"}
IN (Conditional)	DataSyncConfigurations	String[]	This structure contains array of sync configuration for a forwarder such as Inventory, Health, Alerts and Telemetry configurations.
IN (Conditional)	dataSyncConfiguration.Id	Unit8[]	Represents the sync category such as 0 (Inventory) ,1( Alerts), 2(Health) and 3 (Telemetry).
IN (Conditional)	dataSyncConfigurations. DeviceTypes	Unit8[]	Represents the Device Types part of sync configuration such as 1000 for Servers, 2000 for chassis.
IN (Conditional)	dataSyncConfigurations.GroupIds	Unit8[]	Represents the Group Ids part of Sync configuration.
IN (Conditional)	dataSyncConfigurations. AlertseverityTypes	Unit8[]	Represents the severity types part of Sync configuration such as 1 (Unknown), 2 (Info), 4 (Normal) , 8 (Warning) , 16 (Critical)