OpenManage Enterprise–Tech Release REST API Guide
Template service
2.9.1 /api/TemplateService/TemplateTypes
GET
Description
Get the template types.
Privilege
VIEW
HTTP Response Codes
200
GET Usage Examples
Output:
{
"@odata.context": "/api/$metadata#Collection(TemplateService.TemplateTypeModel)",
"@odata.count": 4,
"value": [
{
"@odata.id": "/api/TemplateService/TemplateTypes(0)",
"Id": 0,
"Name": "None",
"ConfigurationSections": []
},
{
"@odata.id": "/api/TemplateService/TemplateTypes(2)",
"Id": 2,
"Name": "Server",
"ConfigurationSections": []
},
{
"@odata.id": "/api/TemplateService/TemplateTypes(4)",
"Id": 4,
"Name": "Chassis",
"ConfigurationSections": []
},
{
"@odata.id": "/api/TemplateService/TemplateTypes(3)",
"Id": 3,
"Name": "IO Module",
"ConfigurationSections": []
}
]
}
2.9.2 /api/TemplateService/TemplateViewTypes
GET
Description
Get the template view types.
Privilege
VIEW
HTTP Response Codes
200
GET Usage Examples
Output:
{
"@odata.context": "/api/$metadata#Collection(TemplateService.TemplateViewTypeModel)",
"@odata.count": 5,
"value": [
{
"@odata.id": "/api/TemplateService/TemplateViewTypes(0)",
"Id": 0,
"Description": "None"
},
{
"@odata.id": "/api/TemplateService/TemplateViewTypes(1)",
"Id": 1,
"Description": "Compliance"
},
{
"@odata.id": "/api/TemplateService/TemplateViewTypes(2)",
"Id": 2,
"Description": "Deployment"
},
{
"@odata.id": "/api/TemplateService/TemplateViewTypes(3)",
"Id": 3,
"Description": "Inventory"
},
{
"@odata.id": "/api/TemplateService/TemplateViewTypes(4)",
"Id": 4,
"Description": "Sample"
}
]
}
2.9.3 /api/TemplateService/Templates
GET
Description
Get the templates.
Privilege
VIEW
HTTP Response Codes
200
GET Usage Examples
Output:
{
"@odata.context": "/api/$metadata#Collection(TemplateService.Template)",
"@odata.count": 8,
"value": [
{
"@odata.id": "/api/TemplateService/Templates(1)",
"Id": 1,
"Name": "iDRAC 13G Enable HPC Profile ",
"Description": "Tune workload for High Performance Computing Environment",
"SourceDeviceId": 0,
"TypeId": 2,
"ViewTypeId": 4,
"TaskId": 0,
"HasIdentityAttributes": false,
"Status": 0,
"IdentityPoolId": 0,
"IsBuiltIn": true,
"CreatedBy": "system",
"CreationTime": "2017-11-30 19:02:11.200378",
"LastUpdatedBy": null,
"LastUpdatedTime": "2017-11-30 19:02:11.200378",
"Views": [
{
"@odata.id": "/api/TemplateService/Templates(1)/Views"
}
]
},
{
"@odata.id": "/api/TemplateService/Templates(2)",
"Id": 2,
"Name": "iDRAC 13G Enable Low Latency Profile",
"Description": "Tune workload for Low Latency Computing Environments",
"SourceDeviceId": 0,
"TypeId": 2,
"ViewTypeId": 4,
"TaskId": 0,
"HasIdentityAttributes": false,
"Status": 0,
"IdentityPoolId": 0,
"IsBuiltIn": true,
"CreatedBy": "system",
"CreationTime": "2017-11-30 19:02:11.200378",
"LastUpdatedBy": null,
"LastUpdatedTime": "2017-11-30 19:02:11.200378",
"Views": [
{
"@odata.id": "/api/TemplateService/Templates(2)/Views"
}
]
},
{
"@odata.id": "/api/TemplateService/Templates(3)",
"Id": 3,
"Name": "iDRAC 14G Enable Performance Profile for Virtualization",
"Description": "Tune workload for Performance Optimized Virtualization",
"SourceDeviceId": 0,
"TypeId": 2,
"ViewTypeId": 4,
"TaskId": 0,
"HasIdentityAttributes": false,
"Status": 0,
"IdentityPoolId": 0,
"IsBuiltIn": true,
"CreatedBy": "system",
"CreationTime": "2017-11-30 19:02:11.200378",
"LastUpdatedBy": null,
"LastUpdatedTime": "2017-11-30 19:02:11.200378",
"Views": [
{
"@odata.id": "/api/TemplateService/Templates(3)/Views"
}
]
},
{
"@odata.id": "/api/TemplateService/Templates(4)",
"Id": 4,
"Name": "iDRAC 14G Enable Power profile for Virtualization",
"Description": "Tune workload for Power Optimized Virtualization",
"SourceDeviceId": 0,
"TypeId": 2,
"ViewTypeId": 4,
"TaskId": 0,
"HasIdentityAttributes": false,
"Status": 0,
"IdentityPoolId": 0,
"IsBuiltIn": true,
"CreatedBy": "system",
"CreationTime": "2017-11-30 19:02:11.200378",
"LastUpdatedBy": null,
"LastUpdatedTime": "2017-11-30 19:02:11.200378",
"Views": [
{
"@odata.id": "/api/TemplateService/Templates(4)/Views"
}
]
},
{
"@odata.id": "/api/TemplateService/Templates(5)",
"Id": 5,
"Name": "iDRAC 14G Enable Performance Profile for Database",
"Description": "Tune workload for Performance Optimized Database",
"SourceDeviceId": 0,
"TypeId": 2,
"ViewTypeId": 4,
"TaskId": 0,
"HasIdentityAttributes": false,
"Status": 0,
"IdentityPoolId": 0,
"IsBuiltIn": true,
"CreatedBy": "system",
"CreationTime": "2017-11-30 19:02:11.200378",
"LastUpdatedBy": null,
"LastUpdatedTime": "2017-11-30 19:02:11.200378",
"Views": [
{
"@odata.id": "/api/TemplateService/Templates(5)/Views"
}
]
},
{
"@odata.id": "/api/TemplateService/Templates(6)",
"Id": 6,
"Name": "iDRAC 14G Enable Power Profile for Database",
"Description": "Tune workload for Power Optimized Database ",
"SourceDeviceId": 0,
"TypeId": 2,
"ViewTypeId": 4,
"TaskId": 0,
"HasIdentityAttributes": false,
"Status": 0,
"IdentityPoolId": 0,
"IsBuiltIn": true,
"CreatedBy": "system",
"CreationTime": "2017-11-30 19:02:11.200378",
"LastUpdatedBy": null,
"LastUpdatedTime": "2017-11-30 19:02:11.200378",
"Views": [
{
"@odata.id": "/api/TemplateService/Templates(6)/Views"
}
]
},
{
"@odata.id": "/api/TemplateService/Templates(7)",
"Id": 7,
"Name": "iDRAC 14G Enable Performance Profile for Software Defined Storage",
"Description": "Tune workload for Performance Optimized Software Defined Storage ",
"SourceDeviceId": 0,
"TypeId": 2,
"ViewTypeId": 4,
"TaskId": 0,
"HasIdentityAttributes": false,
"Status": 0,
"IdentityPoolId": 0,
"IsBuiltIn": true,
"CreatedBy": "system",
"CreationTime": "2017-11-30 19:02:11.200378",
"LastUpdatedBy": null,
"LastUpdatedTime": "2017-11-30 19:02:11.200378",
"Views": [
{
"@odata.id": "/api/TemplateService/Templates(7)/Views"
}
]
},
{
"@odata.id": "/api/TemplateService/Templates(8)",
"Id": 8,
"Name": "iDRAC 14G Enable Power Profile for Software Defined Storage",
"Description": "Tune workload for Power Optimized Software Defined Storage ",
"SourceDeviceId": 0,
"TypeId": 2,
"ViewTypeId": 4,
"TaskId": 0,
"HasIdentityAttributes": false,
"Status": 0,
"IdentityPoolId": 0,
"IsBuiltIn": true,
"CreatedBy": "system",
"CreationTime": "2017-11-30 19:02:11.200378",
"LastUpdatedBy": null,
"LastUpdatedTime": "2017-11-30 19:02:11.200378",
"Views": [
{
"@odata.id": "/api/TemplateService/Templates(8)/Views"
}
]
}
]
}
POST
Description
Create a template.
Privilege
DEVICE_CONFIGURATION
HTTP Response Codes
200
POST Usage Examples: Create a template
Input:
{
"Name": "Test Create",
"TypeId": 2,
"ViewTypeId": 2,
"SourceDeviceId": 5514,
"Fqdds": "idrac,system,nic,lifecycleController,eventFilters"
}
Output:
ID of template.
2.9.4/api/TemplateService/Templates(templateId)
GET
Description
Get a template by TemplateID.
Privilege
VIEW
HTTP Response Codes
200
GET Usage Examples
Output:
{
"@odata.context": "/api/$metadata#TemplateService.Template/$entity",
"@odata.id": "/api/TemplateService/Templates(10)",
"Id": 10,
"Name": "Example Test Template 1",
"Description": null,
"SourceDeviceId": 5514,
"TypeId": 2,
"ViewTypeId": 2,
"TaskId": 33464,
"HasIdentityAttributes": true,
"Status": 2060,
"IdentityPoolId": 0,
"IsBuiltIn": false,
"CreatedBy": "admin",
"CreationTime": "2017-12-05 19:17:17.31158",
"LastUpdatedBy": "admin",
"LastUpdatedTime": "2017-12-05 19:17:17.31158",
"Views": [
{
"@odata.id": "/api/TemplateService/Templates(10)/Views"
}
]
}
PUT
Description
Update a template.
Privilege
DEVICE_CONFIGURATION
HTTP Response Codes
200
PUT Usage Examples: Update a template
Input:
{
“Id": 17,
"Name": "Test Create Renamed"
}
Output:
ID of template.
PUT Usage Examples: Update a compliance template attriubtes
Input:
{
"Id": 12,
"Name": "Example Compliance Template",
"Attributes": [{
"Id": 3592,
"Value": "Test OS Name",
"IsIgnored": false
}]
}
Output:
ID of template.
DELETE
Description
Delete a template.
Privilege
DEVICE_CONFIGURATION
HTTP Response Codes
204
2.9.5/api/TemplateService/Templates(templateId)/Views
GET
Description
Get a template’s views by TemplateID.
Privilege
VIEW
HTTP Response Codes
200
GET Usage Examples
Output:
{
"@odata.context": "/api/$metadata#Collection(TemplateService.AttributeView)",
"@odata.count": 3,
"value": [
{
"@odata.id": "/api/TemplateService/Templates(10)/Views(1)",
"Id": 1,
"Name": "TemplateSpecific",
"Description": "The hierarchy consists of template specific component classes, groups (from the attribute registry) and attributes.",
"AttributeViewDetails": {
"@odata.id": "/api/TemplateService/Templates(10)/Views(1)/AttributeViewDetails"
},
"DeviceAttributeViewDetails": [
{
"@odata.id": "/api/TemplateService/Templates(10)/Views(1)/DeviceAttributeViewDetails"
}
]
},
{
"@odata.id": "/api/TemplateService/Templates(10)/Views(4)",
"Id": 4,
"Name": "NetworkSpecific",
"Description": "The hierarchy consists of network related component classes, groups (from the attribute registry) and attributes.",
"AttributeViewDetails": {
"@odata.id": "/api/TemplateService/Templates(10)/Views(4)/AttributeViewDetails"
},
"DeviceAttributeViewDetails": [
{
"@odata.id": "/api/TemplateService/Templates(10)/Views(4)/DeviceAttributeViewDetails"
}
]
},
{
"@odata.id": "/api/TemplateService/Templates(10)/Views(6)",
"Id": 6,
"Name": "DeviceInventorySpecific",
"Description": "The hierarchy consists of device intentory related component classes, groups.",
"AttributeViewDetails": {
"@odata.id": "/api/TemplateService/Templates(10)/Views(6)/AttributeViewDetails"
},
"DeviceAttributeViewDetails": [
{
"@odata.id": "/api/TemplateService/Templates(10)/Views(6)/DeviceAttributeViewDetails"
}
]
}
]
}
/api/TemplateService/Templates(templateId)/Views(idView)
GET
Description
Get a template’s view details by TemplateID and ViewID.
Privilege
VIEW
HTTP Response Codes
200
GET Usage Examples
Input:
Output:
{
"@odata.context": "/api/$metadata#TemplateService.AttributeView/$entity",
"@odata.id": "/api/TemplateService/Templates(10)/Views(1)",
"Id": 1,
"Name": "DefaultModel",
"Description": "The default hierarchical model of a template. The hierarchy consists of component classes, groups (from the attribute registry) and attributes.",
"AttributeViewDetails": {
"@odata.id": "/api/TemplateService/Templates(10)/Views(1)/AttributeViewDetails"
},
"DeviceAttributeViewDetails": [
{
"@odata.id": "/api/TemplateService/Templates(10)/Views(1)/DeviceAttributeViewDetails"
}
]
}
2.9.7 /api/TemplateService/Templates(templateId)/Views(idView)/AttributeViewDetails
GET
Description
Get a template view’s attribute details by TemplateID and ViewID.
Privilege
VIEW
HTTP Response Codes
200
GET Usage Examples
Output:
{
"@odata.context": "/api/$metadata#TemplateService.AttributeViewDetail/$entity",
"@odata.id": "/api/TemplateService/Templates(11)/Views(1)/AttributeViewDetails",
"Id": 1,
"Name": "TemplateSpecific",
"Description": "The hierarchy consists of template specific component classes, groups (from the attribute registry) and attributes.",
"AttributeGroupNames": [],
"AttributeGroups": [
{
"GroupNameId": 4,
"DisplayName": "LifecycleController",
"SubAttributeGroups": [
{
"GroupNameId": 410,
"DisplayName": "Lifecycle Controller Attributes",
"SubAttributeGroups": [],
"Attributes": [
{
"AttributeId": 3562,
"CustomId": 0,
"AttributeEditInfoId": 1857,
"DisplayName": "LCAttributes 1 VirtualAddressManagementApplication",
"Description": null,
"Value": null,
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3561,
"CustomId": 0,
"AttributeEditInfoId": 1856,
"DisplayName": "LCAttributes 1 VirtualAddressManagement",
"Description": null,
"Value": "Console",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3563,
"CustomId": 0,
"AttributeEditInfoId": 1858,
"DisplayName": "LCAttributes 1 Provisioning Server",
"Description": null,
"Value": null,
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3559,
"CustomId": 0,
"AttributeEditInfoId": 1644,
"DisplayName": "LCAttributes 1 Part Firmware Update",
"Description": null,
"Value": "Match firmware of replaced part",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3558,
"CustomId": 0,
"AttributeEditInfoId": 1643,
"DisplayName": "LCAttributes 1 Part Configuration Update",
"Description": null,
"Value": "Apply always",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3567,
"CustomId": 0,
"AttributeEditInfoId": 1804,
"DisplayName": "LCAttributes 1 Lifecycle Controller State",
"Description": null,
"Value": "Enabled",
"IsReadOnly": false,
"IsIgnored": true
},
{
"AttributeId": 3560,
"CustomId": 0,
"AttributeEditInfoId": 1855,
"DisplayName": "LCAttributes 1 IPChangeNotifyPS",
"Description": null,
"Value": "Off",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3557,
"CustomId": 0,
"AttributeEditInfoId": 1642,
"DisplayName": "LCAttributes 1 Collect System Inventory on Restart",
"Description": null,
"Value": "Enabled",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3564,
"CustomId": 0,
"AttributeEditInfoId": 1859,
"DisplayName": "LCAttributes 1 BIOS Reset To Defaults Requested",
"Description": null,
"Value": "False",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3565,
"CustomId": 0,
"AttributeEditInfoId": 1860,
"DisplayName": "LCAttributes 1 Automatic Update Feature",
"Description": null,
"Value": "Disabled",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3566,
"CustomId": 0,
"AttributeEditInfoId": 1861,
"DisplayName": "LCAttributes 1 Automatic Backup Feature",
"Description": null,
"Value": "Disabled",
"IsReadOnly": false,
"IsIgnored": false
}
]
}
],
"Attributes": []
}
],
"TemplateEditInfoDetails": {
"@odata.id": "/api/TemplateService/Templates(11)/Views(1)/AttributeViewDetails/TemplateEditInfoDetails"
}
}
2.9.8 /api/TemplateService/Templates(templateId)/Views(idView)/AttributeViewDetails/TemplateEditInfo
GET
Description
Get a template view’s template edit attribute details by TemplateID and ViewID.
Privilege
VIEW
HTTP Response Codes
200
GET Usage Examples
Output:
{
"@odata.context": "/api/$metadata#TemplateService.TemplateEditInfo/$entity",
"@odata.id": "/api/TemplateService/Templates(11)/Views(1)/AttributeViewDetails/TemplateEditInfoDetails",
"Id": 1,
"AttributeOptionSets": [
{
"Id": 2,
"OptionId": [
579,
580,
581
]
},
{
"Id": 3,
"OptionId": [
562,
563
]
},
………
{
"Id": 2874,
"DataType": 18,
"Description": "Specify the iSCSI Qualified Name (IQN) of the eighth iSCSI storage target.",
"IsReadOnly": false,
"IsSecure": false,
"TextMinLength": 0,
"TextMaxLength": 223,
"ValueMin": 0,
"ValueMax": 0,
"DependencyText": null,
"OptionSetId": 0,
"DefaultOptionId": 0
},
{
"Id": 2875,
"DataType": 18,
"Description": "Specify the iSCSI Qualified Name (IQN) of the fifth iSCSI storage target.",
"IsReadOnly": false,
"IsSecure": false,
"TextMinLength": 0,
"TextMaxLength": 223,
"ValueMin": 0,
"ValueMax": 0,
"DependencyText": null,
"OptionSetId": 0,
"DefaultOptionId": 0
},
…………
{
"Id": 2692,
"DataType": 18,
"Description": null,
"IsReadOnly": true,
"IsSecure": false,
"TextMinLength": 0,
"TextMaxLength": 32,
"ValueMin": 0,
"ValueMax": 0,
"DependencyText": null,
"OptionSetId": 0,
"DefaultOptionId": 0
},
{
"Id": 2693,
"DataType": 12,
"Description": null,
"IsReadOnly": true,
"IsSecure": false,
"TextMinLength": 0,
"TextMaxLength": 0,
"ValueMin": 0,
"ValueMax": 0,
"DependencyText": null,
"OptionSetId": 0,
"DefaultOptionId": 0
},
{
"Id": 2694,
"DataType": 18,
"Description": null,
"IsReadOnly": true,
"IsSecure": false,
"TextMinLength": 0,
"TextMaxLength": 32,
"ValueMin": 0,
"ValueMax": 0,
"DependencyText": null,
"OptionSetId": 0,
"DefaultOptionId": 0
}
]
}
2.9.9 /api/TemplateService/Templates(tempalteId)/Views(idView)/DeviceAttributeViewDetails(deviceId)
GET
Description
Get a template view’s device attribute details (device specific attributes) by TemplateID, ViewID and DeviceID.
Privilege
VIEW
HTTP Response Codes
200
GET Usage Examples
Output:
{
"@odata.context": "/api/$metadata#TemplateService.AttributeViewDetail/$entity",
"@odata.id": "/api/TemplateService/Templates(10)/Views(4)/DeviceAttributeViewDetails(0)",
"Id": 4,
"Name": "NetworkSpecific",
"Description": "The hierarchy consists of network related component classes, groups (from the attribute registry) and attributes.",
"AttributeGroupNames": [],
"AttributeGroups": [
{
"GroupNameId": 1001,
"DisplayName": "NICModel",
"SubAttributeGroups": [
{
"GroupNameId": 1,
"DisplayName": "Integrated NIC 1",
"SubAttributeGroups": [
{
"GroupNameId": 1,
"DisplayName": "Port ",
"SubAttributeGroups": [
{
"GroupNameId": 1,
"DisplayName": "Partition ",
"SubAttributeGroups": [],
"Attributes": [
{
"AttributeId": 3297,
"CustomId": 0,
"AttributeEditInfoId": 2969,
"DisplayName": "Partition n Minimum TX Bandwidth",
"Description": null,
"Value": "20",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3298,
"CustomId": 0,
"AttributeEditInfoId": 2968,
"DisplayName": "Partition n Maximum TX Bandwidth",
"Description": null,
"Value": "100",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 0,
"CustomId": 43,
"AttributeEditInfoId": 0,
"DisplayName": "Vlan Tagged",
"Description": null,
"Value": null,
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 0,
"CustomId": 43,
"AttributeEditInfoId": 0,
"DisplayName": "Vlan UnTagged",
"Description": null,
"Value": "0",
"IsReadOnly": false,
"IsIgnored": false
}
]
}
],
"Attributes": []
},
{
"GroupNameId": 1,
"DisplayName": "Port ",
"SubAttributeGroups": [
{
"GroupNameId": 2,
"DisplayName": "Partition ",
"SubAttributeGroups": [],
"Attributes": [
{
"AttributeId": 3350,
"CustomId": 0,
"AttributeEditInfoId": 2969,
"DisplayName": "Partition n Minimum TX Bandwidth",
"Description": null,
"Value": "30",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3351,
"CustomId": 0,
"AttributeEditInfoId": 2968,
"DisplayName": "Partition n Maximum TX Bandwidth",
"Description": null,
"Value": "100",
"IsReadOnly": false,
"IsIgnored": false
}
]
}
],
"Attributes": []
},
{
"GroupNameId": 1,
"DisplayName": "Port ",
"SubAttributeGroups": [
{
"GroupNameId": 3,
"DisplayName": "Partition ",
"SubAttributeGroups": [],
"Attributes": [
{
"AttributeId": 3369,
"CustomId": 0,
"AttributeEditInfoId": 2969,
"DisplayName": "Partition n Minimum TX Bandwidth",
"Description": null,
"Value": "20",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3370,
"CustomId": 0,
"AttributeEditInfoId": 2968,
"DisplayName": "Partition n Maximum TX Bandwidth",
"Description": null,
"Value": "100",
"IsReadOnly": false,
"IsIgnored": false
}
]
}
],
"Attributes": []
},
{
"GroupNameId": 1,
"DisplayName": "Port ",
"SubAttributeGroups": [
{
"GroupNameId": 4,
"DisplayName": "Partition ",
"SubAttributeGroups": [],
"Attributes": [
{
"AttributeId": 3388,
"CustomId": 0,
"AttributeEditInfoId": 2969,
"DisplayName": "Partition n Minimum TX Bandwidth",
"Description": null,
"Value": "30",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3389,
"CustomId": 0,
"AttributeEditInfoId": 2968,
"DisplayName": "Partition n Maximum TX Bandwidth",
"Description": null,
"Value": "100",
"IsReadOnly": false,
"IsIgnored": false
}
]
}
],
"Attributes": []
},
{
"GroupNameId": 2,
"DisplayName": "Port ",
"SubAttributeGroups": [
{
"GroupNameId": 1,
"DisplayName": "Partition ",
"SubAttributeGroups": [],
"Attributes": [
{
"AttributeId": 3431,
"CustomId": 0,
"AttributeEditInfoId": 2969,
"DisplayName": "Partition n Minimum TX Bandwidth",
"Description": null,
"Value": "20",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3432,
"CustomId": 0,
"AttributeEditInfoId": 2968,
"DisplayName": "Partition n Maximum TX Bandwidth",
"Description": null,
"Value": "100",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 0,
"CustomId": 47,
"AttributeEditInfoId": 0,
"DisplayName": "Vlan Tagged",
"Description": null,
"Value": null,
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 0,
"CustomId": 47,
"AttributeEditInfoId": 0,
"DisplayName": "Vlan UnTagged",
"Description": null,
"Value": "0",
"IsReadOnly": false,
"IsIgnored": false
}
]
}
],
"Attributes": []
},
{
"GroupNameId": 2,
"DisplayName": "Port ",
"SubAttributeGroups": [
{
"GroupNameId": 2,
"DisplayName": "Partition ",
"SubAttributeGroups": [],
"Attributes": [
{
"AttributeId": 3484,
"CustomId": 0,
"AttributeEditInfoId": 2969,
"DisplayName": "Partition n Minimum TX Bandwidth",
"Description": null,
"Value": "30",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3485,
"CustomId": 0,
"AttributeEditInfoId": 2968,
"DisplayName": "Partition n Maximum TX Bandwidth",
"Description": null,
"Value": "100",
"IsReadOnly": false,
"IsIgnored": false
}
]
}
],
"Attributes": []
},
{
"GroupNameId": 2,
"DisplayName": "Port ",
"SubAttributeGroups": [
{
"GroupNameId": 3,
"DisplayName": "Partition ",
"SubAttributeGroups": [],
"Attributes": [
{
"AttributeId": 3503,
"CustomId": 0,
"AttributeEditInfoId": 2969,
"DisplayName": "Partition n Minimum TX Bandwidth",
"Description": null,
"Value": "20",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3504,
"CustomId": 0,
"AttributeEditInfoId": 2968,
"DisplayName": "Partition n Maximum TX Bandwidth",
"Description": null,
"Value": "100",
"IsReadOnly": false,
"IsIgnored": false
}
]
}
],
"Attributes": []
},
{
"GroupNameId": 2,
"DisplayName": "Port ",
"SubAttributeGroups": [
{
"GroupNameId": 4,
"DisplayName": "Partition ",
"SubAttributeGroups": [],
"Attributes": [
{
"AttributeId": 3522,
"CustomId": 0,
"AttributeEditInfoId": 2969,
"DisplayName": "Partition n Minimum TX Bandwidth",
"Description": null,
"Value": "30",
"IsReadOnly": false,
"IsIgnored": false
},
{
"AttributeId": 3523,
"CustomId": 0,
"AttributeEditInfoId": 2968,
"DisplayName": "Partition n Maximum TX Bandwidth",
"Description": null,
"Value": "100",
"IsReadOnly": false,
"IsIgnored": false
}
]
}
],
"Attributes": []
}
],
"Attributes": []
}
],
"Attributes": []
}
],
"TemplateEditInfoDetails": {
"@odata.id": "/api/TemplateService/Templates(10)/Views(4)/DeviceAttributeViewDetails(0)/TemplateEditInfoDetails"
}
}
2.9.10 /api/TemplateService/Actions/TemplateService.Clone
POST
Description
Clone a template.
Privilege
DEVICE_CONFIGURATION
HTTP Response Codes
200
POST Usage Examples: Clone a template
Input:
{
"SourceTemplateId": 11,
"NewTemplateName": "Example Test Clone"
}
Output:
ID of cloned template.
2.9.11/api/TemplateService/Actions/TemplateService.Export
POST
Description
Export a template.
Privilege
DEVICE_CONFIGURATION
HTTP Response Codes
200
POST Usage Examples : Export a template
Input:
{
"TemplateId": 11
}
Output:
{
"TemplateId": 11,
"Content": "<SystemConfiguration Model=\"PowerEdge M620\" ServiceTag=\"6HHN9Z1\" TimeStamp=\"Tue Dec 5 19:22:25 2017\">\n<Component FQDD=\"LifecycleController.Embedded.1\">\n<Attribute Name=\"LCAttributes.1#VirtualAddressManagementApplication\"/>\n<Attribute Name=\"LCAttributes.1#VirtualAddressManagement\">Console</Attribute>\n<Attribute Name=\"LCAttributes.1#ProvisioningServer\"/>\n<Attribute Name=\"LCAttributes.1#PartFirmwareUpdate\">Match firmware of replaced part</Attribute>\n<Attribute Name=\"LCAttributes.1#PartConfigurationUpdate\">Apply always</Attribute>\n<Attribute Name=\"LCAttributes.1#IPChangeNotifyPS\">Off</Attribute>\n<Attribute Name=\"LCAttributes.1#CollectSystemInventoryOnRestart\">Enabled</Attribute>\n<Attribute Name=\"LCAttributes.1#BIOSRTDRequested\">False</Attribute>\n<Attribute Name=\"LCAttributes.1#AutoUpdate\">Disabled</Attribute>\n<Attribute Name=\"LCAttributes.1#AutoBackup\">Disabled</Attribute>\n</Component>\n</SystemConfiguration>\n",
"ContentType": "xml",
"ViewTypeId": 2
}
2.9.12 /api/TemplateService/Actions/TemplateService.Import
POST
Description
Import a template from XML format.
Privilege
DEVICE_CONFIGURATION
HTTP Response Codes
200
POST Usage Examples : Import a template
Input:
{
"Name": "Import Test",
"Type": 2,
"Content": "<SystemConfiguration Model=\"PowerEdge R620\" ServiceTag=\"1234567\" TimeStamp=\"Thu Aug 14 16:01:06 2017\">\r\n <Component FQDD=\"LifecycleController.Embedded.1\">\r\n <Attribute Name=\"LCAttributes.1#CollectSystemInventoryOnRestart\">Enabled</Attribute>\r\n <Attribute Name=\"LCAttributes.1#PartConfigurationUpdate\">Disabled</Attribute>\r\n <Attribute Name=\"LCAttributes.1#PartFirmwareUpdate\">Disable</Attribute>\r\n <!--<Attribute Name=\"LCAttributes.1#LifecycleControllerState\">Enabled</Attribute>-->\r\n <Attribute Name=\"LCAttributes.1#IPChangeNotifyPS\">Off</Attribute>\r\n <Attribute Name=\"LCAttributes.1#VirtualAddressManagementApplication\" />\r\n <Attribute Name=\"LCAttributes.1#ProvisioningServer\" />\r\n <Attribute Name=\"LCAttributes.1#BIOSRTDRequested\">False</Attribute>\r\n <Attribute Name=\"LCAttributes.1#AutoUpdate\">Enabled</Attribute>\r\n <Attribute Name=\"LCAttributes.1#AutoBackup\">Disabled</Attribute>\r\n <Attribute Name=\"LCAttributes.1#AutoRestore\">Enabled</Attribute>\r\n </Component>\r\n <Component FQDD=\"System.Embedded.1\">\r\n <Attribute Name=\"LCD.1#Configuration\">Service Tag</Attribute>\r\n <!--<Attribute Name=\"LCD.1#UserDefinedString\"/>-->\r\n <Attribute Name=\"ThermalConfig.1#CriticalEventGenerationInterval\">30</Attribute>\r\n <Attribute Name=\"ThermalConfig.1#EventGenerationInterval\">30</Attribute>\r\n <Attribute Name=\"ThermalSettings.1#BaseAlgorithm\">Auto</Attribute>\r\n <Attribute Name=\"ThermalSettings.1#FanSpeedOffset\">None</Attribute>\r\n <Attribute Name=\"ServerPwr.1#PowerCapSetting\">Disabled</Attribute>\r\n <!--<Attribute Name=\"ServerPwr.1#PowerCapValue\">324</Attribute>-->\r\n <Attribute Name=\"ServerPwr.1#PSRedPolicy\">Not Redundant</Attribute>\r\n <Attribute Name=\"ServerPwr.1#PSPFCEnabled\">Disabled</Attribute>\r\n <!--<Attribute Name=\"ServerTopology.1#DataCenterName\"/>-->\r\n <!--<Attribute Name=\"ServerTopology.1#AisleName\"/>-->\r\n <!--<Attribute Name=\"ServerTopology.1#RackName\"/>-->\r\n <!--<Attribute Name=\"ServerTopology.1#RackSlot\">1</Attribute>-->\r\n <!--<Attribute Name=\"ServerTopology.1#RoomName\"/>-->\r\n <!--<Attribute Name=\"ServerOS.1#HostName\">WIN-KGVB03LNPQE</Attribute>-->\r\n <!--<Attribute Name=\"ServerOS.1#OSName\">Windows Server 2012 R2</Attribute>-->\r\n </Component>\r\n <Component FQDD=\"iDRAC.Embedded.1\">\r\n <Attribute Name=\"IPMILan.1#Enable\">Disabled</Attribute>\r\n <Attribute Name=\"IPMILan.1#PrivLimit\">Administrator</Attribute>\r\n <Attribute Name=\"IPMILan.1#EncryptionKey\">0000000000000000000000000000000000000000</Attribute>\r\n <Attribute Name=\"IPMILan.1#CommunityName\">public</Attribute>\r\n <Attribute Name=\"IPMILan.1#AlertEnable\">Disabled</Attribute>\r\n <Attribute Name=\"Update.1#FwUpdateTFTPEnable\">Enabled</Attribute>\r\n <Attribute Name=\"Update.1#FwUpdateIPAddr\">0.0.0.0</Attribute>\r\n <Attribute Name=\"Update.1#FwUpdatePath\" />\r\n <Attribute Name=\"EmailAlert.1#Enable\">Disabled</Attribute>\r\n <Attribute Name=\"EmailAlert.1#Address\" />\r\n <Attribute Name=\"EmailAlert.1#CustomMsg\" />\r\n <Attribute Name=\"EmailAlert.2#Enable\">Disabled</Attribute>\r\n <Attribute Name=\"EmailAlert.2#Address\" />\r\n <Attribute Name=\"EmailAlert.2#CustomMsg\" />\r\n <Attribute Name=\"EmailAlert.3#Enable\">Disabled</Attribute>\r\n <Attribute Name=\"EmailAlert.3#Address\" />\r\n <Attribute Name=\"EmailAlert.3#CustomMsg\" />\r\n <Attribute Name=\"EmailAlert.4#Enable\">Disabled</Attribute>\r\n <Attribute Name=\"EmailAlert.4#Address\" />\r\n <Attribute Name=\"EmailAlert.4#CustomMsg\" />\r\n <Attribute Name=\"Telnet.1#Enable\">Disabled</Attribute>\r\n <Attribute Name=\"Telnet.1#Port\">23</Attribute>\r\n <Attribute Name=\"Telnet.1#Timeout\">1800</Attribute>\r\n <Attribute Name=\"SSH.1#Enable\">Enabled</Attribute>\r\n <Attribute Name=\"SSH.1#Port\">22</Attribute>\r\n <Attribute Name=\"SSH.1#Timeout\">1800</Attribute>\r\n <Attribute Name=\"WebServer.1#Enable\">Enabled</Attribute>\r\n <Attribute Name=\"WebServer.1#HttpPort\">80</Attribute>\r\n <Attribute Name=\"WebServer.1#HttpsPort\">443</Attribute>\r\n <Attribute Name=\"WebServer.1#Timeout\">1800</Attribute>\r\n <Attribute Name=\"WebServer.1#LowerEncryptionBitLength\">Enabled</Attribute>\r\n <Attribute Name=\"WebServer.1#HttpsRedirection\">Enabled</Attribute>\r\n <Attribute Name=\"VirtualConsole.1#Enable\">Enabled</Attribute>\r\n <Attribute Name=\"VirtualConsole.1#EncryptEnable\">None</Attribute>\r\n <Attribute Name=\"VirtualConsole.1#LocalVideo\">Enabled</Attribute>\r\n <Attribute Name=\"VirtualConsole.1#PluginType\">Java</Attribute>\r\n <Attribute Name=\"VirtualConsole.1#MaxSessions\">4</Attribute>\r\n <Attribute Name=\"VirtualConsole.1#Port\">5900</Attribute>\r\n <Attribute Name=\"VirtualConsole.1#Timeout\">1800</Attribute>\r\n <Attribute Name=\"VirtualConsole.1#AccessPrivilege\">Deny Access</Attribute>\r\n <Attribute Name=\"Racadm.1#Enable\">Enabled</Attribute>\r\n <Attribute Name=\"Racadm.1#Timeout\">60</Attribute>\r\n <Attribute Name=\"Serial.1#Enable\">Disabled</Attribute>\r\n <Attribute Name=\"Serial.1#BaudRate\">115200</Attribute>\r\n <Attribute Name=\"Serial.1#IdleTimeout\">300</Attribute>\r\n <Attribute Name=\"Serial.1#NoAuth\">Disabled</Attribute>\r\n <Attribute Name=\"Serial.1#HistorySize\">8192</Attribute>\r\n <Attribute Name=\"Serial.1#Command\" />\r\n <Attribute Name=\"SerialRedirection.1#Enable\">Enabled</Attribute>\r\n <Attribute Name=\"SerialRedirection.1#QuitKey\">^\\</Attribute>\r\n <Attribute Name=\"IPMISerial.1#ConnectionMode\">Basic</Attribute>\r\n <Attribute Name=\"IPMISerial.1#BaudRate\">19200</Attribute>\r\n <Attribute Name=\"IPMISerial.1#FlowControl\">None</Attribute>\r\n <Attribute Name=\"IPMISerial.1#ChanPrivLimit\">Administrator</Attribute>\r\n <Attribute Name=\"IPMISerial.1#LineEdit\">Enabled</Attribute>\r\n <Attribute Name=\"IPMISerial.1#DeleteControl\">Disabled</Attribute>\r\n <Attribute Name=\"IPMISerial.1#EchoControl\">Enabled</Attribute>\r\n <Attribute Name=\"IPMISerial.1#HandshakeControl\">Enabled</Attribute>\r\n <Attribute Name=\"IPMISerial.1#NewLineSeq\">CR-LF</Attribute>\r\n <Attribute Name=\"IPMISerial.1#InputNewLineSeq\">Enter</Attribute>\r\n <Attribute Name=\"IPMISOL.1#Enable\">Enabled</Attribute>\r\n <Attribute Name=\"IPMISOL.1#BaudRate\">115200</Attribute>\r\n <Attribute Name=\"IPMISOL.1#MinPrivilege\">Administrator</Attribute>\r\n <Attribute Name=\"IPMISOL.1#AccumulateInterval\">10</Attribute>\r\n <Attribute Name=\"IPMISOL.1#SendThreshold\">255</Attribute>\r\n <Attribute Name=\"SNMP.1#AgentEnable\">Enabled</Attribute>\r\n <Attribute Name=\"SNMP.1#AgentCommunity\">public</Attribute>\r\n <Attribute Name=\"SNMP.1#TrapFormat\">SNMPv1</Attribute>\r\n <Attribute Name=\"SNMP.1#SNMPProtocol\">All</Attribute>\r\n <Attribute Name=\"SNMP.1#DiscoveryPort\">161</Attribute>\r\n <Attribute Name=\"SNMP.1#AlertPort\">162</Attribute>\r\n <Attribute Name=\"VirtualMedia.1#Attached\">AutoAttach</Attribute>\r\n <Attribute Name=\"VirtualMedia.1#BootOnce\">Disabled</Attribute>\r\n <Attribute Name=\"VirtualMedia.1#KeyEnable\">Disabled</Attribute>\r\n <Attribute Name=\"VirtualMedia.1#FloppyEmulation\">Disabled</Attribute>\r\n <Attribute Name=\"VirtualMedia.1#EncryptEnable\">AES</Attribute>\r\n <Attribute Name=\"IPBlocking.1#RangeEnable\">Disabled</Attribute>\r\n <Attribute Name=\"IPBlocking.1#RangeAddr\">192.168.1.1</Attribute>\r\n <Attribute Name=\"IPBlocking.1#RangeMask\">255.255.255.0</Attribute>\r\n <Attribute Name=\"IPBlocking.1#BlockEnable\">Enabled</Attribute>\r\n <Attribute Name=\"IPBlocking.1#FailCount\">3</Attribute>\r\n <Attribute Name=\"IPBlocking.1#FailWindow\">60</Attribute>\r\n <Attribute Name=\"IPBlocking.1#PenaltyTime\">600</Attribute>\r\n <Attribute Name=\"LocalSecurity.1#PrebootConfig\">Disabled</Attribute>\r\n <Attribute Name=\"LocalSecurity.1#LocalConfig\">Disabled</Attribute>\r\n <Attribute Name=\"Time.1#TimeZoneOffset\">0</Attribute>\r\n <Attribute Name=\"Time.1#DaylightOffset\">0</Attribute>\r\n <Attribute Name=\"Time.1#TimeZone\">CST6CDT</Attribute>\r\n <Attribute Name=\"Security.1#CsrCommonName\" />\r\n <Attribute Name=\"Security.1#CsrOrganizationName\" />\r\n <Attribute Name=\"Security.1#CsrOrganizationUnit\" />\r\n <Attribute Name=\"Security.1#CsrLocalityName\" />\r\n <Attribute Name=\"Security.1#CsrStateName\" />\r\n <Attribute Name=\"Security.1#CsrCountryCode\">US</Attribute>\r\n <Attribute Name=\"Security.1#CsrEmailAddr\" />\r\n <Attribute Name=\"Security.1#CsrKeySize\">1024</Attribute>\r\n <Attribute Name=\"ActiveDirectory.1#Enable\">Enabled</Attribute>\r\n <Attribute Name=\"ActiveDirectory.1#RacName\" />\r\n <Attribute Name=\"ActiveDirectory.1#RacDomain\" />\r\n <Attribute Name=\"ActiveDirectory.1#AuthTimeout\">120</Attribute>\r\n <Attribute Name=\"ActiveDirectory.1#Schema\">Extended Schema</Attribute>\r\n <Attribute Name=\"ActiveDirectory.1#DomainController1\" />\r\n <Attribute Name=\"ActiveDirectory.1#DomainController2\" />\r\n <Attribute Name=\"ActiveDirectory.1#DomainController3\" />\r\n <Attribute Name=\"ActiveDirectory.1#GlobalCatalog1\" />\r\n <Attribute Name=\"ActiveDirectory.1#GlobalCatalog2\" />\r\n <Attribute Name=\"ActiveDirectory.1#GlobalCatalog3\" />\r\n <Attribute Name=\"ActiveDirectory.1#CertValidationEnable\">Disabled</Attribute>\r\n <Attribute Name=\"ActiveDirectory.1#GCLookupEnable\">Disabled</Attribute>\r\n <Attribute Name=\"ActiveDirectory.1#DCLookupEnable\">Disabled</Attribute>\r\n <Attribute Name=\"ActiveDirectory.1#GCRootDomain\" />\r\n <Attribute Name=\"ActiveDirectory.1#DCLookupDomainName\" />\r\n <Attribute Name=\"ActiveDirectory.1#DCLookupByUserDomain\">Enabled</Attribute>\r\n <Attribute Name=\"ActiveDirectory.1#SSOEnable\">Disabled</Attribute>\r\n <Attribute Name=\"SNMPAlert.1#State\">Enabled</Attribute>\r\n <Attribute Name=\"SNMPAlert.2#Destination\">0.0.0.0</Attribute>\r\n <Attribute Name=\"SNMPAlert.2#State\">Disabled</Attribute>\r\n <Attribute Name=\"SNMPAlert.3#Destination\">0.0.0.0</Attribute>\r\n <Attribute Name=\"SNMPAlert.3#State\">Disabled</Attribute>\r\n <Attribute Name=\"SNMPAlert.4#Destination\">0.0.0.0</Attribute>\r\n <Attribute Name=\"SNMPAlert.4#State\">Disabled</Attribute>\r\n <Attribute Name=\"SNMPAlert.5#Destination\">::</Attribute>\r\n <Attribute Name=\"SNMPAlert.5#State\">Disabled</Attribute>\r\n <Attribute Name=\"SNMPAlert.6#Destination\">::</Attribute>\r\n <Attribute Name=\"SNMPAlert.6#State\">Disabled</Attribute>\r\n <Attribute Name=\"SNMPAlert.7#Destination\">::</Attribute>\r\n <Attribute Name=\"SNMPAlert.7#State\">Disabled</Attribute>\r\n <Attribute Name=\"SNMPAlert.8#Destination\">::</Attribute>\r\n <Attribute Name=\"SNMPAlert.8#State\">Disabled</Attribute>\r\n </Component>\r\n <Component FQDD=\"BIOS.Setup.1-1\">\r\n <Attribute Name=\"MemTest\">Enabled</Attribute>\r\n <Attribute Name=\"MemOpMode\">OptimizerMode</Attribute>\r\n </Component>\r\n</SystemConfiguration>",
"ViewTypeId": 2
}
Output:
ID of created template.
2.9.13 /api/TemplateService/Actions/TemplateService.Deploy
POST
Description
Create a Deploy Template job.
Privilege
DEVICE_CONFIGURATION
HTTP Response Codes
200
POST Usage Examples : Create a deploy template task.
Input:
{
"Id": 11,
"TargetIds": [5514],
"NetworkBootIsoModel": {
"BootToNetwork": true,
"ShareType": "CIFS",
"IsoPath": "bootToIsoPath.iso",
"ShareDetail": {
"IpAddress": "1.2.3.4",
"ShareName": "1.2.3.4",
"User": "bootToIsoUsername",
"Password": "bootToIsoPassword"
}
},
"Attributes": [],
"Options": {
"ShutdownType": 0,
"TimeToWaitBeforeShutdown": 300,
"EndHostPowerState": 1
},
"Schedule": {
"RunNow": true,
"RunLater": false
}
}
Output:
Id of created task.
/api/TemplateService/Actions/TemplateService.UpdateNetworkConfig
POST
Description
Update the network configuration parameters of a template (min max bandwidth of NICs).
Privilege
DEVICE_CONFIGURATION
HTTP Response Codes
200
POST Usage Examples : Update the min max bandwidth of NICs.
Input:
{
"TemplateId": 10,
"IdentityPoolId": 0,
"Attributes": [{
"Attributes": [{
"Id": 3297,
"Value": "20",
"IsIgnored": false
},
{
"Id": 3298,
"Value": "100",
"IsIgnored": false
},
{
"Id": 3350,
"Value": "30",
"IsIgnored": false
},
{
"Id": 3351,
"Value": "100",
"IsIgnored": false
},
{
"Id": 3369,
"Value": "20",
"IsIgnored": false
},
{
"Id": 3370,
"Value": "100",
"IsIgnored": false
},
{
"Id": 3388,
"Value": "30",
"IsIgnored": false
},
{
"Id": 3389,
"Value": "100",
"IsIgnored": false
},
{
"Id": 3431,
"Value": "20",
"IsIgnored": false
},
{
"Id": 3432,
"Value": "100",
"IsIgnored": false
},
{
"Id": 3484,
"Value": "30",
"IsIgnored": false
},
{
"Id": 3485,
"Value": "100",
"IsIgnored": false
},
{
"Id": 3503,
"Value": "20",
"IsIgnored": false
},
{
"Id": 3504,
"Value": "100",
"IsIgnored": false
},
{
"Id": 3522,
"Value": "30",
"IsIgnored": false
},
{
"Id": 3523,
"Value": "100",
"IsIgnored": false
}]
}],
"VlanAttributes": []
}
2.9.15 /api/TemplateService/Baselines
GET
Description
Get the configuration compliance baselines.
Privilege
VIEW
HTTP Response Codes
200
GET Usage Examples
Input:
Output:
{
"@odata.context": "/api/$metadata#Collection(TemplateService.Baseline)",
"@odata.count": 2,
"value": [
{
"@odata.id": "/api/TemplateService/Baselines(2)",
"Id": 2,
"Name": "Example Group Compliance Baseline",
"Description": null,
"TemplateId": 12,
"TemplateName": "Example Compliance Template",
"TemplateType": 2,
"TaskId": 33764,
"LastRun": null,
"BaselineTargets": [
{
"Id": 1164,
"Type": {
"Id": 1000,
"Name": "Group"
}
}
],
"ConfigComplianceSummary": {
"ComplianceStatus": "CRITICAL",
"NumberOfCritical": 12,
"NumberOfWarning": 0,
"NumberOfNormal": 1,
"NumberOfDowngrade": 4
},
"DeviceConfigComplianceReports": [
{
"@odata.id": "/api/TemplateService/Baselines(2)/DeviceConfigComplianceReports"
}
]
},
{
"@odata.id": "/api/TemplateService/Baselines(1)",
"Id": 1,
"Name": "Example Baseline",
"Description": "Example Description",
"TemplateId": 12,
"TemplateName": "Example Compliance Template",
"TemplateType": 2,
"TaskId": 33614,
"LastRun": null,
"BaselineTargets": [
{
"Id": 4314,
"Type": {
"Id": 1000,
"Name": "SERVER"
}
},
{
"Id": 5514,
"Type": {
"Id": 1000,
"Name": "SERVER"
}
}
],
"ConfigComplianceSummary": {
"ComplianceStatus": "NOT_INVENTORIED",
"NumberOfCritical": 0,
"NumberOfWarning": 0,
"NumberOfNormal": 1,
"NumberOfDowngrade": 1
},
"DeviceConfigComplianceReports": [
{
"@odata.id": "/api/TemplateService/Baselines(1)/DeviceConfigComplianceReports"
}
]
}
]
}
POST
Description
Create or update a baseline.
Privilege
DEVICE_CONFIGURATION
HTTP Response Codes
200
POST Usage Examples: Create a baseline
Input:
{
"Name": "Baseline test",
"TemplateId": 12,
"BaselineTargets": [{
"Id": 5514,
"Type": {
"Id": 1,
"Name": "DEVICE"
}
}]
}
Output:
{
"Id": 3,
"Name": "Baseline test",
"Description": null,
"LastRun": null,
"TemplateId": 12,
"TemplateName": null,
"TemplateType": 0,
"TaskId": 0,
"ConfigComplianceSummary": null,
"BaselineTargets": [{
"Id": 5514,
"Type": {
"Id": 1,
"Name": "DEVICE"
}
}]
}
POST Usage Examples: Update a baseline
Input:
{
"Id": 2,
"Name": "Example Group Compliance Baseline - Renamed",
"TemplateId": 12,
"BaselineTargets": [{
"Id": 1164,
"Type": {
"Id": 1000,
"Name": "Group"
}
}]
}
Output:
{
"Id": 0,
"Name": "Example Group Compliance Baseline - Renamed",
"Description": null,
"LastRun": null,
"TemplateId": 12,
"TemplateName": null,
"TemplateType": 0,
"TaskId": 0,
"ConfigComplianceSummary": null,
"BaselineTargets": [{
"Id": 1164,
"Type": {
"Id": 1000,
"Name": "Group"
}
}]
}
2.9.16 /api/TemplateService/Baselines(baselineId)
GET
Description
Get the configuration compliance baseline by BaselineID.
Privilege
VIEW
HTTP Response Codes
200
GET Usage Examples
Input:
Output:
{
"@odata.context": "/api/$metadata#TemplateService.Baseline/$entity",
"@odata.id": "/api/TemplateService/Baselines(1)",
"Id": 1,
"Name": "Example Baseline",
"Description": "Example Description",
"TemplateId": 12,
"TemplateName": "Example Compliance Template",
"TemplateType": 2,
"TaskId": 33614,
"LastRun": null,
"BaselineTargets": [
{
"Id": 4314,
"Type": {
"Id": 1000,
"Name": "SERVER"
}
},
{
"Id": 5514,
"Type": {
"Id": 1000,
"Name": "SERVER"
}
}
],
"ConfigComplianceSummary": {
"ComplianceStatus": "NOT_INVENTORIED",
"NumberOfCritical": 0,
"NumberOfWarning": 0,
"NumberOfNormal": 1,
"NumberOfDowngrade": 1
},
"DeviceConfigComplianceReports": [
{
"@odata.id": "/api/TemplateService/Baselines(1)/DeviceConfigComplianceReports"
}
]
}
DELETE
Description
Delete a baseline.
Privilege
DEVICE_CONFIGURATION
HTTP Response Codes
204
2.9.17 /api/TemplateService/Baselines(baselineId)/DeviceConfigComplianceReports
GET
Description
Get the configuration compliance baseline device report by BaselineID.
Privilege
VIEW
HTTP Response Codes
200
GET Usage Examples
Input:
Output:
{
"@odata.context": "/api/$metadata#Collection(TemplateService.DeviceConfigComplianceReports)",
"@odata.count": 2,
"value": [
{
"@odata.id": "/api/TemplateService/Baselines(1)/DeviceConfigComplianceReports(5514)",
"Id": 5514,
"DeviceName": "idrac-6hhn9z1.smd.devops.dell.com",
"Model": "PowerEdge M620",
"ServiceTag": "6HHN9Z1",
"ComplianceStatus": "COMPLIANT",
"DeviceType": 1000,
"InventoryTime": "2017-12-05 19:40:49.395245",
"DeviceComplianceDetails": {
"@odata.id": "/api/TemplateService/Baselines(1)/DeviceConfigComplianceReports(5514)/DeviceComplianceDetails"
}
},
{
"@odata.id": "/api/TemplateService/Baselines(1)/DeviceConfigComplianceReports(4314)",
"Id": 4314,
"DeviceName": "WIN-300NRT6ERMF",
"Model": "PowerEdge M620",
"ServiceTag": "6F7V3Y1",
"ComplianceStatus": "NOT_INVENTORIED",
"DeviceType": 1000,
"InventoryTime": null,
"DeviceComplianceDetails": {
"@odata.id": "/api/TemplateService/Baselines(1)/DeviceConfigComplianceReports(4314)/DeviceComplianceDetails"
}
}
]
}
2.9.18 /api/TemplateService/Baselines(baselineId)/DeviceConfigComplianceReports(deviceId)/DeviceComplianceDetails
GET
Description
Get the configuration compliance baseline device compliance details report by BaselineID and DeviceID.
Privilege
VIEW
HTTP Response Codes
200
GET Usage Examples
Input:
Output:
{
"@odata.context": "/api/$metadata#TemplateService.DeviceComplianceDetail/$entity",
"@odata.id": "/api/TemplateService/Baselines(1)/DeviceConfigComplianceReports(5514)/DeviceComplianceDetails",
"DeviceId": 5514,
"DeviceName": "idrac.dell.com",
"BaselineId": 1,
"BaselineName": "Example Baseline",
"TemplateId": 12,
"TemplateName": "Example Compliance Template",
"ComplianceAttributeGroups": [
{
"GroupNameId": 2,
"DisplayName": "System",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template.",
"ComplianceSubAttributeGroups": [
{
"GroupNameId": 1,
"DisplayName": "Chassis Power State",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template.",
"ComplianceSubAttributeGroups": [],
"Attributes": [
{
"AttributeId": 3585,
"CustomId": 0,
"DisplayName": "ChassisPwrState 1 Chassis LED State",
"Description": null,
"Value": null,
"ExpectedValue": "Off",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
}
]
},
{
"GroupNameId": 3,
"DisplayName": "Server Power",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template.",
"ComplianceSubAttributeGroups": [],
"Attributes": [
{
"AttributeId": 3583,
"CustomId": 0,
"DisplayName": "ServerPwr 1 Power Cap Setting",
"Description": null,
"Value": null,
"ExpectedValue": "Enabled",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
},
{
"AttributeId": 3584,
"CustomId": 0,
"DisplayName": "ServerPwr 1 Power Cap Value",
"Description": null,
"Value": null,
"ExpectedValue": "227",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
}
]
},
{
"GroupNameId": 4,
"DisplayName": "Thermal Configuration",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template.",
"ComplianceSubAttributeGroups": [],
"Attributes": [
{
"AttributeId": 3580,
"CustomId": 0,
"DisplayName": "ThermalConfig 1 Critical Event Generation Interval",
"Description": null,
"Value": null,
"ExpectedValue": "30",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
},
{
"AttributeId": 3579,
"CustomId": 0,
"DisplayName": "ThermalConfig 1 Event Generation Interval",
"Description": null,
"Value": null,
"ExpectedValue": "30",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
}
]
},
{
"GroupNameId": 5,
"DisplayName": "Thermal Settings",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template.",
"ComplianceSubAttributeGroups": [],
"Attributes": [
{
"AttributeId": 3581,
"CustomId": 0,
"DisplayName": "ThermalSettings 1 Thermal Profile Optimization",
"Description": null,
"Value": null,
"ExpectedValue": "Default Thermal Profile Settings",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
}
]
},
{
"GroupNameId": 6,
"DisplayName": "Unknown",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template.",
"ComplianceSubAttributeGroups": [],
"Attributes": [
{
"AttributeId": 3582,
"CustomId": 0,
"DisplayName": "ThermalSettings 1 ThirdPartyPCIFanResponse",
"Description": null,
"Value": null,
"ExpectedValue": "Enabled",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
}
]
}
],
"Attributes": []
},
{
"GroupNameId": 4,
"DisplayName": "LifecycleController",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template.",
"ComplianceSubAttributeGroups": [
{
"GroupNameId": 2,
"DisplayName": "Lifecycle Controller Attributes",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template.",
"ComplianceSubAttributeGroups": [],
"Attributes": [
{
"AttributeId": 3577,
"CustomId": 0,
"DisplayName": "LCAttributes 1 Automatic Backup Feature",
"Description": null,
"Value": null,
"ExpectedValue": "Disabled",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
},
{
"AttributeId": 3576,
"CustomId": 0,
"DisplayName": "LCAttributes 1 Automatic Update Feature",
"Description": null,
"Value": null,
"ExpectedValue": "Disabled",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
},
{
"AttributeId": 3575,
"CustomId": 0,
"DisplayName": "LCAttributes 1 BIOS Reset To Defaults Requested",
"Description": null,
"Value": null,
"ExpectedValue": "False",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
},
{
"AttributeId": 3568,
"CustomId": 0,
"DisplayName": "LCAttributes 1 Collect System Inventory on Restart",
"Description": null,
"Value": null,
"ExpectedValue": "Enabled",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
},
{
"AttributeId": 3571,
"CustomId": 0,
"DisplayName": "LCAttributes 1 IPChangeNotifyPS",
"Description": null,
"Value": null,
"ExpectedValue": "Off",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
},
{
"AttributeId": 3569,
"CustomId": 0,
"DisplayName": "LCAttributes 1 Part Configuration Update",
"Description": null,
"Value": null,
"ExpectedValue": "Apply always",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
},
{
"AttributeId": 3570,
"CustomId": 0,
"DisplayName": "LCAttributes 1 Part Firmware Update",
"Description": null,
"Value": null,
"ExpectedValue": "Match firmware of replaced part",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
},
{
"AttributeId": 3574,
"CustomId": 0,
"DisplayName": "LCAttributes 1 Provisioning Server",
"Description": null,
"Value": null,
"ExpectedValue": null,
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
},
{
"AttributeId": 3572,
"CustomId": 0,
"DisplayName": "LCAttributes 1 VirtualAddressManagement",
"Description": null,
"Value": null,
"ExpectedValue": "Console",
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
},
{
"AttributeId": 3573,
"CustomId": 0,
"DisplayName": "LCAttributes 1 VirtualAddressManagementApplication",
"Description": null,
"Value": null,
"ExpectedValue": null,
"ComplianceStatus": 1,
"ComplianceReason": "All attributes on the target device(s) match the compliance template."
}
]
}
],
"Attributes": []
}
]
}
Please provide ratings (1-5 stars).
Please provide ratings (1-5 stars).
Please provide ratings (1-5 stars).
Please select whether the article was helpful or not.
Comments cannot contain these special characters: <>()\