OpenManage Enterprise and OpenManage Enterprise - Modular Edition RESTful API Guide
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. © 2018 -2020 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents 1 About this document................................................................................................................... 16 2 Overview.................................................................................................................................... 17 RESTful application programming interface..................................................................................................................... 17 OData..................................................
/api/AccountService/Actions/AccountService.Delete........................................................................................... 44 /api/AccountService/Roles.........................................................................................................................................44 /api/AccountService/Roles(Id)..................................................................................................................................
Alert policies......................................................................................................................................................................... 96 /api/AlertService/AlertPolicies................................................................................................................................... 96 /api/AlertService/AlertPolicies(Id)............................................................................................................................
/api/TemplateService/Templates(Id)/Views(Id)/DeviceAttributeViewDetails(Id)........................................... 156 /api/TemplateService/Templates(26)/Views(9)/DeviceAttributeViewDetails(10176)..................................... 161 /api/TemplateService/Profiles.................................................................................................................................. 162 /api/TemplateService/Profiles(Id).........................................................................
GET method for Devices(Id)......................................................................................................................................202 /api/DeviceService/Devices(Id)/InventoryDetails...................................................................................................... 204 GET method for InventoryDetails.............................................................................................................................
/api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.GetComputeIPs......................234 POST method for /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/ DeviceService.GetComputeIPs............................................................................................................................. 234 /api/DeviceService/DeviceSummary............................................................................................................................
/api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0 ...278 GET method for AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0.................................... 278 /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25& $skip=0&$orderby=Identifier asc................................................................................................................................
/api/ApplicationService/Actions/ApplicationService.ResetApplication.....................................................................331 POST method for ResetApplication.......................................................................................................................... 331 12 Console version.......................................................................................................................332 /api/ApplicationService/Info............................................
/api/ManagementDomainService/Domains............................................................................................................378 /api/ManagementDomainService/Domains(Id)..................................................................................................... 380 /api/ManagementDomainService/PendingDomains.............................................................................................. 381 /api/ManagementDomainService/PendingDomains(Id).............................
/api/NetworkService/MultiChassisDomain/Topology/Nodes(Id)/ChildNodes.................................................428 /api/NetworkService/MultiChassisDomain/ValidationErrors...............................................................................430 /api/NetworkService/PortAdminStatuses..............................................................................................................432 /api/NetworkService/PortStatuses......................................................................
/api/AlertService/MobileSubscriptions....................................................................................................................467 /api/AlertService/SubscriptionNotificationService................................................................................................468 /api/AlertService/Actions/AlertService.CreateEditMobileSubscription............................................................. 468 /api/AlertService/Actions/AlertService.DeleteMobileSubscription..........
/api/GroupService/Actions/GroupService.Clone..................................................................................................505 /api/GroupService/Actions/GroupService.DeleteGroup......................................................................................506 /api/GroupService/Actions/GroupService.AddMemberDevices........................................................................ 506 /api/GroupService/Actions/GroupService.RemoveMemberDevices....................................
Redfish—Message Registry............................................................................................................................................570 /redfish/v1/Registries................................................................................................................................................ 570 GET method for Registry instance............................................................................................................................
1 About this document This document contains information about the resource models for OpenManage Enterprise and OpenManage Enterprise – Modular Edition (OME–Modular). Each RESTful API specification includes the URI, method, parameters, request codes, and response codes. Some of the APIs are available only in OME–Modular and do not work if used in OME–Modular and the opposite way. Table 1. Supported REST API versions Product Date of release Whats new OpenManage Enterprise 3.3.
2 Overview RESTful API support in OpenManage Enterprise, OpenManage Enterprise and OME–Modular OME–Modular supports RESTful API. Support for APIs has also been improved for OpenManage Enterprise. Improved support for APIs on these products enhances the systems management capabilities. The RESTful interface is provided over HTTPS in JSON format based on ODATA v4 usable by clients, scripts, and browser-based GUIs.
OpenManage Enterprise – Modular Edition OpenManage Enterprise – Modular Edition (OME–Modular) is the systems management software that runs on the Dell EMC PowerEdge MX-series chassis. OME–Modular shares a common codebase with OpenManage Enterprise and delivers an agile, reliable, and comprehensive platform to manage PowerEdge MX-series servers, storage, and networking products. OME–Modular boosts services delivery and restores IT agility for growing businesses.
3 Key integration concepts This section describes the key integration concepts that are applicable to the use cases and resource model. Topics: • • • • • • • • • • • • • Base URI Security Authentication Authorization Resource addressing Resource operations Security considerations Data filtering Data sorting Data pagination Request headers Response codes Response headers Base URI REST API tree structure The console software provides a web-based hypermedia driven API using a simple folder structure.
Resource tree for OME–Modular OEM scheme Figure 1. Resource tree for OME–Modular OEM scheme Resource tree for OpenManage Enterprise OEM scheme Figure 2.
Redfish scheme https://[IP or DNS name]/redfish/v1 Resource tree for Redfish scheme Figure 3. Resource tree for Redfish scheme NOTE: Current version of the console supports the DMTF-defined schema for a selected set of resources in the hierarchy that is outlined in this image. Resource model https://[IP or DNS name]/redfish/v1/$metadata Security To improve security, only HTTPS is supported. You can also update the SSL self-signed certificate with a custom certificate.
X-Auth-Token authentication X-Auth-Token Authentication provides a more secure implementation. To establish a session, perform a POST operation on the SessionService REST API. POST https://[ IP Address ]/api/SessionService/Sessions Input { "UserName":"root", "Password":"linux", "SessionType":"API" } The X-Auth-Token is available in the header that is returned. connection →Keep-Alive content-length →268 content-type →application/json; odata.
Role Description DEVICE_CONFIGURATION Device configuration, application of templates, manage or migrate IO identity, storage mapping, and so on. OPERATING_SYSTEM_DEPLOYMENT Deploy operating system, map to LUN, and so on. DEVICE_UPDATE Device firmware update, application of update baselines, and so on. TEMPLATE_MANAGEMENT Create and manage templates. BASELINE_MANAGEMENT Create and manage baselines for firmware and configuration policies. POWER_MANAGEMENT Set power budgets.
OME - Modular Table 5.
Resource operations Standard HTTP methods are used for creating, retrieving, updating, and deleting resources. The mapping of the HTTP methods to operational semantics is described in the following table: Table 6. HTTP methods HTTP method Description Example GET Used for retrieving the resource representation. This method does not modify the resource across repeated invocations. The query parameters are appended to the URI to appropriately filter the resource instances.
Filter devices by device type /api/DeviceService/Devices?$filter=Type eq 3000 or Type eq 5000 NOTE: For enumeration of Type, see /api/DeviceService/DeviceType. For more information about $filter, see OData Version 4.0 Part 1: Protocol at docs.oasis-open.org. Data sorting The console software provides sorting options on certain URIs that return a collection of entities.
Response codes For synchronous operations, the server returns HTTP response codes 200 or 204. For operations that take a long time, the server returns a status code of 202 along with an HTTP response header (Location). This response corresponds to the URI of the temporary resource that can be used to monitor the operation. The following table lists some of the response codes: Table 8.
Response Header Description Example permitted before the connection is closed. Content-length The length of the request body in 8-bit bytes or octets. Content-Length: 348 date The date and time that the message originated, in HTTP-date format as defined by RFC 7231 Date/Time Formats. date: Thu, 02 Apr 2009 11:11:28 GMT Odata-version The version of Odata that is used. Odata: 4.0 Location Used in redirection or when a new resource is created.
4 Application settings Network /api/ApplicationService/Network This URI represents the collection of network application services. GET method for Network This method returns the network configuration details. Description Returns the network configuration details. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Network.Network/$entity", "@odata.id": "/api/ApplicationService/Network", "Actions": null, "ProxyConfiguration": { "@odata.
/api/ApplicationService/Network/ WebServerConfiguration This URI represents the web-server configuration. GET method for WebServerConfiguration This method returns the web server configuration, including the status, port number, and session timeout duration. Description Returns the web-server configuration, including the status of the web server, port number, and session timeout duration. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Network.
/api/ApplicationService/Network/TimeConfiguration This URI represents the time-configuration-related application services. GET method for TimeConfiguration This method returns the current time-related configuration. Description Returns the time-related configuration. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Network.TimeConfiguration/$entity", "@odata.
Attribute name Description PrimaryNTPAddress The primary NTP address. SecondaryNTPAddress1 The first secondary NTP address. SecondaryNTPAddress2 The second secondary NTP address. SystemTime The system time. If EnableNTP is False, SystemTime cannot be null or empty. /api/ApplicationService/Network/TimeZones This URI represents the time-zone application services. GET method for TimeZone This method returns the time-zone configuration. Description Returns the time-zone configuration.
HTTP response codes Example response body 200 { } "@odata.context": "$metadata#Network.ProxyConfiguration/$entity", "@odata.id": "/api/ApplicationService/Network/ProxyConfiguration", "IpAddress": null, "PortNumber": 0, "EnableAuthentication": false, "EnableProxy": false, "Username": null, "Password": null PUT method for ProxyConfiguration This method updates the proxy configuration. Description Updates the proxy configuration.
Security and user management /api/AccountService This URI represents the configuration of the user accounts. GET method for AccountService This method returns the account level configuration for the user accounts. Description Returns account level configurations for the accounts. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#AccountService.AccountService", "@odata.
Attribute Description ServiceEnabled Indicates if the service is enabled or disabled. AuthFailureLoggingThreshold Number of authorization failures that need to occur before the failure attempt is logged to the manager log. MinPasswordLength Minimum password length. MaxPasswordLength Maximum password length. AccountLockoutThreshold The number of failed login attempts before a user account is locked for a specified duration. 0 indicates that the account is never locked.
} "Status": { "State": "Enabled", "HealthRollup": "OK", "Health": "OK", "Oem": null }, "Oem": null, "AuthFailureLoggingThreshold": 3, "MinPasswordLength": 8, "MaxPasswordLength": 20, "AccountLockoutThreshold": 3, "AccountLockoutDuration": 30, "AccountLockoutCounterResetAfter": 900, "IpRangeAddress": null, "ServiceEnabled": false, "ByUserName": false, "ByIPAddress": false, "EnableIpRangeAddress": false Table 15.
/api/AccountService/Accounts This URI represents the collection of accounts. GET method for Accounts This method returns a collection of accounts. Description Returns the collection of accounts. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(AccountService.Account)", "@odata.count": 1, "value": [ { "@odata.
POST method for Accounts This method creates an account. Description Creates an account.
/api/AccountService/Accounts(Id) This URI represents a specific account within the collection. GET method for Accounts(ID) This method returns the details of a specific account within the collection. Description Returns the details of a specific account. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#AccountService.Account/$entity", "@odata.
PUT method for Accounts(ID) This method updates the settings for an account. Description Updates the settings for an account.
DELETE method for Accounts(Id) This method deletes an account. Description Deletes an account. Privilege SECURITY_SETUP HTTP response codes 204 Table 20. Attributes Attribute Description Id Uniquely identifies the resource within the collection. /api/AccountService/Accounts(userId)/Permissions This URI represents the permissions for an account. GET method for Permissions This method lists the permissions for an account. Description Lists the permissions for an account.
/api/AccountService/Actions/ AccountService.GetPrivileges This URI represents the list of privileges for a user for a device. POST method for /api/AccountService/Actions/ AccountService.GetPrivileges This method returns the list of privileges for a user for a particular device. Description Returns the current network IP configuration.
HTTP response codes Example response body 202 { } "UserName": "root", "UserDetails": [ { "Id": "10042", "UserName": "root", "RoleId": "10", "RoleName": "CHASSIS_ADMINISTRATOR" } ] /api/AccountService/Actions/AccountService.Enable This URI enables you to enable multiple accounts. POST method for AccountService.Enable This method enables multiple accounts. Description Enables multiple accounts.
Table 23. Attributes Attribute Description AccountIds Account IDs to be disabled. /api/AccountService/Actions/AccountService.Delete This URI enables you to delete multiple accounts. POST method for AccountService.Delete The method deletes multiple accounts. Description Deletes multiple accounts. Privilege SECURITY_SETUP HTTP response codes 204 Example request body { } "AccountIds":[3164,3264] Table 24. Attributes Attribute Description AccountIds Account IDs to be deleted.
} ] "MONITORING_SETUP", "POWER_CONTROL", "DEVICE_CONFIGURATION", "OPERATING_SYSTEM_DEPLOYMENT", "DEVICE_UPDATE", "TEMPLATE_MANAGEMENT", "BASELINE_MANAGEMENT", "POWER_MANAGEMENT" Table 25. Attributes Attribute Description Id Role record ID. Description Role description. Name Name for the role. IsPredefined Indicates if the role is a predefined role. AssignedPrivileges List of assigned privileges. OemPrivileges List of OEM privileges for the role.
Table 26. Attributes Attribute Description Id Role record ID. Description Role description. Name Name for the role. IsPredefined Indicates if the role is a predefined role. AssignedPrivileges List of assigned privileges. OemPrivileges List of OEM privileges for the role. /api/AccountService/ExternalAccountProvider This URI represents the collection of external account providers.
Attribute Description DefaultNetworkTimeOut The default network timeout. DefaultSearchTimeOut The default search timeout. /api/AccountService/ExternalAccountProvider/ DirectoryServiceType This URI represents the collection of directory types. GET method for DirectoryServiceType This method returns the collection of directory types. Description Returns a collection of directory types. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
Example response body { "@odata.context": "$metadata#Collection(ExternalAccountProvider.ADAccountProvider)", "@odata.count": 1, "value": [ { "@odata.id": "/api/AccountService/ExternalAccountProvider/ ADAccountProvider(1264)", "Id": 1264, "Name": "Dell Servers", "ServerType": "MANUAL", "ServerName": [ "ausdc12amer29.amer.dell.
} "10.35.195.1" ], "UserName": "test", "Password": null, "ServerPort": 3268, "NetworkTimeOut": 300, "SearchTimeOut": 300, "CertificateValidation": false, "CertificateFile": null Table 29. Attributes Attribute Description Id Active Directory or LDAP server ID. ServerType Server type of the directory—DNS or Manual. ServerName Server name of the directory service. UserName User name of the directory service. Password Password of the directory service. ServerPort Port of the directory Service.
"SsoEnablement": false, "KerberosFile": null, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": null, "Groups": [ { "@odata.id": "/api/AccountService/ExternalAccountProvider/ ADAccountProvider(1264)/Groups" } ] } ] } PUT method for ADAccountProvider(Id) This method updates the details of a specific Active Directory server in the collection. Description Updates the details of a specific Active Directory server.
Attribute name Description UserName User name of the directory service. Password Password of the directory service. ServerPort Port of the directory service. NetworkTimeOut Network timeout value. SearchTimeOut Search timeout value. CertificateValidation Enable or disable certificate validation for the directory service. CertificateFile Certificate file for authentication. /api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.
Example for ServerType: DNS Example request body { } Example for ServerType: DNS "Name": "AD", "ServerType": "DNS", "ServerName": [ ], "DnsServer": [ "dell.com" ], "GroupDomain": "dell.com", "UserName": null, "Password": "", "ServerPort": 3269, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": "" Example response body { "Name": "AD", "ServerType": "DNS", "ServerName": [ "ausdcdell1.dell.com", "rdudc12dell01.dell.com", "pendc12dell01.dell.
Attribute name Description SearchTimeOut Search timeout value. CertificateValidation Enable or disable certificate validation for the directory service. CertificateFile Certificate file for authentication. /api/AccountService/ExternalAccountProvider/ LDAPAccountProvider This URI represents the collection of LDAP Directory Services. GET method for LDAPAccountProvider This method returns the collection of LDAP Directory Service. Description Returns the collection of LDAP Directory Service.
HTTP response codes 200 Example request body { } Example response body { } "Name": "seaquest", "Id":1, "ServerType": "DNS", "ServerName": ["10.35.195.1"], "UserName": "Admin", "Password": "XXXXX", "ServerPort": 0, "BaseDistinguishedName" : "dc=dell,dc=com", "AttributeUserLogin": null, "AttributeGroupMembership": null, "NetworkTimeOut": 300, "SearchTimeOut": 300, "CertificateValidation": false, "CertificateFile": "" "Id": 2914, "Name": "seaquest", "ServerType": "DNS", "ServerName": [ "10.35.195.
/api/AccountService/ExternalAccountProvider/ LDAPAccountProvider(Id) This URI represents a specific LDAP server within the collection of LDAP Directory Service. GET method for LDAPAccountProvider(Id) This method returns the details of a single server of the LDAP Directory Service. Description Returns the details of a single LDAP server. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#ExternalAccountProvider.LDAPAccountProvider/ $entity", "@odata.
"BaseDistinguishedName" : "dc=dell,dc=com", "NetworkTimeOut": 300, "SearchTimeOut": 300, "CertificateValidation": false, "CertificateFile": "" } Example response body { } "Id": 2964, "Name": "seaquest", "ServerType": "DNS", "ServerName": [ "10.35.195.
/api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.TestLDAPConnection This URI enables you to test the LDAP Directory Service connection. POST method for ExternalAccountProvider.TestLDAPConnection This method tests the LDAP Directory Service connection. Description Tests the LDAP Directory Service connection.
} Example for ServerType: DNS "UserName": null, "Password": "", "ServerPort": 636, "BindDN": null, "BindPassword": "", "BaseDistinguishedName": "dc=dell,dc=com", "AttributeUserLogin": null, "AttributeGroupMembership": null, "SearchFilter": null, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": "" Example response body { } "Name": "LDAP", "ServerType": "DNS", "ServerName": [ "ausdcdell1.dell.com", "rdudc12dell01.dell.com", "pendc12dell01.dell.
Attribute name Description AttributeGroupMembership Group member information. SearchFilter Search type. NetworkTimeOut Network timeout value. SearchTimeOut Search timeout value. CertificateValidation Enable or disable certificate validation for the directory service. CertificateFile Certificate file for authentication. /api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.SearchGroups POST method for ExternalAccountProvider.
/api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.DeleteExternalAccountProvider This URI enables you to delete an Active Directory or an LDAP Directory Service. POST method for ExternalAccountProvider.DeleteExternalAccountProvider This method deletes an Active Directory or LDAP Directory Service. Description Deletes an Active Directory or LDAP Directory Service.
"Password": "", "UserName": "MSMDevelopmentTeam", "RoleId": "10", "Locked": false, "Enabled": true, "ObjectGuid": "21dd5985-602f-48a2-bde5-dde50eefb422" } ] Example Response Body [ { "Id": "4664", "UserTypeId": 2, "DirectoryServiceId": 0, "Name": "test456", "Password": null, "UserName": "test456", "Description": "admin", "Oem": null, "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true, "ObjectGuid": null }, { ] } "Id": "4764", "UserTypeId": 2, "DirectoryServiceId": 0, "Name": "test
Security and certificate management /api/ApplicationService/Security This URI represents the security information. GET method for Security This method returns the security information for the system. Description Returns the security information. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#ApplicationService.Security/$entity", "@odata.type": "#ApplicationService.Security", "@odata.
/api/ApplicationService/Certificate This URI represents the certificates resource. GET method for Certificate This method returns the details of the certificates. Description Returns the details of the security certificates. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(ApplicationService.CertInfo)", "@odata.
Attribute name Description Value.IssuedTo.BusinessName Business name to which the certificate is issued. Value.IssuedTo.Locality Locality to which the certificate is issued. Value.IssuedTo.State State to which the certificate is issued. Value.IssuedTo.Country Country to which the certificate is issued. Value.IssuedTo.Email Email address to which the certificate is issued. /api/ApplicationService/Actions/ ApplicationService.
Attribute name Description Country Country. Email Email associated with the issuer. /api/ApplicationService/Actions/ ApplicationService.UploadCertificate This URI allows you to upload certificates. POST method for UploadCertificate This method uploads a certificate. Description Uploads a certificate.
} "ValidTo": "Aug 14 2022 22:14:36" Monitoring and alert notifications api/AlertService/AlertDestinations/SNMPConfiguration This URI represents the collection of SNMP configuration. GET method for SNMPConfiguration This method returns a collection of SNMP configuration. Description Returns a collection of SNMP configuration. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(AlertDestinations.SNMPConfiguration)", "@odata.
} ] Table 40. Attributes Attribute name Description Id ID of the SNMP configuration. Enabled Indicates if the SNMP send trap is enabled or disabled. DestinationAddress SNMP destination address. PortNumber SNMP port number. Version SNMP version. Community SNMP community. NOTE: By default, you can configure up to four destinations for syslog/SNMP and the responses are sent to each destination. If there is no information in the response, PortNumber is displayed as 0.
] } "DestinationAddress": "100.97.1.185", "PortNumber": "162", "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } Response: Example response body [ { "Id": 1, "Enabled": true, "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" }, "SnmpV3Credential": null }, { ] "Id": 2, "Enabled": true, "DestinationAddress": "100.97.1.
Attribute name Description Community SNMP community. /api/AlertService/AlertDestinations/SyslogConfiguration This URI represents a collection of syslog configuration. GET method for SyslogConfiguration This method returns a list of syslog configuration. Description Returns a list of syslog configuration. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(AlertDestinations.SyslogConfiguration)", "@odata.
api/AlertService/AlertDestinations/Actions/ AlertDestinations.ApplySyslogConfig POST method for AlertDestinations.ApplySyslogConfig This method configures the syslog. Description Configures the syslog. Privilege MONITORING_SETUP HTTP response codes 200 Example request body [ { "Enabled": true, "DestinationAddress": "100.97.10.17", "PortNumber": 514 }, { "Enabled": true, "DestinationAddress": "100.97.10.17", "PortNumber": 514 }, { "Enabled": true, "DestinationAddress": "10.19.12.
Table 43. Attributes Attribute name Description Id ID of the syslog. Enabled Indicates if syslog is enabled or disabled. DestinationAddress Destination address of syslog. PortNumber Port number of syslog. /api/AlertService/AlertDestinations/SMTPConfiguration This URI represents the SMTP configuration. GET method for SMTPConfiguration This method returns a collection of SMTP configuration. Description Returns a collection of SMTP configuration.
} Example response body { } "PortNumber":25, "UseCredentials":false, "UseSSL" : false, "Credential": { "User":"root", "Password":"calvin" } "DestinationAddress": "10.35.12.7", "PortNumber": 25, "UseCredentials": false, "UseSSL": false, "Credential": null Table 45. Attributes Attribute name Description DestinationAddress Destination address of SMTP. PortNumber Port number of SMTP. UseCredentials Indicates if credentials are used. UseSSL Indicates if SSL is used.
Attribute name Description Version Version of SNMP. Community Community of SNMP.
5 Alerts Alert logs /api/AlertService/Alerts This URI represents the alerts. Table 47. Filters Filter name Description Top Top records to return. Default value is 100. Skip Max records to skip. Default value is 0. Orderby Order to apply to the output. Id Filter by event ID. Default value is 0. AlertDeviceId Filter by device ID. Default value is 0. AlertDeviceIdentifier Filter by device identifier. AlertDeviceType Filter by device type. Default value is 0.
} ] } "SeverityType": 16, "SeverityName": "Critical", "AlertDeviceId": 1714, "AlertDeviceName": "localhost.smd.devops.dell.com", "AlertDeviceType": 1000, "AlertDeviceIpAddress": "xx.xx.xx.
Attribute name Description AlertVarBindDetails List of variable bindings of the alert, if applicable. AlertMessageType Type of message—Internal, SNMP, Redfish, and so on. /api/AlertService/Alerts? $filter=contains(UserName,'admin') This URL represents alerts by username and role. GET method for Alerts?$filter=contains(UserName,'admin') This method returns alerts by username and role. Description Returns alerts by username and role.
"CategoryName": "Storage", "SubCategoryId": 113, "SubCategoryName": "Storage Controller", "StatusType": 2000, "StatusName": "Not-Acknowledged", "TimeStamp": "2019-09-16 05:33:02.279", "Message": "Message Id: CTL38, Device Display Name: Integrated RAID Controller 1, Message: The Patrol Read operation completed for Integrated RAID Controller 1., Device Status: 3, Device Fqdd: RAID.Integrated.
Alerts(4579)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4578)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4577)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4576)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4575)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4574)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4573)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4572)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4571)",…}, {"@odata.type": "#AlertService.
Alerts(4543)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4542)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4541)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4540)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4539)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4538)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4537)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4536)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4535)",…}, {"@odata.type": "#AlertService.
Alerts(4507)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(4506)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(4505)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(4504)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(4503)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(4502)",…}, {"@odata.type": "#AlertService.
"SubCategoryName": "System Info", "StatusType": 1000, "StatusName": "Acknowledged", "TimeStamp": "2019-09-12 09:29:40.118", "Message": "Message Id: SYS1003, Device Display Name: iDRAC, Message: System CPU Resetting., Device Status: 3, Device Fqdd: iDRAC.Embedded.
Alerts(4288)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4286)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4285)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4284)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4283)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4282)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4281)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4273)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4272)",…}, {"@odata.type": "#AlertService.
Alerts(4034)",…}, {"@odata.type": "#AlertService.Alert", Alerts(3971)",…}, {"@odata.type": "#AlertService.Alert", Alerts(3961)",…}, {"@odata.type": "#AlertService.Alert", Alerts(3946)",…}, {"@odata.type": "#AlertService.Alert", Alerts(3940)",…}, {"@odata.type": "#AlertService.Alert", Alerts(3930)",…}, {"@odata.type": "#AlertService.Alert", Alerts(3995)",…}, {"@odata.type": "#AlertService.Alert", Alerts(3923)",…}, {"@odata.type": "#AlertService.Alert", Alerts(3984)",…}, {"@odata.type": "#AlertService.
Alerts(3744)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(3743)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(3733)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(3768)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(3715)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(3746)",…}, {"@odata.type": "#AlertService.
Example response body { } "@odata.context": "$metadata#AlertService.Alert/$entity", "@odata.id": "/api/AlertService/Alerts(3)", "Id": 3, "SeverityType": 16, "SeverityName": "Critical", "AlertDeviceId": 1714, "AlertDeviceName": "localhost.smd.devops.dell.com", "AlertDeviceType": 1000, "AlertDeviceIpAddress": "xx.xx.xx.
Attribute name Description RecommendedAction Recommended action for the alert. AlertMessageId Event and Alert Message ID associated with the issue. AlertVarBindDetails List of variable bindings of the alert, if applicable. AlertMessageType Type of message—Internal, SNMP, Redfish, and so on. /api/AlertService/AlertCategories This URI represents all the alert categories. GET method for AlertCategories This method returns all the alert categories. Description Returns all alert categories.
Table 50. Attributes Attribute name Description Name Name of the catalog for the category. CategoriesDetails Id ID of the category associated on the catalog. Name Name of category. Catalog Name Name of the catalog for which the category is associated. SubCategoryDetails Id ID of subcategory. Name Name of subcategory. Description Description of subcategory. /api/AlertService/AlertCategories('Name') This URI represents the alert categories for a specific catalog within the collection.
Attribute name Description Name Name of category. Catalog Name Name of the catalog for which the category is associated. SubCategoryDetails Id ID of subcategory. Name Name of subcategory. Description Description of subcategory. /api/AlertService/AlertSeverities This URI represents the alert severities. GET method for AlertSeverities This method returns all the severities applicable to an alert. Description Returns all the severities applicable to an alert.
Table 52. Attributes Attribute name Description Id ID of the severity. Name Name of the severity. Description Description of the severity. /api/AlertService/AlertSeverities(Id) This URI represents a specific alert severity. GET method for AlertSeverities(Id) This method returns the details of a specific alert severity. Description Returns the details of a specific alert severity. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#AlertService.
} ] "Name": "Acknowledged", "Description": "The event was acknowledged" }, { "@odata.id": "/api/AlertService/AlertStatuses(2000)", "Id": 2000, "Name": "Not-Acknowledged", "Description": "The event was not acknowledged" } Table 54. Attributes Attribute name Description Id ID of the alert status. Name Name of the alert status Description Description of the alert status. /api/AlertService/AlertStatus(Id) This URI represents a specific alert status within the collection.
Filter name Description Id Filter by event ID. Default value is 0. GET method for AlertCatalogs This method returns the catalogs applicable to events. Description Returns the catalogs applicable to events. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(AlertService.AlertCatalog)", "@odata.count": 9, "value": [ { "@odata.
/api/AlertService/AlertCatalogs(Id) This URI represents a specific alert catalog. GET method for AlertCatalogs(Id) This method returns the details of a specific alert catalog. Description Returns the details of a specific alert catalog. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#AlertService.AlertCatalog/$entity", "@odata.
} "Severity": "Warning" /api/AlertService/Actions/AlertService.Acknowledge POST method for AlertService.Acknowledge This method acknowledges the alerts. Description Acknowledges alerts.
/api/AlertService/Actions/AlertService.Unacknowledge POST method for AlertService.Unacknowledge This method removes the acknowledgment from the alerts. Description Removes the acknowledgment from the alerts.
/api/AlertService/Actions/AlertService.RemoveAlerts POST method for AlertService.RemoveAlerts This method removes the alerts. Description Removes the alerts.
Alert policies /api/AlertService/AlertPolicies This URI represents the policies that are created. Table 62. Filters Filter name Description Top Top records to return. Default value is 100. Skip Maximum records to skip. Default value is 0. Id Filter by policy IDs. State Filter by state—True or False. Visible Filter by visible state—True or False. GET method for AlertPolicies This method returns the policies that are created. Description Returns all the policies.
"StartTime": null, "EndTime": null, "CronString": null } ] } }, "Actions": [ { "Id": 1, "Name": "OnDemandHealth", "ParameterDetails": [], "TemplateId": 80 } ] }, "State": true, "Visible": true, "PolicyActions": [ { "@odata.id": "/api/AlertService/AlertPolicies(314)/PolicyActions" } ], "PolicyCriteria": [ { "@odata.id": "/api/AlertService/AlertPolicies(314)/PolicyCriteria" } ] Table 63. Attributes Attribute name Description Id Event record ID. Name Name associated with the policy.
Attribute name Description EndTime End event-time to verify. This value indicates the end date and time for policy validity. If defined. This field is checked during policy evaluation. CronString CRON string associated to the policy. This field indicates a special CRON that can be applied to the policy to indicate values such as the days for which the policy is valid. Actions Id ID of action. Name Name associated with the action. ParameterDetails Extra parameters that can be used for the action.
"Name": "subject", "Value": "Device Name: $name, Device IP Address: $ip, Severity: $severity" }, { "Name": "to", "Value": "test@dell.com" }, { "Name": "from", "Value": "MCSIApplication@Dell.
"StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.000", "CronString": "* * * ? * * *" }, "Actions": [ { "Id": 3, "Name": "Email", "ParameterDetails": [ { "Name": "subject", "Value": "Device Name: $name, Device IP Address: $ip, Severity: $severity", "Type": "string", "TypeParams": [ { "Name": "maxLength", "Value": "255" } ] }, { "Name": "to", "Value": "test@dell.
/api/AlertService/AlertPolicies(Id) This URI represents a specific policy within the collection. GET method for AlertPolicies(Id) This method returns the details of a specific policy. Description Returns the details of a specific policy. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#AlertService.AlertPolicy/$entity", "@odata.
{ } ] } "@odata.id": "/api/AlertService/AlertPolicies(314)/PolicyCriteria" Table 64. Attributes Attribute name Description Id Event record ID. Name Name associated with the policy. Description Description associated with the policy. Enabled Indicates if the policy is enabled or disabled. DefaultPolicy Indicates if the policy is the default policy or pre-seeded. State State associated with the policy. Visible Indicate if the policy is visible or hidden.
PUT method for AlertPolicies(Id) This method updates a policy. Description Updates a policy.
} Example response body 104 Alerts { "Id": 4114, "Name": "Policy Test1", "Description": "Policy Test1", "Enabled": true, "DefaultPolicy": false, "Editable": true, "Visible": true, "PolicyData": { "Catalogs": [ { "CatalogName": "iDRAC", "Categories": [ 0 ], "SubCategories": [ 0 ] }, { "CatalogName": "Application", "Categories": [ 0 ], "SubCategories": [ 0 ] } ], "Severities": [ 16, 1, 2, 4, 8 ], "Devices": [ 1914 ], "DeviceTypes": [ 1000 ], "Groups": [], "Schedule": { "StartTime": "2016-06-06 15:02:46.
"Value": "test@dell.com", "Type": "string", "TypeParams": [ { "Name": "maxLength", "Value": "255" } ] }, { "Name": "from", "Value": "MCSIApplication@Dell.
Attribute name Description Devices List of devices associated to the policy. This field is validated during policy evaluation. DevicesTypes List of devices types associated to the policy. Groups List of groups associated to the policy. This field is validated during policy evaluation. Schedule StartTime Start event-time to verify. This value indicates the start date and time for policy validity. If defined. This field is validated during policy evaluation. EndTime End event-time to verify.
Example response body { "@odata.context": "$metadata#Collection(AlertService.PolicyCriterion)", "@odata.count": 1, "value": [ { "@odata.id": "/api/AlertService/AlertPolicies(314)/PolicyCriteria(4)", "Id": 4, "PolicyId": 314, "Parameter": "", "Value": "(catalogName == 'iDRAC' AND categoryId==3300) AND (severityType==1 OR severityType==2 OR severityType==4 OR severityType==8 OR severityType==16)", "Type": 3, "TypeName": "EXPRESSION", "ComparisonType": 3, "ComparisonTypeName": "Equal" } ] } Table 67.
} "Type": 3, "TypeName": "EXPRESSION", "ComparisonType": 3, "ComparisonTypeName": "Equal" Table 68. Attributes Attribute name Description Id ID of the criteria. PolicyId ID of policy with which the criteria is associated. Parameter Any extra parameter that can be used in the criteria. Value Expression that is used during policy evaluation with events. Type ID of the criteria type. TypeName Name of the criteria type. ComparisonType ID of comparison type.
} ] } } "Disabled": false, "ParameterDetails": [] Table 70. Attributes Attribute name Description Id ID of the criteria. PolicyId ID of the policy with which the action is associated. Name Name of the action. Parameters Extra parameter that can be added to the action. TemplateId ID of the action template associated with the action. Template Id ID of the template. Name Name of the template. Description Additional description of the template.
Table 71. Attributes Attribute name Description Id ID of the criteria. PolicyId ID of the policy with which the action is associated. Name Name of the action. Parameters Extra parameter that can be added to the action. TemplateId ID of the action template associated with the action. Template Id ID of the template. Name Name of the template. Description Extra description of the template. Disabled Indicates if template is enabled or disabled.
"Id": 80, "Name": "OnDemandHealth", "Description": "OnDemandHealth", "Disabled": false, "ParameterDetails": [] }, { } ] } "@odata.id": "/api/AlertService/AlertActionTemplates(100)", "Id": 100, "Name": "Ignore", "Description": "Ignore", "Disabled": false, "ParameterDetails": [] Table 72. Attributes Attribute name Description Id ID of the action template. Name Name of the action template. Description Description of the action template. Disabled Indicates if the template is enabled or disabled.
/api/AlertService/Actions/ AlertService.EnableAlertPolicies POST method for AlertService.EnableAlertPolicies This method enables the selected alert policies. Description Enables the selected alert policies. Privilege MONITORING_SETUP HTTP response codes 201 Example request body { "AlertPolicyIds": [100,200,300] } Or { "AllPolicies": true } /api/AlertService/Actions/ AlertService.DisableAlertPolicies POST method for AlertService.
/api/AlertService/Actions/ AlertService.RemoveAlertPolicies POST method for AlertService.RemoveAlertPolicies This method removes the selected set of alert policies or all the alert policies. Description Removes the selected alerts policies. Privilege MONITORING_SETUP HTTP response codes 201 Example request body { "AlertPolicyIds": [100,200,300] } Or { } "AllPolicies": true Alert definitions /api/AlertService/AlertMessageDefinitions This URI represents the definitions for the alert messages.
"@odata.context": "$metadata#Collection(AlertService.AlertMessageDefinition)", "@odata.count": 3, "value": [ { "@odata.id": "/api/AlertService/AlertMessageDefinitions('RAC9000')", "MessageId": "RAC9000", "Prefix": "RAC", "SequenceNo": 9000, "Message": "Device has become non compliant.", "RecommendedAction": "No response action is required.", "Severity": "Critical", "Category": "Configuration", "SubCategory": null, "DetailedDescription": "A device has become non compliant." }, { "@odata.
"@odata.id": "/api/AlertService/AlertMessageDefinitions('RAC0600')", "MessageId": "RAC0600", "Prefix": "RAC", "SequenceNo": 600, "Message": "Unable to retrieve the temperature information.", "RecommendedAction": "Power on the server. If the server is already powered on, wait for a few minutes and refresh the page. If the problem persists, contact service provider.", "Severity": "Warning", "Category": "Configuration", "SubCategory": null, "DetailedDescription": "" } Table 76.
{"@odata.type": "#AlertService.AlertMessageDefinitionCategory", "@odata.id": "/api/AlertService/ AlertMessageDefinitionsCategories('Updates')",…}, {"@odata.type": "#AlertService.AlertMessageDefinitionCategory", "@odata.id": "/api/AlertService/AlertMessageDefinitionsCategories('Work %20Notes')",…} ] } /api/AlertService/ AlertMessageDefinitionsCategories('Name') This URI represents a specific alert definition category.
}, { "SubCategory": "Hardware Config" "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "iDRAC Service Module" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Interface" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "IP Address" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Job Control" }, { "@odata.type": "#AlertService.
{ "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Power Usage POW" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "RAC Event" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Redundancy" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Server" }, { "@odata.type": "#AlertService.
6 Configure Firmware /api/UpdateService/Catalogs This URI represents the catalogs in the appliance. GET method for Catalogs This method returns the catalogs that are created in the appliance. Description Returns the list of catalogs. Privilege VIEW HTTP response codes 200 Example request body { "@odata.context": "/api/$metadata#Collection(UpdateService.Catalogs)", "@odata.count": 1, "value": [ { "@odata.type": "#UpdateService.Catalogs", "@odata.
"BaselineId": 7, "BaselineName": "Test 100" }, { "BaselineId": 8, "BaselineName": "Test 2500+" } ] } } ], "Repository": { "@odata.type": "#UpdateService.Repository", "Id": 12, "Name": "Dell", "Description": "", "Source": "downloads.dell.com", "DomainName": null, "Username": null, "Password": null, "CheckCertificate": false, "RepositoryType": "DELL_ONLINE" } Table 77.
Attribute Description Password Password to access the share containing the catalog (CIFS / HTTPS). CheckCertificate Whether certificate checking is enabled for the HTTPS repository. RepositoryType NFS / CIFS / HTTP / HTTPS/DELL_ONLINE POST method for Catalogs This method creates a catalog. Description Creates a catalog. Privilege BASELINE_MANAGEMENT HTTP response codes 201 Example request body { } "Filename":"catalog.
} "LastUpdated": "2018-09-10 03:26:51.362", "BundlesCount": 3, "PredecessorIdentifier": "", "AssociatedBaselines": [ { "BaselineId": 12, "BaselineName": "cifs1" } ], "Repository": { "@odata.type": "#UpdateService.Repository", "Id": 18, "Name": "cifs1", "Description": "", "Source": "2607:f2b1:f082:5::b1a", "DomainName": "", "Username": "administrator", "Password": null, "CheckCertificate": false, "RepositoryType": "CIFS" } PUT method for Catalogs(Id) This method updates the catalog details.
} } "CheckCertificate": false, "RepositoryType": "CIFS" api/UpdateService/Baselines This URI represents the baselines. GET method for Baselines This method returns the baselines. Description Returns the baselines. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Collection(UpdateService.Baselines)", "@odata.count": 6, "value": [ { "@odata.type": "#UpdateService.Baselines", "@odata.
Table 78. Attributes Attribute Description Name Name of the Baseline. Description Description of the Baseline. CatalogId ID of the catalog. RepositoryId ID of the repository. TaskId Identifier of task which created this baseline. RepositoryName Repository name. RepositoryType Repository type. DowngradeEnabled Field to indicate if downgrade is possible. Is64Bit Always set to "true". Target Id Identifier of device or group that this baseline targets. Type Id Device Type ID.
"Description": "HTTP1", "CatalogId": 22, "RepositoryId": 12, "RepositoryName": "HTTP", "RepositoryType": "HTTP", "DowngradeEnabled": true, "Is64Bit": true, "Targets": [ { "Id": 25015, "Type": { "Id": 1000, "Name": "DEVICE" } }, { "Id": 25016, "Type": { "Id": 1000, "Name": "DEVICE" } }, { "Id": 25017, "Type": { "Id": 1000, "Name": "DEVICE" } }, { "Id": 25019, "Type": { "Id": 1000, "Name": "DEVICE" } }, { "Id": 25021, "Type": { "Id": 1000, "Name": "DEVICE" } }, { "Id": 25022, "Type": { "Id": 1000, "Name": "DE
}, { } ] } ] } "Id": 25035, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25038, "Type": { "Id": 1000, "Name": "DEVICE" } Table 79.
"@odata.context": "/api/$metadata#UpdateService.Baselines/$entity", "@odata.type": "#UpdateService.Baselines", "@odata.id": "/api/UpdateService/Baselines(8)", "Id": 8, "Name": "https", "Description": "https", "CatalogId": 24, "RepositoryId": 14, "TaskId": 25790, "RepositoryName": "https", "RepositoryType": "HTTPS", "LastRun": "2018-09-10 04:46:56.
"Id": 25585, "Type": { "Id": 1000, "Name": "DEVICE" } } ], "ComplianceSummary": { "ComplianceStatus": "OK", "NumberOfCritical": 0, "NumberOfWarning": 0, "NumberOfNormal": 9, "NumberOfDowngrade": 0 }, "DeviceComplianceReports@odata.navigationLink": "/api/UpdateService/ Baselines(8)/DeviceComplianceReports" } PUT method for Baselines(Id) This method updates the baseline details. Description Returns the baseline details.
} ] /api/UpdateService/Actions/ UpdateService.GetBaselinesForDevices This API represents the firmware compliance baselines for specific devices. POST method for /api/UpdateService/Actions/ UpdateService.GetBaselinesForDevices This method returns the firmware compliance baseline information for specific devices. Description Returns the firmware compliance for specific devices.
/api/UpdateService/Actions/ UpdateService.CheckBaselinesAssociation This API represents baseline association information. Post method for checking baseline association This method returns information about baseline associations. Description Returns information about baseline associations. Privilege VIEW HTTP response code 201 Example request body { } “Ids”: [] /api/UpdateService/ComplianceStatuses This UR returns compliance status information.
] } /api/UpdateService/Baselines(Id)/ DeviceComplianceReports This URI represents the compliance reports for baselines. GET method for DeviceComplianceReports This method returns the compliance report for a specific baseline. Description Returns the compliance report for a baseline.
Attribute Description ComplianceStatus Shows the compliance status. DeviceTypeId Numeric value for the device type such as server(1000). RebootRequired Indicates if a reboot is required to make the device compliant. Link Link to the component compliance report, identifying the software components on the device and if they match up against the catalog. /api/UpdateService/Baselines(Id)/ DeviceComplianceReports(Id) This URI represents a specific compliance report for a baseline.
{"@odata.type": "#UpdateService.ComponentComplianceReport", "Version": "1.0.9.6", "CurrentVersion": "1.0.9.6",…}, {"@odata.type": "#UpdateService.ComponentComplianceReport", "Version": "1.10.00", "CurrentVersion": "1.10.00",…}, {"@odata.type": "#UpdateService.ComponentComplianceReport", "Version": "1.10.00", "CurrentVersion": "1.10.00",…}, {"@odata.type": "#UpdateService.ComponentComplianceReport", "Version": "2.40", "CurrentVersion": "2.
/api/UpdateService/Actions/ UpdateService.RefreshCatalogs This API refreshes catalog information. POST method for /api/UpdateService/Actions/ UpdateService.RefreshCatalogs This method refreshes catalogs by checking for and downloading newer versions. Description Refreshes catalogs by checking for and downloading newer versions of catalogs. Privilege VIEW HTTP response codes 200 Example response body { "CatalogIds": [22], "AllCatalogs": false } /api/UpdateService/Actions/ UpdateService.
Example request body { } "BaselineIds":[13] /api/UpdateService/RollbackSoftwares This URI returns software rollback information. GET method for rollback software This method returns the software rollback information. Description Returns the software rollback information. Privilege HTTP response code Example response body 200 /api/UpdateService/RollbackSoftwares?$filter=DeviceId eq { "@odata.context": "/api/ $metadata#Collection(UpdateService.RollbackSoftwares)", "@odata.
Example request body { } Example response body { } "FileToken": "1481131455800" "Date": "2016-01-12 02:37:36.000", "VendorVersion": "1.4.3", "SchemaVersion": "1.0", "ReleaseDate": "2016-01-11 00:00:00.000", "ReleaseId": "G1JD51.4.3", "PackageId": "G1JD5X03-00", "XmlGenVersion": "1.0.3681", "DellVersion": "1.4.3", "PackageType": "LW64", "RequiresReboot": true /api/UpdateService/Actions/ UpdateService.
} "ComponentName": "IDRAC @ Lifecycle Controller V.,2.30.30.30, A00" }, { ] "DeviceId": 1662, "DeviceReport": { "ComponentUpdateAction": "UPGRADE", "DeviceTypeId": "1000", "ComponentCurrentVersion": "2.21.21.21", "ComponentUriInformation": null, "DeviceTypeName": "SERVER", "ComponentVersion": "2.30.30.30", "ComponentCriticality": "Recommended", "DeviceId": "1662", "DeviceServiceTag": "9PKM9Z1", "IsCompliant": "CRITICAL", "ComponentTargetIdentifier": "25227", "ComponentSourceName": "DCIM:INSTALLED#iDRAC.
} Example response body [ ] "Ids":["Device ID"] { } "Id": 6, "Name": "Baseline1", "Description": "", "LastRun": "2021-09-14 20:34:18.
HTTP response codes Example request body 200 { } Example response body { } "UriPath": "https://[ IP Address ]" "Version": "3", "Subject": "ST=Texas, C=USA, O=Dell Inc., L=Round Rock, CN=OMEDEV-DAHIR", "SignatureAlgorithm": "SHA1withRSA", "SignatureAlgorithmOid": "1.2.840.113549.1.1.5", "PublicKey": "X.509", "ValidityFrom": "Wed Sep 17 12:49:56 UTC 2014", "ValidityTo": "Tue Sep 18 12:49:56 UTC 2074", "Issuer": "ST=Texas, C=USA, O=Dell Inc.
NOTE: OME-Modular supports only the Server template type. Table 81. Attributes Attribute Description Id Unique identifier for the template type. Name The type of device for which this template type holds configuration attributes. /api/TemplateService/TemplateViewTypes This URI represents the different features that support template operations. GET method for TemplateViewTypes This method returns the features that support template operations.
/api/TemplateService/Templates This URI represents the templates. GET method for Templates This method returns the details of all available templates. Table 83. Filters Filter name Description Top Top records to return. Default value is 100. Skip Maximum records to skip. Default value is 0. Orderby Order to apply to the output. SearchFilter Search type. Description Returns the details of all templates. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
"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.
"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.
} ] } "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" } ] NOTE: For information about template attributes, see the Attributes table under GET method for Templates(Id). POST method for Templates This method creates a template. Description Creates a template.
Attribute Description • • • • LifeCycleController RAID EventFilters All To get the entire device configuration, useAll. POST method for IOA Templates This method creates an IOA template. Description Creates an IOA template. Privilege TEMPLATE_MANAGEMENT HTTP response codes 201 Example request body { "Name": "Switch-FJM0Y42", "TypeId": 3, "ViewTypeId": 2, "SourceDeviceId": 10173, "Fqdds": "" } Table 85. Attributes Attribute Description Name Template name TypeId Template type.
/api/TemplateService/Templates(Id) This URI represents a specific template. GET method for Templates(Id) This method returns the details of a specific template. Description Returns the details of a specific template. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#TemplateService.Template/$entity", "@odata.
Attribute Description IsBuiltIn Indicates whether the template is a preinstalled template or customer-defined. CreatedBy The name of the user who created the template. CreationTime Timestamp indicating when this template was created. Last UpdatedBy The name of the user who last modified this template. LastUpdatedTime Timestamp indicating when this template was last modified. PUT method for Templates(Id) This method updates a template. Description Updates a specific template.
DELETE method for Templates(Id) This method deletes a template. Description Deletes a specific template. Privilege DEVICE_CONFIGURATION HTTP response codes 204 api/TemplateService/Templates(26) This URL represents the template configuration content. GET method for Templates(26) Description By using this method, you can view the IOA template configuration content. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#TemplateService.
lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/21\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/22\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/23\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/24\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/25\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/26\n auto vlan\n! \n proto
Attribute Description TypeId Template type. For more information, see /TemplateService/ TemplateTypes. ViewTypeId Template View type. For more information, see / TemplateService/TemplateViewTypes. TaskId The identifier of the task that created the template. HasIdentityAttributes Indicates whether the template contains any identity attributes, that is, any attributes that must be assigned a unique value from an Identity Pool before they can be deployed to a target device.
"@odata.id": "/api/TemplateService/Templates(1)/Views(2)", "Id": 2, "Name": "SystemSpecific", "Description": "The hierarchy consists of unique system specific related component classes, groups (from the attribute registry) and attributes.", "AttributeViewDetails": { "@odata.id": "/api/TemplateService/Templates(1)/Views(2)/ AttributeViewDetails" }, " HYPERLINK "mailto:DeviceAttributeViewDetails@odata.navigationLink" DeviceAttributeViewDetails@odata.
/api/TemplateService/Templates(Id)/Views(Id)/ AttributeViewDetails This URI represents the attribute details of a specific view of a template. GET method for AttributeViewDetails This method returns the details for all attributes applicable to a specific template view.. NOTE: This API does not return the information needed for editing attributes. To get that information, use API / TemplateService/Templates(Id)/Views(Id)/AttributeViewDetails/TemplateEditInfoDetails.
Restart", Requested", "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", "IsReadO
"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" } } Table 90.
"@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": 3636, "DataType": 4308, "Description": "Specify the iSCSI Qualified Name (IQN) of the eighth iSCSI storage target.
"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 /api/TemplateService/Templates(Id)/Views(Id)/ DeviceAttributeViewDetails(Id) This URI represents the
"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", "Is
"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": "Pa
"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
{ "GroupNameId": 2, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 2, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3484, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum "Description": null, "Value": "30", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3485, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnore
{ "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",
{ "@odata.context": "/api/$metadata#TemplateService.DeviceAttributeView/ $entity", "@odata.type": "#TemplateService.DeviceAttributeView", "@odata.id": "/api/TemplateService/Templates(26)/Views(9)/ DeviceAttributeViewDetails(10176)", "Id": 9, "Name": "SystemIoaDeploySpecific", "Description": "Hierarchy of attributes, with component classes and groups, containing boot settings for IOA.Virtual components.
TemplateService/Profiles(48)",…}, {"@odata.type": "#TemplateService.Profile", "@odata.id": "/api/ TemplateService/Profiles(38)",…}, {"@odata.type": "#TemplateService.Profile", "@odata.id": "/api/ TemplateService/Profiles(46)",…}, {"@odata.type": "#TemplateService.Profile", "@odata.id": "/api/ TemplateService/Profiles(37)",…} ] } /api/TemplateService/Profiles(Id) This URI represents a specific profile. GET method for Profiles(Id) This method returns the details of a specific profile.
}, { }, { }, { }, { }, { }, { }, { } ] } "Name": "WaitingDeployment" "@odata.type": "#TemplateService.ProfileState", "Id": 2, "Name": "DeploymentTaskCreated" "@odata.type": "#TemplateService.ProfileState", "Id": 3, "Name": "DeploymentInProgress" "@odata.type": "#TemplateService.ProfileState", "Id": 4, "Name": "DeploymentCompletedWithErrors" "@odata.type": "#TemplateService.ProfileState", "Id": 5, "Name": "DeploymentFailedOnNoTargetAvailable" "@odata.type": "#TemplateService.
}, { }, { ] } } "Name": "Slot" "@odata.type": "#TemplateService.ProfileUsage", "Id": 3, "Name": "DeviceAndSlot" "@odata.type": "#TemplateService.ProfileUsage", "Id": 4, "Name": "ServiceTag" /api/TemplateService/Actions/ TemplateService.AssignIdentities POST method for TemplateService.AssignIdentities This method reserves virtual identities for target devices based on the configuration in a specified template. Identities are reserved from the identity pool associated with the specified template.
Example request body { } Example response body "TemplateId" : 13, "BaseEntityId" : 25010 The reply is a hierarchical structure for the cards, ports, and partitions for which identities were assigned, or that have boot options.
] "AttributeEditInfoId": 0, "DisplayName": "Protocol", "Description": "", "Value": "iSCSI", "IsReadOnly": true, "IsIgnored": false }, { "AttributeId": 0, "CustomId": 0, "AttributeEditInfoId": 0, "DisplayName": "iSCSI IQN", "Description": "iSCSI IQN", "Value": "iqn.pool1.
/api/TemplateService/Actions/ TemplateService.AttachProfile This API represents information about server profiles that are created from templates. Post method for /api/TemplateService/Actions/ TemplateService.AttachProfile This method returns information about server profiles that are created from templates. Description Returns information about server profiles that are created from templates.
Example response body { "SourceDeviceEntityId":1234, "DestinationSlotEntityId":1234 } /api/TemplateService/Actions/ TemplateService.UpdateProfile This API updates device-specific attributes in server profiles. POST method for updating profiles This method updates device-specific attributes in server profiles. Description Updates device-specific attributes in the server profile.
"DestinationDeviceEntityId":5555, "ForceMigrate":false } /api/TemplateService/Actions/ TemplateService.DetachProfile This API detaches profiles from slots. If IO identities that are associated with the profile are in the reserved state, they are returned to the pool. If a profile is tied to a compute device, the IO identity that is associated with the profile is cleared from the device. The IO identity is then returned to the pool.
Privilege DEVICE_CONFIGURATION HTTP response codes 200 Example request body { } Example response body "TemplateId": 11 { "TemplateId": 11, "Content": "\n\n\nConsole\n
HTTP response codes Example request body 172 Configure 200 { "Name": "Import Test - IOA", "Type": 3, "Content": "\n!Cloning Header Start\n!ReleasePlatform XL\n!ReleaseVersion 9-14(0-30)\n!ReleaseSize 48140985\n!ReleaseTime Jun 19 2018 01:29:05\n! OPTM0 10GBASE-T\n!OPTM1 -\n!Service-Tag FJM0Y42\n!Serial-Number CN2829865N0013\n!FCPortsPresent FALSE\n!QuadPortsPresent 33 37 49 53\n!IOMMode standalone\n!CheckSum 4fd3e503fd1df86f419aecd3cd23bd21\n!Cloning Header End\n\n\n! Version 9-14(0-30)\n!\nboot system
shutdown\n! \ninterface TenGigabitEthernet 0/53\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/54\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/55\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/56\n! \n protocol lldp \n no shutdown\n! \ninterface ManagementEthernet 0/0\n ip address dhcp\n no shutdown\n! \ninterface Port-channel 128\n no shutdown\n! \ninterface Vlan 1\n ip address dhcp\n no shutdown\n!\nsnmp-server community public ro \
"Attributes": [ { "Id": 9000, "Value": "hostname-2", "IsIgnored": false } ] } } ], "Options": { "ShutdownType": 0, "TimeToWaitBeforeShutdown": 300, "EndHostPowerState": 1, "PrecheckOnly": false, "ContinueOnWarning": true }, "Schedule": { "RunNow": true, "RunLater": false } /api/TemplateService/Actions/ TemplateService.UpdateNetworkConfig POST method for TemplateService.UpdateNetworkConfig This method updates the network configuration parameters of a template.
}, { } ] "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", "IsIgnore
] } /api/TemplateService/Actions/ TemplateService.RemoveBaseline POST method for TemplateService.RemoveBaseline Description This method removes the compliance baseline. Privilege TEMPLATE_MANAGEMENT HTTP response codes 200 Example request body { "BaselineIds": [1,2,5..] } /api/TemplateService/Actions/ TemplateService.Remediate POST method for TemplateService.Remediate Description This method ensures that the device is compliant to a baseline.
Example response body { "Id":2664, "Deviceids":[ 2514 ], "Attributes":[ { "DeviceId":2514, "Attributes":[ { "Id":341, "Value":"MSM RAC 2", "Deploy":true } ] } ] } /api/TemplateService/Actions/ TemplateService.MigrateProfile POST method for TemplateService.MigrateProfile Description This method migrates a profile from one server to another.
[ { "@odata.type": "#IdentityPoolService.IdentityPool", "@odata.id": "/api/IdentityPoolService/IdentityPools(1)", "Id": 1, "Name": "Pool 1", "Description": "This is Pool 1", "CreatedBy": "admin", "CreationTime": "2018-09-06 16:41:47.612624", "LastUpdatedBy": "admin", "LastUpdateTime": "2018-09-06 16:41:47.
"Description": "This is a sample Identity Pool", "CreatedBy": "admin", "CreationTime": "2018-09-11 17:12:46.166658", "LastUpdatedBy": "admin", "LastUpdateTime": "2018-09-11 17:12:46.166658", "EthernetSettings": { "Mac": { "IdentityCount": 55, "StartingMacAddress": "UFBQUFAA" } }, "IscsiSettings": { "Mac": { "IdentityCount": 65, "StartingMacAddress": "YGBgYGAA" }, "InitiatorConfig": { "IqnPrefix": "iqn.myprefix." }, "InitiatorIpPoolSettings": { "IpRange": "10.33.0.1-10.33.0.255", "SubnetMask": "255.255.255.
HTTP response codes Example request body 200 { } "Name":"New Identity Pool 4", "EthernetSettings": { "Mac": { "IdentityCount":55, "StartingMacAddress": "UFBQUFAA" } }, "IscsiSettings": { "Mac": { "IdentityCount":65, "StartingMacAddress": "YGBgYGAA" }, "InitiatorConfig": { "IqnPrefix":"Iqn.
"@odata.context": "/api/$metadata#IdentityPoolService.IdentityPool/ $entity", "@odata.type": "#IdentityPoolService.IdentityPool", "@odata.id": "/api/IdentityPoolService/IdentityPools(4)", "Id": 4, "Name": "New Identity Pool 4", "Description": null, "CreatedBy": "admin", "CreationTime": "2018-09-13 15:45:37.83158", "LastUpdatedBy": "admin", "LastUpdateTime": "2018-09-13 15:45:37.
Example request body { { { "Id": 4, "Name": "New Identity Pool 4", "EthernetSettings": "Mac": { "IdentityCount": 55, "StartingMacAddress": "UFBQUFAA" } }, "IscsiSettings": "Mac": { "IdentityCount": 65, "StartingMacAddress": "YGBgYGAA" }, "InitiatorConfig": { } { }, "FcoeSettings": "Mac": { { "IdentityCount": 75, "StartingMacAddress": "cHBwcHAA" } }, "FcSettings": "Wwnn": { "IdentityCount": 85, "StartingAddress": "IACAgICAgAA=" }, "Wwpn": { } "IqnPrefix": "Iqn.
Attribute name Description Starting WWNN address Initial WWNN Address DELETE method for IdentityPools(Id) This method deletes an identity pool. Description Deletes an identity pool. Privilege TEMPLATE_MANAGEMENT HTTP response codes 204 /api/IdentityPoolService/IdentityPools(Id)/UsageCounts This URI represents the summary of the usage of identity pools. GET method for UsageCounts This method returns the summary of the usage of identity pools.
} ] } "TotalRequested": 0, "TotalReserved": 14, "TotalDeployed": 0 /api/IdentityPoolService/IdentityPools(Id)/ UsageIdentitySets This URI represents the usage identity sets. GET method for UsageIdentitySets This method returns usage identity sets. These sets represent the different protocols for which identity values get reserved. Description Returns the usage identity sets. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
} ] /api/IdentityPoolService/IdentityPoolsI(Id)/ UsageIdentitySets(Id) This URI represents a specific usage identity set. GET method for UsageIdentitySets(Id) This method returns a specific usage identity set. Description Returns a usage identity set. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#IdentityPoolService.UsageIdentitySet/ $entity", "@odata.type": "#IdentityPoolService.UsageIdentitySet", "@odata.
{ "@odata.type": "#IdentityPoolService.UsageDetail", "TypeofDataSchemaFunction": 3, "IdentitySetId": 1, "Status": 2, "MacAddress": "10:10:10:10:10:22", "IscsiIqn": null, "IscsiInitiatorIp": null, "Wwnn": null, "Wwpn": null, "NicIdentifier": "NIC in Mezzanine 1A Port 2 Partition 1", "DeviceInfo": { "ChassisName": "MX-LCX", "SlotNumber": "7", "ServerName": "idrac-SRVC333", "ManagementIp": "10.215.2.134" } }, { } ] } "@odata.type": "#IdentityPoolService.
"Description": "Assigned to a profile; deployment pending." }, { } ] } "@odata.type": "#IdentityPoolService.IdentityState", "@odata.id": "/api/IdentityPoolService/IdentityStates(2)", "Id": 2, "Name": "Assigned", "Description": "Assigned to a profile and provisioned on device." /api/IdentityPoolService/IdentityStates(Id) This URI represents a specific identity state. GET method for IdentityStates(Id) This method returns the details of a specific identity state.
Network Configuration Service This resource enables you to access the network service and perform network-related tasks. These tasks include viewing the logical networks and the network types, creating a new logical network, deleting a logical network, and so on. Use the URIs in this resource to access the network service and the associated actions. /api/NetworkConfigurationService/Networks This URI represents the logical networks.
Attribute name Description VlanMaximum VLan can be defined as either a range or a single value. If a single value is defined, the same value is assigned to both VlanMaximum and VlanMinimum. VlanMinimum VLan can be defined as either a range or a single value. If a single value is defined, the same value is assigned to both VlanMaximum and VlanMinimum. Type Network type. For more information, see the details of other URIs of this resource. CreatedBy The user who created the network.
/api/NetworkConfigurationService/Networks(Id) This URI represents a specific network within the collection. GET method for Networks(Id) This method returns the details of a specific network from the collection. Description Returns the details of a specific network. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#NetworkConfigurationService.Network/ $entity", "@odata.
} "InternalRefNWUUId": 0 Table 93. Attributes Attribute name Description ID The identifier of the target network profile. Name The target network profile name. Description The target network profile description. VlanMaximum Maximum VLAN value, when a network profile is defined as a range. VlanMinimum Minimum VLAN value, when a network profile is defined as a range. NOTE: To define a profile which is not in a range, the VlanMaximum and VlanMinimum need to be same.
{ "@odata.id": "/api/NetworkConfigurationService/NetworkTypes(11)", "Id": 11, "Name": "VMWare FT Logging", "Description": "This is the network for VMware-specific Fault tolerance logging.", "VendorCode": "VMFTLog", "NetworkTrafficType": "Ethernet", "QosType": 1 } ] } Table 94. Attributes Attribute name Description Id ID of the network. Name Name of the network type. Description Description of the network type. VendorCode The vendor code for each network type.
/api/NetworkConfigurationService/QosTypes This URI represents the types of Quality-of-Service (QoS) that the system supports. GET method for QosTypes This method returns the types of Quality-of-Service (QoS) that the system supports. Description Returns the supported QoS. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkConfigurationService.QosType)", "@odata.count": 4, "value": [ { "@odata.
/api/NetworkConfigurationService/Actions/ NetworkConfigurationService.RemoveNetworks POST method for removing networks This method deletes the specified networks from the system. Description Deletes the specified networks.
7 Devices /api/DeviceService This URI represents the device services. GET method for DeviceService This method returns a list of all the device services. Description Returns a list of device services. Privilege VIEW HTTP response codes 200 Example Response Body { "@odata.context": "/api/$metadata#DeviceService.DeviceService", "@odata.type": "#DeviceService.DeviceService", "@odata.id": "/api/DeviceService", "Actions": null, "Devices@odata.
"Type": 8000, "Identifier": "0G16RFCP007BN00BA", "DeviceServiceTag": null, "ChassisServiceTag": "7BU0772", "Model": "PowerEdge MX5000s", "PowerState": 17, "ManagedState": 3000, "Status": 1000, "ConnectionState": true, "AssetTag": "12345678910", "SystemId": 2031, "DeviceName": "IOM-C1", "LastInventoryTime": "2019-09-06 06:30:11.936", "LastStatusTime": "2019-09-06 06:30:06.
Devices(10278)",…}, {"@odata.type": "#DeviceService.Device", "@odata.id": "/api/DeviceService/ Devices(10281)",…} ] } /api/DeviceService/Devices?$filter=Type eq 1000 This URI gets a collection of devices with filter. GET method for device filter This method gets a collection of devices.
5, 6, 7, 8, 9, 41, 11, 12, 13, 14, 15, 1009, 17, 50, 18, 30, 31 ], "SlotConfiguration": { "ChassisName": null }, "DeviceManagement": [ { "ManagementId": 5002, "NetworkAddress": "XX.XX.X.XX", "MacAddress": "58:8a:5a:ee:01:6e", "ManagementType": 2, "InstrumentationName": "WIN-02GODDHDJTC", "DnsName": "idrac-gmgr064.smd.devops.dell.com", "ManagementProfile": [ { "ManagementProfileId": 5002, "ManagementId": 5002, "AgentName": "iDRAC", "Version": "3.30.30.30", "ManagementURL": "https://XX.XX.X.
"@odata.id": "/api/DeviceService/Devices(10074)/Temperature" }, "Power": { "@odata.id": "/api/DeviceService/Devices(10074)/Power" }, "SystemUpTime": { "@odata.id": "/api/DeviceService/Devices(10074)/SystemUpTime" }, "BlinkStatus": { "@odata.id": "/api/DeviceService/Devices(10074)/BlinkStatus" }, "PowerUsageByDevice@odata.navigationLink": "/api/DeviceService/ Devices(10074)/PowerUsageByDevice", "DeviceBladeSlots@odata.
"MacAddress": "50:9a:4c:b2:f6:16", "ManagementType": 2, "InstrumentationName": "WIN-02GODDHDJTC", "DnsName": "idrac-gmgr075.smd.devops.dell.com", "ManagementProfile": [ { "ManagementProfileId": 5012, "ManagementId": 5012, "AgentName": "iDRAC", "Version": "3.36.36.36", "ManagementURL": "https://XX.XX.X.XX:XXX", "HasCreds": 0, "Status": 1000, "StatusDateTime": "2019-12-02 16:00:58.651" } ] } ], "Actions": null, "SensorHealth@odata.
"@odata.id": "/api/DeviceService/Devices(10085)", "Id": 10085, "Type": 1000, "Identifier": null, "DeviceServiceTag": null, "ChassisServiceTag": "", "Model": "unknown", "PowerState": 17, "ManagedState": 3000, "Status": 1000, "ConnectionState": true, "AssetTag": null, "SystemId": 0, "DeviceName": "10.35.0.95", "LastInventoryTime": "2019-12-02 16:02:51.
"Baselines": { "@odata.id": "/api/DeviceService/Devices(10085)/Baselines" }, "InventoryDetails@odata.navigationLink": "/api/DeviceService/ Devices(10085)/InventoryDetails", "HardwareLogs@odata.navigationLink": "/api/DeviceService/ Devices(10085)/HardwareLogs", "SubSystemHealth@odata.navigationLink": "/api/DeviceService/ Devices(10085)/SubSystemHealth", "RecentActivity@odata.navigationLink": "/api/DeviceService/ Devices(10085)/RecentActivity", "InventoryTypes": { "@odata.
"@odata.id": "/api/DeviceService/Devices(10053)", "Id": 10053, "Type": 2000, "Identifier": "MX70005", "DeviceServiceTag": "MX70005", "ChassisServiceTag": null, "Model": "PowerEdge MX7000", "PowerState": 17, "ManagedState": 3000, "Status": 1000, "ConnectionState": true, "AssetTag": null, "SystemId": 2031, "DeviceName": "MX-MX70005", "LastInventoryTime": "2019-09-06 06:42:47.989", "LastStatusTime": "2019-09-06 06:43:01.
"@odata.id": "/api/DeviceService/Devices(10053)/InventoryTypes" }, "LogSeverities":{ "@odata.id": "/api/DeviceService/Devices(10053)/LogSeverities" }, "Settings@odata.navigationLink": "/api/DeviceService/Devices(10053)/ Settings", "Temperature":{ "@odata.id": "/api/DeviceService/Devices(10053)/Temperature" }, "Power":{ "@odata.id": "/api/DeviceService/Devices(10053)/Power" }, "SystemUpTime":{ "@odata.id": "/api/DeviceService/Devices(10053)/SystemUpTime" }, "BlinkStatus":{ "@odata.
{ }, { }, { }, { }, { }, { }, { }, { ] } "Id": 128, "SlotNumber": "P2PBridge.Embedded.1-1", "Manufacturer": "Intel Corporation", "Description": "Lewisburg PCI Express Root Port #1", "DatabusWidth": "Unknown", "SlotLength": "Unknown", "SlotType": "Unknown" "Id": 129, "SlotNumber": "HostBridge.Embedded.1-1", "Manufacturer": "Intel Corporation", "Description": "Intel Corporation", "DatabusWidth": "Unknown", "SlotLength": "Unknown", "SlotType": "Unknown" "Id": 130, "SlotNumber": "Video.Embedded.
}, { ] } "Family": "Intel(R) Xeon(TM)", "MaxSpeed": 4000, "CurrentSpeed": 1600, "SlotNumber": "CPU.Socket.1", "Status": 2000, "NumberOfCores": 8, "NumberOfEnabledCores": 8, "BrandName": "Intel", "ModelName": "Genuine Intel(R) CPU 0000%@", "InstanceId": "CPU.Socket.1", "Voltage": "1.8" "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('serverNetworkInterfaces')", "InventoryType": "serverNetworkInterfaces", "InventoryInfo": [] }, { "@odata.
"@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('serverRaidControllers')", "InventoryType": "serverRaidControllers", "InventoryInfo": [ { "Id": 20, "DeviceId": 0, "Name": "Lewisburg SATA Controller [AHCI mode]", "Fqdd": "AHCI.Embedded.2-1", "Status": 2000, "StatusTypeString": "UNKNOWN", "RollupStatus": 2000, "RollupStatusString": "UNKNOWN", "CacheSizeInMb": 0, "PciSlot": 0 }, { "Id": 19, "DeviceId": 0, "Name": "Lewisburg SSATA Controller [AHCI mode]", "Fqdd": "AHCI.Embedded.
}, { }, { }, { }, { }, { ] } "Id": 111, "PowerState": 8 "Id": 112, "PowerState": 10 "Id": 113, "PowerState": 11 "Id": 114, "PowerState": 12 "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('deviceLicense')", "InventoryType": "deviceLicense", "InventoryInfo": [ { "SoldDate": "2016-06-12 14:48:13.000", "LicenseBound": 4, "EvalTimeRemaining": 0, "AssignedDevices": "iDRAC.Embedded.
}, { }, { }, { }, { }, { assigned Storage" }, { }, { }, { details" }, { } "Name": "POWER_HISTORY", "Description": "Retrieve historical power data" "Id": 370, "CapabilityType": { "CapabilityId": 13, "Name": "TSR", "Description": "Tech Support Report" } "Id": 371, "CapabilityType": { "CapabilityId": 12, "Name": "DIAGS", "Description": "Diagnostics" } "Id": 372, "CapabilityType": { "CapabilityId": 11, "Name": "HW_LOGS ", "Description": "System Hardware logs" } "Id": 373, "CapabilityType": { "Capabil
}, { }, { }, { }, { }, { }, { ] } "CapabilityType": { "CapabilityId": 3, "Name": "POWER_CONTROL_RESET", "Description": "Power reset hard/graceful" } "Id": 379, "CapabilityType": { "CapabilityId": 2, "Name": "POWER_CONTROL_OFF", "Description": "Power Down hard/graceful" } "Id": 380, "CapabilityType": { "CapabilityId": 1, "Name": "POWER_CONTROL_ON", "Description": "Power up" } "Id": 381, "CapabilityType": { "CapabilityId": 32, "Name": "REMOTE_SSH", "Description": "14G specific features" } "Id": 382, "
{ }, { ] } "Id": 19, "Rack": "78", "Aisle": "Lakeln", "Datacenter": "AlladiaAnoop" "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('deviceManagement')", "InventoryType": "deviceManagement", "InventoryInfo": [ { "ManagementId": 5003, "IpAddress": "xx.xx.xx.
"DCIM:PREVIOUS#iDRAC.Embedded.1-1#IDRACinfo" }, { "Version": "0.3.0", "InstallationDate": "2017-06-16T01:22:28Z", "Status": "Installed", "SoftwareType": "BIOS", "ComponentId": "159", "DeviceDescription": "BIOS", "InstanceId": "DCIM:INSTALLED#741__BIOS.Setup.1-1" }, { "Version": "NA03", "InstallationDate": "2017-07-21T03:30:51Z", "Status": "Installed", "SoftwareType": "FRMW", "ComponentId": "104258", "DeviceDescription": "Disk 0 on Embedded AHCI Controller 2", "InstanceId": "DCIM:INSTALLED#304_C_Disk.Direct.
}, { ] "@odata.
} ] "SubsystemName": }, { "Id": 146, "Status": 1000, "SubsystemName": }, { "Id": 147, "Status": 1000, "SubsystemName": }, { "Id": 148, "Status": 1000, "SubsystemName": }, { "Id": 149, "Status": 3000, "SubsystemName": }, { "Id": 150, "Status": 1000, "SubsystemName": }, { "Id": 151, "Status": 1000, "SubsystemName": }, { "Id": 152, "Status": 2000, "SubsystemName": } "cpuRollupStatus" "sysMemPrimaryStatus" "voltRollupStatus" "batteryRollupStatus" "licensingRollupStatus" "storageRollupStatus" "tempRollu
Example response body { "@odata.context": "/api/$metadata#DeviceService.InventoryDetail/$entity", "@odata.type": "#DeviceService.InventoryDetail", "@odata.id": "/api/DeviceService/Devices(25009)/ InventoryDetails('deviceSoftware')", "InventoryType": "deviceSoftware", "InventoryInfo": [ {"Version": "0.3.0", "InstallationDate": "2017-07-13T00:00:00Z", "Status": "Installed", "SoftwareType": "BIOS",…}, {"Version": "3.20.20.
Table 96. Attributes Attribute Description SettingType Defines the setting type that must be applied. The setting here is, "ReplicableChassisConfigurations" Configurations Defines the configuration you want to apply. The Configurations attribute requires the Type and Replicate flag. Type The configuration you want to apply. The Type attribute supports "AlertDestination" or "TimeConfigurations". Replicate Boolean flag to determine if you prefer to set the configuration or not.
HTTP response code 200 Enabling Chassis Direct feature Example request body { } Example response body { } "SettingType": "LocalAccessConfiguration", "EnableChassisPowerButton": true, "EnableKvmAccess": true, "LedPresence": "Absent", "QuickSync": { "QuickSyncHardware": "Present", "QuickSyncAccess": "READ_WRITE", "EnableInactivityTimeout": true, "TimeoutLimit": 120, "TimeoutLimitUnit": "SECONDS", "EnableReadAuthentication": true, "EnableQuickSyncWifi": true }, "EnableChassisDirect": true, "LcdAccess":
} Example response body { } "LcdCustomString": "", "LcdLanguage": "en" "SettingType": "LocalAccessConfiguration", "EnableChassisPowerButton": true, "EnableKvmAccess": true, "LedPresence": "Absent", "QuickSync": { "QuickSyncHardware": "Present", "QuickSyncAccess": "READ_WRITE", "EnableInactivityTimeout": true, "TimeoutLimit": 120, "TimeoutLimitUnit": "SECONDS", "EnableReadAuthentication": true, "EnableQuickSyncWifi": true }, "EnableChassisDirect": false, "LcdAccess": "VIEW_AND_MODIFY", "LcdPresence": "Pr
"DateFormat": "CIM" }, { "LogTimestamp": "20170907053540.000000-300", "LogSequenceNumber": 286412, "LogSeverity": 1000, "LogComment": "[set comment here]", "LogMessageId": "USR0030", "LogMessage": "Successfully logged in using root, from 10.32.19.194 and wsman.", "LogId": "DCIM:LifeCycleLog:286412", "LogCategory": "Audit", "DateFormat": "CIM" }, { "LogTimestamp": "20170907053540.
"RollupStatus": "1000" }, { } ] "SubSystem": "Current", "RollupStatus": "1000" }, { "SubSystem": "Processor", "RollupStatus": "2000" }, { "SubSystem": "Memory", "RollupStatus": "2000" }, { "SubSystem": "Temperature", "RollupStatus": "1000" } /api/DeviceService/Devices(Id)/RecentActivity This URI represents the recent activities for a specific device. GET method for RecentActivity This method returns the recent activities for a specific device.
} ] } "TaskId": 4015, "TaskType": 24 /api/DeviceService/Devices(Id)/InventoryTypes This URI represents the inventory types for a specific device. GET method for InventoryTypes This method returns the inventory types for a specific device. Description Returns the inventory types for a specific device. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#DeviceService.InventoryTypes/$entity", "@odata.
Example response body { } "@odata.context": "$metadata#DeviceService.LogSeverities/$entity", "@odata.id": "/api/DeviceService/Devices(3265)/LogSeverities", "Warning": 2000, "Critical": 3000, "Fatal": 4000, "Info": 1000 NOTE: The severity "Unknown": 5000 is not displayed by REST. To view logs in Unknown state, use the web interface. /api/DeviceService/Devices(Id)/Settings This URI represents the settings of a specific device.
GET method for device settings by type This method returns the available attributes under a specific setting type. Description Returns the available attributes under a specific setting type. Privilege VIEW HTTP response codes 200 Example for network settings for IOM Example response body { } Example for network settings for Chassis "@odata.context": "/api/$metadata#DeviceService.DeviceSetting/$entity", "@odata.type": "#DeviceService.DeviceSetting", "@odata.
} "EnableAutoconfiguration": true, "StaticIPv6Address": "", "StaticPrefixLength": "0", "StaticGateway": "", "UseDHCPv6ObtainDNSServerAddresses": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "GeneralSettings": { "EnableNIC": true, "RegisterDNS": false, "DnsName": "MX7000", "UseDHCPForDomainName": false, "DnsDomainName": "", "AutoNegotiation": true, "NetworkSpeed": "1_GB", "Delay": 0 } PUT method for device settings by type This method updates the attributes under a specific setti
Example for network settings for IOM Example response body { } Example for IOM names Example response body { Example for network settings for Chassis "@odata.id": "/api/DeviceService/Devices(25773)/Settings('Network')", "EnableMgmtVLANId": false, "@odata.context": "/api/$metadata#DeviceService.
{ } Example for network settings for Chassis } "EnableNIC": true, "RegisterDNS": false, "DnsName": "MX7000", "UseDHCPForDomainName": false, "DnsDomainName": "", "AutoNegotiation": true, "NetworkSpeed": "1_GB", "Delay": 0 Example response body { } "SettingType": "Network", "DhcpProvisioning": null, "MgmtVLANId": "1", "EnableVLAN": false, "Ipv4Settings": { "EnableIPv4": true, "EnableDHCP": true, "StaticIPAddress": "", "StaticSubnetMask": "", "StaticGateway": "", "UseDHCPObtainDNSServerAddresses": true,
HTTP response codes 200 Example response body { "@odata.context": "$metadata#DeviceService.TemperatureResponseModel/ $entity", "@odata.id": "/api/DeviceService/Devices(3265)/Temperature", "peakTemperatureUnit": "celsius", "avgTemperatureUnit": "celsius", "DateFormat": "CIM", "instantaneousTemperatureUnit": "celsius", "avgTemperatureTimeStamp": "20170907071015.
} "@odata.id": "/api/DeviceService/Devices(3265)/Power", "avgPower": "0", "systemEnergyConsumptionUnit": "killowatt-hour", "systemEnergyConsumptionTimeStamp": "20170907071147.450000-300", "powerUnit": "watt", "minimumPowerTimeStamp": "19691231180000.000000-360", "avgPowerUnit": "watt", "minimumPower": "65535", "peakPower": "73", "DateFormat": "CIM", "systemEnergyConsumption": "0.000", "Since": "20170414145039.000000-300", "peakPowerTimeStamp": "20170414145039.
} ] /api/DeviceService/Devices(Id)/GraphicInfo This URI represents the graphics information of a specific device. GET method for GraphicInfo This method returns the graphics-related information of a specific device. Description Returns the graphics-related information of a specific device. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#DeviceService.GraphicInfo/$entity", "@odata.
/api/DeviceService/Devices(Id)/DeployRequired This API represents the device deployment results. GET method for deployment by device IDs This method returns the results for deployment on devices by IDs. Description Returns the results for deployment on devices by IDs. Privilege HTTP response code Example response body 200 { "@odata.context": "/api/$metadata#DeviceService.DeployRequired", "@odata.type": "#DeviceService.DeployRequired", "@odata.
/api/DeviceService/Actions/DeviceService/ Devices(Id)Actions/ DeviceService.UploadFSDCertificate This API represents Field Service Debug (FSD) certificate information. POST method for uploading FSD certificate This method returns information about the FSD certificate upload process. Description Returns information about the FSD certificate upload process.
/api/DeviceService/DeviceStatuses This URI represents the statuses that the devices can be in. GET method for DeviceStatuses This method returns a list of statuses for the devices. Description Returns a list of statuses for the devices. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(DeviceService.DeviceStatus)", "@odata.count": 5, "value": [ { "GlobalStatus": 1000, "Name": "NORMAL", "Description": "The device is running normal.
Example response body { } "@odata.context": "$metadata#Collection(DeviceService.DeviceType)", "@odata.
/api/DeviceService/Actions/DeviceService/ Devices(Id)Actions/DeviceService.GetTermState This API represents term state information for devices. POST method for getting term state This method returns term state information. Description Returns term state information. Privilege DEVICE_CONFIGURATION HTTP response codes 202 Table 98. Attributes Attribute name Description Id—Devices(Id) ID of the device. /api/DeviceService/Actions/DeviceService/ Devices(Id)Actions/ DeviceService.
/api/DeviceService/DeviceSummary This URI represents the summary of the devices statuses. In the response, devices of the same type are grouped. GET method for DeviceSummary This method returns the summary of device statuses. Description Returns the summary of device statuses. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(DeviceService.DeviceSummary)", "@odata.count": 6, "value": [ { "@odata.
] }, { } "StatusType": 5000, "Count": 0 "@odata.id": "/api/DeviceService/DeviceSummary(9000)", "DeviceType": 9000, "TotalCount": 0, "DeviceStatusSummary": [ { "StatusType": 1000, "Count": 0 }, { "StatusType": 2000, "Count": 0 }, { "StatusType": 3000, "Count": 0 }, { "StatusType": 4000, "Count": 0 }, { "StatusType": 5000, "Count": 0 } ] }, { "@odata.
{ ] "StatusType": 3000, "Count": 0 }, { "StatusType": 4000, "Count": 0 }, { "StatusType": 5000, "Count": 0 } }, { } ] } "@odata.
"DeviceStatusSummary":[ { "@odata.type": "#DeviceService.DeviceStatusSummary", "StatusType": 1000, "Count": 8 }, { "@odata.type": "#DeviceService.DeviceStatusSummary", "StatusType": 2000, "Count": 0 }, { "@odata.type": "#DeviceService.DeviceStatusSummary", "StatusType": 3000, "Count": 0 }, { "@odata.type": "#DeviceService.DeviceStatusSummary", "StatusType": 4000, "Count": 0 }, { "@odata.type": "#DeviceService.
/api/DeviceService/Actions/ DeviceService.DevicesByPrivilegesAction This API represents the device information that users can access, based on privileges. POST method for device privileges action This method returns device information that users can access, based on their privileges. Description Returns device information that users can access, based on their privileges.
Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(DeviceService.DeviceSlotType)", "@odata.count": 6, "value": [ { "SlotType": 1000, "SlotName": "UNKNOWN", "Description": "Slot type is unknown." }, { "SlotType": 2000, "SlotName": "Sled Slot", "Description": "This is Sled Slot type." }, { "SlotType": 3000, "SlotName": "Fan Slot", "Description": "This is Fan Slot type.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Id": 1000, "Property": "redundancyPolicy", "Key": "NO_REDUNDANCY", "Value": "No Redundancy", "Description": "Redundancy policy type is No redundancy" "Id": 2000, "Property": "redundancyPolicy", "Key": "GRID_REDUNDANCY", "Value": "GRID Redundancy", "Description": "Redundancy policy type is GRID redundancy" "Id": 3000, "Property": "duplexMode", "Key": "HALF", "Value": "Half", "Description": "Duplex Mode is half.
}, { }, { }, { }, { }, { }, { }, { }, { } 242 Devices ] } "Key": "DISABLED", "Value": "Disabled", "Description": "QuickSyncAccess is disabled" "Id": 12000, "Property": "quickSyncAccess", "Key": "READ_ONLY", "Value": "Read Only", "Description": "QuickSyncAccess is read only" "Id": 13000, "Property": "quickSyncAccess", "Key": "READ_WRITE", "Value": "Read-Write", "Description": "QuickSyncAccess is read write" "Id": 14000, "Property": "timeoutLimitUnit", "Key": "SECONDS", "Value": "Seconds", "Descr
/api/DeviceService/GlobalExcludes This URI represents the globally excluded ranges. GET method for GlobalExcludes This method returns the globally excluded ranges. Description Returns the globally excluded ranges. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(DeviceService.GlobalExclude)", "@odata.count": 4, "value": [ { "@odata.
} ] POST method for GlobalExcludes This method globally excludes ranges. Description Globally excludes ranges. Privilege APPLIANCE_SETUP HTTP response codes 201 Example request body Example response body {"DeviceIds": [2464,2614,2514]} True /api/DeviceService/Actions/ DeviceService.AddNetworkRange This URI adds ranges to the globally excluded range. POST method for DeviceService.AddNetworkRange This method adds ranges to global exclusion. Description Adds network ranges to global exclusion.
/api/DeviceService/Actions/ DeviceService.EditNetworkRange This URI edits the global exclusion ranges. POST method for DeviceService.EditNetworkRange This method edits ranges in global exclusion. Description Edits ranges in global exclusion. Privilege APPLIANCE_SETUP HTTP response codes 204 Example request body } { "Id": 4, "Identifier": "IPRange2", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 0, "NetworkAddress": "xx.xx.xx.xx-xx.xx.xx.xx" } ] /api/DeviceService/Actions/ DeviceService.
/api/DeviceService/Actions/ DeviceService.ValidateExcludes This URI validates global exclusion. POST method for DeviceService.ValidateExcludes This method validates ranges in global exclusion. Description Validates ranges in global exclusion. Privilege APPLIANCE_SETUP HTTP response codes 200 Example request body ] } { "Id": 0, "Identifier": "IPRange2", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 0, "NetworkAddress": "xx.xx.xx.xx" }, { "Id": 0, "NetworkAddress": "xx.xx.xx.xx-xx.xx.xx.
8 Diagnostic /api/DeviceService/Devices(Id)/Actions/ DeviceService.Diagnostic This URI allows you to execute supported diagnostic commands. POST method for DeviceService.Diagnostic This method executes the supported diagnostics commands. Description Executes supported diagnostic commands.
9 Groups /api/GroupService/Groups This URI represents the groups. GET method for Groups This method returns a list of groups. Description Returns a list of groups. Privilege VIEW HTTP response codes 200 Example response body 248 Groups { "@odata.context": "$metadata#Collection(GroupService.Group)", "@odata.count": 1, "value": [ { "@odata.id": "/api/GroupService/Groups(64)", "Id": 64, "Name": "All Devices", "Description": "Group associated to all devices.
} ] } ] Table 99. Attributes Attribute name Description Id ID of the group. Name Name of the group. Description Description of the group. GlobalStatus Global status of the group. Indicates the health of the group. ParentId Parent ID of the group. If the group is a root group, ParentId is 0. CreationTime Date and time when the group was created. UpdatedTime Date and time when the group was updated. CreatedBy User who created the group. UpdatedBy User who last updated the group.
Attribute name Description DefinitionId Filter by group definition ID. DefinitionDescription Filter by group definition description. Visible Filter by group visibility. CreatedBy Filter by the entity that created the group. UpdatedBy Filter by the entity that updated the group. CreationTimeBegin Filter by the start-time when the group was created. CreationTimeEnd Filter by the end-time when the group was created. UpdatedTimeBegin Filter by the start-time when the group was updated.
} } "@odata.id": "/api/GroupService/Groups(64)/SubGroups" ], "GroupDevicesSummary": [ { "@odata.id": "/api/GroupService/Groups(64)/GroupDevicesSummary" } ] Table 101. Attributes Attribute name Description Id ID of the group. Name Name of the group. Description Description of the group. GlobalStatus Global status of the group. Indicates the health of the group. ParentId Parent ID of the group. If the group is a root group, ParentId is 0. CreationTime Date and time when the group was created.
Example request body { } Example response body { } "Id": 1564, "Name": "Test Group1", "Description": "Test Group1", "GlobalStatus": 0, "DefinitionId": 0, "ParentId": 0 "Id": 1564, "Name": "Test Group1", "Description": "Test Group1", "TypeId": 3000, "MembershipTypeId": 12, "GlobalStatus": 5000, "ParentId": 0, "CreatedBy": "root", "UpdatedBy": "root", "CreationTime": "2017-06-08 20:14:37.252", "UpdatedTime": "2017-06-08 20:20:02.
NOTE: For more information about the properties for device responses, see DeviceService. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 1, "value": [ { "@odata.
{ ] } } "@odata.id": "/api/DeviceService/Devices(1614)/InventoryDetails" } ], "HardwareLogs": [ { "@odata.id": "/api/DeviceService/Devices(1614)/HardwareLogs" } ], "SubSystemHealth": [ { "@odata.id": "/api/DeviceService/Devices(1614)/SubSystemHealth" } ], "RecentActivity": [ { "@odata.id": "/api/DeviceService/Devices(1614)/RecentActivity" } ], "InventoryTypes": { "@odata.id": "/api/DeviceService/Devices(1614)/InventoryTypes" }, "LogSeverities": { "@odata.
/api/GroupService/Groups(Id)/ GroupDevicesSummary This URI represents the device summary for a group. GET method for GroupDevicesSummary This method returns the device summary of a group. The summary contains the device types and their status. The status indicates the health of each set of devices. Description Returns the device summary of a group. Privilege VIEW HTTP response codes Example response body { } "@odata.context": "$metadata#Collection(GroupService.GroupDevicesSummary)", "@odata.
/api/GroupService/Groups(group id)/ AllLeafDeviceSummaries This URL returns the device data in the specified group. GET method for AllLeafDeviceSummaries Description Returns the device data in the specified group. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(DeviceService.DeviceMinModel)", "@odata.count": 25, "value": [ { "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
] }, { } "AgentName": "iDRAC", "Version": "2.63.60.62", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(14214)", "Id": 14214, "DeviceName": "XXX.XX.XXX.
}, { "Identifier": "8FWV992a", "DeviceServiceTag": "8FWV992", "Type": 1000, "Status": 1000, "PowerState": 18, "ConnectionState": true, "ManagedState": 3000, "DeviceCapabilities": [ 14, 31, 30, 12, 8, 13, 7, 41, 15, 18, 6, 10, 3, 1, 4, 9, 2, 5, 1009, 50 ], "DeviceManagement": [ { "DeviceId": 14264, "ManagementId": 5002, "NetworkAddress": "XXX.XX.XXX.
7, 41, 8, 9, 10, 31, 12, 13, 14, 30, 15, 1 }, { ], "DeviceManagement": [ { "DeviceId": 14314, "ManagementId": 5003, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "74:86:7a:e5:c5:fa", "InstrumentationName": "idrac-8FWV992b", "ManagementProfile": [ { "ManagementProfileId": 5003, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.63.60.62", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
"NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "10:98:36:9a:ee:03", "InstrumentationName": "MINWINPC", "ManagementProfile": [ { "ManagementProfileId": 5004, "ManagementId": 0, "AgentName": "VxRail", "Version": "2.50.50.50", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] }, { } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
50, 201, 8, 1009, 18, 3, 11, 12, 1 }, { ], "DeviceManagement": [ { "DeviceId": 15130, "ManagementId": 5281, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "4C:D9:8F:45:CC:6C", "InstrumentationName": "MX-GFYH9V2", "ManagementProfile": [ { "ManagementProfileId": 5281, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
"DeviceId": 15132, "ManagementId": 5297, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:80:24:b9", "InstrumentationName": "newserver1", "ManagementProfile": [ { "ManagementProfileId": 5297, "ManagementId": 0, "AgentName": "iDRAC", "Version": "3.20.20.20", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] }, { } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
] }, { } } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(15136)", "Id": 15136, "DeviceName": "100.97.133.
}, { "Id": 15146, "DeviceName": "IOM-C2", "Model": "PowerEdge MX5000s", "Identifier": "0PG5NRA02CNFCP008B2000Y", "DeviceServiceTag": null, "Type": 8000, "Status": 2000, "PowerState": 1, "ConnectionState": false, "ManagedState": 7000, "DeviceCapabilities": [ 18, 7, 2, 9, 5, 1, 3, 8 ], "DeviceManagement": [], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(15230)", "Id": 15230, "DeviceName": "localhost.
] }, { } } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(15231)", "Id": 15231, "DeviceName": "100.97.135.
}, { "DeviceServiceTag": "1LPSG52", "Type": 1000, "Status": 1000, "PowerState": 17, "ConnectionState": true, "ManagedState": 3000, "DeviceCapabilities": [ 41, 14, 50, 10, 2, 1009, 15, 8, 3, 1, 6, 1001, 31, 33, 12, 13, 30, 7, 9, 18, 4, 5 ], "DeviceManagement": [ { "DeviceId": 15232, "ManagementId": 5180, "NetworkAddress": "XXX.XX.XXX.
18, 7, 50, 12, 2, 201 }, { ], "DeviceManagement": [ { "DeviceId": 15250, "ManagementId": 5280, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "D0:94:66:8D:BE:2D", "InstrumentationName": "MX-8ZG70T2", "ManagementProfile": [ { "ManagementProfileId": 5280, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
] }, { } "ManagementId": 0, "AgentName": "iDRAC", "Version": "3.36.36.36", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
"@odata.type": "#DeviceService.DeviceMinModel", "@odata.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(15253)", "Id": 15253, "DeviceName": "MX5108n Ethernet Switch", "Model": "MX5108n Ethernet Switch", "Identifier": "8Y280T2", "DeviceServiceTag": "8Y280T2", "Type": 4000, "Status": 1000, "PowerState": 17, "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 18, 1, 3, 8, 2, 9, 7, 5 ], "DeviceManagement": [ { "DeviceId": 15253, "ManagementId": 5294, "NetworkAddress": "XXX.XX.XXX.
}, { "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 2, 7, 9, 5, 1, 3 ], "DeviceManagement": [], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
}, { "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(15256)", "Id": 15256, "DeviceName": "IOM-B1", "Model": "MX7116n Fabric Expander Module", "Identifier": "902B0T2", "DeviceServiceTag": "902B0T2", "Type": 4000, "Status": 1000, "PowerState": 17, "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 3, 9, 1, 2, 7, 5 ], "DeviceManagement": [], "IpAddress": "XXX.XX.XXX.XX" }, { "@odata.
{ ] }, { } "ManagementProfileId": 5222, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.63.60.62", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
}, { "@odata.type": "#DeviceService.DeviceMinModel", "@odata.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(15389)", "Id": 15389, "DeviceName": "100.97.133.
} ] } "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 7, 3, 5, 9, 8, 2, 1 ], "DeviceManagement": [ { "DeviceId": 15390, "ManagementId": 5296, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "88:94:71:DB:E8:98", "InstrumentationName": "MXG610s FC Switch 2SFP", "ManagementProfile": [ { "ManagementProfileId": 5296, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http://XXX.XX.XXX.XX" } ] } ], "IpAddress": "XXX.XX.XXX.
"Identifier": "8Y280T2", "DeviceServiceTag": "8Y280T2", "Type": 4000, "Status": 1000, "PowerState": 17, "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 18, 1, 3, 8, 2, 9, 7, 5 ], "DeviceManagement": [ { "DeviceId": 15253, "ManagementId": 5294, "NetworkAddress": "XXX.XX.XXX.
5, 1, 3 }, { ], "DeviceManagement": [], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
}, { "Id": 15256, "DeviceName": "IOM-B1", "Model": "MX7116n Fabric Expander Module", "Identifier": "902B0T2", "DeviceServiceTag": "902B0T2", "Type": 4000, "Status": 1000, "PowerState": 17, "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 3, 9, 1, 2, 7, 5 ], "DeviceManagement": [], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
/api/GroupService/Groups(group id)/ AllLeafDeviceSummaries?$filter=Type eq 4000& $top=25&$skip=0 This URL returns the specified list of device data beginning with the first device in the list and can also skip the specified number of devices. GET method for AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0 Description Returns the specified list of device data beginning with the first device in the list and can also skip the specified number of devices.
}, { ] "DeviceId": 15253, "ManagementId": 5295, "NetworkAddress": "2607:f2b1:f083:133::2b6", "MacAddress": "20:04:0F:13:3C:E2", "InstrumentationName": "MX5108n Ethernet Switch", "ManagementProfile": [ { "ManagementProfileId": 5295, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http:// [2607:f2b1:f083:133::2b6]" } ] } ], "IpAddress": "XXX.XX.XXX.XX" }, { "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
{ }, { "DeviceId": 15255, "ManagementId": 5292, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "20:04:0F:12:DF:62", "InstrumentationName": "MX5108n Ethernet Switch", "ManagementProfile": [ { "ManagementProfileId": 5292, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http://XXX.XX.XXX.
} ] } "PowerState": 17, "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 7, 3, 5, 9, 8, 2, 1 ], "DeviceManagement": [ { "DeviceId": 15390, "ManagementId": 5296, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "88:94:71:DB:E8:98", "InstrumentationName": "MXG610s FC Switch 2SFP", "ManagementProfile": [ { "ManagementProfileId": 5296, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http://XXX.XX.XXX.XX" } ] } ], "IpAddress": "XXX.XX.XXX.
}, { "Id": 15390, "DeviceName": "MXG610s FC Switch 2SFP", "Model": "MXG610s FC Switch 2SFP", "Identifier": "0FM3R3A01CN7969096FC008", "DeviceServiceTag": null, "Type": 4000, "Status": 3000, "PowerState": 17, "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 7, 3, 5, 9, 8, 2, 1 ], "DeviceManagement": [ { "DeviceId": 15390, "ManagementId": 5296, "NetworkAddress": "XXX.XX.XXX.
}, { ] } "ManagementProfileId": 5292, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http://XXX.XX.XXX.XX" "DeviceId": 15255, "ManagementId": 5293, "NetworkAddress": "2607:f2b1:f083:133::78", "MacAddress": "20:04:0F:12:DF:62", "InstrumentationName": "MX5108n Ethernet Switch", "ManagementProfile": [ { "ManagementProfileId": 5293, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http:// [2607:f2b1:f083:133::78]" } ] } ], "IpAddress": "XXX.XX.XXX.
"NetworkAddress": "2607:f2b1:f083:133::2b6", "MacAddress": "20:04:0F:13:3C:E2", "InstrumentationName": "MX5108n Ethernet Switch", "ManagementProfile": [ { "ManagementProfileId": 5295, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http:// [2607:f2b1:f083:133::2b6]" } ] } ], "IpAddress": "XXX.XX.XXX.XX" }, { "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
/api/GroupService/Groups(Id)/SubGroups This URI represents the subgroups of a specific group. GET method for SubGroups This method returns the list of subgroups of a specific group. Description Returns the list of subgroups. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(GroupService.Group)", "@odata.count": 1, "value": [ { "@odata.
Table 105. Attributes Attribute name Description Id ID of the group. Name Name of the group. Description Description of the group. GlobalStatus Global status of the group. Indicates the health of the group. ParentId Parent ID of the group. If the group is a root group, ParentId is 0. CreationTime Date and time when the group was created. UpdatedTime Date and time when the group was updated. CreatedBy User who created the group. UpdatedBy User who last updated the group.
} "value": [ { "ParentGroupId": 64, "ChildGroupId": 19164 } ] Table 106. Attributes Attribute name Description Id ID of the group. ParentGroupId ID of the parent group. ChildGroupId ID of the subgroup within the group. /api/GroupService/GroupTypes This URI represents the group types. GET method for GroupTypes This method returns a list of all the group types. Description Returns all the group types. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
} ] } "Description": "Multi-Chassis Internal Group." Table 107. Attributes Attribute name Description Id ID of the group type. Name Name of the group type. Description Description of the group type. /api/GroupService/GroupTypes(Id) This URI represents a group type within the collection. GET method for GroupTypes(Id) This method returns the details of a specific group from the collection. Description Returns the details of a specific group.
Example response body { } "@odata.context": "$metadata#Collection(GroupService.MembershipType)", "@odata.count": 2, "value": [ { "@odata.id": "/api/GroupService/MembershipTypes(12)", "Id": 12, "Name": "Static", "Description": "Static type" }, { "@odata.id": "/api/GroupService/MembershipTypes(24)", "Id": 24, "Name": "Dynamic", "Description": "Dynamic type" } ] Table 109. Attributes Attribute name Description Id ID of the membership type. Name Name of the membership type.
/api/GroupService/AllGroupsHierarchy This URI represents the hierarchy of all the groups and subgroups. GET method for AllGroupsHierarchy This method returns the hierarchy of all the groups and subgroups. Description Returns the hierarchy of all the groups and subgroups. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(GroupService.GroupHierarchy)", "@odata.
/api/GroupService/Actions/ GroupService.GroupsPrivilegesAction POST method for GroupService.GroupsPrivilegesAction This method returns the group privileges for the logged-in user. Description Returns the group privileges for the user. To view the privileges of multiple groups, provide the group IDs separated by a comma.
[“DEVICE_UPDATE”] } Example response body 292 Groups List of groups on which the user the specified privilege.
10 Monitor Audit logs /api/ApplicationService/AuditLogs This URI represents a collection of audit logs of the system. GET method for AuditLogs This method returns a collection of audit logs of the system. Description Returns a collection of audit logs. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(ApplicationService.AuditLog)", "@odata.count": 7, "value": [ { "@odata.
Privilege HTTP response code Example response body 200 { "@odata.context": "/api/ $metadata#Collection(ApplicationService.AuditLogCategories)", "@odata.count": 1, "value":[ { "@odata.type": "#ApplicationService.
Table 111. Attributes Attribute Description Id Identifier of the SessionService. Severity Severity of the event or error message. Possible values are Critical, Warning, and Informational. Message Message text. Category Category of the message. UserName Authenticated user who generated the message. IpAddress IP address of the authenticated user. MessageArgs Message parameters associated with the message. MessageID Message identifier. CreatedDate Date on which the message was generated.
{ "Id": 6000, "Name": "GROUP" } } ], "Params": [ { "JobId": 10016, "Key": "defaultInventoryTask", "Value": "TRUE" } ], "LastRunStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" }, "JobType": { "@odata.type": "#JobService.JobType", "Id": 8, "Name": "Inventory_Task", "Internal": false }, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2020, "Name": "Scheduled" }, "ExecutionHistories@odata.
Attribute Description JobDescription Description of the job. JobType Type of the job. NextRun The next time when the job will be executed. LastRun The last time when the job was executed. StartTime Start time of the job. EndTime End time of the job. Schedule Job schedule (cron string). State Indicates whether the job is enabled or disabled. CreatedBy User who created the job. UpdatedBy User who updated the job. Visible Indicates whether the job is visible.
} Example response body { } "Name":"Inventory_Task" }, "Targets": [ { "Id": 25915, "Data": "", "TargetType": { "Id":1000, "Name":"DEVICE" } } ] "Id": 26097, "JobName": "Inventory Task Device", "JobDescription": "Inventory Task Device", "NextRun": null, "LastRun": null, "StartTime": null, "EndTime": null, "Schedule": "startnow", "State": "Enabled", "CreatedBy": "root", "UpdatedBy": null, "LastRunStatus": { "Id": 2200, "Name": "NotRun" }, "JobType": { "Id": 8, "Name": "Inventory_Task", "Internal": false
"JobDescription": "", "Schedule": "", "State": "Enabled", "JobType": { "Id": 5, Name": "Update_Task" }, "Targets": [ { "Id": , "Data": ";;;;;;;;;;", "TargetType":{"Id":1000, "Name":"Device"}}, { "Id": , "Data":";;;;; ;;
} ], "Params": [ { "Key": "operationName", "Value": "SET_NAME" }, { "Key": "name", "Value": "MX-7BU258R" } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task" } } POST method for Example response body setting slot names { for blade servers "JobName": "Update slot name", "JobDescription": "Update slot name", "Schedule": "startnow", "State": "Enabled", "Targets": [ { "Id": 25016, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "slotConfig", "Value": "1|1000|SLED1" }, { "K
"Value": "25041" }, { "Key": "rootCredential", "Value": "password" }, { } Quick Deploy of sleds ] "Key": "networkTypeV4", "Value": "Dhcp" }, { "Key": "protocolTypeV4", "Value": "true" }, { "Key": "subnetMaskV4", "Value": "" }, { "Key": "gatewayV4", "Value": "" }, { "Key": "networkTypeV6", "Value": "" }, { "Key": "protocolTypeV6", "Value": "" }, { "Key": "prefixLength", "Value": "" }, { "Key": "gatewayV6", "Value": "" }, { "Key": "slotId=1", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId
"State": "Enabled", "Targets": [], "Params": [ { "Key": "slotId=5", "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1" }, { "Key": "slotId=6", "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1" }, { "Key": "slotId=7", "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1" }, { "Key": "slotId=8", "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.
} Rolling back firmware update —Device method "JobType": { "Id": 42, "Name": "QuickDeploy_Task", } Example response body { } "JobName":"Rollback Firmware", "Schedule":"", "State":"Enabled", "JobType":{ "Id": 15, "Name":"RollbackSoftware_Task" }, "Params":[ { "Key":"operationName", "Value":"INSTALL_FIRMWARE" }, { "Key":"stagingValue", "Value":"false" }, { "Key":"signVerify", "Value":"true" } ], "Targets":[ { "Id":, "Data": "available=", "TargetType":{ "Id":1000,
} Rolling back firmware update —Browse method 304 Monitor } Example response body { } Failover of management module ] "TargetType":{ "Id":1000, "Name":"Device" } "JobName":"Rollback Firmware", "Schedule":"", "State":"Enabled", "JobType":{ "Id": 15, "Name":"RollbackSoftware_Task" }, "Params":[ { "Key":"operationName", "Value":"INSTALL_FIRMWARE" }, { "Key":"stagingValue", "Value":"false" }, { "Key":"signVerify", "Value":"true" } ], "Targets":[ { "Id":, "Data": "unavailable
} Chassis backup } Example response body { "JobName": "Backup Task", "JobDescription": "Create a Backup of the chassis", "Schedule": "startnow", "State": "Enabled", "Targets": [], "Params": [ { }, { }, { }, { }, { }, { }, { } Chassis restore "Key": "shareName", "Value": "share" "Key": "shareType", "Value": "" "Key": "device_id", "Value": "25019" "Key": "shareAddress", "Value": "100.97.203.
}, { }, { }, { }, { }, { }, { "Value": "
} } "Name": "ValidateNWFileShare_Task" Chassis Extract Example response body Logs—Local Share { "JobName": "Extract Log", "JobDescription": "Extract device log", "Schedule": "startnow", "State": "Enabled", "Targets": [ { "Id": 25016, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "shareAddress", "Value": "127.0.0.
}, { }, { }, { }, { } "Key": "shareName", "Value": "share" "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" "Key": "shareType", "Value": "NFS" "Key": "maskSensitiveInfo", "Value": "FALSE" } ], "JobType": { "Id": 18, "Name": "DebugLogs_Task" } Chassis Extract Example response body Logs—CIFS Share { "JobName": "Extract Log", "JobDescription": "Extract device log to CIFS location", "Schedule": "startnow", "State": "Enabled", "Targets": [ { "Id": 25016, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVIC
} "JobType": { "Id": 18, "Name": "DebugLogs_Task" } Device-based Example response body reseat for { compute, storage, "JobName": "Virtual_Reseat", or IOM "JobDescription": " Virtual_Reseat ", "Schedule": "startnow", "State":"Enabled", "Targets": [ { "Id": 50115, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "override", "Value": "true" }, { "Key": "operationName", "Value": "VIRTUAL_RESEAT" }, { "Key": "deviceTypes", "Value": "1000" } ], "JobType": { "Id": 3, "Name": "
"Key": "slotNumber", "Value": "6" } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task", "Internal": false }} Chassis power off operation Example response body { "JobName": "Power Off (Non-graceful)", "JobDescription": "Power Control Task: Power Off (Non-graceful)", "Schedule": "startnow", "State": "Enabled", "Targets": [ { "Id": 50115, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } }], "Params": [ { "Key": "override", "Value": "true" }, { "Key": "powerState", "Value": "8" }, { "Key": "operati
"Value": "true" }, { "Key": "powerState", "Value": "8" }, { "Key": "operationName", "Value": "POWER_CONTROL" }, { "Key": "deviceTypes", "Value": "1000" } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task", "Internal": false } } IOM power off operation Example response body { "JobName": "Power Off (graceful)", "JobDescription": "Power Control Task: Power Off (graceful)", "Schedule": "startnow", "State": "Enabled", "Targets": [ { "Id": 10660, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } }], "
} "Targets": [ { "Id": 10099, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "slotNumber", "Value": "2" }, { "Key": "operationName", "Value": "RESET_IDRAC" }, { "Key": "slotType", "Value": "2000" } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task", "Internal": false } Where Slot type is always 2000 for compute SLED and ID "10099" is for chassis ID. Table 114. Attributes Attribute Description Target Id ID of the device.
/api/JobService/Jobs(Id) This URI represents the details of a job. GET method for Jobs(Id) This method returns the details of a specific job. Description Returns details of a job. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#JobService.Job/$entity", "@odata.type": "#JobService.Job", "@odata.
"Id": 2020, "Name": "Scheduled" }, "ExecutionHistories@odata.navigationLink": "/api/JobService/Jobs(10016)/ ExecutionHistories" } Table 115. Attributes Attribute Description Id ID of the job. JobName Name of the job. JobDescription Description of the job. JobType Type of the job. NextRun The next time when the job will be executed. LastRun The last time when the job was executed. StartTime Start time of the job. EndTime End time of the job. Schedule Job schedule (cron string).
HTTP response codes Example request body 200 { } Example response body { "Id":26097, "JobName":"Inventory Task", "JobDescription":"Inventory Task", "Schedule":"startnow", "State":"Enabled", "JobType": { "Id":8, "Name":"Inventory_Task" }, "Targets": [ { "Id": 25915, "Data": "", "TargetType": { "Id":1000, "Name":"DEVICE" } } ] "Id": 26097, "JobName": "Inventory Task", "JobDescription": "Inventory Task", "NextRun": null, "LastRun": "2018-09-14 15:31:13.
} } ], "Params": [], "Visible": true, "Editable": true, "Builtin": false Table 116. Attributes Attribute Description Id ID of the job. JobName Name for the job. JobDescription Description for the job. Schedule The schedule to start the job. State Enabled state for the job. It should be enabled. JobType Id of job type. JobName Name of the job type. DELETE method for Jobs(Id) This method deletes a specific job. Description Deletes a job.
}, { "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2030)", "Id": 2030, "Name": "Queued" }, { } ] "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2040)", "Id": 2040, "Name": "Starting" }, { "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2050)", "Id": 2050, "Name": "Running" }, { "@odata.type": "#JobService.JobStatus", "@odata.
Table 118. Attributes Attribute Description Id ID of the job status. Name Name of the job status. /api/JobService/JobStatuses(Id) This URI represents the status of a job. GET method for JobStatuses(Id) This method returns the details of a specific job status. Description Returns details of a specific job status. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#JobService.JobStatus/$entity", "@odata.type": "#JobService.JobStatus", "@odata.
}, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(5)", "Id": 5, "Name": "Update_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(8)", "Id": 8, "Name": "Inventory_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(15)", "Id": 15, "Name": "RollbackSoftware_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.
"@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(38)", "Id": 38, "Name": "MCMOffBoarding_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(39)", "Id": 39, "Name": "MCMGroupCreation_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(41)", "Id": 41, "Name": "ProfileUpdate_Task", "Internal": false }, { } ] } "@odata.type": "#JobService.JobType", "@odata.
Table 121. Attributes Attribute Description Id ID of the job type. Name Name of the job type. Internal Indicates whether the job is internal. /api/JobService/Jobs(Id)/ExecutionHistories This URI represents all the execution histories for a job. GET method for ExecutionHistories This method returns the details of all the execution histories for a job. Description Returns details of all executions histories for a job. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
}, { "@odata.type": "#JobService.ExecutionHistory", "@odata.id": "/api/JobService/Jobs(10016)/ExecutionHistories(18774)", "Id": 18774, "JobName": "Default Inventory Task", "Progress": "100", "StartTime": "2018-09-14 14:00:00.526", "EndTime": "2018-09-14 14:00:29.312", "LastUpdateTime": "2018-09-14 14:00:29.312", "ExecutedBy": "admin", "JobId": 10016, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" }, "ExecutionHistoryDetails@odata.
Attribute Description Progress Percentage of completion. StartTime The start time of job execution. EndTime The end time of job execution. Schedule Job schedule (cron string). State Indicates whether the job is enabled or disabled. LastUpdatedTime Timestamp when the job-execution history was last updated. ExecutedBy Details of who executed the job. JobId Job associated with the execution history. JobStatus Job execution history detail completion status.
] } } "ExecutionHistoryId": 18683, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" } Table 123. Attributes Attribute Description Id Job execution history detail ID. Progress Percentage of completion. StartTime The start time of job execution. EndTime The end time of job execution. Key Job execution history details key. Value Job execution history details value. ExecutionHistoryId Execution history ID associated with the detail.
{ "AllJobs": true, } /api/JobService/Actions/JobService.DisableJobs POST method for JobService.DisableJobs This method disables the selected jobs. Description Disables the selected jobs.
HTTP response codes Example request body 201 { "JobIds": [100,200,300], } Or { } "Filters": { "Status": 2020, "State": "", "JobType": "AlertSubscription_Task", "StartTime": "2017-06-06 10:00:00.00", "EndTime": "2017-06-07 10:00:00.00" } Or { } "AllJobs": true, /api/JobService/Actions/JobService.Schedule This API represents the job schedule information. POST method for job schedule This method returns the job schedule information. Description Returns information about job schedules.
• • • A single job A set of jobs based on the filters you provide All jobs Privilege DEVICE_CONFIGURATION HTTP response codes 201 Example request body { "JobIds": [100,200,300], } Or { "Filters": { "Status": 2020, "State": "", "JobType": "AlertSubscription_Task", "StartTime": "2017-06-06 10:00:00.00", "EndTime": "2017-06-07 10:00:00.00" } } Or { "AllJobs": true, } /api/JobService/Actions/JobService.StopJobs POST method for JobService.StopJobs This method stops the selected jobs.
} } "StartTime": "2017-06-06 10:00:00.00", "EndTime": "2017-06-07 10:00:00.00" Or { } "AllJobs": true, /api/JobService/Actions/JobService.Schedule This API represents the job schedule information. POST method for job schedule This method returns the job schedule information. Description Returns information about job schedules.
/api/JobService/Actions/JobService.Cancel This API represents information about jobs that are canceled. POST method for canceled jobs This method returns information about jobs that are canceled. Description Returns information about a canceled job. Privilege DEVICE_CONFIGURATION HTTP response codes 201 Example response body { } "JobIds": [], "AllJobs": true, "Filters": { "Status": 2020, "State": "", "JobType": "", "StartTime": "", "EndTime": "" } /api/JobService/Actions/JobService.
HTTP response codes Example response body 201 { } "JobIds": [], "AllJobs": true, "Filters": { "Status": 2020, "State": "", "JobType": "", "StartTime": "", "EndTime": "" } /api/JobService/Actions/JobService.ExecuteAction This API creates and runs jobs such as quick deploy, and compliance report. Create a job model payload to create and run the job to which the model is associated. POST method for /api/JobService/Actions/ JobService.
11 Reset application /api/ApplicationService/Actions/ ApplicationService.ResetApplication This URI resets the application and select between resetting all data or only resetting the configuraiton. POST method for ResetApplication This method resets the application. You can either reset only the configuration or also clear all the data. Description Resets the application by clearing only the configuration, or by clearing the configuration and the data.
12 Console version /api/ApplicationService/Info This URI represents the product information. GET method for Info This method returns the product information. Description Returns the product information. Privilege VIEW HTTP response codes 200 Example response body { } 332 Console version "@odata.context": "/api/$metadata#ApplicationService.Info/$entity", "@odata.type": "#ApplicationService.Info", "@odata.
13 Console capabilities /api/ApplicationService/Capabilities This URI represents the capabilities of the management console—OpenManage Enterprise or OME–Modular. GET method for Capabilities This method returns the capabilities of the management console—OME–Modular or OME–Modular. These two management consoles have different capabilities. Description Returns the capabilities of the management console.
"@odata.type": "#ApplicationService.Capability", "Name": "DEVICE_MANAGEMENT", "Description": "This capability tells whether the console is capable of restricting execution of tasks based on onboarded and not-onboarded devices" }, { "@odata.type": "#ApplicationService.Capability", "Name": "BOOT_TO_NETWORK_ISO", "Description": "This capability is for booting devices from network iso." }, { "@odata.type": "#ApplicationService.
14 Search This resource enables you to search for navigation links and documents using query strings. Use the URIs in this resource to search for navigation links and documents by providing search query strings. Topics: • /api/SearchService/Actions/SearchService.Search /api/SearchService/Actions/ SearchService.Search POST method for SearchService.Search This method performs a search using the query string that you provide and returns links to the corresponding navigation pages.
1864", "_index": "msm", "_type": "tasks", "_id": "3864", "_score": 1, "_source": { "tskNm": "Device_Config_Task (1493523261197) - for Device with Id: "tskTyp": "Device Config Task", "tskStatus": "Task status is Failed", "tskDesc": "Device_Config_Task (1493523261197) - for Device with Id: 1864", "tskCreatedBy": "system", "tskId": "3864" } } ] } } Table 124. Attributes Attribute name Description QueryString String to search. FilterType Indexes to be searched for the query string.
15 Session /api/SessionService This URI represents the collection of session services. GET method for SessionService This method returns a collection of the sessions services. Description Returns a collection of session services. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#SessionService.SessionService", "@odata.
/api/SessionService/Sessions This URI represents a collection of active session services. GET method for Sessions This method returns the collection of active session service. Description Returns a collection of active session services. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(SessionService.Session)", "@odata.count": 1, "value": [ { "@odata.
Example request body { } Example response body { } "UserName":"root", "Password":"linux", "SessionType":"API" "Id": "7b723932-a119-4843-a5b7-7a122e4def99", "Description": "root", "Name": "API", "UserName": "root", "Password": null, "Roles": [ "ADMINISTRATOR" ], "IpAddress": "xx.xx.xx.xx", "StartTimeStamp": "2017-04-17 20:07:12.357", "LastAccessedTimeStamp": "2017-04-17 20:07:12.357" Table 127. Attributes Attribute Name Description UserName The Session user name.
} Example response body { } "Id": "7b723932-a119-4843-a5b7-7a122e4def99", "Description": "root", "Name": "API", "UserName": "root", "Password": null, "Roles": [ "ADMINISTRATOR" ], "IpAddress": "xx.xx.xx.xx", "StartTimeStamp": "2017-04-17 20:07:12.357", "LastAccessedTimeStamp": "2017-04-17 20:07:12.357" Table 128. Attributes Attribute Name Description Id The unique identifier of the SessionService. UserName The session user name. Password The session user password. Roles Role privileges.
"@odata.context": "/api/ $metadata#Collection(SessionService.SessionConfiguration)", "@odata.count": 6, "value": [ { "@odata.type": "#SessionService.SessionConfiguration", "SessionType": "GUI", "MaxSessions": 6, "SessionTimeout": 1320000, "MinSessionTimeout": 60000, "MaxSessionTimeout": 86400000, "MinSessionsAllowed": 1, "MaxSessionsAllowed": 6 }, { "@odata.type": "#SessionService.
/api/SessionService/Actions/ SessionService.SessionConfigurationUpdate POST method for SessionService.SessionConfigurationUpdate Description This method adds the ability to configure the inactivity (not active sessions) timeout interval and the maximum number of sessions that are enabled per session type. When these properties are changed, the properties of the current active sessions are not terminated or modified.
16 APIs specific to OpenManage Enterprise – Modular Edition /api/ApplicationService/Settings This URI represents the application settings information. GET method for /api/ApplicationService/Settings This method returns the application settings. Description Returns the application settings. Privilege VIEW HTTP response codes 201 Example Request Body { } ] } "@odata.type": "#ApplicationService.
/api/ApplicationService/Network/ CurrentAddressConfiguration This URI represents the current network IP configuration. NOTE: This API is not available in OpenManage Enterprise from version 3.3.1. GET method for CurrentAddressConfiguration This method returns the current network IP configuration. Description Returns the current network IP configuration. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Network.
Attribute name Description Ipv4Setting.CurrentPreferredDNSServer Current IPv4 DNS preferred server. Ipv4Setting.CurrentAlternateDNSServer Current IPv4 DNS alternate server. Ipv6Setting.Enable IPv6 network settings status. Ipv6Setting.EnableAutoConfiguration IPv6 via DHCP server status. Ipv6Setting.CurrentIPAddress Current IPv6 address. Ipv6Setting.CurrentGateway Current IPv6 prefix length. Ipv6Setting.CurrentLinkLocalAddress Current IPv6 gateway address. Ipv6Setting.
} "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "ManagementVLAN": { "EnableVLAN": false, "Id": 1 }, "DnsConfiguration": { "RegisterWithDNS": false, "DnsName": "MX7000", "UseDHCPForDNSDomainName": false, "DnsDomainName": "" }, "Delay": 0 PUT method for AddressConfiguration This method updates the network configuration. Description Updates the network configuration. Privilege APPLIANCE_SETUP HTTP response codes 200 Example request body 346 { "@odata.
} Example response body { } "Delay": 0 "EnableNIC": true, "Ipv4Configuration": { "Enable": true, "EnableDHCP": true, "StaticIPAddress": "", "StaticSubnetMask": "", "StaticGateway": "", "UseDHCPForDNSServerNames": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "Ipv6Configuration": { "Enable": false, "EnableAutoConfiguration": true, "StaticIPAddress": "", "StaticPrefixLength": 0, "StaticGateway": "", "UseDHCPForDNSServerNames": true, "StaticPreferredDNSServer": "", "StaticAlternat
Attribute name Description Ipv6Configuration.StaticIPAddress Set Static IPv6 address. Ipv6Configuration.StaticPrefixLength Set Static IPv6 prefix length. Ipv6Configuration.StaticGateway Set Static IPv6 gateway address. Ipv6Configuration.UseDHCPForDNSServerNames Obtain IPv6 DNS servers via DHCP server options. Ipv6Configuration.StaticPreferredDNSServer Set Static IPv6 DNS preferred server. Ipv6Configuration.StaticAlternateDNSServer Set Static IPv6 DNS alternate server. ManagementVLAN.
"Name": "WebServer.1#WebserverEnable", "Value": true }, { "Name": "Preference.1#DeviceName", "Value": "SLOT_NAME" }, { "Name": "LoginSecurity.1#Id", "Value": "10" }, { "Name": "LoginSecurity.1#LockoutFailCount", "Value": 3 }, { "Name": "LoginSecurity.1#LockoutFailCountTime", "Value": 30 }, { "Name": "LoginSecurity.1#LockoutPenaltyTime", "Value": 900 }, { "Name": "LoginSecurity.1#IPRangeAddr", "Value": null }, { "Name": "LoginSecurity.
"Name": "RemoteSystemLog.3#Port", "Value": 0 }, { "Name": "RemoteSystemLog.4#RemoteSyslogEnable", "Value": false }, { "Name": "RemoteSystemLog.4#destinationAddress", "Value": null }, { "Name": "RemoteSystemLog.4#Port", "Value": 0 }, { "Name": "ChassisPower.1#SystemInputPowerCap", "Value": "6763" }, { "Name": "ChassisPower.1#RedundancyPolicy", "Value": "NO_REDUNDANCY" }, { "Name": "ChassisPower.1#EnablePowerCap", "Value": true }, { "Name": "SNMPAlerts.1#Enable", "Value": true }, { "Name": "SNMPAlerts.
"Name": "SNMPAlerts.3#DestinationIP", "Value": null }, { "Name": "SNMPAlerts.3#port", "Value": 0 }, { "Name": "SNMPAlerts.3#version", "Value": null }, { "Name": "SNMPAlerts.3#CommunityString", "Value": null }, { "Name": "SNMPAlerts.4#Enable", "Value": false }, { "Name": "SNMPAlerts.4#DestinationIP", "Value": null }, { "Name": "SNMPAlerts.4#port", "Value": 0 }, { "Name": "SNMPAlerts.4#version", "Value": null }, { "Name": "SNMPAlerts.4#CommunityString", "Value": null }, { "Name": "TimeConfig.
"Name": "QuickSync.1#Access", "Value": "READ_WRITE" }, { "Name": "QuickSync.1#InactivityTimerEnable", "Value": true }, { "Name": "QuickSync.1#InactivityTimeout", "Value": 120 }, { "Name": "QuickSync.1#ReadAuthentication", "Value": true }, { "Name": "QuickSync.1#WifiEnable", "Value": true }, { "Name": "EmailAlertsConf.1#DestinationEmailAddress", "Value": "10.36.0.167" }, { "Name": "EmailAlertsConf.1#portNumber", "Value": 25 }, { "Name": "EmailAlertsConf.
"Name": "Racadm.1#Enable", "Value": true }, { "Name": "Proxy.1#ipAddress", "Value": null }, { "Name": "Proxy.1#Port", "Value": 0 }, { "Name": "Proxy.1#user", "Value": null }, { "Name": "Proxy.1#password", "Value": null }, { "Name": "Proxy.1#enableAuthentication", "Value": false }, { "Name": "Proxy.
"Name": "Network#Ipv6Settings#EnableIPv6", "Value": false }, { "Name": "Network#Ipv6Settings#EnableAutoconfiguration", "Value": true }, { "Name": "Network#Ipv6Settings#StaticIPv6Address", "Value": "" }, { "Name": "Network#Ipv6Settings#StaticPrefixLength", "Value": "0" }, { "Name": "Network#Ipv6Settings#StaticGateway", "Value": "" }, { "Name": "Network#Ipv6Settings#UseDHCPv6ObtainDNSServerAddresses", "Value": true }, { "Name": "Network#Ipv6Settings#StaticPreferredDNSServer", "Value": "" }, { "Name": "Network
{ "Name": "Users.1#Name", "Value": "root" }, { "Name": "Users.1#Privilege", "Value": "10" }, { "Name": "Users.1#Enable", "Value": true }, { "Name": "Users.1#Password", "Value": null }, { "Name": "Users.2#userType", "Value": 1 }, { "Name": "Users.2#SHA256Password", "Value": "$2a $10$zpVUzQIfE3nCOpodYXiz9.A.rr6SAkYcovyTEd49hxL7N83ZeqkqK" }, { "Name": "Users.2#Name", "Value": "ravi2" }, { "Name": "Users.2#Privilege", "Value": "10" }, { "Name": "Users.2#Enable", "Value": true }, { "Name": "Users.
"Value": "$2a $10$ntDJPWAkaB5oemKyzLQPG.M5HliotxOby.q9cHPg2XIiYgPZjannC" }, { "Name": "Users.4#Name", "Value": "MK" }, { "Name": "Users.4#Privilege", "Value": "10" }, { "Name": "Users.4#Enable", "Value": true }, { "Name": "Users.4#Password", "Value": null }, { "Name": "Users.5#userType", "Value": 2 }, { "Name": "Users.5#SHA256Password", "Value": "$2a $10$H0cK06cAnceieSNuaI3JT.TI8DfX49XkdVcNbHC4G2X92lAhCAstS" }, { "Name": "Users.5#Name", "Value": "MSMMegatronTeam" }, { "Name": "Users.
{ "Name": "ActiveDirectory.1#Port", "Value": 3269 }, { "Name": "ActiveDirectory.1#NetworkTimeout", "Value": 120 }, { } } ] } ] "Name": "ActiveDirectory.1#SearchTimeout", "Value": 120 }, { "Name": "ActiveDirectory.1#CertValidationEnable", "Value": false }, { "Name": "ActiveDirectory.1#certificateFile", "Value": "" }, { "Name": "LDAP.1#name", "Value": "LDAP Dell" }, { "Name": "LDAP.1#serverType", "Value": "MANUAL" }, { "Name": "LDAP.1#DomainController1", "Value": "10.36.0.167" }, { "Name": "LDAP.
Attribute Description ServiceTag Chassis Service Tag. TimeStamp Time stamp when the configuration is retrieved. Components Components for which the configuration is retrieved. FQDD A key for each setting. Attributes Key-value pairs of attributes. Name Attribute name. Value Attribute value. /api/ApplicationService/Actions/ ApplicationService.ApplyConfiguration POST method for ApplicationService.ApplyConfiguration This method updates the system settings.
"Name": "LoginSecurity.1#LockoutFailCountTime", "Value": 30 }, { "Name": "LoginSecurity.1#LockoutPenaltyTime", "Value": 900 }, { "Name": "LoginSecurity.1#IPRangeAddr", "Value": null }, { "Name": "LoginSecurity.1#LockoutByUsernameEnable", "Value": false }, { "Name": "LoginSecurity.1#LockoutByIPEnable", "Value": true }, { "Name": "LoginSecurity.1#IPRangeEnable", "Value": false }, { "Name": "RemoteSystemLog.1#RemoteSyslogEnable", "Value": true }, { "Name": "RemoteSystemLog.
"Name": "ChassisPower.1#SystemInputPowerCap", "Value": "6763" }, { "Name": "ChassisPower.1#RedundancyPolicy", "Value": "NO_REDUNDANCY" }, { "Name": "ChassisPower.1#EnablePowerCap", "Value": true }, { "Name": "SNMPAlerts.1#Enable", "Value": true }, { "Name": "SNMPAlerts.1#DestinationIP", "Value": "10.36.0.167" }, { "Name": "SNMPAlerts.1#port", "Value": 162 }, { "Name": "SNMPAlerts.1#version", "Value": "SNMPV1" }, { "Name": "SNMPAlerts.1#CommunityString", "Value": "public" }, { "Name": "SNMPAlerts.
"Name": "SNMPAlerts.4#Enable", "Value": false }, { "Name": "SNMPAlerts.4#DestinationIP", "Value": null }, { "Name": "SNMPAlerts.4#port", "Value": 0 }, { "Name": "SNMPAlerts.4#version", "Value": null }, { "Name": "SNMPAlerts.4#CommunityString", "Value": null }, { "Name": "TimeConfig.1#TimeZone", "Value": "TZ_ID_11" }, { "Name": "TimeConfig.1#NTPEnable", "Value": false }, { "Name": "TimeConfig.1#NTPServer1", "Value": null }, { "Name": "TimeConfig.1#NTPServer2", "Value": null }, { "Name": "TimeConfig.
"Name": "QuickSync.1#WifiEnable", "Value": true }, { "Name": "EmailAlertsConf.1#DestinationEmailAddress", "Value": "10.36.0.167" }, { "Name": "EmailAlertsConf.1#portNumber", "Value": 25 }, { "Name": "EmailAlertsConf.1#useCredentials", "Value": false }, { "Name": "EmailAlertsConf.1#useSSL", "Value": false }, { "Name": "EmailAlertsConf.1#user", "Value": null }, { "Name": "EmailAlertsConf.1#Password", "Value": null }, { "Name": "SNMPService.1#Enable", "Value": true }, { "Name": "SNMPService.
}, { }, { }, { }, { }, { "Name": "Proxy.1#password", "Value": null "Name": "Proxy.1#enableAuthentication", "Value": false "Name": "Proxy.
"Name": "Network#Ipv6Settings#StaticGateway", "Value": "" }, { "Name": "Network#Ipv6Settings#UseDHCPv6ObtainDNSServerAddresses", "Value": true }, { "Name": "Network#Ipv6Settings#StaticPreferredDNSServer", "Value": "" }, { "Name": "Network#Ipv6Settings#StaticAlternateDNSServer", "Value": "" }, { "Name": "Network#GeneralSettings#EnableNIC", "Value": true }, { "Name": "Network#GeneralSettings#RegisterDNS", "Value": true }, { "Name": "Network#GeneralSettings#DnsName", "Value": "MX-01PTCMSM1234" }, { "Name":
{ "Name": "Users.2#userType", "Value": 1 }, { "Name": "Users.2#SHA256Password", "Value": "$2a $10$zpVUzQIfE3nCOpodYXiz9.A.rr6SAkYcovyTEd49hxL7N83ZeqkqK" }, { "Name": "Users.2#Name", "Value": "ravi2" }, { "Name": "Users.2#Privilege", "Value": "10" }, { "Name": "Users.2#Enable", "Value": true }, { "Name": "Users.2#Password", "Value": null }, { "Name": "Users.3#userType", "Value": 1 }, { "Name": "Users.3#SHA256Password", "Value": "$2a $10$dTg7igLe1neXnZthG9vzP.8ML.tcUOxyeP.
"Name": "Users.4#Password", "Value": null }, { "Name": "Users.5#userType", "Value": 2 }, { "Name": "Users.5#SHA256Password", "Value": "$2a $10$H0cK06cAnceieSNuaI3JT.TI8DfX49XkdVcNbHC4G2X92lAhCAstS" }, { "Name": "Users.5#Name", "Value": "MSMMegatronTeam" }, { "Name": "Users.5#Privilege", "Value": "10" }, { "Name": "Users.5#Enable", "Value": true }, { "Name": "Users.5#objectGuid", "Value": "d22005b6-0ce5-40ed-88d0-7f7759b52f25" }, { "Name": "Users.5#Password", "Value": null }, { "Name": "Users.
{ "Name": "ActiveDirectory.1#certificateFile", "Value": "" }, { } Example response body { } } ] } ] "Name": "LDAP.1#name", "Value": "LDAP Dell" }, { "Name": "LDAP.1#serverType", "Value": "MANUAL" }, { "Name": "LDAP.1#DomainController1", "Value": "10.36.0.167" }, { "Name": "LDAP.1#Port", "Value": 636 }, { "Name": "LDAP.1#BaseDN", "Value": "dc=dell,dc=com" }, { "Name": "LDAP.1#NetworkTimeout", "Value": 120 }, { "Name": "LDAP.1#SearchTimeout", "Value": 120 }, { "Name": "LDAP.
Attribute Description Value Attribute value. Brand /api/ApplicationService/Actions/ ApplicationService.BrandInfo This URI represents the brand information. POST method for BrandInfo This method returns the brand information. Description Returns the brand information. Privilege VIEW HTTP response codes 200 Example response body { "BrowserTitle": "globalNavigation.consoleBrowserTitle", "ConsoleTitle": "globalNavigation.
Example request body { "BrandType":"DEBRANDED" } OR { } Example response body { } "BrandType":"DEFAULT" 200 OK Multichassis management /api/ManagementDomainService This method represents the role of the chassis in a Multi-Chassis Management (MCM)domain. GET method for ManagementDomainService This method returns the role of the chassis in a MCM domain. Description Returns the role of the chassis in a MCM domain.
DiscoveredDomains", "ConfigurationTypes@odata.navigationLink": "/api/ManagementDomainService/ ConfigurationTypes" } Output — Lead chassis: { "@odata.context": "/api/ $metadata#ManagementDomainService.ManagementDomainService", "@odata.type": "#ManagementDomainService.ManagementDomainService", "@odata.
"ConfigurationTypes@odata.navigationLink": "/api/ManagementDomainService/ ConfigurationTypes" } Table 133. Attributes Attribute Description GroupId Unique group ID across different domains. DeviceGroupId Group configuration record ID. GroupName Name of the group. GroupDescription Description of the group. JoinApproval Join approval • • Automatic: Join requests from a standalone chassis are automatically approved.
}, { "ConfigType": "ProxySettings", "Enabled": false }, { } Example response body Request for creating a group { } Example request body "JobId": 36183, "Status": "Success" Request for editing a group { 372 "ConfigType": "SecuritySettings", "Enabled": false }, { "ConfigType": "NetworkServices", "Enabled": false }, { "ConfigType": "LocalAccessConfiguration", "Enabled": false } ],"VirtualIPConfiguration": { "IPv4": { "StaticIPv4Address":"10.35.155.155", "SubnetMask":"255.255.255.32", "Gateway":"10.
"Enabled": false }, { } Example response body } "JobId": 36181, "Status": "SUCCESS" Request for configuring static IPv4 on the lead chassis { } Example response body } Request for editing a group { Example request body ] "ConfigType": "LocalAccessConfiguration", "Enabled": false "GroupName": "256", "GroupDescription": "", "JoinApproval": "Manual", "ConfigReplication": [ { "ConfigType": "UserAuthentication", "Enabled": false }, { "ConfigType": "NetworkServices", "Enabled": false }, { "ConfigType"
"Status": "Success" } NOTE: You can use the API, /api/JobService/Jobs(JobId) for polling the job status. Table 134. Attributes Attribute Description GroupId Unique group ID across different domains. GroupName Name of the group. GroupDescription Description of the group. JoinApproval Join approval • • Automatic: Join requests from a stand-alone chassis are automatically approved. Manual: Join requests from a stand-alone chassis are queued on the lead for approval of the administrator.
} ] "GroupId": "053ca12c-e181-4502-b4b5-7f5090bbf08c", "GroupName": "null", "GroupDescription": "", "PublicAddress": [ "10.35.0.191", "fd76:6c:61:6e36:9d41:a14f:c77f:97d6" ], "Name": "MX-SKY000S", "Description": "POWEREDGE MX7000", "Identifier": "SKY000S", "DomainTypeId": 4000, "DomainTypeValue": "MSM", "DomainRoleTypeId": 3002, "DomainRoleTypeValue": "STANDALONE", "Version": "1" }, { "@odata.type": "#ManagementDomainService.
Attribute Description DomainTypeId Information for internal programmatic use. DomainTypeValue Information for internal programmatic use. DomainRoleTypeId ID of the domain role. Possible value: • • • DomainRoleTypeValue 3000 — LEAD 3001 — MEMBER 3002 — STANDALONE Type of domain role. Possible values: • • • Version LEAD MEMBER STANDALONE Version of OME–Modular. /api/ManagementDomainService/ConfigurationTypes This URI represents the configuration types supported on the management domain service.
{ "@odata.type": "#ManagementDomainService.ConfigurationType", "@odata.id": "/api/ManagementDomainService/ConfigurationTypes(5)", "Id": 5, "Name": "Power", "Description": "Power" }, { "@odata.type": "#ManagementDomainService.ConfigurationType", "@odata.id": "/api/ManagementDomainService/ConfigurationTypes(6)", "Id": 6, "Name": "ProxySettings", "Description": "Proxy Settings" }, { "@odata.type": "#ManagementDomainService.ConfigurationType", "@odata.
"Name": "Power", "Description": "Power" } Table 137. Attributes Attribute Description Id ID of the configuration. Name Name of the configuration. Description Description of the configuration. /api/ManagementDomainService/Domains This URI represents the roles of the domains, details of the compatibility between the backup and lead chassis, and health of the configuration data synchronization.
"DomainRoleTypeValue": "STANDALONE", "Version": "1.10.00", "Local": true, "GroupId": "049a7707-c9d3-4b5d-9152-3710984f669d", "GroupName": null, "BackupLead": false, "Capabilities":[], "BackupLeadHealth": 2000 } ] } Table 138. Attributes Attribute Description Id Record ID. DeviceId Device ID. Address IP address. Name Name of the chassis. Description Description of the chassis. Identifier Service Tag of the chassis. DomainTypeId Information for internal programmatic use.
/api/ManagementDomainService/Domains(Id) This URI represents the role of a specific chassis domain. GET method for Domains(Id) This method returns the role of a specific chassis domain. The chassis domain role is as follows: • • Chassis domain part of MCM group — LEAD or MEMBER Chassis domain not part of a MCM group — STANDALONE Description Returns the role of a specific chassis domain.
Attribute Description • • • LEAD MEMBER STANDALONE Version Version of OME–Modular. Local • • TRUE — Indicates that this domain is the local domain where the API is executed. FALSE — Indicates that this domain is the remote domain where the API is executed. GroupId Unique identifier of the group across different domains. GroupName Group name for the MCM domain group. /api/ManagementDomainService/PendingDomains This URI represents the pending domain-related requests.
Attribute Description • • • • • • • 1001 - Join approval is pending with the lead domain. 1002 - Join request is approved by the lead. 1004 - Onboarding is in progress. 1006 - Request is initiated to delete the member domain. 1007 - Request is in progress to delete the member domain. 1012 - Request to join group is initiated from the stand-alone chassis. 1013 - This onboard state is displayed only on stand-alone chassis when the lead approves the pending join request and initiates the onboarding.
Attribute Description • • • • • • • 1001 - Join approval is pending with the lead domain. 1002 - Join request is approved by the lead. 1004 - Onboarding is in progress. 1006 - Request is initiated to delete the member domain. 1007 - Request is in progress to delete the member domain. 1012 - Request to join group is initiated from the stand-alone chassis. 1013 - This onboard state is displayed only on stand-alone chassis when the lead approves the pending join request and initiates the onboarding.
[ ] Example response body { } "GroupId": "91e0b654-9de4-4a62-b5b1-c0da11d81b70" Adding multiple domains to an MCM group { "JobId": 36128, "Status": "APPROVED" } Table 142. Attributes Attribute Description JobId Job ID created for the operation. Status Status of the operation. NOTE: The Status is always displayed as APPROVED. To track the status of the job, use the JobID. /api/ManagementDomainService/Actions/ ManagementDomainService.Join POST method for ManagementDomainService.
/api/ManagementDomainService/Actions/ ManagementDomainService.Leave POST method for ManagementDomainService.Leave This method enables a member chassis domain to leave an MCM domain group. This API is applicable only to member chassis domains. Description Enables a member chassis domain to leave an MCM domain group. Privilege APPLIANCE_SETUP HTTP response codes 200 Example response body { } "JobId": 13664, "Status": "SUCCESS" Table 144.
Table 145. Attributes Attribute Description JobId Job ID created for the operation. Status Status of the operation. NOTE: The Status is always displayed as SUCCESS. To track the status, use the JobId. /api/ManagementDomainService/Actions/ ManagementDomainService.DeleteGroup POST method for ManagementDomainService.DeleteGroup This method deletes an MCM domain group. Description Deletes an MCM domain group.
/api/ManagementDomainService/Actions/ ManagementDomainService.ApproveJoin POST method for ManagementDomainService.ApproveJoin If the group is created with manual onboarding policy, this method enables the lead domain administrator to approve or reject pending requests that are made for joining a MCM domain group. Description Approves or rejects pending requests for joining a MCM domain group.
/api/ManagementDomainService/Actions/ ManagementDomainService.AssignBackupLead This API assigns a member chassis as the backup lead and displays an error if a backup exists. POST method for assigning backup lead This method assigns a member chassis in the chassis group as the backup lead. Description Assigns a member chassis as the backup lead. Privilege APPLIANCE_SETUP HTTP Response Code 200 Example request body [{ }] Example response body { } "Id":25706 "JobId": 25857 Table 148.
Table 149. Attributes Attribute Description Id Member chassis identifier on the lead. JobId Job ID for the tracking the status of unassigning the backup lead. NOTE: You can use the API, /api/JobService/ Jobs(JobId) to poll the job status. /api/ManagementDomainService/Actions/ ManagementDomainService.UnassignBackupLead This URI unassigns the backup lead. POST method for unassigning backup lead This method unassigns the backup lead in the chassis group. Description Unassigns the backup lead.
Example request body { } Example response body { } "RollbackOnRecoverableError" : true, "PurgeLeadReferences" : false "JobId": 25857 Table 151. Attributes Attribute Description RollbackOnRecoverableError If this flag is passed as true, rollback is performed during promote failure and in a recoverable situation. PurgeLeadReferences If this flag is passed as true, all old lead references are purged on new lead during the promote process.
Attribute Description PostRetirementRoleType Input from the user on the type of role for the lead chassis to be retired. The options available are: • • JobID Standalone Member ID of the job for tracking the status of the "Retire Lead" task. FIPS mode settings /api/ApplicationService/Security/SecurityConfiguration This URI represents the security configuration. GET method for SecurityConfiguration This method returns the security configuration. Description Returns the security configuration.
"Fabrics@odata.navigationLink": "/api/NetworkService/Fabrics", "FabricDesigns@odata.navigationLink": "/api/NetworkService/FabricDesigns", "MultiChassisDomain": { "@odata.id": "/api/NetworkService/MultiChassisDomain" }, "UplinkTypes@odata.navigationLink": "/api/NetworkService/UplinkTypes", "NodeTypes@odata.navigationLink": "/api/NetworkService/NodeTypes", "FabricHealthStatuses@odata.navigationLink": "/api/NetworkService/ FabricHealthStatuses", "FabricActivityTypes@odata.
{ "MessageId": "NFAB0017", "Message": "The network fabric is not healthy because all ISLs are not connected.", "MessageArgs": [], "Severity": "Warning", "Resolution": "Make sure that all the ISLs are connected as per the specification.", "Category": "Audit", "DetailedDescription": "", "TimeStamp": "2018-07-18T05:29:52Z" }, { "MessageId": "NFAB0018", "Message": "The network fabric is not healthy because uplinks are not configured.
Example response body { } Example for creating fabric "Name": "Fabric 1", "Description": "update 01", "OverrideLLDPConfiguration": "Disabled", "FabricDesignMapping": [ { "DesignNode": "Switch-A", "PhysicalNode": "CBJXLN2" }, { "DesignNode": "Switch-B", "PhysicalNode": "F13RPK2" } ], "FabricDesign": { "Name": "2xMX9116n_Fabric_Switching_Engines_in_different_chassis" } Example response body { } "Name": "Fabric 1", "Description": "Description 01", "OverrideLLDPConfiguration": "Disabled", "FabricDesignMap
/api/NetworkService/FabricDesign This URI represents the fabric designs. GET method for FabricDesign This method returns a list of the fabric designs. Description Returns a list of fabric designs. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Collection(NetworkService.FabricDesign)", "@odata.count": 3, "value": [ { "@odata.type": "#NetworkService.FabricDesign", "@odata.
"SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/38", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/38" }, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/40", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/40" }, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/39", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/39" } ], "FabricDesignNode": [ { "NodeName": "Switch-A", "ChassisName": "Chassis-X", "Slot": "Sl
"Type": "WeaverSwitch" }, { "NodeName": "Switch-B", "ChassisName": "Chassis-Y", "Slot": "Slot-A2", "Type": "WeaverSwitch" } ] } ] } /api/NetworkService/Fabrics(Id) This URI represents a specific fabric in the fabric collection. GET method for Fabrics(Id) This method returns a specific fabric from the collection of fabrics. Description Returns a specific fabric. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#NetworkService.
] } "DetailedDescription": "", "TimeStamp": "2018-07-12T18:47:56Z" }, "FabricDesignMapping": [ { "DesignNode": "Switch-A", "PhysicalNode": "41F2MN2" }, { "DesignNode": "Switch-B", "PhysicalNode": "41F4MN2" } ], "Switches@odata.navigationLink": "/api/NetworkService/ Fabrics('31db245a-9865-4a23-9697-4902cd2d5421')/Switches", "Servers@odata.navigationLink": "/api/NetworkService/ Fabrics('31db245a-9865-4a23-9697-4902cd2d5421')/Servers", "FabricDesign": { "@odata.
} Example response body TRUE Table 154. Attributes Attribute name Description ID The identifier of the fabric. Name The fabric name. Description The fabric name description. DesignNode DesignNode must be identical to the name provided in the selected fabric design. PhysicalNode Service Tag of the switch that you want to configure for the given fabric. FabricDesign Name (FabricDesign) The fabric design name. DELETE method for Fabrics(Id) This method deletes a specific fabric.
} "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/38", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/38" }, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/40", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/40" }, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/39", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/39" } ], "FabricDesignNode": [ { "NodeName": "Switch-A", "ChassisName": "Chassis-X", "Slot": "Slot
"ChassisServiceTag": "SKY002P1234567890123456789012345", "Description": "Unable to validate the network fabric because the I/O Modules are in same slot.", "ProblemLink": { "SourceNode": "", "SourceInterface": "", "DestinationNode": "", "DestinationInterface": "" }, "RecommendedLink": { "SourceNode": "", "SourceInterface": "", "DestinationNode": "", "DestinationInterface": "" }, "RecommendedAction": "Make sure that the I/O Modules are in different slots", "Timestamp": "1531891792" }, { "@odata.
"SourceInterface": "DPM4XC2:ethernet1/1/42", "DestinationNode": "DPM4XC1", "DestinationInterface": "DPM4XC1:ethernet1/1/42" }, "RecommendedLink": { "SourceNode": "DPM4XC2", "SourceInterface": "DPM4XC2:ethernet1/1/42", "DestinationNode": "DPM4XC1", "DestinationInterface": "DPM4XC1:ethernet1/1/42" }, "RecommendedAction": "Make sure that the links are connected as per design.", "Timestamp": "1531891792" }, { "@odata.type": "#NetworkService.ValidationError", "@odata.
"SourceNode": "DPM4XC1", "SourceInterface": "DPM4XC1:ethernet1/1/42", "DestinationNode": "DPM4XC2", "DestinationInterface": "DPM4XC2:ethernet1/1/42" }, "RecommendedAction": "Make sure that the links are connected as per design.", "Timestamp": "1531891792" } ] } /api/NetworkService/Fabrics(Id)/Uplinks This URI represents the uplinks of a specific fabric. GET method for Uplinks for a specific fabric This method returns the uplinks of a specific fabric. Description Returns the uplinks of a specific fabric.
Example request body { } Example response body "Name":"Uplink_Ethernet_Fabric-B", "Description":"Ethernet Uplink created from REST.", "MediaType":"Ethernet", "Ports":[ { "Id": "6ZB1XC2:ethernet1/1/41" }, { "Id": "5ZB1XC2:ethernet1/1/41" } ], "Networks":[ { "Id":95614 } ] Uplink Id Table 155. Attributes Attribute name Description ID The identifier of the fabric. Name The fabric name. Description The fabric name description. MediaType Type of the uplink.
"PortCount": 4, "NetworkCount": 2 }, "Ports@odata.navigationLink": "/api/NetworkService/ Fabrics('43be623e-0d74-4f6d-87b3-3ea40bf6372d')/Uplinks('bda43da9d6d8-4fc5-98b7-cb9030e8008e')/Ports", "Networks@odata.navigationLink": "/api/NetworkService/ Fabrics('43be623e-0d74-4f6d-87b3-3ea40bf6372d')/Uplinks('bda43da9d6d8-4fc5-98b7-cb9030e8008e')/Networks" } PUT method for Uplinks(Id) This method updates a specific uplink. Description Updates a specific uplink.
{ } } "IqnPrefix":"Iqn.MyIqnPrefix" }, "FcoeSettings": { "Mac": { "IdentityCount":75, "StartingMacAddress": "cHBwcHAA" } }, "FcSettings": { "Wwnn": { "IdentityCount":85, "StartingAddress": "IACAgICAgAA=" }, "Wwpn": { "IdentityCount":85, "StartingAddress": "IAGAgICAgAA=" } } Table 156. Attributes Attribute name Description ID The identifier of the target uplink. Name The target uplink name Description The target uplink description MediaType Indicates, type of uplink.
/api/NetworkService/Fabrics(Id)/Uplinks(Id)/Ports This URI represents the uplink ports of a specific uplink in a fabric. GET method for Ports for a specific uplink This method returns the uplink ports of a specific uplink in a fabric. Description Returns the uplink ports. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Collection(NetworkService.Port)", "@odata.count": 4, "value": [ { "@odata.type": "#NetworkService.Port", "@odata.
"Type": "PhysicalEthernet", "MediaType": "Ethernet", "NodeServiceTag": "1ZB1XC2", "PortNumber": "ethernet1/1/40", "Status": "Down", "AdminStatus": "Enabled", "CurrentSpeed": "0", "MaxSpeed": "0", "ConfiguredSpeed": "0", "OpticsType": "NotPresent", "BlinkStatus": "OFF", "Role": "Uplink" }, { "@odata.type": "#NetworkService.Port", "@odata.
"VlanMinimum": 11, "Type": 1, "CreatedBy": "root", "CreationTime": "2018-07-11 03:35:11.590", "UpdatedBy": null, "UpdatedTime": "2018-07-11 03:35:11.590", "InternalRefNWUUId": "fd4d9ece-732e-4beb-8613-ab986889fe43" }, { "@odata.type": "#NetworkConfigurationService.Network", "@odata.
HTTP Response Code Example response body { } "UplinkType":1 /api/NetworkService/Fabrics(Id)/ NetworkService.GetApplicableUplinkPorts POST method for GetApplicableUplinkPorts This method returns the available uplink ports applicable to a fabric design. Description Returns applicable uplink ports.
}, { ] } "Id": "1ZB1XC2:ethernet1/1/35", "Name": "", "Description": "", "PortNumber": "1ZB1XC2:ethernet1/1/35" }, { "NodeServiceTag": "DPM4XC1", "Ports": [ { "Id": "DPM4XC1:ethernet1/1/37", "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/37" }, { "Id": "DPM4XC1:ethernet1/1/40", "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/40" }, { "Id": "DPM4XC1:ethernet1/1/41", "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/41" }, { "Id": "DPM4XC1:ethernet1/1/4
} ] } ] } Table 157. Attributes Attribute name Description UplinkType ID of the uplink type. For more information, see /api/ NetworkService/UplinkTypes). /api/NetworkService/Fabrics(Id)/Switches This URI represents the switches of a specific fabric. GET method for Switches for a specific fabric This method returns the switches of a specific fabric. Description Returns the uplinks of a specific fabric. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
"@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/HardwareLogs" } ], "SubSystemHealth": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/SubSystemHealth" } ], "RecentActivity": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/RecentActivity" } ], "InventoryTypes": { "@odata.
"LastInventoryTime": null, "DeviceCapabilities": [], "DeviceSubscription": { "@odata.id": null }, "DeviceSpecificData": { "@odata.id": null }, "DeviceManagement": [], "InventoryDetails": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/InventoryDetails" } ], "HardwareLogs": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/HardwareLogs" } ], "SubSystemHealth": [ { "@odata.
Example response body { "@odata.context": "/api/$metadata#Collection(NetworkService.ISLLink)", "@odata.count": 4, "value": [ { "@odata.type": "#NetworkService.ISLLink", "@odata.
}, { } "PortNumber": "41F4MN2:ethernet1/1/9", "PortName": null "@odata.type": "#NetworkService.ISLLink", "@odata.
HTTP response codes Example response body 200 { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 1, "value": [ { "@odata.
} ] } ] } /api/NetworkService/Fabrics(Id)/Topology/Nodes(Id) This URI represents a specific node of a fabric topology. GET method for Nodes(Id) This method returns the details of a specific node of a fabric topology. Description Returns the details of a specific node. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 1, "value": [ { "@odata.
"@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/SubSystemHealth" } ], "RecentActivity": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/RecentActivity" } ], "InventoryTypes": { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/InventoryTypes" }, "Settings": [ { "@odata.
"SwitchMode": "Fabric", "PowerState": 17, "Name": "IOM-B1" }, "ChildNodes@odata.navigationLink": "/api/NetworkService/ Fabrics('43be623e-0d74-4f6d-87b3-3ea40bf6372d')/Topology/Nodes('Switch %3A1ZB1XC2')/ChildNodes" }, { "@odata.type": "#NetworkService.Node", "@odata.
/api/NetworkService/Actions/ NetworkService.RemoveUplinks POST method for NetworkService.RemoveUplinks This method deletes multiple fabric uplinks. Description Deletes multiple fabric uplinks. Privilege FABRIC_MANAGEMENT HTTP response codes 200 Example request body { } Example response body { } "FabricId":"FabricId", "UplinkIds":["id1","id2"] "id1": true, "id2": true /api/NetworkService/FabricDesigns(Id)/ NetworkService.
"NodeName":"Switch-B","ChassisName":"Chassis-Y","Slot":"SlotA2","Type":"WeaverSwitch" }, "ApplicableNodes": [ { "ServiceTag":"DPM4XC2","Slot":"IOM-B2","ChassisName":"MXSKY002P1234567890123456789012345","ChassisServiceTag":"SKY002P123456789012345678901234 } ] } ] } /api/NetworkService/UplinkTypes This URI represents the uplink types. GET method for UplinkTypes This method returns the uplink types. Description Returns the uplink types.
/api/NetworkService/NodeTypes This URI represents the node types. GET method for NodeTypes This method returns the node types. Description Returns the node types. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#Collection(NetworkService.NodeType)", "@odata.count": 3, "value": [ { "@odata.type": "#NetworkService.NodeType", "Id": 1, "Name": "CHASSIS" }, { "@odata.type": "#NetworkService.NodeType", "Id": 2, "Name": "NWIOM" }, { "@odata.
"@odata.type": "#NetworkService.EnumerationEntry", "Id": "Upgrade", "Name": "Upgrade" }, { } ] "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Delete", "Name": "Delete" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "ReplaceNode", "Name": "ReplaceNode" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Unknown", "Name": "Unknown" } /api/NetworkService/FabricActivityStatuses This URI represents the possible status values of the fabric activities.
}, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2070", "Name": "Failed" }, { } ] "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2080", "Name": "New" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2090", "Name": "Warning" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2100", "Name": "Aborted" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2101", "Name": "Paused" }, { "@odata.type": "#NetworkService.
"Id": "3000", "Name": "WARNING" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "4000", "Name": "CRITICAL" }, { } ] "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2000", "Name": "UNKNOWN" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "5000", "Name": "NOSTATUS" } /api/NetworkService/MultiChassisDomain GET method for MultiChassisDomain This method provides access to the multi-chassis topology and validation errors.
"@odata.id": "/api/NetworkService/MultiChassisDomain/Topology", "Nodes@odata.navigationLink": "/api/NetworkService/MultiChassisDomain/ Topology/Nodes" } /api/NetworkService/MultiChassisDomain/Topology/ Nodes This URI represents all the nodes in an MCM group. GET method for Nodes in an MCM group This method returns the details of all the nodes in an MCM group. Description Returns the list of nodes in an MCM group and their details.
"Name": "MX-SKY00201234567890123456789012345" }, "ChildNodes@odata.navigationLink": "/api/NetworkService/ MultiChassisDomain/Topology/Nodes('Chassis %3ASKY00201234567890123456789012345')/ChildNodes" } ] } /api/NetworkService/MultiChassisDomain/Topology/ Nodes(Id) This URI represents a chassis node in an MCM group. GET method for Nodes(Id) in an MCM group This method returns the details of a chassis node in an MCM group. Description Returns the details of a chassis node in an MCM group.
HTTP response codes Example response body 200 { "@odata.context": "/api/$metadata#Collection(NetworkService.Node)", "@odata.count": 2, "value": [ { "@odata.type": "#NetworkService.Node", "@odata.id": "/api/NetworkService/MultiChassisDomain/Topology/ Nodes('Switch%3A1ZB1XC2')", "Id": "Switch:1ZB1XC2", "Type": "NETWORK_IOM", "ParentNodeId": "SKY00201234567890123456789012345", "Location": "IOM-B1", "NodeInformation": { "@odata.type": "#NetworkService.
/api/NetworkService/MultiChassisDomain/ ValidationErrors This URI represents the fabric validation errors in an MCM group. GET method for ValidationErrors This method returns the fabric validation errors in an MCM group. Description Returns the list of fabric validation errors. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.ValidationError)", "@odata.count": 5, "value": [ { "@odata.type": "#NetworkService.
"ProblemLink": { "SourceNode": "", "SourceInterface": "", "DestinationNode": "", "DestinationInterface": "" }, "RecommendedLink": { "SourceNode": "", "SourceInterface": "", "DestinationNode": "", "DestinationInterface": "" }, "RecommendedAction": "Make sure that the HE IOMs are in different chassis", "Timestamp": "1531280042" }, { "@odata.type": "#NetworkService.ValidationError", "@odata.
}, "RecommendedLink": { "SourceNode": "1ZB1XC2", "SourceInterface": "1ZB1XC2:ethernet1/1/41", "DestinationNode": "DPM4XC1", "DestinationInterface": "DPM4XC1:ethernet1/1/41" }, "RecommendedAction": "Make sure that the links are connected as per design.", "Timestamp": "1531280042" }, { "@odata.type": "#NetworkService.ValidationError", "@odata.
} "value": [ { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Disabled", "Name": "Disabled" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Enabled", "Name": "Enabled" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Unknown", "Name": "Unknown" } ] /api/NetworkService/PortStatuses This URI represents the possible statuses of the ports. GET method for PortStatuses This method returns the possible statuses of a port.
/api/NetworkService/PortBlinkStatuses This URI returns blink status information for ports. GET method for /api/NetworkService/PortBlinkStatuses This method returns the blink status information of ports. Description Returns blink status of the port Privilege HTTP response code Example response body 200 { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.count": 0, "value":[ ] } /api/NetworkService/PortRoles This URI represents the possible roles of the ports.
} ] } "Id": "ISL", "Name": "ISL" api/NetworkService/ServerProfileBondingTechnologies This URI represents the server bonding technologies. GET method for server bonding technologies This method gets all applicable server bonding technologies. Description Gets all applicable server bonding technologies. Returns and empty list if the IOM containing the Fabric Manager. Privilege VIEW HTTP Response Code Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.
"@odata.id": "/api/NetworkService/ServerProfiles('8ZJC0T2')", "Id": "8ZJC0T2", "ServerServiceTag": "8ZJC0T2", "ServerInterfaceProfiles@odata.navigationLink": "/api/NetworkService/ ServerProfiles('8ZJC0T2')/ServerInterfaceProfiles" }, { "@odata.type": "#NetworkService.ServerProfile", "@odata.id": "/api/NetworkService/ServerProfiles('FFN70T2')", "Id": "FFN70T2", "ServerServiceTag": "FFN70T2", "ServerInterfaceProfiles@odata.
"Id": "5099PH2", "ServerServiceTag": "5099PH2", "BondingTechnology": "LACP", "ServerInterfaceProfiles@odata.navigationLink": "/api/NetworkService/ ServerProfiles('5099PH2')/ServerInterfaceProfiles" } /api/NetworkService /ServerProfiles(arg1) This URI is used to update the service tag of server profiles in the Fabric Manager. GET method for updating server profile IDs This method returns the service tag of the server profile. Description Returns the service tag of the server profile in the Fabric Manager.
}, { "Id": "NIC.Mezzanine.1A-2-1", "NativeVLAN": 1, "NicBonded": false, "Networks": [{ "Id": 10111 }] }] } Example response body true Table 159. Attributes Attribute Description Id Server profile identifier. ServerServiceTag Service tag of the server. ServerInterfaceProfiles Sub payload that takes information that is associated with a server NIC. The request can take one or more server interface profiles, as part of the payload. ServerInterfaceProfiles/Id Server NIC identifier.
Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.ServerInterfaceProfile)", "@odata.count": 2, "value": [ { "@odata.type": "#NetworkService.ServerInterfaceProfile", "@odata.id": "/api/NetworkService/ServerProfiles('PFSTN16')/ ServerInterfaceProfiles('NIC.Mezzanine.1A-1-1')", "Id": "NIC.Mezzanine.1A-1-1", "OnboardedPort": "GQ61XC2:ethernet1/1/4", "NativeVLAN": 18, "Networks@odata.count": 2, "Networks": [ { "@odata.type": "#NetworkConfigurationService.Network", "@odata.
/api/NetworkService /ServerProfiles(arg1)/ ServerInterfaceProfiles(arg2) This URI returns the server profile ID of a server profile in the Fabric Manager. GET method for server interface profile IDs This method returns server interface profile IDs. Description Returns server interface profile ID of a server profile in the Fabric Manager. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#NetworkService.ServerInterfaceProfile/ $entity", "@odata.
/api/NetworkService /ServerProfiles(arg1)/ ServerInterfaceProfiles(arg2)/Networks This URI returns tagged VLANs that are configured for server profiles. GET method for tagged VLANs configured for server interface profiles This method returns all tagged VLANs of a server interface profile. Description Returns all tagged VLANs that were configured for a specific server interface profile in the Fabric Manager. Privilege VIEW HTTP response code 200 Example response body { "@odata.
api/NetworkService/ServerProfiles(Id)/ ServerInterfaceProfiles This URI gets a list of server interface profiles by server profile IDs. GET method for server interface profiles This method gets the server interface profiles by server profile IDs. Description Privilege VIEW HTTP Response Code Response api/NetworkService/ServerProfiles(Id1)/ ServerInterfaceProfiles(Id2) This URI gets server interface profiles by IDs. GET method for server interface profiles Add your section content here.
"Networks": [{ "Id": 10111 }] }] }] Example response body { } "JobId": 12984 Table 161. Attributes Attribute Description JobId ID of the job that is created as part of the request. You can track the progress of the request using the Job ID. BondingTechnology Indicates the NIC bonding technology that is configured for the server profile. Enables the NIC teaming type that you want to configure for a profile.
} Example response body { } ] } "JobId": 25546 Table 162. Attributes Attribute Description JobId ID of the job that is created as part of the request. You can track the progress of the request using the Job ID. BondingTechnology Indicates the NIC bonding technology that is configured for the server profile. Enables the NIC teaming type that you want to configure for a profile.
Example response body { } "JobId": 25546 /api/NetworkService/Actions/ NetworkService.DeleteServerNetworks This API enables you to delete network profiles from an existing interface profile for one or many targeted servers. POST method for deleting server networks This method enables you to delete network profiles from an existing interface profile for one or many targeted servers.
Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.FeatureCapability)", "@odata.count": 4, "value": [ { "@odata.type": "#NetworkService.FeatureCapability", "Name": "ServerBondingConfiguration" }, { "@odata.type": "#NetworkService.FeatureCapability", "Name": "PortVLANConfiguration" }, { "@odata.type": "#NetworkService.FeatureCapability", "Name": "FabricLLDPConfiguration" }, { "@odata.type": "#NetworkService.
] } "Id":2664, "Data":"", "TargetType": { "Id":4000, "Name":"DEVICE" } POST method for enabling or disabling auto-negotiation This method enables or disables auto-negotiation. Description Enables or disables auto-negotiation.
Example request body "Params": [ { "Key":"operationName", "Value":"CONFIGURE_PORT_NAME_DESCRIPTION" }, { "Key":"interfaceId", "Value":"GF86XC2:1/1/9" }, { "Key":"name", "Value":"Port A" }, { "Key":"description", "Value":"This is Port A." } ], "Targets": [ { "Id":2664, "Data":"", "TargetType": { "Id":4000, "Name":"DEVICE" } } ] POST method for configuration port speed or breakout This method configures the port speed or breakout. Description Configures the port speed or breakout.
}, { } "Key": "operationName", "Value": "CONFIGURE_PORT_BREAK_OUT" } ], "JobType": { "@odata.type": "#JobService.JobType", "Id": 3, "Name": "DeviceAction_Task", "Internal": false } Table 163. Attributes Attribute name Description TargetType (Id) Network IOM device ID. InterfaceId Port name. Key Operation name. Depending on the type of configuration you want to perform, select the operation name as provided in the Input snippet.
}, { "Key":"serverSlots", "Value": } } ], "Targets": [ { "Id":, "Data":"", "TargetType": { "Id":1000, "Name":"DEVICE" } } ] Clear enclosure assignment POST method for clearing enclosure assignment Description Creates a job to clear the storage assignments in Enclosure Assigned mode.
Assign drives POST method for drive assignment Description Creates a job to assign individual storage drives to server slots.
} "JobName":"Storage Assignment", "JobDescription":"Storage Assignment Task", "Schedule":"startnow", "State":"Enabled", "JobType":{ "Id":3, "Name":"DeviceAction_Task" }, "Params":[ { "Key":"operationName", "Value":"CLEAR_STORAGE_ASSIGNMENT" }, { "Key":"assignmentMode", "Value":"2" }, { "Key":"driveSlotIds", "Value":
} ] } "Id":, "Data":"", "TargetType": { "Id": 1000, "Name": "DEVICE" } Clear configuration on SAS IOM POST method for clearing SAS IOM configuration Description Creates a job to clear the configuration on SAS IOM.
HTTP response codes Example request body 201 { } "Id": 0, "JobName": "Extract Log", "JobDescription": "Extract device log to NFS location", "Schedule": "startnow", "State": "Enabled", "JobType": { "Id": 18, "Name": "DebugLogs_Task" }, "Targets": [ { "Id": e.g: 2614, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" }, { "Key": "shareAddress", "Value": e.g: "100.100.100.
} "Targets": [ { "Id": e.g: 2614, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" }, { "Key": "shareAddress", "Value": e.g: "100.100.100.
"State":"Enabled", "JobType":{ "Id":27, "Name":"QuickDeploy_Task" }, "Params":[ { "Key":"operationName", "Value":"SERVER_QUICK_DEPLOY" }, { "Key":"deviceId", "Value":"1016" }, { "Key":"rootCredential", "Value":"calvin" }, { "Key":"networkTypeV4", "Value":"Static" }, { "Key":"protocolTypeV4", "Value":"true" }, { "Key":"subnetMaskV4", "Value":"255.255.255.0" }, { "Key":"gatewayV4", "Value":"255.255.255.
}, "JobType": { "Id": 27, "Name": "QuickDeploy_Task" "Params": [ { "Key": "operationName", "Value": "SERVER_QUICK_DEPLOY" }, { "Key": "deviceId", "Value": "1016" }, { "Key": "rootCredential", "Value": "calvin" }, { "Key": "networkTypeV4", "Value": "Static" }, { "Key": "protocolTypeV4", "Value": "true" }, { "Key": "subnetMaskV4", "Value": "255.255.255.0" }, { "Key": "gatewayV4", "Value": "255.255.255.
Attribute name Description Schedule The schedule to start the Job. Quick-Deploy is startnow. State Indicates if the job is enabled or disabled. JobType Id ID of the job type. Name Name of the job type. Params operationName Name of the Quick-Deploy operation. deviceId Device ID indicates the Chassis ID. rootCredential Root user password. networkTypeV4 Indicates if the IPv4 is static or dynamic. protocolTypeV4 Indicates whether IPv4 protocol is selected.
/api/NetworkService /ServerProfiles(arg1) This URI represents the server profile information. GET method for server profiles This method returns the server information about the server profile set on the Fabric Manager. Description Returns the service tag of the server in a server profile on the Fabric Manager. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": /api/$metadata#NetworkService.ServerProfile/$entity", "@odata.type": "#NetworkService.
Example response body true Table 166. Attributes Attribute Description Id Server profile identifier. ServerServiceTag Service tag of the server. NOTE: When the server profile is created using the server deployment process, the server profile id gets set as the service tag of the server. ServerInterfaceProfiles Sub payload, that takes information that is associated with a server NIC. The request can take one or more ServerInterfaceProfiles, as part of the payload.
e5118f1d85ba" … }, { "Name": "10", "Description": "10", "VlanMaximum": 10, "VlanMinimum": 10, "Type": 1, "CreatedBy": "system", "CreationTime": "1970-01-31 00:08:21.946", "UpdatedBy": null, "UpdatedTime": "1970-01-31 00:08:21.946", "InternalRefNWUUId": "991f2843-376e-49f3-a407}, ] "@odata.type": "#NetworkService.ServerInterfaceProfile", "@odata.id": "/api/NetworkService/ServerProfiles('PFSTN16')/ ServerInterfaceProfiles('NIC.Mezzanine.1A-2-1')", "Id": "NIC.Mezzanine.
/api/NetworkService /ServerProfiles(arg1)/ ServerInterfaceProfiles(arg2)/Networks This URI represents the network profile information that is configured for server profiles. GET method for network service This method returns the information about the tagged VLAN network for server interface profiles. Description Returns the all tagged VLANs that are configured for a server interface profile on Fabric Manager. Privilege VIEW HTTP Response Code 200 Example response body { "@odata.
/api/NetworkService /ServerProfiles(arg1)/ ServerInterfaceProfiles(arg2)/Networks (arg3) This URI represents information about network profiles that are configured for server profiles. GET method for network service in server interface profiles This method returns information about the tagged VLANs that are configured for server interface profiles on Fabric Manager. Description Returns the tagged VLANs that are configured for server profiles.
}, { }, { }] }] "Id": 25114 "Id": "NIC.Mezzanine.1-1-1" }] Example response body { } "JobId": 25546 Table 168. Attributes Attribute Description JobId Identifier of the job that is created as part of the request. You can track the progress of the task using the ID.
17 APIs specific to OpenManage Enterprise Application settings Console update /api/JobService/Jobs This URI updates the OpenManage Enterprise appliance. POST method for Jobs This method updates the OpenManage Enterprise appliance. Description Updates the OpenManage Enterprise appliance.
/api/ConsoleUpdateService/Updates?$filter= Auto eq true This URI represents the update job status of the OpenManage Enterprise appliance. GET method for Updates?$filter= Auto eq true This method returns the update job status of OpenManage Enterprise. Description Returns the update job status of OpenManage Enterprise. Privilege VIEW HTTP response code 200 Example Response Body { "@odata.context": "/api/$metadata#Collection(ConsoleUpdateService.Update)", "@odata.count": 1, "value": [ { "Version": "3.
POST method for ConsoleUpdateService.DeleteUpgradeBundles Description This method deletes the downloaded console update bundle. Privilege APPLIANCE_SETUP HTTP response code 200 /api/ConsoleUpdateService/Actions/ ConsoleUpdateService.DownloadBundle This URL downloads the console update bundle. NOTE: This API is available in OpenManage Enterprise 3.3.1, and can be used while performing an upgrade to later versions. POST method for ConsoleUpdateService.
"Enabled": true, "AlertPolicyId": 414, "AlertPolicyName": "Default Profile Update Policy", "Token": "APA91bF944FuE2F5wIJQFEX6Uz1N29OvOXvASzGPtfCtOg3sZEPuFezjerOYuBaykTtXl0WWnAcItLYKHvE5E Ek9_BvS1TGFEVbIPr37DCGCbNUQBrE3Op8yGNwSZx8JYrI7f", "Description": "Samsung Quasi-Stellar Object", "LastConnection": "2017-09-18 14:24:51.997", "Created": "2017-09-18 14:24:51.997", "LastError": "1970-01-01 00:00:00.0", "LastPush": "1970-01-01 00:00:00.
HTTP response codes Example request body 200 { "IdDevice": "7cb19d45-cfe5-4ee6-a02d-8a5fcef0d085", "IdSubscriberService": 1, "UserName": "danl", "Enabled": true, "AlertPolicyId": 414, "Token": "APA91bEbGmqbAy7nMxDOI0rAS3RVCUGv3szsCi5uQUlyIApwzTGYbgZ_CRy54McKZKP3MUSbcfxovqlpDx39L "Description": "Samsung Quasi-Stellar Object" } /api/AlertService/Actions/ AlertService.DeleteMobileSubscription This URI represents the deletion of mobile subscriptions. POST method for AlertService.
/api/AlertService/Actions/ AlertService.FilterAlertsByPolicy This URI filters the alerts by using the policy ID. GET method for AlertService.FilterAlertsByPolicy This method returns alerts based on the policy ID. Description Returns alerts based on the policy ID. Privilege VIEW HTTP response codes 200 Example request body { "PolicyId": 14164, "Top": 2, "Skip": 1 } Example response body { "@odata.context": "/api/$metadata#Collection(AlertService.Alert)", "@odata.count": 1, "value": [ { "@odata.
oid>Integer3201.3.6.1.4.1.674.10892.1.5000.10.5.0Integer3201.3.6.1.4.1.674.10892.1.5000.10.6.
} "DefaultValue": "disable_V_1", "Value": "enable_V_1", "DataType": "", "GroupName": "" POST method for DeviceHealth settings Description Configures the OpenManage Enterprise device health settings. Privilege APPLIANCE_SETUP HTTP response codes 200 Example Request Body "ConsoleSetting": [ { "Name": "CONSOLE_CONNECTION_SETTING", "DefaultValue": "last_known", "Value": "unknown", "DataType": "java.lang.
Example Request Body { } "ConsoleSetting": [ { "Name": "REPORTS_MAX_RESULTS_LIMIT", "DefaultValue": "1000", "Value": 998, "DataType": "java.lang.Integer" } ] POST method for EmailSender settings Description Configures the email sender settings. Privilege APPLIANCE_SETUP HTTP response codes 200 Example Request Body { } "ConsoleSetting": [ { "Name": "EMAIL_SENDER", "DefaultValue": "admin@dell.com", "Value": "admin@dell.com", "DataType": "java.lang.
Alerts https:///api/ApplicationService/Settings POST method for Alert Display settings Description Configures the alerts to be displayed on the alerts log page. Privilege APPLIANCE_SETUP HTTP response codes 200 Example Request Body { } "ConsoleSetting": [ { "Name": "ALERT_ACKNOWLEDGEMENT_VIEW", "DefaultValue": "2000", "Value": 1000, "DataType": "java.lang.
https:///api/AlertService/AlertDestinations/Actions/ AlertDestinations.ApplySNMPConfig POST method for AlertDestinations.ApplySNMPConfig Description Configures the SNMP server for alerts. Privilege MONITORING_SETUP HTTP response codes 200 Example Request Body [ { }, { }, { }, { ] } "Id": 1, "Enabled": true, "DestinationAddress": "10.32.19.
HTTP response codes Example Request Body 200 [ { }, { }, { }, { ] } "Id": 1, "Enabled": true, "DestinationAddress": "100.69.123.
}, { }, { }, { }, { }, { }, { }, { } ] } } "authenticationProtocol": "NONE", "authenticationPassphrase": "", "privacyProtocol": "NONE", "privacyPassphrase": "", "localizationEngineID": null, "community": "lex", "port": 162, "enableV3": true, "enableV1V2": false, "retries": 3, "timeout": 3 "JobId": 0, "Key": "protocolType", "Value": "SNMP" "JobId": 0, "Key": "enableV1", "Value": "true" "JobId": 0, "Key": "enableV2", "Value": "true" "JobId": 0, "Key": "enableV3", "Value": "true" "JobId": 0, "Key":
} [ { "Name": "WARRANTY_SCOREBOARD", "DefaultValue": "false", "Value": "true", "DataType": "java.lang.Boolean", "GroupName": "WARRANTY_SCOREBOARD" ] } Network Configuration /api/ApplicationService/Network/AdapterConfigurations This URL returns all the network adapter information. GET method for AdapterConfigurations Description Returns all the network adapter information. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/api/ $metadata#Collection(Network.
}, { "DnsConfiguration": { "RegisterWithDNS": false, "DnsName": "", "UseDHCPForDNSDomainName": false, "DnsDomainName": "", "FqdndomainName": "", "Ipv4CurrentPreferredDNSServer": "", "Ipv4CurrentAlternateDNSServer": "", "Ipv6CurrentPreferredDNSServer": "", "Ipv6CurrentAlternateDNSServer": "" }, "CurrentSettings": { "Ipv4Settings": { "Enable": true, "EnableDhcp": true, "CurrentIPAddress": [ "XX.XXX.X.XXX" ], "CurrentSubnetMask": "255.255.248.0", "CurrentGateway": "10.255.0.
"ManagementVLAN": { "EnableVLAN": false, "Id": 0 }, "DnsConfiguration": { "RegisterWithDNS": false, "DnsName": "", "UseDHCPForDNSDomainName": false, "DnsDomainName": "", "FqdndomainName": "", "Ipv4CurrentPreferredDNSServer": "", "Ipv4CurrentAlternateDNSServer": "", "Ipv6CurrentPreferredDNSServer": "", "Ipv6CurrentAlternateDNSServer": "" }, "CurrentSettings": { "Ipv4Settings": { "Enable": false, "EnableDhcp": false, "CurrentIPAddress": [], "CurrentSubnetMask": null, "CurrentGateway": "", "UseDHCPForDNSServer
"@odata.type": "#Network.AdapterConfigurations", "@odata.
"Delay": 0, "PrimaryInterface": true } /api/ApplicationService/Actions/ Network.ConfigureNetworkAdapter This URL configures the network adapter. POST method for Network.ConfigureNetworkAdapter NOTE: The interface name of the network adapter in an appliance varies based on the hypervisor. Description This method configures the network adapter.
Example for primary interface Example response body { "Id": 10085, "JobName": "OMERealtime_Task", "JobDescription": "Generic OME runtime task", "NextRun": null, "LastRun": null, "StartTime": null, "EndTime": null, "Schedule": "startnow", "State": "Enabled", "CreatedBy": "system", "UpdatedBy": null, "LastRunStatus": { "Id": 2080, "Name": "New" }, "JobType": { "Id": 207, "Name": "OMERealtime_Task", "Internal": true }, "JobStatus": { "Id": 2080, "Name": "New" }, "Targets": [], "Params": [ { "JobId": 10085, "
} Example for secondary interface "StaticGateway": "" }, "Ipv6Configuration": { "Enable": true, "EnableAutoConfiguration": true, "StaticIPAddress": "", "StaticPrefixLength": 0, "StaticGateway": "" }, "ManagementVLAN": { "EnableVLAN": false, "Id": 0 }, "Delay": 0, "PrimaryInterface": false Example response body { "Id": 10085, "JobName": "OMERealtime_Task", "JobDescription": "Generic OME runtime task", "NextRun": null, "LastRun": null, "StartTime": null, "EndTime": null, "Schedule": "startnow", "State": "E
], "Visible": true, "Editable": true, "Builtin": false } Troubleshoot service The troubleshoot service methods retrieve TechSupport Report (TSR) or diagnostic log files from the managed systems—iDRACs. The troubleshoot service also has methods to retrieve various service logs from the appliance. /api/JobService/Jobs This URI is used to create a TSR or diagnostic job. POST method for Jobs This method creates a TSR or diagnostic job. Description Creates a TSR or diagnostic job.
"Key":"user_eula_Agreement", "Value":"true" }, { "Key":"ScheduledStartTime", "Value":"TIME_NOW" } ], "Targets": [ { "Id":25085, "Data":"", "TargetType": { "Id":25085, "Name":"SERVER" } } ] } Example to create a diagnostic job Example request body { "Id":0, "JobName":"FinalTest", "JobDescription":"amit612", "Schedule":"startnow", "State":"Enabled", "JobType": { "Id":25, "Name":"Diagnostic_Task" }, "Params": [ { "Key":"deviceTypes", "Value":"1000" }, { "Key":"fileName", "Value":"FinalTest" }, { "Key":"oper
"Targets": [ { "Id":3714, "Data":"", "TargetType": { "Id":3714, "Name":"SERVER" } } ] } /api/TroubleshootService/Files This URI returns TechSupport Report (TSR) or diagnostic log files. GET method for Files This method returns TechSupport Report (TSR) or diagnostic log files. Description Returns TechSupport Report (TSR) or diagnostic log files.
/api/TroubleshootService/Actions/ TroubleshootService.GetTroubleshootDocument This URI represents TSR/Diagnostic job reports. POST method for TroubleshootService.GetTroubleshootDocument This method extracts TSR/Diagnostic job reports. Description Extracts TSR/Diagnostic job reports. Privilege JOB_MANAGEMENT, DEVICE_CONFIGURATION HTTP response codes 200 Example Request Body { "DeviceId":0, "DeviceOperation":"", "JobId":0, "FilePath":"/shared/dell/omc/cifs/idrac/F3TPXK2/SERVER_EXECUTE_TSR/TSR/ TSR.
Query support service /api/QuerySupportService/Queries This URI represents summary information for all queries for reports. GET method for QuerySupportService/Queries This method returns summary information for all queries for reports. Description Returns summary information for all queries for reports. Privilege VIEW HTTP response codes 200 Example Response Body { "@odata.context": "/api/$metadata#Collection(QuerySupportService.Query)", "@odata.count": 6, "value": [ { "@odata.
/api/QuerySupportService/Queries(Id) This URI represents detailed information for a specific query. GET method for QuerySupportService/Queries(Id) This method returns summary information for a specific query. Description Returns summary information for a specific query. Privilege VIEW HTTP response codes 200 Example Response Body { [ "@odata.context": "/api/$metadata#QuerySupportService.Query/$entity", "@odata.type": "#QuerySupportService.Query", "@odata.
[ { } "@odata.type": "#QuerySupportService.QueryContextSummary", "@odata.id": "/api/QuerySupportService/QueryContextSummaries(5)", "Id": 5, "Name": "Jobs", "Description": null, "BaseCategoryId": 3 }, { "@odata.type": "#QuerySupportService.QueryContextSummary", "@odata.id": "/api/QuerySupportService/QueryContextSummaries(4)", "Id": 4, "Name": "Groups", "Description": null, "BaseCategoryId": 4 }, { "@odata.type": "#QuerySupportService.QueryContextSummary", "@odata.
"BaseCategoryId": 2 } /api/QuerySupportService/QueryContexts(Id) This URI represents detailed information of a query context. GET method for QueryContexts(Id) This method returns the information for a specified Query Context. Description Returns the information for a specified Query Context. Privilege VIEW HTTP response codes 200 Example Response Body { "@odata.context": "/api/$metadata#QuerySupportService.QueryContext/$entity", "@odata.type": "#QuerySupportService.QueryContext", "@odata.
{ "Id": 1000, "Name": "Normal" }, { "Id": 2000, "Name": "Unknown" }, { "Id": 3000, "Name": "Warning" }, { "Id": 4000, "Name": "Critical" }, { "Id": 5000, "Name": "No Status" } ] }, { "Id": 19, "Name": "Device Model", "TableId": 5, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 20, "Name": "Device Service Tag", "TableId": 5, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 23, "Name": "Device Asset Tag", "TableId": 5, "Description": null,
} ] "FieldTypeId": 4, "StrMaxLen": 0, "EnumOpts": [ { "Id": 1000, "Name": "Acknowledged" }, { "Id": 2000, "Name": "Not Acknowledged" } ] }, { "Id": 5, "Name": "Alert Message ID", "TableId": 1, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 2, "Name": "Alert Message", "TableId": 1, "Description": null, "FieldTypeId": 1, "StrMaxLen": 2048, "EnumOpts": [] } /api/QuerySupportService/QueryContexts(Id)/ QuerySupportService.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "FilterText": "", "ContextId": 2 "Id": 1010, "Name": "Dell iDRAC Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1007, "Name": "Dell Networking Switches", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1008, "Name": "Fibre Channel Switches", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1017, "Name": "HCI Appliances", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1014, "Name": "Hypervisor Systems", "UsageId": 1, "
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 496 "Id": 1023, "Name": "OEM Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1001, "Name": "PowerEdge Chassis", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1002, "Name": "PowerEdge FX2", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1003, "Name": "PowerEdge M1000e", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1004, "Name": "PowerEdge VRTX", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1009, "Na
} ] "Id": 1019, "Name": "XC", "UsageId": 1, "FilterText": "", "ContextId": 2 Table 170. Attributes Attribute Description Id Unique identifier of the filter (query). Name Name of the filter. UsageId 1=Query Group, 2=Report FilterText Unused ContextId The Query Context identifier of the filter. It should match the Query Context ID in the request. /api/QuerySupportService/OperatorInfo This URI represents the supported logical operators of a query.
{ "Id": 7, "Name": "contains" }, { "Id": 8, "Name": "does not contain" }, { "Id": 9, "Name": "is null" }, { "Id": 10, "Name": "is not null" }, { "Id": 11, "Name": "begins with" }, { "Id": 12, "Name": "ends with" }, { "Id": 13, "Name": "before" }, { "Id": 14, "Name": "after" } ], "FieldTypes": [ { "FieldTypeId": 1, "Name": "String", "OperatorIds": [ 1, 2, 3, 4, 5, 6, 11, 12, 7, 8, 9, 10 ] }, { "FieldTypeId": 2, "Name": "Number", "OperatorIds": [ 1, 2, 3, 4, 5, 6, 9, 10 ] }, { "FieldTypeId": 3, "Name": "Date
"OperatorIds": [ 1, 2, 13, 14, 9, 10 ] }, { "FieldTypeId": 4, "Name": "Enum", "OperatorIds": [ 1, 2, 9, 10 ] }, { "FieldTypeId": 5, "Name": "Boolean", "OperatorIds": [ 1, 2, 9, 10 ] } } ] /api/QuerySupportService/Filters This URI represents summary information for all filters. GET method for Filters This method returns summary information for all filters. Description Returns summary information for all filters. Privilege VIEW HTTP response codes 200 Example Response Body { "@odata.
}, { }, { }, { }, { } ] } "@odata.id": "/api/QuerySupportService/Filters(1010)", "Id": 1010, "Name": "Dell iDRAC Servers", "UsageId": 1, "FilterText": "", "ContextId": 2, "Conditions": [] "@odata.type": "#QuerySupportService.Filter", "@odata.id": "/api/QuerySupportService/Filters(1007)", "Id": 1007, "Name": "Dell Networking Switches", "UsageId": 1, "FilterText": "", "ContextId": 2, "Conditions": [] "@odata.type": "#QuerySupportService.Filter", "@odata.
"@odata.context": "/api/$metadata#QuerySupportService.Filter/$entity", "@odata.type": "#QuerySupportService.Filter", "@odata.
} Example Response Body { } "Description": "Test Group1", "GlobalStatus": 0, "ParentId": 0 "Id": 1564, "Name": "Test Group1", "Description": "Test Group1", "TypeId": 3000, "MembershipTypeId": 12, "GlobalStatus": 0, "ParentId": 0, "CreatedBy": "root", "UpdatedBy": "", "CreationTime": "2017-06-08 20:14:37.252", "UpdatedTime": "2017-06-08 20:14:37.
{ } "@odata.context": "$metadata#Collection(GroupService.StatusSummary)", "@odata.count": 3, "value": [ { "StatusType": 4000, "Count": 26 }, { "StatusType": 3000, "Count": 4 }, { "StatusType": 1000, "Count": 15 } ] /api/GroupService/Groups(Id)/EventStatusSummary This URI represents the events status counts. GET method for EventStatusSummary This method returns events status counts per status values. Description Returns events status counts per status values.
/api/GroupService/Groups(group id)/ EventSeveritySummary?$filter=StatusType eq 1000 This URL returns the count of acknowledged alerts. GET method for EventSeveritySummary?$filter=StatusType eq 1000 Description This method returns the count of acknowledged alerts. /api/GroupService/Groups(group id)/ EventSeveritySummary$filter=StatusType eq 1 This URL returns the count of all the alerts.
"MembershipTypeId":24, "ParentId": 0 }, "GroupModelExtension" :{ "FilterId":0, "ContextId":2, "Conditions":[{ "LogicalOperatorId":1, "LeftParen":false, "FieldId":9, "OperatorId":1, "Value":"1000", "RightParen":false }] } } /api/GroupService/Actions/GroupService.UpdateGroup This URI represents the updates to a group. PUT method for GroupService.UpdateGroup This method updates a group. Description Updates a group.
"DefinitionId": 0, "ParentId": 12 } /api/GroupService/Actions/GroupService.DeleteGroup This URI represents deleting a group. POST method for GroupService.DeleteGroup This method deletes group(s). Description Deletes group(s). Privilege GROUP_MANAGEMENT HTTP response codes 204 Example Request Body {"GroupIds": [5114]} /api/GroupService/Actions/ GroupService.AddMemberDevices This URI represents adding devices to a group. POST method for GroupService.
HTTP response codes 204 Example Request Body { "GroupId":2614, "MemberDeviceIds" : [2514] } /api/GroupService/Actions/ GroupService.AddUserToGroups This URI represents adding users to groups. POST method for GroupService.AddUserToGroups This method adds user to a group. Description Adds user to a group.
qNTuSKuAwLLmvBKqb +eWEGt4TVbq1A4Q0AxHkvJKlAhKYoOS0q6pJjYbi1chuy2wAYtS0JWc8OBG18UiaZq0SGF mbP7cq4bdys4A49tht239Zo9Dl4MEcPW2qtcMUgg7SknKbTbe7Uc3NtX73qPLa/ BSLMfsd7qGEwkPPtDGReBqTjr ZhVB065Ecr2kjldvPp3U/cnHYycXMRxD4dIr3DhWB9V", "Type": "SSH_KNOWN_HOSTS", "AssociatedDevice": 0 } ] } /api/DeviceService/Actions/DeviceService.AddKeys This URL enables you to manually add the known host keys. POST method for DeviceService.AddKeys Description This method enables you to manually add the known host keys.
Example request body { "Host":["1.1.1.1"] } /api/DeviceService/Actions/DeviceService.RemoveKeys This URL deletes the keys. POST method for DeviceService.RemoveKeys Description This method deletes the keys. Privilege DEVICE_CONFIGURATION HTTP response codes 200 Example request body { "KeyIds":[ 1,2,3,4 ] } Auto deploy /api/AutoDeployService/Targets This URL is used to get all the auto deploy targets. GET method for Targets Description This method is used to get all the auto deploy targets.
}, { } ] } "IsoPath": null, "TaskId": 0, "TaskLastRunStatusId": 2200, "CreatedBy": "admin", "CreatedOn": "2019-05-15 17:24:29.411303" "@odata.type": "#AutoDeployService.AutoDeployTarget", "@odata.
} ] } "ResultCode": 0, "BaseEntityId": 10328 Table 173. Attributes Attribute name Description ResultCode 0=Action Successful 1=Identifier has invalid length 2=A device with this identifier has already been discovered 3=An auto-deploy request exists for this identifier 4=The identifier is a Node ID, which cannot be used with a chassisbased template. 100=Invalid value for TeamplateId 101=Invalid value for AutoDeployId /api/AutoDeployService/Actions/ AutoDeployService.
/api/AutoDeployService/AutoDeploy After the identifiers are validated, this URL is used to complete the AutoDeploy request with the NetworkBootIso details. POST method for AutoDeploy Description After the identifiers are validated, this method is used to complete the AutoDeploy request with the NetworkBootIso details.
Monitor Discovery service /api/DiscoveryConfigService/Jobs This URI represents the information of discovery tasks. GET method for Jobs This method returns the discovery job information with discovery request details. Description Returns the discovery job information. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(DiscoveryConfigService.DiscoveryJob)", "@odata.count": 5, "value": [ { "@odata.type": "#DiscoveryConfigService.
}, { }, { }, { } 514 ] } "Count": 31 "@odata.type": "#DiscoveryConfigService.DiscoveryJob", "@odata.id": "/api/DiscoveryConfigService/Jobs(25120)", "JobId": 25120, "JobName": "Amit", "JobDescription": "Amit", "JobSchedule": "", "JobStartTime": "2018-09-13 16:48:22.428", "JobEndTime": "2018-09-13 00:00:00.0", "JobProgress": "100", "JobStatusId": 2102, "JobNextRun": "2018-09-13 16:25:04.174", "JobEnabled": true, "UpdatedBy": "admin", "LastUpdateTime": "2018-09-13 16:48:22.
} ] Table 174. Attributes Attribute Description JobId ID of the discovery job. JobName Name of the discovery job. JobSchedule Discovery job schedule information. JobStartTime Start time of the discovery job. JobEndTime Completion time of the discovery job. JobProgress Percentage of discovery job completion. JobStatusId Status of the discovery job. For example, Complete, Failed, and so on. JobNextRun If discovery job is scheduled, returns the next schedule time.
} ], "Schedule":{ "RunNow":true, "RunLater":false, "Cron":"startnow", "StartTime":"", "EndTime":"" }, "CreateGroup":true, "TrapDestination":false } Example to run discovery job at a later time ] Example request body { "DiscoveryConfigGroupName":"Discovery-2017091613542121", "DiscoveryConfigGroupDescription":"null", "DiscoveryConfigModels":[ { "DiscoveryConfigId":916135421, "DiscoveryConfigDescription":"", "DiscoveryConfigStatus":"", "DiscoveryConfigTargets":[ { "DiscoveryConfigTargetId":0, "NetworkAddr
"NetworkAddressDetail":"xx.xx.xx.xx", "AddressType":30, "Disabled":false, "Exclude":false } ], "ConnectionProfileId":0, "ConnectionProfile":"{\"profileName\":\"\",\"profileDescription \":\"\",\"type\":\"DISCOVERY\",\"credentials\":[{\"id\":0,\"type\":\"WSMAN \",\"authType\":\"Basic\",\"modified\":false,\"credentials\":{\"username \":\"root\",\"password\":\"calvin\",\"caCheck\":false,\"cnCheck \":false,\"port\":443,\"retries\":3,\"timeout\":60,\"isHttp \":false,\"keepAlive\":false}}]}", "DeviceType":[ 1000
} } ] 1000, 2000, 5000, 7000 ], "Schedule":{ "RunNow":true, "RunLater":false, "Cron":"startnow", "StartTime":"", "EndTime":"" }, "CreateGroup":true, "TrapDestination":false Example to email a Example request body discovery task { after completion "DiscoveryConfigGroupName":"Discovery-2017091613591313", "DiscoveryConfigGroupDescription":"null", "DiscoveryStatusEmailRecipient":"test@dell.
/api/DiscoveryConfigService/Actions/ DiscoveryConfigService.RemoveDiscoveryGroup This URI represents removing a discovery group. POST method for DiscoveryConfigService.RemoveDiscoveryGroup This method removes a discovery group. Description Removes a discovery group. Privilege DISCOVERY_MANAGEMENT HTTP response codes 204 Example request body { "DiscoveryGroupIds":[1,2,3] } /api/DiscoveryConfigService/Actions/DiscoveryConfigService.Parse This URI represents discovery ranges parsed from a .CSV file.
"DiscoveryConfigTargetId": 0, "NetworkAddressDetail": "xx.xx.xx.xx-xx.xx.xx.xx", "AddressType": 30, "Disabled": false, "Exclude": false }], "ConnectionProfile":"{\"profileName\":\"\",\"profileDescription \":\"\",\"type\":\"DISCOVERY\",\"credentials\":[{\"id\":0,\"type\":\"REDFISH \",\"authType\":\"Basic\",\"modified\":false,\"credentials\":{\"username \":\"root\",\"password\":\"calvin\",\"caCheck\":false,\"cnCheck \":false,\"port\":443,\"retries\":2,\"timeout\":4,\"isHttp \":false,\"keepAlive\":false}}]}",
} "DiscoveryConfigTasks": [], "Schedule": { "RunNow": false, "RunLater": false, "Recurring": null, "Cron": "startnow", "StartTime": null, "EndTime": null }, "TrapDestination": false, "ChassisIdentifier": null Table 175.
} "State": "N/A", "ItemNumber": "N/A", "ServiceLevelCode": "N/A", "ServiceLevelDescription": "No valid warranties found", "ServiceLevelGroup": 0, "ServiceProvider": "N/A", "StartDate": "0001-01-01 00:00:00.000", "EndDate": "0001-01-01 00:00:00.000", "DaysRemaining": 0, "Timestamp": "2018-09-03 00:00:00.000" } ] Table 176.
/api/JobService/Jobs This URL represents the creation of a warranty job. POST method for Warranties Description This method creates a warranty job.
Example response body { "@odata.context": "/api/$metadata#Collection(ReportService.ReportDef)", "@odata.count": 21, "value": [{ "@odata.type": "#ReportService.ReportDef", "@odata.id": "/api/ReportService/ReportDefs(10042)", "Id": 10042, "Name": "Alert Counts per Device Report", "Description": "This report contains alert counts per severity and totals per Device.", "IsBuiltIn": true, "LastEditedBy": "admin", "LastRunDate": "2018-09-11 15:36:17.05", "LastRunBy": "admin", "LastRunDuration": "0.
"Width": 20, "Sequence": 9 } ], "FilterGroupId": 0, "QsmQuery": false, "ReportResults": { "@odata.id": "/api/ReportService/ReportDefs(10042)/ReportResults" } }] } Table 177.
}, { "Width":20, "Sequence":4, "Name":"Software Description" } ], "FilterGroupId":64, "QueryDefRequest":{ "ContextId":3, "ResultFields":[ { "FieldId":61 }, { "FieldId":64 }, { "FieldId":63 }, { "FieldId":99 }, { "FieldId":102 } ], "SortFields":[ } } ] PUT method for ReportDefs This method updates a report. Description Updates a report.
"LeftParen": false, "FieldId": 65, "OperatorId": 1, "Value": "1000", "RightParen": false }], "ResultFields": [{ "FieldId": 71 }, { "FieldId": 68 }, { "FieldId": 69 }, { "FieldId": 70 }, { "FieldId": 65 }], "SortFields": [{ "FieldId": 65, "SortDir": 0 }] } } Table 178. Attributes Attribute name Description ID Report ID Name Report Name Description Definition of the report. FilterGroupId Group to filter the report output. ColumnNames Names of the columns for the reports.
"Name": "Device Type", "Width": 20, "Sequence": 1 }, { "Id": 23, "Name": "Device Model", "Width": 20, "Sequence": 2 }, { "Id": 24, "Name": "Identifier", "Width": 20, "Sequence": 3 }, { "Id": 25, "Name": "Device Asset Tag", "Width": 25, "Sequence": 4 }, { "Id": 26, "Name": "Datacenter", "Width": 25, "Sequence": 5 }, { "Id": 27, "Name": "Aisle", "Width": 25, "Sequence": 6 }, { "Id": 28, "Name": "Rack", "Width": 25, "Sequence": 7 } ], "ResultRows@odata.
] } } ] "SERVER", "PowerEdge R640", "792B0M2", "", "", "", "" /api/ReportService/Actions/ReportService.RunReport This URI is used to run a report. POST method for Running Reports This method is used to run reports. Description Used to run reports. Privilege REPORT_RUN HTTP response codes 200 Example request body { "ReportDefId":1564, "FilterGroupId":0 } /api/ReportService/Actions/ReportService.DownloadReport The URI represents the download of reports. POST method for ReportService.
HTTP response codes Example request body 200 [1564] /api/ReportService/Actions/ReportService.CloneReport This URI represents cloning of a report. POST method for ReportService.CloneReport This method clones a report. Description Clones a group. Privilege REPORT_MANAGEMENT HTTP response codes 200 Example request body { "ReportDefId":"25074", "ReportDefName":"new clone report" } /api/ReportService/Actions/ReportService.EmailReport Run and email the requested report.
HTTP response codes Example request body 200 { "@odata.context": "/api/ $metadata#Collection(MIBImportService.GetTrapsPayload)", "@odata.count": 2269, "value": [{ "@odata.type": "#MIBImportService.GetTrapsPayload", "EnterpriseOid": ".1.3.6.1.4.1.674.10892.1", "EventDefinition": { "Name": "enhancedAlertMemoryDeviceNonRecoverable", "EventCategory": { "Id": 1000, "EventCategoryName": "System Health" }, "EventCatalog": { "EventCatalogId": 1000, "Name": "OMSA", "ReleaseVersion": "7.4.
"EventCategoryName": "System Health" }, "EventDefinitionId": 1004542258, "EventSubCategory": { "Description": "Removable Flash media events", "Name": "vFlash Event", "Id": 4500, "Prefix": "RFM" }, "EventType": { "EventTypeId": 1001, "Name": "SNMP", "Description": "SNMP event" }, "Name": "test new", "Description": "test description", "Severity": { "Description": "Critical", "Name": "Critical", "Id": 16 } }, "FormatString": "$3", "GenericTrapId": 6, "SnmpEventId": 1142, "SpecificTrapId": 5754, "SnmpEventStatu
/api/MIBImportService/MIBImportService/EventSeverities This URI represents the event severities. GET method for EventSeverities This method returns the event severities. Description Returns the event severities. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(MIBImportService.MIBEventSeverity)", "@odata.count": 5, "value": [{ "@odata.type": "#MIBImportService.MIBEventSeverity", "@odata.
/api/MIBImportService/MIBImportService/EventCategories This URI represents the event categories. GET method for EventCategories This method returns the event categories. Description Returns the event categories. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(MIBImportService.MIBEventCategory)", "@odata.count": 7, "value": [{ "@odata.type": "#MIBImportService.MIBEventCategory", "@odata.
grained instrumentation to provide increased visibility over power consumption, anomalies, and utilization. In addition, the Power Manager extension alerts and reports on thermal events with servers and groups of servers. This enables increased control, faster response times, greater accuracy, and broader decision-making intelligence than would otherwise be possible.
"@odata.id": "/api/PluginService/Plugins('2F6D05BE-EE4B-4B0E-B873C8D2F64A4625')", "Id": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625", "Auto": true, "Name": "Power Manager", "UpdateAvailable": false, "Installed": true, "Enabled": true, "Publisher": "DELL EMC", "CurrentVersion": "1.0.0.
possible. When used with Dell EMC PowerEdge servers or chassis with the required iDRAC Enterprise or Chassis Management Control (CMC) Enterprise license, OpenManage Enterprise Power Manager leverages information from the OpenManage Enterprise console for platform-level power management.
} Table 181. Attributes Attribute Description OmeVersion If empty version is passed, current installed OpenManage Enterprise version is used to check compatibility. Version format 1.0.0.325 (major.minor.revision.BuildNumber). Build number is not required. Id ID of the plug-in. Version Version of the plug-in. Version should be same as mentioned in catalog file .
Attribute Description NOTE: • • • Output The version is not required for uninstall, enable, and disable. For install and update, the version that needs to be installed should be mentioned. Only one action can occur at a time for multiple plugins. The output returns the task ID. Power Metrics NOTE: The APIs in this section can be used only when the power plug-in is installed on OpenManage Enterprise. /api/MetricService/Metrics This URL returns all the device or group metrics.
} Table 183. Attributes Attribute Description PluginId ID of a plug-in. EntityType Type of entity—device or group. EntityId ID of an entity—device or group. MetricTypes Types of metrics supported. Duration Duration of metric data collection. SortOrder Order of metric data collected.
Attribute Description 5 Seven Days 6 One Month 7 Three Months 8 Six Months 9 One Year Sort Order 0 Descending 1 Ascending /api/MetricService/TopEnergyConsumption This URL represents the most high energy consumption. POST method for TopEnergyConsumption Description This method returns the information of the most high energy consumption.
Table 184. Attributes Attribute Description PluginId ID of plug-in. Top Top values, 1–5. EntityType Type of entity device or group. DeviceType Type of device—server or chassis. Duration Duration Entity Type 0 Device 1 Group Device Type 1000 Server 2000 Chassis Duration 4 One day 5 One week 6 Two weeks 7 One month 8 Three months 9 Six months 10 One year /api/MetricService/EnergyConsumption This URL returns the energy consumption of the device.
Table 185. Attributes Attribute Description PluginId ID of a plug-in. EntityType Type of an entity, only device. EntityId ID of an entity, only device. Duration Duration Total Energy Energy Consumption in KWH. Duration 1 One hour 2 Six hours 3 Twelve hours 4 One day 5 Seven days 6 One month 7 Three months 8 Six months 9 One year /api/MetricService/MetricTypes This URL returns all the supported metric types.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 544 "@odata.type": "#MetricService.MetricType", "Id": 4, "Name": "INSTANT_POWER", "Description": "Instant System Power" "@odata.type": "#MetricService.MetricType", "Id": 5, "Name": "MAX_INLET_TEMP", "Description": "Maximum Inlet Temperature" "@odata.type": "#MetricService.MetricType", "Id": 6, "Name": "MIN_INLET_TEMP", "Description": "Average Inlet Temperature" "@odata.type": "#MetricService.
}, { }, { }, { } ] } "@odata.type": "#MetricService.MetricType", "Id": 16, "Name": "MIN_UTIL_IO", "Description": "Minimum IO utilization" "@odata.type": "#MetricService.MetricType", "Id": 17, "Name": "AVG_UTIL_IO", "Description": "Average IO utilization" "@odata.type": "#MetricService.MetricType", "Id": 18, "Name": "SYS_AIRFLOW", "Description": "System Air Flow" "@odata.type": "#MetricService.
] } Table 186. Attributes Attribute Description PluginId ID of a plug-in. EntityType Type of an entity—device or group. EntityId ID of an entity—device or group. Duration Duration MetricTypes Type that is supported by the metric.
} "UpperWarning": "100", "UpperCritical": "150", "LowerWarning": "70", "LowerCritical": "80" Table 187. Attributes Attribute Description PluginId ID of a plug-in. EntityId ID of an entity—device or group. Type Type—temperature or power. State State of an entity—unknown, normal, warning, critical. UpperWarning Upper limit threshold of state warning. UpperCritical Upper limit threshold of state critical. LowerWarning Lower limit threshold of state warning.
Table 188. Attributes Attribute Description Supported threshold LowerWarning, lowerCritical, upperWarning, upperCritical Supported state Unknown, normal, warning, critical Supported power UpperWarning, upperCritical Supported temperature LowerCritical, lowerWarning, upperWarning, upperCritical Reset threshold Pass empty values in all the threshold fields in the payload. PluginId ID of a plug-in. EntityId ID of an entity—device or group. Type Type—temperature or power.
18 Redfish resource model Dell EMC incrementally improves the support for API and the associated operations during the life cycle of the products. The limited Redfish implementation follows the industry-standard DMTF specifications. For more information, see the documentation available on the DMTF website.
"AlertService":{"@odata.id": "/api/AlertService"} } }, "Id": "RootService", "Name": "Root Service", "Links":{ "Sessions":{ "@odata.id": "/redfish/v1/SessionService/Sessions" }, "Oem":{ } }, "RedfishVersion": "1.2.0", "CompositionService":{ "@odata.id": "/redfish/v1/CompositionService" }, "AccountService":{ "@odata.id": "/redfish/v1/AccountService" }, "Chassis":{ "@odata.id": "/redfish/v1/Chassis" }, "Systems":{ "@odata.id": "/redfish/v1/Systems" }, "SessionService":{ "@odata.
MessageRegistryFileCollection_v1.xml">
"kind": "Singleton" }, { "name": "Systems", "url": "/redfish/v1/Systems", "kind": "Singleton" }, { "name": "Chassis", "url": "/redfish/v1/Chassis", "kind": "Singleton" }, { "name": "Managers", "url": "/redfish/v1/Managers", "kind": "Singleton" }, { "name": "TaskService", "url": "/redfish/v1/TaskService", "kind": "Singleton" }, { "name": "SessionService", "url": "/redfish/v1/SessionService", "kind": "Singleton" }, { "name": "Registries", "url": "/redfish/v1/Registries", "kind": "Singleton" }, { "name": "Mess
} "Description": "SessionService", "Name": "SessionService", "Status": { "State": "Enabled", "HealthRollup": "OK", "Health": "OK" }, "ServiceEnabled": true, "SessionTimeout": 1800, "Actions": null, "Sessions": [ { "@odata.id": "/api/SessionService/Sessions" } ] Table 189. Attributes Attribute name Description Id ID of the session service. ServiceEnabled Indicates if the session service is enabled or disabled. SessionTimeout The period of time after which the session is timed out.
Table 190. Attributes Attribute name Description Id ID of the session service. UserName User name of the active session. Password Password of the active session. Roles Privilege assigned to the role. IpAddress IP Address of session source. StartTimeStamp Date and time when the session began. LastAccessedTimeStamp Date and time when the session was last accessed. POST method for Members This method authenticates a user and establishes a session. Description Establishes a session.
/redfish/v1/SessionService/Sessions/Members(Id) This URI represents a specific session. GET method for Members(Id) This method returns the details of a specific session. Description Returns the details of a session.
/redfish/v1/AccountService This URI represents the account configuration of all the accounts. GET method for AccountService This method returns the account configuration of all the accounts. Description Returns the account configuration. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#AccountService.v1_0_2.AccountService", "@odata.
Attribute name Description MaxPasswordLength Maximum length of the password. ServiceEnabled Indicates if the service is enabled or disabled. AuthFailureLoggingThreshold The number of authorization failures after which the failure attempt is logged in the Manager log. AccountLockoutThreshold The number of failed login attempts after which a user account is locked for the specified duration. 0 indicates that the account is never locked.
} "AuthFailureLoggingThreshold": 3, "MinPasswordLength": 8, "MaxPasswordLength": 20, "AccountLockoutThreshold": 3, "AccountLockoutDuration": 30, "AccountLockoutCounterResetAfter": 900, "IpRangeAddress": null, "ServiceEnabled": false, "ByUserName": false, "ByIPAddress": false, "EnableIpRangeAddress": false Table 193. Attributes Attribute name Description ID ID of the account service. Description Description of the account service. Name Name of the account service.
HTTP response codes Example response body 200 { "@odata.context": "/redfish/ v1/$metadata#Collection(ManagerAccount.v1_1_3.ManagerAccount)", "@odata.count": 2, "value":[ { "@odata.type": "#ManagerAccount.v1_1_3.ManagerAccount", "@odata.
POST method for Members This method creates an account. Description Creates an account.
/redfish/v1/AccountService/Accounts/Members(Id) This URI represents a specific account within the collection. GET method for Members(Id) This method returns the details of a specific account. Description Returns the details of a specific account. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#ManagerAccount.v1_0_2.ManagerAccount/$entity", "@odata.
HTTP response codes Example request body 200 { } Example response body { } "Id": "3064", "UserTypeId": 1, "DirectoryServiceId": 0, "Name": "user2", "Password": "Dell123$", "UserName": "user2", "Description": "user2 description", "RoleId": "10", "Locked": false, "Enabled": true "Id": "3064", "UserTypeId": 1, "DirectoryServiceId": 0, "Name": "user2", "Password": null, "UserName": "user2", "Description": "user2 description", "Oem": null, "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": tr
Example Input: Output: Table 198. Attributes Attribute name Description Id ID of the account to be deleted. redfish/v1/AccountService/Roles/Members This API gets a list of all roles of members. GET method for Roles This method returns the role details of members. Description Returns role details of the members. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/redfish/v1/$metadata#Collection(Role.v1_2_2.Role)", "@odata.count": 5, "value":[ { "@odata.
/redfish/v1/AccountService/Roles/Members(Id) This URI represents the role details of a specific account. GET method for Members(Id) This method returns the details of the role for a specific account. Description Returns the details of a role. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Role.Role/$entity", "@odata.
} ], "Dellv1_0_0": [ { "@odata.id": "/redfish/v1/Registries/Dellv1_0_0" } ] GET method for Registry instance This API represents the registry information of members. GET method for registry instance This method returns the registry information of members, by ID. Description Returns the registry information of members, by ID. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/redfish/ v1/$metadata#MessageRegistryFile.v1_0_0.MessageRegistryFile", "@odata.
"Language": "de", "Uri": "/redfish/v1/MessageRegistryCollection/ Members('EEMIRegistry.v1_0_0_de')" }, { "Language": "ko", "Uri": "/redfish/v1/MessageRegistryCollection/ Members('EEMIRegistry.v1_0_0_ko')" } ] } redfish/v1/MessageRegistryCollection/ Members() This API represents message listings for a location. GET method for messages of location This method returns a list of messages for a specific location. Description Returns a list of messages for a location.
HTTP response code Example response body 200 { "@odata.context": "/redfish/ v1/$metadata#ChassisCollection.ChassisCollection", "@odata.type": "#ChassisCollection.ChassisCollection", "@odata.id": "/redfish/v1/Chassis", "Description": null, "Name": "Chassis Collection", "Oem": null, "Members@odata.count": 8, "Members": [ { "@odata.id": "/redfish/v1/Chassis/Members('25013')" }, { "@odata.id": "/redfish/v1/Chassis/Members('25014')" }, { "@odata.id": "/redfish/v1/Chassis/Members('25012')" }, { "@odata.
"Model": "MX9116n Fabric Engine", "SKU": "8ZD60T2", "SerialNumber": "CNDND008890100", "PartNumber": "0RFX85A02null", "AssetTag": "CH1-SLOT-A1", "IndicatorLED": "Unknown", "Links":{ "ManagedBy":[ { "@odata.id": "/redfish/v1/Managers/Members('ChassisManager')" } ], "ManagedBy@odata.count": 1, "Drives":[ ] }, "Actions":{ "Oem":{ "#DellChassis.VirtualReseat":{ "target": "/redfish/v1/Chassis/Members('10057')/Actions/Oem/ DellChassis.VirtualReseat" } }, "#Chassis.Reset":{ "ResetType@Redfish.
"IndicatorLED": "Unknown", "Links":{ "ManagedBy":[ { "@odata.id": "/redfish/v1/Managers/Members('ChassisManager')" } ], "ManagedBy@odata.count": 1, "Drives":[ ] }, "Actions":{ "Oem":{ "#DellChassis.VirtualReseat":{ "target": "/redfish/v1/Chassis/Members('10057')/Actions/Oem/ DellChassis.VirtualReseat" } }, "#Chassis.Reset":{ "ResetType@Redfish.AllowableValues":["On", "ForceOff", "GracefulShutdown", "PowerCycle"], "target": "/redfish/v1/Chassis/Members('10057')/Actions/Chassis.
"CorrectionInMs": 0 }, "Status":{ }, "RelatedItem":[ ] } redfish/v1/Chassis/Members(id)/Power/ PowerSupplies() This API represents chassis power supply information. GET method for power supply information This method returns chassis power supply information. Description Returns chassis power supply information. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/redfish/v1/$metadata#Power.v1_0_0.PowerSupply", "@odata.type": "#Power.v1_0_0.
"Name": "Thermal", "Status":{ "State": "Enabled", "HealthRollup": "OK", "Health": "OK" }, "Temperatures@odata.count": 0, "Temperatures":[ ], "Fans@odata.count": 0, "Fans":[ ], "Redundancy":[ ] } redfish/v1/Chassis/Members(id)/Thermal/ Temperatures() This API represents chassis temperature information. GET method for temperature information This method returns chassis temperature information. Description Returns chassis temperature information.
"@odata.type": "#Thermal.v1_0_0.Fan", "@odata.id": "/redfish/v1/Chassis/Members('10054')/Thermal/ Fans('Fan.Slot.8')", "MemberId": "Fan.Slot.8", "FanName": "Rear Fan 4", "PhysicalContext": "Fan", "Status":{ "Health": "OK" }, "Reading": 8731 } redfish/v1/Managers/Members() This API represents the chassis manager information. GET method for chassis manager information This API returns the chassis manager information. Description Returns the chassis manager information.
redfish/v1/Chassis/Members(id)/Actions/Chassis.Reset This API represents chassis reset information. POST method for chassis reset This method resets the chassis. Description Resets the chassis. Privilege DEVICE_CONFIGURATION HTTP response codes 202 Example request body { "ResetType": "" } Table 200. Attributes Attribute name Description ResetType The allowed values are: • • • • On ForceOff Graceful Shutdown PowerCycle Some of the options work based on the type of the device.
Redfish—Systems This API represents server information. /redfish/v1/Systems This URI represents the systems. GET method for Systems This method returns the collection of the systems. Description Returns the collection of systems. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/redfish/ v1/$metadata#ComputerSystemCollection.ComputerSystemCollection", "@odata.type": "#ComputerSystemCollection.ComputerSystemCollection", "@odata.
"ResourceBlocks":[ { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Members('19')" }, {"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Members('2')"}, {"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Members('3')"}, {"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Members('4')"}, {"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Members('5')"}, {"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Members('6')"}, {"@odata.
"HostingRoles":[ "StorageServer", "ApplicationServer" ], "HostedServices":{ "Oem":{ } }, "Processors":{ "@odata.id": "/redfish/v1/Systems/Members('10055')/Processors" }, "EthernetInterfaces":{ "@odata.id": "/redfish/v1/Systems/Members('10055')/EthernetInterfaces" }, "SimpleStorage":{ "@odata.id": "/redfish/v1/Systems/Members('10055')/SimpleStorage" }, "Storage":{ "@odata.
redfish/v1/Systems/Members(id)/Processors/ Members(id) This API represents server processor information of specific systems. GET method for processors by IDs This method returns server processor information, by device ID. Description Returns server processor information. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/redfish/v1/$metadata#Processor.v1_0_0.Processor", "@odata.type": "#Processor.v1_0_0.Processor", "@odata.
}, { "@odata.id": "/redfish/v1/Systems/Members('10189')/EthernetInterfaces/ Members('15676')" }, { "@odata.id": "/redfish/v1/Systems/Members('10189')/EthernetInterfaces/ Members('15677')" }, { "@odata.id": "/redfish/v1/Systems/Members('10189')/EthernetInterfaces/ Members('15678')" }, { "@odata.id": "/redfish/v1/Systems/Members('10189')/EthernetInterfaces/ Members('15679')" }, { "@odata.id": "/redfish/v1/Systems/Members('10189')/EthernetInterfaces/ Members('15680')" }, { "@odata.
redfish/v1/Systems/Members(id)/SimpleStorage This API represents simple server storage information. GET method for storage device This method returns simple server storage information. Description Returns simple server storage information. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/redfish/ v1/$metadata#SimpleStorageCollection.SimpleStorageCollection", "@odata.type": "#SimpleStorageCollection.SimpleStorageCollection", "@odata.
"UefiDevicePath": "", "Devices":[], "Status":{ "State": "Enabled", "HealthRollup": "OK", "Health": "OK" } }, {"@odata.type": "#SimpleStorage.v1_0_0.SimpleStorage", "@odata.id": "/ redfish/v1/Systems/Members('10055')/SimpleStorage/Members('10054')",…}, {"@odata.type": "#SimpleStorage.v1_0_0.SimpleStorage", "@odata.id": "/ redfish/v1/Systems/Members('10055')/SimpleStorage/Members('10055')",…}, {"@odata.type": "#SimpleStorage.v1_0_0.SimpleStorage", "@odata.
HTTP response codes 202 Example request body { "ResetType": "" } Table 202. Attributes Attribute name Description ResetType The allowed values are: • • • • PowerOn PowerOffNonGraceful PowerOffGraceful PowerCycle Redfish—CompositionService redfish/v1/CompositionService This API represents the composition service information. GET method for CompositionService This method returns the composition service information. Description Returns the composition service information.
redfish/v1/CompositionService/ResourceBlocks This API represents the chassis information by devices IDs. GET method for ResourceBlocks This method returns the chassis information. Description Returns the chassis information. Privilege VIEW HTTP response code 200 Example response body 588 { "@odata.context": "/redfish/ v1/$metadata#ResourceBlockCollection.ResourceBlockCollection", "@odata.type": "#ResourceBlockCollection.ResourceBlockCollection", "@odata.
}, { "@odata.id": }, { "@odata.id": }, { "@odata.id": }, { "@odata.id": }, { "@odata.id": }, { "@odata.id": }, { "@odata.id": }, { "@odata.
} ], "Chassis":[ { "@odata.id": "/redfish/v1/Chassis/Members('10189')" } ], "Zones":[ { "@odata.id": "/redfish/v1/CompositionService/ResourceZones/Members('3')" } ] }, "ComputerSystems@odata.count": 1, "ComputerSystems":[ { "@odata.id": "/redfish/v1/Systems/Members('10189')" } ], "Drives@odata.count": 0, "Drives":[] } redfish/v1/CompositionService/ResourceZones This API represents power control information. GET method for ResourceZones This method returns the power control information.
"@odata.id": "/redfish/v1/CompositionService/ResourceZones/Members('38')" } ] } redfish/v1/CompositionService/ResourceZones/ Members() This API represents power supply information, by device ID. GET method for ResourceZones by ID This method returns the power supply information, by device ID. Description Returns the power supply information, by device ID. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/redfish/v1/$metadata#Zone.v1_0_0.Zone", "@odata.
Example request body { "ResourceBlock": { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members()" } } /redfish/v1/Systems/Members()/Actions/ ComputerSystem.RemoveResourceBlock This API represents removing a member chassis from a chassis group. POST method for removing ResourceBlock This method removes member chassis from a chassis group. Description Removes member chassis from a chassis group.
