OpenManage Enterprise Version 3.4 and OpenManage Enterprise - Modular Edition Version 1.20.00 RESTful API Guide June 2020 Rev.
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 Chapter 1: About this document...................................................................................................... 17 Chapter 2: Overview...................................................................................................................... 19 RESTful application programming interface..................................................................................................................... 19 OData...........................................................
/api/AccountService/Actions/AccountService.Delete........................................................................................... 46 /api/AccountService/Roles......................................................................................................................................... 47 /api/AccountService/Roles(Id)...................................................................................................................................
Alert policies......................................................................................................................................................................... 98 /api/AlertService/AlertPolicies................................................................................................................................... 98 /api/AlertService/AlertPolicies(Id)............................................................................................................................
/api/TemplateService/Templates(Id)/Views(Id)/DeviceAttributeViewDetails(Id)........................................... 160 /api/TemplateService/Templates(26)/Views(9)/DeviceAttributeViewDetails(10176).................................... 165 /api/TemplateService/Actions/TemplateService.AssignIdentities...................................................................... 166 /api/TemplateService/Actions/TemplateService.GetAssignedIdentities............................................................
GET method for local access configuration..............................................................................................................218 /api/DeviceService/Devices(Id)/HardwareLogs......................................................................................................... 220 GET method for HardwareLogs................................................................................................................................
POST method for api/DeviceService/Actions/DeviceService.DevicesPrivilegesAction.................................. 240 /api/DeviceService/Actions/DeviceService.DevicesByPrivilegesAction...................................................................241 POST method for device privileges action............................................................................................................... 241 /api/DeviceService/Actions/DeviceService.ExecuteAction...............................................
/api/GroupService/Groups(Id)/GroupHierarchy.........................................................................................................290 GET method for GroupHierarchy..............................................................................................................................290 /api/GroupService/GroupTypes.................................................................................................................................... 290 GET method for GroupTypes...........
Chapter 13: Console capabilities................................................................................................... 346 /api/ApplicationService/Capabilities..............................................................................................................................346 GET method for Capabilities...................................................................................................................................... 346 Chapter 14: Search..........................
/api/ManagementDomainService/Actions/ManagementDomainService.Domains.......................................... 399 /api/ManagementDomainService/Actions/ManagementDomainService.Join..................................................400 /api/ManagementDomainService/Actions/ManagementDomainService.Leave............................................... 401 /api/ManagementDomainService/Actions/ManagementDomainService.Delete..............................................
/api/NetworkService/PortAdminStatuses............................................................................................................. 455 /api/NetworkService/PortStatuses........................................................................................................................ 456 /api/NetworkService/PortBlinkStatuses................................................................................................................ 457 /api/NetworkService/PortRoles.....................
/api/JobService/Jobs................................................................................................................................................ 493 /api/ConsoleUpdateService/Updates?$filter= Auto eq true............................................................................... 494 /api/ConsoleUpdateService/UpdateBundleInfo.....................................................................................................494 /api/ConsoleUpdateService/Actions/ConsoleUpdateService.
/api/GroupService/Groups(Id)/DeviceStatusSummary....................................................................................... 532 /api/GroupService/Groups(Id)/EventStatusSummary........................................................................................ 533 /api/GroupService/Groups(group id)/EventSeveritySummary?$filter=StatusType eq 2000....................... 533 /api/GroupService/Groups(group id)/EventSeveritySummary?$filter=StatusType eq 1000........................
/api/PluginService/Plugins........................................................................................................................................575 /api/PluginService/Plugins('').................................................................................................................577 /api/PluginService/Plugins('')/AvailableVersionDetails.......................................................................577 /api/PluginService/Actions/PluginService.
redfish/v1/CompositionService/ResourceZones................................................................................................... 633 redfish/v1/CompositionService/ResourceZones/Members().......................................................634 /redfish/v1/Systems/Members()/Actions/ComputerSystem.AddResourceBlock..................... 634 /redfish/v1/Systems/Members()/Actions/ComputerSystem.RemoveResourceBlock..............
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 What's new OpenManage Enterprise 3.
Table 1. Supported REST API versions (continued) Product Date of release What's new • • • • OpenManage Enterprise – Modular Edition 1.10.00 September 2019 • • • • • • 18 About this document Fabrics(Id)/Uplinks(Id) and /api/ ManagementDomainService APIs to validate, import, and export VLAN definitions. For more information, see, NetworkConfigurationService. API to log off from the current user session. For more information, see /api/ SessionService/Actions/ SessionService.Logoff.
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.
Table 3. Role descriptions OME-Modular (continued) Role Description MONITORING_SETUP Alerting policies, forwarding, SupportAssist, and so on. POWER_CONTROL Reboot or power-cycle device. 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.
Table 4. Roles and associated privileges for OME - Modular (continued) Privilege Roles CHASSIS_ADMINI STRATOR COMPUTE_MANA GER Y Y NETWORK_MANA GEMENT STORAGE_MANA GER FABRIC_MANAGE R VIEWER Y OME - Modular Table 5.
Following is the format of a resource URI: // Following is an example of a resource URI, where 1234 is the unique identifier for the device: /DeviceService/Devices(1234) 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.
Data filtering The console software provides filtering options on certain URIs that return a collection of entities. Using this feature, the clients can extract a selected set of records using comparison operators on attributes of the model entity behind the collection. The relevant URI sections contain the information about the attributes and the operators that support filtering.
The following table lists a few examples of request headers: Table 7. Examples of request headers Request Header Description Example x-auth-token Authentication token taken from the return header of the SessionService/ Sessions POST operation to create a session. x-auth-token: d6399a19-38c8-467ba1ec-75ffa03efb7c Accept-Language Choice of language that the client can request—Optional. Accept-Language: en Response codes For synchronous operations, the server returns HTTP response codes 200 or 204.
Table 9. Examples of response headers Response Header Description Example Connection Control options for the current connection and list of hop-by-hop request fields. Connection: Keep-Alive Content-Type Specifies the format of the content that the Content-Type: application/json; server returns. If there are multiple formats odata.metadata=minimal that can be accepted in the client request (using the Accept header), the server chooses the appropriate supported format.
4 Application settings Topics: • • • • Network Security and user management Security and certificate management Monitoring and alert notifications 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.
/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": "/api/$metadata#Network.TimeConfiguration", "@odata.type": "#Network.TimeConfiguration", "@odata.
Table 11. Attributes Attribute name Description TimeZone The timezone to use. EnableNTP Specify whether to enable or disable NTP. 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.
/api/ApplicationService/Network/ProxyConfiguration This URI represents the proxy configuration. GET method for ProxyConfiguration This method returns the current proxy configuration. Description Returns the current proxy configuration. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Network.ProxyConfiguration/$entity", "@odata.
Table 13. Attributes (continued) Attribute name Description EnableProxy Enable or disable HTTP Proxy Settings. Username Username, if Proxy Authentication is enabled. Password Password, if Proxy Authentication is enabled. 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.
Table 14. Attributes Attribute Description Description Description for the Account service. Name Name given for Account service. State Indicates the known state of the resource. HealthRollup Health rollup status. Health Health of the resource. 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.
} Example response body { } "AccountLockoutCounterResetAfter": 900, "EnableIpRangeAddress": false, "IpRangeAddress": null, "ByUserName": false, "ByIPAddress": false "Id": "10", "Description": "OME-Modular User Accounts", "Name": "Account Service", "Status": { "State": "Enabled", "HealthRollup": "OK", "Health": "OK", "Oem": null }, "Oem": null, "AuthFailureLoggingThreshold": 3, "MinPasswordLength": 8, "MaxPasswordLength": 20, "AccountLockoutThreshold": 3, "AccountLockoutDuration": 30, "AccountLockoutCou
Table 15. Attributes (continued) Attribute Description EnableIpRangeAddress Enable or disable IP range address. IpRangeAddress IP rage address to be used. ByUserName Configure the service by user name. ByIPAddress Configure the service by IP address. /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.
Table 16. Attributes (continued) Attribute Description UserName User name of the account. RoleId Role for the account. Locked Indicates if the account is locked or unlocked. IsBuiltin Indicates if the account is an in-built account. Enabled Indicates if the account enabled or disabled. Permissions Permissions for this account. POST method for Accounts This method creates an account. Description Creates an account.
Table 17. Attributes (continued) Attribute Description Password Password for the user. When retrieving the details, Password is displayed as blank. UserName User name of the account. RoleId Role for the account. Locked Indicates if the account is locked or unlocked. IsBuiltin Indicates if the account is an in-built account. Enabled Indicates if the account enabled or disabled. /api/AccountService/Accounts(Id) This URI represents a specific account within the collection.
Table 18. Attributes (continued) Attribute Description Password Password for the user. When retrieving the details, Password is displayed as blank. UserName User name of the account. RoleId Role for the account. Locked Indicates if the account is locked or unlocked. IsBuiltin Indicates if the account is an in-built account. Enabled Indicates if the account enabled or disabled. Permissions Permissions for the account.
Table 19. Attributes (continued) Attribute Description Description Description for the user. Name Name of the user. This name is the same as user name. Password Password for the user. When retrieving the details, Password is displayed as blank. UserName User name of the account. RoleId Role for the account. Locked Indicates if the account is locked or unlocked. IsBuiltin Indicates if the account is an in-built account. Enabled Indicates if the account enabled or disabled.
} ] Table 21. Attributes Attribute Description Id Permission record ID. UserId Account ID for which permissions are retrieved. RoleId Role ID of the account. Entities List of entities that the account has access to. /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.
/api/AccountService/Actions/ AccountService.GetUserDetail This API returns details of the user who has logged in. POST method for /api/AccountService/Actions/ AccountService.GetUserDetail This method returns details of the user who has logged in. The details include user name, user ID, and role details. Description Returns details the user who has logged in.
/api/AccountService/Actions/AccountService.Disable This URI enables you to disable multiple accounts. POST method for AccountService.Disable This method disables multiple accounts. Description Disables multiple accounts. Privilege SECURITY_SETUP HTTP response codes 204 Example request body { } "AccountIds":[3164,3264] Table 23. Attributes Attribute Description AccountIds Account IDs to be disabled. /api/AccountService/Actions/AccountService.
/api/AccountService/Roles This URI represents the user roles. GET method for Roles This method returns a list of roles and the respective privileges. Description Returns a list of user roles and respective privileges. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(AccountService.Role)", "@odata.count": 5, "value": [ { "@odata.
Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(AccountService.Role)", "@odata.count": 5, "value": [ { "@odata.
"DefaultLDAPPort": 389, "DefaultADPort": 3268, "DefaultNetworkTimeOut": 120, "DefaultSearchTimeOut": 120, "Actions": null, "LDAPAccountProvider": [ { "@odata.id": "/api/AccountService/ExternalAccountProvider/ LDAPAccountProvider" } ], "ADAccountProvider": [ { "@odata.id": "/api/AccountService/ExternalAccountProvider/ ADAccountProvider" } ], "DirectoryServiceType": [ { "@odata.id": "/api/AccountService/ExternalAccountProvider/ DirectoryServiceType" } ] } Table 27.
} ] } "DirectoryType": "LDAP" Table 28. Attributes Attribute Description Id Identifier of the Directory Type. DirectoryType Directory Type. /api/AccountService/ExternalAccountProvider/ ADAccountProvider This URI represents the collection of Active-Directory services. GET method for ADAccountProvider This method returns the details of Active Directory services. The details include name, server type, username, timeouts, and port information.
Example response body { } "Id": 2714, "Name": "Starship", "ServerType": "DNS", "ServerName": [ "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.
"ServerType": "MANUAL", "ServerName": [ "ausdc12amer29.amer.dell.com" ], "UserName": "Admin", "Password": "XXXXXX", "ServerPort": 3268, "SsoEnablement": false, "KerberosFile": null, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": null, "Groups": [ { "@odata.
Table 30. Attributes Attribute name Description Id The identifier of the AD account provider. Name Directory name. 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. NetworkTimeOut Network timeout value. SearchTimeOut Search timeout value.
} Example for ServerType: DNS Example request body { } Example for ServerType: DNS "ServerPort": 3268, "NetworkTimeOut": 300, "SearchTimeOut": 300, "CertificateValidation": false, "CertificateFile": null "Name": "AD", "ServerType": "DNS", "ServerName": [ ], "DnsServer": [ "dell.com" ], "GroupDomain": "dell.
Table 31. Attributes (continued) 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.
} ] POST method for LDAPAccountProvider This method adds an LDAP Directory Service. Description Adds an LDAP Directory Service. Privilege SECURITY_SETUP HTTP response codes 200 Example request body { } Example response body { } "Name": "seaquest", "Id":1, "ServerType": "DNS", "ServerName": ["10.35.195.
Table 32. Attributes (continued) Attribute name Description BaseDistinguishedName Domain names for search base. Example: dc=dell, dc=com. AttributeUserLogin User login details. 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.
PUT method for LDAPAccountProvider(Id) This method updates the details of a server of the LDAP Directory Service. Description Updates the details of an LDAP server. Privilege SECURITY_SETUP HTTP response codes 200 Example request body { "Name": "seaquest", "Id":2964, "ServerType": "DNS", "ServerName": ["10.35.195.
Table 33. Attributes (continued) Attribute name Description 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.TestLDAPConnection This URI enables you to test the LDAP Directory Service connection.
} Example for ServerType: DNS Example request body { } Example for ServerType: DNS "Name": "LDAP", "ServerType": "DNS", "ServerName": [ ], "DnsServer": [ "dell.
Table 34. Attributes Attribute name Description Id ID of the LDAP account provider. Name Directory name. 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. BaseDistinguishedName Domain names for search base. Example: dc=dell, dc=com. AttributeUserLogin User login details. AttributeGroupMembership Group member information. SearchFilter Search type.
Table 35. Attributes Attribute name Description CommonName Common name of the directory service. OrganizationalUnit Organization unit of the directory service. DistinguishedName Distinguished name of the directory service. DomainComponent Domain name of the directory service. ObjectGuid Unique ObjectGuid for the group. /api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.
"DirectoryServiceId": 0, "Description": "admin", "Name": "OME-ModularMegatronTeam", "Password": "", "UserName": "OME-ModularMegatronTeam", "RoleId": "10", "Locked": false, "Enabled": true, "ObjectGuid": "d22005b6-0ce5-40ed-88d0-7f7759b52f25" }, { "UserTypeId": 2, "DirectoryServiceId": 0, "Description": "admin", "Name": "OME-ModularDevelopmentTeam", "Password": "", "UserName": "OME-ModularDevelopmentTeam", "RoleId": "10", "Locked": false, "Enabled": true, "ObjectGuid": "21dd5985-602f-48a2-bde5-dde50eefb422"
Table 37. Attributes (continued) Attribute name Description Name Name of the user. This value is the same as the user name. Password Password for the user. The password is not displayed while retrieving the details. UserName Username of the account. RoleId Role for the account. Locked Indicates if the account is locked. IsBuiltin Indicates if the account is an in-built account. Enabled Indicates if the account is enabled. ObjectGuid Unique group ID for directory service.
Example response body { "@odata.context": "/api/$metadata#ApplicationService.FIPSModeConfiguration/ $entity", "@odata.type": "#ApplicationService.FIPSModeConfiguration", "@odata.id": "/api/ApplicationService/Security/SecurityConfiguration", "FipsMode": "OFF" } /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.
Table 38. Attributes (continued) Attribute name Description Value.IssuedBy.DistinguishedName Distinguished name of the certificate issuer. Value.IssuedBy.DepartmentName The department which issued the certificate. Value.IssuedBy.BusinessName Business name by which the certificate is issued. Value.IssuedBy.Locality Locality of the certificate issuer. Value.IssuedBy.State State of the certificate issuer. Value.IssuedBy.Country Country of the certificate issuer. Value.IssuedBy.
SIb3DQEJBzEWExRBIGNoYWxsZW5nZSBwYXNzd29yZDANBgkqhkiG9w0BAQUFAAOB gQCxcBNjn5PYe5+NPmD+LjEF+XB34XCZvh4QrCsECyK6B2jRXLP39SxABFlxxd3w D+tddrxy6/8pDdSLMl8FqcV9HLrgJqFn5ue+pA3BLjtkZaM9cxVWHtFZst64WF4v hioJNM68xeFObTxWS99lKufKF8dWKkbQessaABq3yQMikw== -----END CERTIFICATE REQUEST----- Table 39. Attributes Attribute name Description DistinguishedName Distinguished name of the certificate issuer. DepartmentName Department name that issued the certificate.
HTTP response code Example request body 202 { "DirectoryServerId": “10430”, "Type": "AD", } Example response body { } "DirectoryServerId": 10430, "Type": "AD", "SerialNumber": "401413413584593270254610161813845066096050178", "IssuerCN": "Dell Root Certificate Authority 2015", "SubjectCN": "Dell Issuing Certificate Authority 101", "ValidFrom": "Aug 14 2015 22:04:36", "ValidTo": "Aug 14 2022 22:14:36" Monitoring and alert notifications api/AlertService/AlertDestinations/SNMPConfiguration This URI repr
"DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } }, { } ] } "Id": 4, "Enabled": true, "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } 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.
] "DestinationAddress": "100.97.1.185", "PortNumber": "162", "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } }, { "Enabled": false, "DestinationAddress": "100.97.1.185", "PortNumber": "162", "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } }, { "Enabled": true, "DestinationAddress": "100.97.1.
] } "Community": "public" }, "SnmpV3Credential": null Table 41. 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. /api/AlertService/AlertDestinations/SyslogConfiguration This URI represents a collection of syslog configuration.
} ] Table 42. Attributes Attribute name Description Id ID of the syslog configuration. Enabled Indicates if syslog is enabled or disabled. DestinationAddress Destination address of syslog. PortNumber Port number of syslog. 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. api/AlertService/AlertDestinations/Actions/ AlertDestinations.
{ "Id": 2, "Enabled": true, "DestinationAddress": "100.97.10.17", "PortNumber": 514 }, { "Id": 3, "Enabled": true, "DestinationAddress": "10.19.12.1", "PortNumber": 514 }, { ] } "Id": 4, "Enabled": true, "DestinationAddress": "100.97.1.23", "PortNumber": 514 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.
Table 44. Attributes (continued) Attribute name Description PortNumber Port number of SMTP. UseCredentials Indicates if credentials are used. UseSSL Indicates if SSL is used. POST method for SMTPConfiguration This method configures SMTP to send emails. Description Configures SMTP. Privilege MONITORING_SETUP HTTP response codes 200 Example request body { } Example response body { } "DestinationAddress":"10.35.12.
Privilege MONITORING_SETUP HTTP response codes 200 Example request body { } "Enabled":"true", "DestinationAddress":"10.35.12.7", "PortNumber":162, "Version":"SNMPV1", "SnmpV1V2Credential": { "Community":"public" } Table 46. Attributes Attribute name Description DestinationAddress Destination address of SNMP. PortNumber Trap port number of SNMP. Version Version of SNMP. Community Community of SNMP.
5 Alerts Topics: • • • Alert logs Alert policies Alert definitions 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.
Example response body { } "@odata.context": "$metadata#Collection(AlertService.Alert)", "@odata.count": 11, "value": [ { "@odata.id": "/api/AlertService/Alerts(2)", "Id": 2, "SeverityType": 16, "SeverityName": "Critical", "AlertDeviceId": 1714, "AlertDeviceName": "localhost.smd.devops.dell.com", "AlertDeviceType": 1000, "AlertDeviceIpAddress": "xx.xx.xx.
Table 48. Attributes (continued) Attribute name Description StatusType ID of status type. StatusName Name of status type. TimeStamp Date and time when the alert was raised. Message Message describing the issue. EemiMessage Event and Error Message describing the issue, if applicable. 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.
{ "@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4592)", "Id": 4592, "SeverityType": 2, "SeverityName": "Info", "AlertDeviceId": 10056, "AlertDeviceName": "Sled-5", "AlertDeviceType": 1000, "AlertDeviceIpAddress": "100.97.211.
Alerts(4587)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4586)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4585)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4584)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4583)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4582)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4581)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4580)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4579)",…}, {"@odata.type": "#AlertService.
Alerts(4551)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4550)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4549)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4548)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4547)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4546)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4545)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4544)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4543)",…}, {"@odata.type": "#AlertService.
Alerts(4515)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(4514)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(4513)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(4512)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(4511)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(4510)",…}, {"@odata.type": "#AlertService.
"@odata.
Alerts(4297)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4296)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4293)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4292)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4291)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4290)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4289)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4287)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4288)",…}, {"@odata.type": "#AlertService.
Alerts(4063)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4062)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4061)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4060)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4059)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4058)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4057)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4035)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4034)",…}, {"@odata.type": "#AlertService.
Alerts(3753)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(3752)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(3751)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(3750)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(3749)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(3748)",…}, {"@odata.type": "#AlertService.
/api/AlertService/Alerts(Id) This URI represents a specific alert. GET method for Alerts(Id) This method returns the details of a specific alert. Description Returns the details of a specific alert. Privilege VIEW HTTP response codes 200 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.
Table 49. Attributes (continued) Attribute name Description CatalogName Catalog name associated to alert. CategoryId Category ID associated to alert. CategoryName Category name associated to alert. SubCategoryId Sub category ID associated to alert. SubCategoryName Sub category name associated to alert. StatusType ID of status type. StatusName Name of status type. TimeStamp Date and time when the alert was raised. Message Message describing the issue.
] }, { } } ] } "Id": 1003, "Name": "Audit", "CatalogName": "Application", "SubCategoryDetails": [ { "Id": 7600, "Name": "Device Compliance", "Description": "Device Compliance" } ] 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.
} } ] "Description": "Online Status of Managed device" }, { "Id": 7400, "Name": "Health Status of Managed device", "Description": "Health Status of Managed device" } Table 51. 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": "Normal" }, { "@odata.id": "/api/AlertService/AlertSeverities(8)", "Id": 8, "Name": "Warning", "Description": "Warning" }, { "@odata.id": "/api/AlertService/AlertSeverities(16)", "Id": 16, "Name": "Critical", "Description": "Critical" } 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.
/api/AlertService/AlertStatuses This URI represents the statuses for an alert. GET method for AlertStatuses This method returns all possible statues that are applicable to an alert. Description Returns all the possible alert statues. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(AlertService.AlertStatus)", "@odata.count": 2, "value": [ { "@odata.
"Description": "The event was acknowledged" } Table 55. Attributes Attribute name Description Id ID of the alert status Name Name of the alert status Description Description of the alert status /api/AlertService/AlertCatalogs This URI represents the catalogs applicable to an event. Table 56. 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 event ID. Default value is 0.
} } "IsVisible": true Table 57. Attributes Attribute name Description Id Catalog ID. CatalogName Name of the catalog. InternalName Internal name associated with the catalog. ReleaseVersion Catalog version. IsBuiltIn Indicates if the catalog in built-in or is manually included. IsVisible Indicates if the catalog is visible or hidden. /api/AlertService/AlertCatalogs(Id) This URI represents a specific alert catalog.
/api/AlertService/Events This URI represents the events. POST method for Events This method creates an event. Description Creates a Redfish event. Privilege MONITORING_SETUP HTTP response codes 201 Example request body { } "Context": "OME-ModularSubsc", "EventId": "0", "EventTimestamp": "2016-11-19T10:54:26+0000", "EventType": "Alert", "MemberId": "bbdbfb20-ae33-11e6-a44b-1866da78fcba", "Message": "The system board battery is low.
Table 59. Attributes Attribute Description AlertIds List of alert IDs. This value is an empty list when AllAlerts is True. AllAlerts True or False. Determines if action should be taken for all alerts. Filters Optional filters to specify when AllAlerts is True. DeviceIds List of IDs of devices. DeviceType Device type ID. Severity ID of severity. StatusType ID of status type. StartDate Start date and time when the alerts were raised. EndDate End date and time when the alerts were raised.
Table 60. Attributes Attribute Description AlertIds List of alert IDs. This value is an empty list when AllAlerts is True. AllAlerts True or False. Determines if action should be taken for all alerts. Filters Optional filters to specify when AllAlerts is True. DeviceIds List of IDs of devices. DeviceType Device type ID. Severity ID of severity. StatusType ID of status type. StartDate Start date and time when the alerts were raised. EndDate End date and time when the alerts were raised.
Table 61. Attributes Attribute Description AlertIds List of alert IDs. This value is an empty list when AllAlerts is True. AllAlerts True or False. Determines if action should be taken for all alerts. Filters Optional filters to specify when AllAlerts is True. DeviceIds List of IDs of devices. DeviceType Device type ID. Severity ID of severity. StatusType ID of status type. StartDate Start date and time when the alerts were raised. EndDate End date and time when the alerts were raised.
"Name": "Default OnDemand Health Policy", "Description": "This policy is applicable to all devices. A health task will be triggered if category is for system health.
Table 63. Attributes (continued) Attribute name Description State State associated with the policy. Visible Indicate if the policy is visible or hidden. PolicyData CatalogName Name of the catalogs associated with the policy. This field is checked during policy evaluation. Categories Name of the categories associated with the policy. This field is checked during policy evaluation. SubCategories Name of the subcategories associated with the policy.
Example request body { "Id": 0, "Name": "Policy", "Description": "Policy", "Enabled": true, "DefaultPolicy": false, "PolicyData": { "Catalogs": [ { "CatalogName": "iDRAC", "Categories": [0], "SubCategories": [0] }, { "CatalogName": "Application", "Categories": [0], "SubCategories": [0] } ], "Severities": [16, 1, 2, 4, 8], "Devices": [1714], "Groups": [], "DeviceTypes": [1000], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.
"Catalogs": [ { "CatalogName": "iDRAC", "Categories": [ 0 ], "SubCategories": [ 0 ] }, { "CatalogName": "Application", "Categories": [ 0 ], "SubCategories": [ 0 ] } ], "Severities": [ 16, 1, 2, 4, 8 ], "Devices": [ 1714 ], "DeviceTypes": [ 1000 ], "Groups": [], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.
{ ] } "Name": "maxLength", "Value": "255" }, { "Name": "message", "Value": "Event occurred for Device Name: $name, Device IP Address: $ip, Service Tag: $identifier, Time: $time, Severity: $severity, $message", "Type": "string", "TypeParams": [ { "Name": "maxLength", "Value": "255" } ] } ], "TemplateId": 50 } ] }, "State": true } /api/AlertService/AlertPolicies(Id) This URI represents a specific policy within the collection.
8, 16 } ], "Devices": [], "DeviceTypes": [], "Groups": [ 4 ], "Schedule": { "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 64.
Table 64. Attributes (continued) Attribute name Description Groups List of groups associated to the policy. This field is checked 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 checked during policy evaluation. 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.
"Devices": [1914], "Groups": [], "DeviceTypes": [1000], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.000", "CronString": "* * * ? * * *" }, "Actions": [ { "TemplateId": 50, "Name": "Email", "ParameterDetails": [ { "Name": "subject", "Value": "Device Name: $name, Device IP Address: $ip, Severity: $severity" }, { "Name": "to", "Value": "test@dell.com" }, { "Name": "from", "Value": "MCSIApplication@Dell.
"Severities": [ 16, 1, 2, 4, 8 ], "Devices": [ 1914 ], "DeviceTypes": [ 1000 ], "Groups": [], "Schedule": { "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.
] } } ], "TemplateId": 50 }, "State": true Table 65. 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.
Table 65. Attributes (continued) Attribute name Description PolicyCriteria Link to the criteria for the evaluation of the alert contents with the policy contents. This evaluation determines if the policy is valid and if any actions are triggered. /api/AlertService/AlertPolicies(Arg1)/PolicyCriteria This URI represents the criteria used for matching the policy with incoming events. The criteria determine if the policy can trigger any actions. Table 66.
Table 67. Attributes (continued) Attribute name Description 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. ComparisonTypeName Name of comparison type. /api/AlertService/AlertPolicies(Arg1)/ PolicyCriteria(Arg2) This URI represents a specific criteria for a specific policy.
/api/AlertService/AlertPolicies(Arg1)/PolicyActions This URI represents the actions associated with a policy. Table 69. Filters Attribute name Description Top Top records to return. Default value is 100. Skip Maximum records to skip. Default value is 0. Arg1 Filter by list of policies IDs. Default value is 0. Id Filter by list of action IDs. Default value is 0. TemplateId Filter by list of template IDs. Default value is 0.
Table 70. Attributes (continued) Attribute name Description Description Additional description of the template. Disabled Indicates if template is enabled or disabled. ParameterDetails List of other parameter that the template can carry and apply. /api/AlertService/AlertPolicies(Arg1)/ PolicyActions(Arg2) This URI represents a specific action associated with a specific policy. GET method for PolicyActions(Arg2) This method returns a specific action associated with a specific policy.
/api/AlertService/AlertActionTemplates This URI represents the alert-action templates. GET method for AlertActionTemplates This method returns the alert-action templates. Description Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(AlertService.AlertActionTemplate)", "@odata.count": 5, "value": [ { "@odata.
Table 72. Attributes (continued) Attribute name Description Description Description of the action template. Disabled Indicates if the template is enabled or disabled. ParameterDetail Extra parameter that the template can carry and apply. /api/AlertService/AlertActionTemplates(Id) This URI represents a specific alert-action template. GET method for AlertActionTemplates(Id) This method returns a specific alert-action template. Description Returns a specific alert-action template.
Example request body { "AlertPolicyIds": [100,200,300] } Or { "AllPolicies": true } /api/AlertService/Actions/ AlertService.DisableAlertPolicies POST method for AlertService.DisableAlertPolicies This method disables the selected alert policies. Description Disables the selected alert policies. Privilege MONITORING_SETUP HTTP response codes 201 Example request body Request: { "AlertPolicyIds": [100,200,300] } Or InRequestput: { "AllPolicies": true } /api/AlertService/Actions/ AlertService.
{ } "AllPolicies": true Alert definitions /api/AlertService/AlertMessageDefinitions This URI represents the definitions for the alert messages. Table 74. Filters Filter name Description Top Top records to return. Default value is 100. Skip Maximum records to skip. Default value is 0. MessageId Filter by message ID. Category Filter by event ID. SubCategory Filter by subcategory. Message Filter by message. Severity Filter by severity.
} } "Message": "Event definition not found for Event.", "RecommendedAction": "No response action is required.", "Severity": "Informational", "Category": "Configuration", "SubCategory": null, "DetailedDescription": "An unknwon event was received from a device." Table 75. Attributes Attribute Description MessageId ID of message definition. Prefix A 3-letter prefix of the message. SequenceNo Sequence number of the message. Message Message indicating the issue.
Table 76. Attributes (continued) Attribute Description Prefix A 3-letter prefix of the message. SequenceNo Sequence number of the message. Message Message indicating the issue. RecommendedAction Recommended action for the message. Severity Type of severity. Category Category associated to the message. SubCategory Subcategory associated with the message. DetailedDescription Detailed description of the issue.
/api/AlertService/ AlertMessageDefinitionsCategories('Name') This URI represents a specific alert definition category. GET method for AlertMessageDefinitionsCategories('Name') This method returns the details of a specific alert definition category. Description Returns the details of a specific alert definition category. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#AlertService.AlertMessageDefinitionCategory/$entity", "@odata.
}, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "IP Address" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Job Control" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Licensing" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Lifecycle Controller" }, { "@odata.type": "#AlertService.
"@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Redundancy" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Server" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Software Change" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Software Config" }, { "@odata.type": "#AlertService.
6 Configure Topics: • • • • Firmware Template Service Identity pools Network Configuration Service 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 { 122 Configure "@odata.context": "/api/$metadata#Collection(UpdateService.Catalogs)", "@odata.
{ "BaselineId": 11, "BaselineName": "500" }, { "BaselineId": 6, "BaselineName": "Test" }, { "BaselineId": 7, "BaselineName": "Test 100" }, { "BaselineId": 8, "BaselineName": "Test 2500+" } Example request body ] } } ], "Repository": { "@odata.type": "#UpdateService.Repository", "Id": 12, "Name": "Dell", "Description": "", "Source": "downloads.dell.
Table 77. Attributes (continued) Attribute Description Status Status of creating the catalog. TaskId The identifier of the task or job that is created to download the catalog. BaseLocation The repository location for the catalog (for example for online catalogs, the location is downloads.dell.com) ManifestIdentifier Catalog manifest identifier *. ReleaseIdentifier Catalog release identifier *. ManifestVersion Catalog manifest version *. ReleaseDate Catalog release date *.
} } "DomainName":"", "Username":"", "Password":"", "CheckCertificate":false /api/UpdateService/Catalogs(Id) This URI represents a specific catalog. GET method for Catalogs(Id) This method returns the details of a specific catalog. Description Returns the details of a specific catalog. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#UpdateService.Catalogs/$entity", "@odata.type": "#UpdateService.Catalogs", "@odata.
PUT method for Catalogs(Id) This method updates the catalog details. Description Updates details of a specific catalog. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#UpdateService.Catalogs/$entity", "@odata.type": "#UpdateService.Catalogs", "@odata.id": "/api/UpdateService/Catalogs(28)", "Id": 28, "Filename": "CatalogA00.
"@odata.count": 6, "value": [ { "@odata.type": "#UpdateService.Baselines", "@odata.id": "/api/UpdateService/Baselines(8)", "Id": 8, "Name": "Test 2500+", "Description": "", "CatalogId": 22, "RepositoryId": 12, "TaskId": 27734, "RepositoryName": "Dell", "RepositoryType": "DELL_ONLINE", "LastRun": "2018-08-08 21:22:36.
Table 78. Attributes (continued) Attribute Description NumberOfCritical Number of critical devices. NumberOfWarning Number of warning devices. NumberOfNormal Number of normal devices. NumberOfDowngrade Number of downgrade devices. Link to Device compliance Report Gives the link to the device compliance report. POST method for Baselines This method creates a baseline. Description Creates a baseline.
}, { }, { }, { }, { }, { }, { }, { }, { } ] } ] } "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": "DEVICE" } "Id": 25023, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25032, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25033, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25035, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25038, "Typ
Table 79. Attributes Attribute Description Name Name of the Baseline Description Description of the Baseline CatalogId ID of the catalog - The user needs to enumerate all catalogs and match the "Name" of the repository with the input provided at creation time RepositoryId ID of the repository - Derived from the catalog response DowngradeEnabled If the firmware can be downgraded Is64Bit This should always be set to true - The DUP files used are 64 bit DUPs only.
}, { }, { }, { }, { }, { }, { }, { }, { } "Id": 1000, "Name": "DEVICE" "Id": 25028, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25029, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25030, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25031, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25033, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25035, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25580, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25585, "Type": { "Id": 1000, "Name": "DEVICE" }
PUT method for Baselines(Id) This method updates the baseline details. Description Returns the baseline details. 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.
Privilege VIEW HTTP response codes 200 Example response body { } "DeviceIds": [10229] api/UpdateService/FirmwareBaselineSummary This API represents the firmware baseline information. GET method for baseline summary This API returns the total number of baselines that meet a specific compliance status. Description Returns the total number of baselines that meet a specific compliance status. Privilege VIEW HTTP response code 200 Example response body { "@odata.
/api/UpdateService/ComplianceStatuses This UR returns compliance status information. GET method for /api/UpdateService/ComplianceStatuses This method returns the compliance statuses. Description Returns compliance statuses. Privilege HTTP response code Example response body 200 { "@odata.context": "/api/ $metadata#Collection(UpdateService.ComplianceStatus)", "@odata.count": 4, "value":[ { "@odata.type": "#UpdateService.ComplianceStatus", "@odata.
Example Request: Response: { "@odata.context": "/api/ $metadata#Collection(UpdateService.DeviceComplianceReport)", "@odata.count": 1, "value": [ { "@odata.type": "#UpdateService.DeviceComplianceReport", "@odata.
HTTP response codes Example response body 200 { "@odata.context": "/api/ $metadata#Collection(UpdateService.DeviceComplianceReport)", "@odata.count": 1, "value":[ { "@odata.type": "#UpdateService.DeviceComplianceReport", "@odata.
HTTP response codes Example request body 200 Header: Content-Type: application/octet-stream Request: Example response body A numeric token ID is returned. /api/UpdateService/Actions/UpdateService.RemoveFile POST method for RemoveFile This method removes a file from the system. Description Removes a file identified by the numeric token ID. Privilege DEVICE_UPDATE HTTP response codes 200 Example request body { } "FileToken": "1481131455800" /api/UpdateService/Actions/ UpdateService.
/api/UpdateService/Actions/ UpdateService.RemoveCatalogs POST method for RemoveCatalogs This method deletes catalogs. Description Deletes a catalog. Privilege BASELINE_MANAGEMENT HTTP response codes 204 Example request body { } "CatalogIds":["12"] /api/UpdateService/Actions/ UpdateService.RemoveBaselines POST method for RemoveBaselines This method deletes baselines. Description Deletes baselines.
$metadata#Collection(UpdateService.RollbackSoftwares)", "@odata.count": 1, "value": [ { "@odata.type": "#UpdateService.RollbackSoftwares", "@odata.id": "/api/UpdateService/RollbackSoftwares(1)", "Id": 1, "InstanceId": "DCIM:PREVIOUS#741__BIOS.Setup.1-1", "DeviceId": 10143, "RollbackVersion": "1.0.2", "CurrentVersion": "1.6.
/api/UpdateService/Actions/ UpdateService.GetSingleDupReport POST method for GetSingleDupReport This method returns the report of a Dell Update Package (DUP). Description Returns the report of a DUP.
} }, { ] } "DeviceId": 1682, "DeviceReport": { "ComponentUpdateAction": "UPGRADE", "DeviceTypeId": "1000", "ComponentCurrentVersion": "1.57.57", "ComponentUriInformation": null, "DeviceTypeName": "SERVER", "ComponentVersion": "2.30.30.30", "ComponentCriticality": "Recommended", "DeviceId": "1682", "DeviceServiceTag": "7T2W1V1", "IsCompliant": "CRITICAL", "ComponentTargetIdentifier": "25227", "ComponentSourceName": "DCIM:INSTALLED#iDRAC.Embedded.
"NumberOfNormal": 3, "NumberOfDowngrade": 0 ] } }, "Targets": [ { "Id": 25019, "Type": { "Id": 1000, "Name": "DEVICE" } } ], "DeviceComplianceReports": [ { "Id": 5, "DeviceId": 25019, "ServiceTag": "testing", "DeviceModel": "POWEREDGE MX7000", "DeviceTypeId": 2000, "DeviceTypeName": "MX-testing", "DeviceName": null, "FirmwareStatus": "Compliant", "ComplianceStatus": "OK", "RebootRequired": false, "ComponentComplianceReports": [] } ] /api/UpdateService/Actions/ UpdateService.
Template Service /api/TemplateService/TemplateTypes This URI represents the types of templates. GET method for TemplateTypes This method returns information about each type of template, indicating the types of devices for which configuration is supported, such as chassis and servers. Description Returns information for each supported template type. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(TemplateService.
HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(TemplateService.TemplateViewTypeModel)", "@odata.count": 5, "value": [ { "@odata.id": "/api/TemplateService/TemplateViewTypes(0)", "Description": "None" }, { "@odata.id": "/api/TemplateService/TemplateViewTypes(1)", "Description": "Compliance" }, { "@odata.id": "/api/TemplateService/TemplateViewTypes(2)", "Description": "Deployment" }, { "@odata.
Example response body { "@odata.context": "/api/$metadata#Collection(TemplateService.Template)", "@odata.count": 8, "value": [ { "@odata.
"LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(3)/Views" } ] }, { "@odata.
"Views": [ { "@odata.id": "/api/TemplateService/Templates(6)/Views" } ] }, { "@odata.id": "/api/TemplateService/Templates(7)", "Id": 7, "Name": "iDRAC 14G Enable Performance Profile for Software Defined Storage", "Description": "Tune workload for Performance Optimized Software Defined Storage ", "SourceDeviceId": 0, "TypeId": 2, "ViewTypeId": 4, "TaskId": 0, "HasIdentityAttributes": false, "Status": 0, "IdentityPoolId": 0, "IsBuiltIn": true, "CreatedBy": "system", "CreationTime": "2017-11-30 19:02:11.
HTTP response codes 200 Example request body { } Example response body "Name": "Test Create", "Description": "This is a test template", "TypeId": 2, "ViewTypeId": 2, "SourceDeviceId": 5514, "Fqdds": "idrac,system,nic,lifecycleController,eventFilters" ID of the template Table 84. Attributes Attribute Description Name Template name Description Definition for the template TypeId Template type. For more information, see /TemplateService/ TemplateTypes. ViewTypeId Template View type.
"Fqdds": "" } Table 85. Attributes Attribute Description Name Template name TypeId Template type. For more information, see /TemplateService/ TemplateTypes. ViewTypeId Template View type. For more information, see / TemplateService/TemplateViewTypes. SourceDeviceId The identifier of the device—the reference device—from which a template is created. FQDDs The FQDDs to copy from the reference device, as a commaseparated string.
} "Views": [ { "@odata.id": "/api/TemplateService/Templates(10)/Views" } ] Table 86. Attributes Attribute Description Id Unique identifier for referencing a template. Name Template name. Description Definition for the template. SourceDeviceId The identifier of the device whose configuration was used as a reference for creating the template. TypeId Template type. For more information, see /TemplateService/ TemplateTypes. ViewTypeId Template View type.
Example response body ID of the template Example to update Example request body a compliance { template "Id": 12, attriubtes "Name": "Example Compliance Template", "Attributes": [ { "Id": 3592, "Value": "Test OS Name", "IsIgnored": false } ] } Example response body ID of the template Table 87.
"@odata.type": "#TemplateService.Template", "@odata.id": "/api/TemplateService/Templates(10)", "Id": 10, "Name": "Switch-FJM0Y42", "Description": null, "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!SerialNumber CN2829865N0013\n!FCPortsPresent FALSE\n!QuadPortsPresent 33 37 49 53\n!IOM-Mode standalone\n!CheckSum 4fd3e503fd1df86f419aecd3cd23bd21\n! Cloning Heade
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 \nsnmp-server enable traps snmp linkdown linkup \nsnmp-server enable traps stack\n!\n!\nclock timezone TZ-68 5 30 \n!\nfeature fip-snoopi
/api/TemplateService/Templates(Id)/Views This URI represents the views of a specific template. GET method for Views of a template This method returns the views available for a specific template. Each view displays template data in a specific structure. Description Returns the views available for a specific template. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(TemplateService.AttributeView) HYPERLINK "mailto:\",\"@odata.
/api/TemplateService/Templates(Id)/Views(Id) This URI represents a specific view of a template. GET method for Views(Id) This method returns the details of a specific view of a template. Description Returns a specific view of a template. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#TemplateService.AttributeView/$entity", "@odata.
HTTP response codes Example response body 200 { "@odata.context": "/api/$metadata#TemplateService.AttributeViewDetail/ $entity", "@odata.id": "/api/TemplateService/Templates(11)/Views(1)/ AttributeViewDetails", "Id": 1, "Name": "TemplateSpecific", "Description": "The hierarchy consists of template specific component classes, groups (from the attribute registry) and attributes.
"AttributeEditInfoId": 1643, "DisplayName": "LCAttributes "Description": null, "Value": "Apply always", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3567, "CustomId": 0, "AttributeEditInfoId": 1804, "DisplayName": "LCAttributes "Description": null, "Value": "Enabled", "IsReadOnly": false, "IsIgnored": true }, { "AttributeId": 3560, "CustomId": 0, "AttributeEditInfoId": 1855, "DisplayName": "LCAttributes "Description": null, "Value": "Off", "IsReadOnly": false, "IsIgnored": false } { "Attribut
} "Attributes": [] ], "TemplateEditInfoDetails": { "@odata.id": "/api/TemplateService/Templates(11)/Views(1)/ AttributeViewDetails/TemplateEditInfoDetails" } } Table 90. Attributes Attribute Description AttributeId Unique identifier for an attribute. AttributeEditInfoId Identifier for editing-related info for the attribute. DisplayName Text for displaying the name of the attribute. Description Attribute definition. Value The current value for the attribute.
[ ] 562, 563 }, { "Id": 3636, "DataType": 4308, "Description": "Specify the iSCSI Qualified Name (IQN) of the eighth iSCSI storage target.", "IsReadOnly": false, "IsSecure": false, "TextMinLength": 0, "TextMaxLength": 223, "ValueMin": 0, "ValueMax": 0, "DependencyText": null, "OptionSetId": 0, "DefaultOptionId": 0, "GenericNameId": 2258 }, { "Id": 3637, "DataType": 4308, "Description": "Specify the iSCSI Qualified Name (IQN) of the fifth iSCSI storage target.
} ] } "TextMaxLength": 32, "ValueMin": 0, "ValueMax": 0, "DependencyText": null, "OptionSetId": 0, "DefaultOptionId": 0 /api/TemplateService/Templates(Id)/Views(Id)/ DeviceAttributeViewDetails(Id) This URI represents the device-specific attributes for a view of a template. GET method for DeviceAttributeViewDetails(Id) This method returns the device-specific attributes for a view of a template. Description Returns the device-specific attributes for a view of a template.
} }, { ] "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3298, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 0, "CustomId": 43, "AttributeEditInfoId": 0, "DisplayName": "Vlan Tagged", "Description": null, "Value": null, "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 0, "CustomId": 43, "AttributeEditInfoId": 0, "DisplayName": "Vlan UnTag
{ "GroupNameId": 1, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 3, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3369, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum "Description": null, "Value": "20", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3370, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnore
"GroupNameId": 2, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 1, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3431, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", "Description": null, "Value": "20", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3432, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "Is
} ] "Value": "30", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3485, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] }, { "GroupNameId": 2, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 3, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3503, "CustomId": 0, "AttributeEditInfoId": 2969,
} ] "Value": "30", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3523, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] } ], "Attributes": [] } ], "Attributes": [] } ], "TemplateEditInfoDetails": { "@odata.
] } } ] } "AttributeId": 18968, "CustomId": 0, "AttributeEditInfoId": 0, "DisplayName": "IOA.Hostname", "Value": "dell-lex-c3", "IsReadOnly": false, "IsIgnored": false /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 response body "BaseEntityId" : 25010 The reply is a hierarchical structure for the cards, ports, and partitions for which identities were assigned, or that have boot options.
] "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.Clone POST method for TemplateService.Clone This method creates a clone of a template. Description Clones a template. Privilege DEVICE_CONFIGURATION HTTP response codes 200 Example request body { } Example response body "SourceTemplateId": 12, "NewTemplateName": "clone example", "ViewTypeId": 2 ID of cloned template /api/TemplateService/Actions/TemplateService.Export POST method for TemplateService.Export This method exports a template.
/api/TemplateService/Actions/TemplateService.Import POST method for TemplateService.Import This method creates a template from a specified configuration text in .XML format. The text is generally from an exported template file or an SCP file that is created from a device. The text must use the same structure as SCP files. Description Creates a template from a specified configuration text in SCP XML format.
lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/16\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/17\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/18\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/19\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/20\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/21\n auto vlan\n! \n proto
} "Schedule" : { "RunNow" : , "RunLater" : , "Cron" : "", "StartTime" : "", "EndTime" : "" }, "Attributes" : [ { "DeviceId" : , "Attributes" : [ { "Id" : , "Value" : "", "IsIgnored" : }, ... ] },...
Example response body ID of created task Deployment using Boot to ISO method { "Id":9, "TargetIds":[ "10135" ], } }, ], }, } "NetworkBootIsoModel":{ "BootToNetwork":true, "ShareType":"CIFS", "IsoPath":"CentOS-8.1.1911-x86_64-boot.iso", "IsoTimeout":"1", "ShareDetail":{ "IpAddress":"X.X.X.X", "ShareName":"cifs", "User":"Administrator", "Password":"passwd" "Attributes":[ "Options":{ "Schedule":{ "RunNow":true, "RunLater":false } POST method for TemplateService.
"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. Description Updates the network configuration parameters of a template.
} Table 91. Attributes Attribute name Description BondingTechnology Possible values are: • • • PropagateVlan NoTeaming LACP Other Possible values are: • • True False /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.
Identity pools /api/IdentityPoolService/IdentityPools This URI represents the identity pools. GET method for IdentityPools This method returns the details of all identity pools. Description Returns identity pools. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(IdentityPoolService.IdentityPool)", "@odata.count": 2, "value": [ { "@odata.type": "#IdentityPoolService.IdentityPool", "@odata.
} }, "FcSettings": { "Wwnn": { "IdentityCount": 260, "StartingAddress": "IAAWFhYWFgE=" }, "Wwpn": { "IdentityCount": 260, "StartingAddress": "IAEWFhYWFgE=" } }, "UsageCounts": { "@odata.id": "/api/IdentityPoolService/IdentityPools(1)/UsageCounts" }, "UsageIdentitySets@odata.navigationLink": "/api/IdentityPoolService/ IdentityPools(1)/UsageIdentitySets" }, { "@odata.type": "#IdentityPoolService.IdentityPool", "@odata.
"StartingAddress": "IACAgICAgAA=" }, "Wwpn": { "IdentityCount": 85, "StartingAddress": "IAGAgICAgAA=" } }, "UsageCounts": { "@odata.id": "/api/IdentityPoolService/IdentityPools(10)/UsageCounts" }, "UsageIdentitySets@odata.navigationLink": "/api/IdentityPoolService/ IdentityPools(10)/UsageIdentitySets" } ] } POST method for IdentityPools This method creates an identity pool. Description Creates an identity pool.
} } } "StartingAddress": "IAGAgICAgAA=" /api/IdentityPoolService/IdentityPools(Id) This URI represents a specific identity pool. GET method for IdentityPools(Id) This method returns the details of a specific identity pool. Description Returns a specific identity pool. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#IdentityPoolService.IdentityPool/ $entity", "@odata.type": "#IdentityPoolService.IdentityPool", "@odata.
"IdentityCount": 85, "StartingAddress": "IACAgICAgAA=" }, "Wwpn": { "IdentityCount": 85, "StartingAddress": "IAGAgICAgAA=" } }, "UsageCounts": { "@odata.id": "/api/IdentityPoolService/IdentityPools(4)/UsageCounts" }, "UsageIdentitySets@odata.navigationLink": "/api/IdentityPoolService/ IdentityPools(4)/UsageIdentitySets" } PUT method for IdentityPools(Id) This method updates a specific identity pool. Description Updates an identity pool.
} } } "StartingAddress": "IAGAgICAgAA=" Table 92.
"IdentityTypeId": 9, "TotalRequested": 75, "TotalReserved": 0, "TotalDeployed": 0 }, { "IdentityTypeId": 10, "TotalRequested": 65, "TotalReserved": 0, "TotalDeployed": 0 }, { "IdentityTypeId": 8, "TotalRequested": 55, "TotalReserved": 42, "TotalDeployed": 0 }, { "IdentityTypeId": 3, "TotalRequested": 85, "TotalReserved": 3, "TotalDeployed": 0 }, { "IdentityTypeId": 4, "TotalRequested": 85, "TotalReserved": 3, "TotalDeployed": 0 }, { } ] } "IdentityTypeId": 7, "TotalRequested": 0, "TotalReserved
"Details@odata.navigationLink": "/api/IdentityPoolService/ IdentityPools(4)/UsageIdentitySets(1)/Details" }, { "@odata.type": "#IdentityPoolService.UsageIdentitySet", "@odata.id": "/api/IdentityPoolService/IdentityPools(4)/ UsageIdentitySets(2)", "IdentitySetId": 2, "Name": "iSCSI", "Details@odata.navigationLink": "/api/IdentityPoolService/ IdentityPools(4)/UsageIdentitySets(2)/Details" }, { "@odata.type": "#IdentityPoolService.UsageIdentitySet", "@odata.
/api/IdentityPoolService/IdentityPools(Id)/ UsageIdentitySets(Id)/Details This URI represents usage details for a specific identity pool and identity set (protocol). GET method for Details of UsageIdentitySets(Id) This method returns the usage details for a specific identity pool and identity set or protocol. NOTE: • To get the identifier for each available Identity Pool, use the API /IdentityPoolService/IdentityPools.
} ] /api/IdentityPoolService/IdentityStates This URI represents the identity states for the identities in an identity pool. GET method for IdentityStates This method returns the identity states, such as Reserved and Assigned, for the identities in an identity pool. Description Returns identity states. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(IdentityPoolService.IdentityState)", "@odata.count": 2, "value": [ { "@odata.
} "Description": "Assigned to a profile; deployment pending." /api/IdentityPoolService/Actions/ IdentityPoolService.DeleteIdentityPools POST method for deleting identity pools This method deletes identity pools. Description Deletes identity pools. Privilege TEMPLATE_MANAGEMENT HTTP response codes 200 Example request body { } "IdentityPoolIds":[1,3,4] Network Configuration Service This resource enables you to access the network service and perform network-related tasks.
}, { }, { } ] } "CreatedBy": "system", "CreationTime": "1970-01-31 00:12:56.376", "UpdatedBy": null, "UpdatedTime": "1970-01-31 00:12:56.376", "InternalRefNWUUId": "00bc07d7-5d3c-429e-96a3-5c6600230851" "@odata.type": "#NetworkConfigurationService.Network", "@odata.id": "/api/NetworkConfigurationService/Networks(10134)", "Id": 10134, "Name": "Test", "Description": "test", "VlanMaximum": 1, "VlanMinimum": 1, "Type": 3, "CreatedBy": "system", "CreationTime": "1970-01-31 00:12:56.
Table 93. Attributes (continued) Attribute name Description Orderby Order to apply to the output InternalRefId Reference ID used for internal purposes. POST method for Networks This method creates a network. Description Creates a network. Privilege TEMPLATE_MANAGEMENT HTTP response codes 201 Example request body { } Example response body "Name": "abc-1", "Description": "abc", "VlanMaximum": 19, "VlanMinimum": 19, "Type": 1 { "@odata.context": "/api/$metadata#NetworkConfigurationService.
} "Id": 42214, "Name": "Network-1", "Description": "abc", "VlanMaximum": 3, "VlanMinimum": 3, "Type": 1, "CreatedBy": "root", "CreationTime": "1970-01-01 01:01:48.181", "UpdatedBy": null, "UpdatedTime": "1970-01-01 01:01:48.181", "InternalRefNWUUId": 0 PUT method for Networks(Id) This method updates an existing network. Description Updates a network.
Table 94. Attributes (continued) Attribute name Description NOTE: To define a profile which is not in a range, the VlanMaximum and VlanMinimum need to be same. Type Network profile definition type. For more information, see /api/ NetworkConfigurationService/NetworkTypes. DELETE method for Networks(Id) This method deletes a network from the system. Description Deletes a network.
Table 95. 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. NetworkTrafficType Network traffic types. Possible values are Ethernet and FCoE. QosType The type of quality-of-service (QoS). /api/NetworkConfigurationService/NetworkTypes(Id) This URI represents a specific network type within the collection.
{ "@odata.id": "/api/NetworkConfigurationService/QosTypes(1)", "Id": 1, "Name": "Platinum" }, . . { } ] } "@odata.id": "/api/NetworkConfigurationService/QosTypes(4)", "Id": 4, "Name": "Bronze" Table 96. Attributes Attribute name Description Id ID of the QoS type. Name Name of the QoS type. /api/NetworkConfigurationService/QosTypes(Id) This URI represents a specific QoS type within the collection. GET method for QosTypes(Id) This method returns a specific QoS type.
} "NetworkIds": [42214,42314] api/NetworkConfigurationService/Actions/ NetworkConfigurationService.ImportVLANDefinitions This URI imports all network profiles. POST method for importing network profiles This method imports all network profiles. Description Imports all network profiles.
api/NetworkConfigurationService/Actions/ NetworkConfigurationService.ExportVLANDefinitions This URI exports all network profiles. POST method for exporting VLAN definitions This method exports all network profiles. Description Exports all network profiles. Privilege VIEW HTTP response code 201 Example response body None api/NetworkConfigurationService/Actions/ NetworkConfigurationService.ValidateNetworkDefinitionFi le This URI validates the network profiles, which you want to import.
Table 98. Attributes (continued) Attribute name Description Name Name of the network. Description Description of the network. 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.
7 Devices Topics: • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • 196 /api/DeviceService /api/DeviceService/Devices /api/DeviceService/Devices?$filter=Type eq 1000 /api/DeviceService/Devices(Id) /api/DeviceService/Devices(Id)/InventoryDetails /api/DeviceService/Devices(Id)/InventoryDetails(InventoryType) /api/DeviceService/Devices(Id)/Settings('ReplicableChassisConfigurations') /api/DeviceService/Devices(Device_ID)/Settings('LocalAccessConfiguration') /api/DeviceService
/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.navigationLink": "/api/DeviceService/Devices", "DeviceStatuses@odata.
"AssetTag": "12345678910", "SystemId": 2031, "DeviceName": "IOM-C1", "LastInventoryTime": "2019-09-06 06:30:11.936", "LastStatusTime": "2019-09-06 06:30:06.794", "DeviceSubscription": null, "DeviceCapabilities":[1, 802, 2, 18, 3, 803, 804, 5, 7, 8, 9], "SlotConfiguration":{"ChassisName": "MX-7BU0772", "ChassisId": "10069", "SlotNumber": "5", "SledBlockPowerOn": "null",…}, "DeviceManagement":[], "Actions": null, "InventoryDetails@odata.
DeviceService/Devices?$orderby=Identifier&$top=50&$skip=0, to select the first 50 devices. /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.
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)/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.navigationLink": "/api/DeviceService/ Devices(10074)/DeviceBladeSlots", "GraphicInfo": { "@odata.
"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.navigationLink": "/api/DeviceService/ Devices(10079)/SensorHealth", "VirtualSession": { "@odata.
"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.
"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.id": "/api/DeviceService/Devices(10085)/ InventoryTypes" }, "LogSeverities": { "@odata.
"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)/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": "/api/DeviceService/Devices(10053)/BlinkStatus" }, "PowerUsageByDevice@odata.
}, { }, { }, { }, { }, { }, { }, { ] } "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.1-1", "Manufacturer": "Matrox Electronics Systems Ltd.
}, { ] } "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.
}, { "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.
}, { }, { }, { }, { ] } "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" }, { "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": { "CapabilityId": 9, "Name": "BLINK", "Description": "Identify function on server" } "I
}, { }, { }, { }, { }, { }, { ] } } "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, "CapabilityType": { "CapabilityId": 31, "Name": "REMOTE_IPMI", "Descr
}, { ] } "Aisle": "Lakeln", "Datacenter": "AlladiaAnoop" "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('deviceManagement')", "InventoryType": "deviceManagement", "InventoryInfo": [ { "ManagementId": 5003, "IpAddress": "xx.xx.xx.
}, { 2", "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 "InstanceId": "DCIM:INSTALLED#304_C_Disk.Direct.0-0:AHCI.Embedded.2-1" }, { "Version": "3.20.
"@odata.
} ] "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": } "sysMemPrimaryStatus" "voltRollupStatus" "batteryRollupStatus" "licensingRollupStatus" "storageRollupStatus" "tempRollupStatus" "intrusionRollupStatus" /api/D
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 99. 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.
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": "VIEW_AND_MODIFY", "LcdPr
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": false, "LcdAccess": "VIEW_AND_MODIFY", "LcdPresence": "Present", "LcdCustomString": "", "LcdLanguage":
"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.000000-300", "LogSequenceNumber": 286411, "LogSeverity": 1000, "LogComment": "[set comment here]", "LogMessageId": "USR0030", "LogMessage": "Successfully logged in using root, from 10.32.22.
"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. Description Returns the recent activities for a specific device.
} ] /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.
} "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 Settings This method returns the details of the settings of a specific device. Description Returns the details of 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 101. 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" "@odata.type": "#DeviceService.DeviceSettingsMetadata", "Id": 2000, "Property": "redundancyPolicy", "Key": "GRID_REDUNDANCY", "Value": "GRID Redundancy", "Description": "Redundancy policy type is GRID redundancy" "@odata.type": "#DeviceService.
}, { }, { }, { }, { }, { }, { }, { }, { }, { 244 Devices "Id": 13000, "Property": "quickSyncAccess", "Key": "READ_WRITE", "Value": "Read-Write", "Description": "QuickSyncAccess is read write" "@odata.type": "#DeviceService.DeviceSettingsMetadata", "Id": 14000, "Property": "timeoutLimitUnit", "Key": "SECONDS", "Value": "Seconds", "Description": "Time out limit unit is seconds" "@odata.type": "#DeviceService.
}, { }, { }, { }, { }, { ] } } "Id": 19003, "Property": "lcdLanguage", "Key": "en", "Value": "English", "Description": "English" "@odata.type": "#DeviceService.DeviceSettingsMetadata", "Id": 19004, "Property": "lcdLanguage", "Key": "fr", "Value": "French", "Description": "French" "@odata.type": "#DeviceService.DeviceSettingsMetadata", "Id": 19005, "Property": "lcdLanguage", "Key": "de", "Value": "German", "Description": "German" "@odata.type": "#DeviceService.
} "@odata.count": 4, "value": [ { "@odata.id": "/api/DeviceService/GlobalExcludes(1)", "Id": 1, "Identifier": "9PKM9Z1", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 1, "NetworkAddress": "xx.xx.xx.xx" } ] }, { "@odata.id": "/api/DeviceService/GlobalExcludes(2)", "Id": 2, "Identifier": null, "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 2, "NetworkAddress": "xx.xx.xx.xx" } ] }, { "@odata.
Example response body 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. Privilege APPLIANCE_SETUP HTTP response codes 204 Example request body { } "Id": 0, "Identifier": "IPRange2", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 0, "NetworkAddress": "xx.xx.xx.xx-xx.xx.xx.
} ] /api/DeviceService/Actions/ DeviceService.RemoveFromExclusion This URI removes ranges from Global Exclusion. POST method for DeviceService.RemoveFromExclusion This method removes ranges in global exclusion. Description Removes ranges in global exclusion. Privilege APPLIANCE_SETUP HTTP response codes 204 Example request body {"Ids": [1,2,3,4,5,6]} /api/DeviceService/Actions/ DeviceService.ValidateExcludes This URI validates global exclusion. POST method for DeviceService.
/api/DeviceService/Actions/ DeviceService.RemoveDevices This URI deletes an array of devices. POST method for DeviceService.RemoveDevices Description Deletes an array of devices.
8 Diagnostic Topics: • /api/DeviceService/Devices(Id)/Actions/DeviceService.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 Topics: • • • • • • • • • • • • • • • • • • /api/GroupService/Groups /api/GroupService/Groups(Id) /api/GroupService/Groups(Id)/Devices /api/GroupService/Groups(Id)/GroupDevicesSummary /api/GroupService/Groups(group id)/AllLeafDeviceSummaries /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000 /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0 /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25
} ] } "DefinitionDescription": "Root group for all Types of Devices.", "TypeId": 2000, "MembershipTypeId": 24, "Devices": [ { "@odata.id": "/api/GroupService/Groups(64)/Devices" } ], "AllLeafDevices": [ { "@odata.id": "/api/GroupService/Groups(64)/AllLeafDevices" } ], "GroupHierarchy": [ { "@odata.id": "/api/GroupService/Groups(64)/GroupHierarchy" } ], "SubGroups": [ { "@odata.id": "/api/GroupService/Groups(64)/SubGroups" } ], "GroupDevicesSummary": [ { "@odata.
Table 102. Attributes (continued) Attribute name Description • 24 — Dynamic Link Devices Group link to list group devices. AllLeafDevices Group link to list all group sub groups devices. GroupHierarchy Group link to list the group hierarchy. SubGroup Group link to display the list of sub groups of this group. GroupDevicesSummary Group link to display a summary of all group devices. Table 103. Filters Attribute name Description Top Top records to return. Default value is 100.
Example response body { } "@odata.context": "$metadata#GroupService.Group/$entity", "@odata.id": "/api/GroupService/Groups(64)", "Id": 64, "Name": "All Devices", "Description": "Group associated to all devices.", "GlobalStatus": 5000, "ParentId": 0, "CreationTime": "2017-06-08 18:48:27.069", "UpdatedTime": "2017-06-08 21:15:01.746", "CreatedBy": "system", "UpdatedBy": "", "Visible": true, "DefinitionId": 500, "DefinitionDescription": "Root group for all Types of Devices.
Table 104. Attributes (continued) Attribute name Description DefinitionDescription Definition description of the group. TypeId Group type. • • • • • MembershipTypeId 1000 — Internal 2000 — Predefined 3000 — User defined 4000 — Discovery defined 5000 — MCM group Group membership type. • • 12 — Static 24 — Dynamic Link Devices Group link to list group devices. AllLeafDevices Group link to list all group sub groups devices. GroupHierarchy Group link to list the group hierarchy.
} "DefinitionDescription": "" DELETE method for Groups(Id) This method deletes a group from the collection. Description Deletes a group. Privilege DEVICE_CONFIGURATION HTTP response codes 204 Example request body { } "Id": 1564 Table 105. Attributes Attribute name Description Id ID of the group to be deleted. /api/GroupService/Groups(Id)/Devices This URI represents the devices within a group. GET method for Devices This method returns the list of devices within a specific group.
"LastStatusTime": "2017-06-08 21:31:41.
} ] } } ], "Temperature": { "@odata.id": "/api/DeviceService/Devices(1614)/Temperature" }, "Power": { "@odata.id": "/api/DeviceService/Devices(1614)/Power" }, "BlinkStatus": { "@odata.id": "/api/DeviceService/Devices(1614)/BlinkStatus" }, "PowerUsageByDevice": [ { "@odata.id": "/api/DeviceService/Devices(1614)/PowerUsageByDevice" } ], "Faults": [ { "@odata.id": "/api/DeviceService/Devices(1614)/Faults" } ], "DeviceBladeSlots": [ { "@odata.
{ } ] } ] "StatusType": "Count": 29 }, { "StatusType": "Count": 5 }, { "StatusType": "Count": 4 }, { "StatusType": "Count": 17 }, { "StatusType": "Count": 0 } 1000, 2000, 3000, 4000, 5000, Table 107. Attributes Attribute name Description Id ID of the group. /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.
}, { "DeviceCapabilities": [ 1, 12, 5, 41, 2, 30, 8, 9, 1009, 10, 14, 4, 6, 3, 18, 15, 7, 31, 13, 50 ], "DeviceManagement": [ { "DeviceId": 14164, "ManagementId": 5000, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "74:86:7a:e5:c5:fe", "InstrumentationName": "idrac-8FWV992d", "ManagementProfile": [ { "ManagementProfileId": 5000, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.63.60.62", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.
8, 7, 6, 5, 50 }, { ], "DeviceManagement": [ { "DeviceId": 14214, "ManagementId": 5001, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "74:86:7a:e5:c5:fc", "InstrumentationName": "idrac-2476qm2.fwtestwin.com", "ManagementProfile": [ { "ManagementProfileId": 5001, "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.
] }, { } "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.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(14314)", "Id": 14314, "DeviceName": "100.97.135.
}, { "Model": "Dell XC430-Express", "Identifier": "1HYZT72", "DeviceServiceTag": "1HYZT72", "Type": 1000, "Status": 3000, "PowerState": 18, "ConnectionState": true, "ManagedState": 3000, "DeviceCapabilities": [ 6, 12, 4, 1009, 41, 15, 31, 30, 1001, 9, 5, 18, 14, 2, 13, 1, 50, 3, 10 ], "DeviceManagement": [ { "DeviceId": 14364, "ManagementId": 5004, "NetworkAddress": "XXX.XX.XXX.
"NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "64:00:6a:c4:13:a8", "InstrumentationName": "MINWINPC", "ManagementProfile": [ { "ManagementProfileId": 5010, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.61.60.60", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] }, { } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
}, { "Type": 1000, "Status": 1000, "PowerState": 17, "ConnectionState": true, "ManagedState": 3000, "DeviceCapabilities": [ 17, 31, 18, 13, 12, 3, 50, 14, 1009, 11, 30, 7, 10, 2, 15, 9, 4, 5, 8, 33, 16, 6, 1001, 1 ], "DeviceManagement": [ { "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.
41, 7, 2, 8, 33, 1009, 9, 10, 11, 31, 12, 1, 13, 18, 14, 15, 17, 3 }, { ], "DeviceManagement": [ { "DeviceId": 15133, "ManagementId": 5299, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:8c:ec:7a", "InstrumentationName": "idrac-4598BS2", "ManagementProfile": [ { "ManagementProfileId": 5299, "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.
3, 15, 8, 1006, 14, 18, 31, 50 }, { ], "DeviceManagement": [ { "DeviceId": 15136, "ManagementId": 5073, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:8e:a9:d1", "InstrumentationName": "idrac-GGWD9V2", "ManagementProfile": [ { "ManagementProfileId": 5073, "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.
3, 2, 7, 10, 31, 41, 1, 12, 6, 13, 30, 5, 14, 4, 15, 18, 1009, 8 }, { ], "DeviceManagement": [ { "DeviceId": 15230, "ManagementId": 5176, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "5c:f9:dd:d6:9d:54", "InstrumentationName": "idrac-6FP7F2S", "ManagementProfile": [ { "ManagementProfileId": 5176, "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.
1, 12, 6, 10 }, { ], "DeviceManagement": [ { "DeviceId": 15231, "ManagementId": 5178, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "10:98:36:9b:03:7f", "InstrumentationName": "localhost", "ManagementProfile": [ { "ManagementProfileId": 5178, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.63.60.61", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
] }, { } "ManagementProfileId": 5180, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.63.60.61", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(15250)", "Id": 15250, "DeviceName": "ngmmcm.publicnet.
}, { "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 4, 16, 12, 1009, 8, 11, 7, 1, 14, 2, 9, 3, 10, 18, 17, 15, 41, 13, 33 ], "DeviceManagement": [ { "DeviceId": 15251, "ManagementId": 5211, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:87:a9:7f", "InstrumentationName": "", "ManagementProfile": [ { "ManagementProfileId": 5211, "ManagementId": 0, "AgentName": "iDRAC", "Version": "3.36.36.36", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.
14, 15, 16, 17, 30, 31, 33, 41, 50, 1001, 1009 }, { ], "DeviceManagement": [ { "DeviceId": 15252, "ManagementId": 5303, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:8b:4d:b3", "InstrumentationName": "WIN-FP7P1J8GN1B", "ManagementProfile": [ { "ManagementProfileId": 5303, "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.
}, { "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.
}, { "ConnectionState": true, "ManagedState": 3000, "DeviceCapabilities": [ 1009, 7, 1001, 2, 6, 4, 5, 50, 12, 15, 14, 10, 31, 18, 1, 30, 9, 3, 13, 41, 8 ], "DeviceManagement": [ { "DeviceId": 15382, "ManagementId": 5222, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "5c:f9:dd:d7:e0:5a", "InstrumentationName": "bharathsled1", "ManagementProfile": [ { "ManagementProfileId": 5222, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.63.60.62", "ManagementURL": "https://XXX.XX.XXX.
33, 41, 8, 7, 6, 50, 5, 4, 17, 3, 1009, 2, 18 }, { ], "DeviceManagement": [ { "DeviceId": 15388, "ManagementId": 5306, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:8b:49:4f", "InstrumentationName": "WIN-8U5E5RHPHL0", "ManagementProfile": [ { "ManagementProfileId": 5306, "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.
}, { ], "DeviceManagement": [ { "DeviceId": 15389, "ManagementId": 5301, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:87:af:3c", "InstrumentationName": "idrac-4RKG9V2", "ManagementProfile": [ { "ManagementProfileId": 5301, "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.
/api/GroupService/Groups(group id)/ AllLeafDeviceSummaries?$filter=Type eq 4000 This URL returns the device data by specifying the device type. Get method for AllLeafDeviceSummaries?$filter=Type eq 4000 Description Returns the device data specified by device type. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(DeviceService.DeviceMinModel)", "@odata.count": 5, "value": [ { "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
"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.
}, { "InstrumentationName": "MX5108n Ethernet Switch", "ManagementProfile": [ { "ManagementProfileId": 5292, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http://XXX.XX.XXX.
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.
"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.
9, 5, 1, 3 }, { ], "DeviceManagement": [], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
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.type": "#DeviceService.DeviceMinModel", "@odata.
/api/GroupService/Groups(group id)/ AllLeafDeviceSummaries?$filter=Type eq 4000& $top=25&$skip=0&$orderby=Identifier asc This URL returns the device data by specifying the order—ascending or descending. GET method for AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0&$orderby=Identifier asc Description Returns the device data by specifying the order—ascending or descending. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
}, { "@odata.type": "#DeviceService.DeviceMinModel", "@odata.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(15255)", "Id": 15255, "DeviceName": "MX5108n Ethernet Switch", "Model": "MX5108n Ethernet Switch", "Identifier": "8XZ70T2", "DeviceServiceTag": "8XZ70T2", "Type": 4000, "Status": 1000, "PowerState": 17, "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 1, 5, 9, 3, 7, 2, 18, 8 ], "DeviceManagement": [ { "DeviceId": 15255, "ManagementId": 5292, "NetworkAddress": "XXX.
"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.XX", "MacAddress": "20:04:0F:13:3C:E2", "InstrumentationName": "MX5108n Ethernet Switch", "ManagementProfile": [ { "ManagementProfileId": 5294, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http://XXX.XX.XXX.
}, { ], "DeviceManagement": [], "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.
} ] } "TypeId": 3000, "MembershipTypeId": 12, "Devices": [ { "@odata.id": "/api/GroupService/Groups(19164)/Devices" } ], "AllLeafDevices": [ { "@odata.id": "/api/GroupService/Groups(19164)/AllLeafDevices" } ], "GroupHierarchy": [ { "@odata.id": "/api/GroupService/Groups(19164)/GroupHierarchy" } ], "SubGroups": [ { "@odata.id": "/api/GroupService/Groups(19164)/SubGroups" } ], "GroupDevicesSummary": [ { "@odata.id": "/api/GroupService/Groups(19164)/GroupDevicesSummary" } ] Table 108.
Table 108. Attributes (continued) Attribute name Description Link Devices Group link to list group devices. AllLeafDevices Group link to list all group sub groups devices. GroupHierarchy Group link to list the group hierarchy. SubGroup Group link to display the list of sub groups of this group. GroupDevicesSummary Group link to display a summary of all group devices. /api/GroupService/Groups(Id)/GroupHierarchy This URI represents the hierarchy of the subgroup within a group.
HTTP response codes Example response body 200 { "@odata.context": "$metadata#Collection(GroupService.GroupType)", "@odata.count": 5, "value": [ { "@odata.id": "/api/GroupService/GroupTypes(1000)", "Id": 1000, "Name": "Internal Group", "Description": "Internal group. This type is asssocated with a task operation." }, { "@odata.id": "/api/GroupService/GroupTypes(2000)", "Id": 2000, "Name": "Pre-Defined Group", "Description": "Pre-existing group." }, { "@odata.
Example response body { "@odata.context": "$metadata#GroupService.GroupType/$entity", "@odata.id": "/api/GroupService/GroupTypes(1000)", "Id": 1000, "Name": "Internal Group", "Description": "Internal group. This type is associated with a task operation." } Table 111. Attributes Attribute name Description Id ID of the group type. Name Name of the group type. Description Description of the group type. /api/GroupService/MembershipTypes This URI represents the membership types.
/api/GroupService/MembershipTypes(Id) This URI represents a specific membership type within the collection. GET method for MembershipTypes(Id) This method returns the details of a specific membership type. Description Returns the details of a specific membership type. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#GroupService.MembershipType/$entity", "@odata.
"ChildGroupId": 2614 }, { } ] } "ParentGroupId": 64, "ChildGroupId": 19164 /api/GroupService/Actions/ GroupService.AddMemberDevices POST method for GroupService.AddMemberDevices This method adds a device as a member to a group. Description Adds a device to a group. Privilege DEVICE_CONFIGURATION HTTP response codes 201 Example request body { } "GroupId": 100, "MemberDeviceIds" : [1414, 1464, 1214, 1264] /api/GroupService/Actions/ GroupService.
} ] "JOB_MANAGEMENT", "BASELINE_MANAGEMENT", "OPERATING_SYSTEM_DEPLOYMENT", "POWER_CONTROL", "DEVICE_CONFIGURATION", "MONITORING_SETUP", "POWER_MANAGEMENT", "VIEW", "APPLIANCE_SETUP" /api/GroupService/Actions/ GroupService.GroupsByPrivilegesAction POST method for GroupService.GroupsByPrivilegesAction This method returns the groups and devices on which the user has the specified privileges. Description Returns the groups and devices on which the user has the specified privileges.
10 Monitor Topics: • • Audit logs Jobs 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 { } 296 Monitor "@odata.context": "$metadata#Collection(ApplicationService.AuditLog)", "@odata.count": 7, "value": [ { "@odata.
/api/ApplicationService/AuditLogCategories This API represents information about audit log categories. GET method for /api/ApplicationService/AuditLogCategories This method returns the audit log categories. Description Returns the audit log categories. Privilege HTTP response code Example response body 200 { "@odata.context": "/api/ $metadata#Collection(ApplicationService.AuditLogCategories)", "@odata.count": 1, "value":[ { "@odata.type": "#ApplicationService.
"IpAddress": "xx.xx.xx.xx", "MessageArgs": "root || xx.xx.xx.xx", "MessageID": "CUSR0001", "CreatedDate": "2017-04-26 16:13:57.880" } Table 114. 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.
"UpdatedBy": null, "Visible": false, "Editable": false, "Builtin": true, "Targets": [ { "JobId": 10016, "Id": 500, "Data": "All-Devices", "TargetType": { "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.
Table 115. Filters (continued) Filter name Description NextRunEnd Filter by next run time end. LastRunBegin Filter by last run time start. LastRunEnd Filter by last run time end. Table 116. 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.
POST method for Jobs This method creates a job. Description Creates a job.
"JobId": 26097, "Id": 25915, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } } ], "Params": [], "Visible": true, "Editable": true, "Builtin": false Updating firmware Example response body using Compliance { method "JobName": "", "JobDescription": "", "Schedule": "", "State": "Enabled", "JobType": { "Id": 5, Name": "Update_Task" }, "Targets": [ { "Id": , "Data": ";;;;
{"Id":, "Data":";", "TargetType":{"Id":1000, "Name":"Device"}}, ], "Params": [ { "Key": "operationName", "Value": "INSTALL_FIRMWARE" }, { "Key": "complianceUpdate", "Value": "false" }, { "Key": "signVerify", "Value": "true" }, { "Key": "stagingValue", "Value": "true" } { "Key":"rebootType", "Value":""} ] } Configuring chassis name Example response body { "JobName": "Update Chassis Name", "JobDescription": "Update Chassis Name", "Schedule": "startno
} Quick Deploy of IOM Example response body { 304 Monitor } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task" } "JobName": "Quick Deploy Task", "JobDescription": "Quick Deploy Task", "Schedule": "startnow", "State": "Enabled", "JobType": { "Id": 42, "Name": "QuickDeploy_Task" }, "Params": [ { "Key": "operationName", "Value": "IOM_QUICK_DEPLOY" }, { "Key": "deviceId", "Value": "25041" }, { "Key": "rootCredential", "Value": "password" }, { "Key": "networkTypeV4", "Value": "Dhcp" }, { "Key": "protocolT
}, { "Key": "slotId=3", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" }, { "Key": "slotId=4", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" }, { "Key": "slotId=5", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" }, { } Quick Deploy of sleds ] } "Key": "slotId=6", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" Example response body { "JobName": "Quick Deploy", "JobDescription": "New Quick Deploy Configuration", "Schedule": "
"Key": "slotId=2", "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1" }, { "Key": "slotId=4", "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1" }, { "Key": "slotId=1", "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.
Rolling back Example response body firmware update { —Catalog method "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": "=
Failover of management module Example response body { } Chassis backup "JobName": "Failover Operation", "JobDescription": "Failover Operation", "Schedule": "", "State": "Enabled", "Targets": [ { "Id": 25039, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "operationName", "Value": "FAILOVER" } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task" } Example response body { "Id": 0, "JobName": "Backup Task", "JobDescription": "Create a Backup of the chassis", "Schedule
} Chassis restore } ], "JobType": { "Id": 21, "Name": "Backup_Task", "Internal": false } Example response body { "Id": 0, "JobName": "Restore Task", "JobDescription": "Restore an existing device backup" "Schedule": "startnow", "State": "Enabled", "Targets": [], "Params": [ { }, { }, { }, { }, { }, { }, { }, { ], } "Key": "shareType", "Value": "" "Key": "backup_filename", "Value": "
Exporting chassis profiles Example response body { 310 Monitor "@odata.context": "/api/$metadata#JobService.Job", "@odata.type": "#JobService.Job", "@odata.id": "/api/JobService/Jobs(13286)", "Id": 13286, "JobName": "Export Profile", "JobDescription": "Create and export profile of the chassis", "NextRun": null, "LastRun": "2020-06-10 12:33:19.
ExecutionHistories" } Importing chassis profiles Example response body { "@odata.context": "/api/$metadata#JobService.Job", "@odata.type": "#JobService.Job", "@odata.id": "/api/JobService/Jobs(13288)", "Id": 13288, "JobName": "Import Profile", "JobDescription": "Import of backed up chassis profile", "NextRun": null, "LastRun": "2020-06-10 12:35:09.
"Internal": false }, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2080, "Name": "New" }, "ExecutionHistories@odata.
{ }, { }, { }, { } Chassis Extract Logs—NFS Share "Key": "shareName", "Value": "/var/nfsshare" "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" "Key": "shareType", "Value": "HTTPS" "Key": "maskSensitiveInfo", "Value": "FALSE" } ], "JobType": { "Id": 18, "Name": "DebugLogs_Task" } Example response body { } "JobName": "Extract Log", "JobDescription": "Extract device log to NFS location", "Schedule": "startnow", "State": "Enabled", "Targets": [ { "Id": 25016, "Data": "", "TargetType": { "Id": 1000, "Name
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": "DEVICE" } } ], "Params": [ { "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" }, { "Key": "password", "Value": "sharepass" }, { "Key": "userName", "Value": "administrator" }, { "Key": "shareType", "Value": "CIFS" }, { "Key": "shareName", "Value": "cifs
{ "Key": "override", "Value": "true" }, { "Key": "operationName", "Value": "VIRTUAL_RESEAT" }, { "Key": "deviceTypes", "Value": "1000" } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task", "Internal": false }} Slot-based reseat for compute, storage, or IOM Example response body Chassis power off operation Example response body { "JobName": "Slot Based Virtual Reseat", "JobDescription": "Virtual_Reseat_Slot_based", "Schedule": "startnow", "State":"Enabled", "Targets": [ { "Id": 25045, "Data": "", "Targ
} }], "Params": [ { "Key": "override", "Value": "true" }, { "Key": "powerState", "Value": "8" }, { "Key": "operationName", "Value": "POWER_CONTROL" }, { "Key": "deviceTypes", "Value": "1000" } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task", "Internal": false } } Blade server (sled) power off operation 316 Monitor Example response body { "JobName": "Power Off (Non-graceful)", "JobDescription": "Power Control Task: Power Off (Non-graceful)", "Schedule": "startnow", "State": "Enabled", "Targets": [ {
IOM 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": 10660, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } }], "Params": [ { "Key": "override", "Value": "true" }, { "Key": "powerState", "Value": "8" }, { "Key": "operationName", "Value": "POWER_CONTROL" }, { "Key": "deviceTypes", "Value": "1000" } ], "JobType": { "Id": 3, "Name": "De
} ], "JobType": { "Id": 3, "Name": "DeviceAction_Task", "Internal": false } Where Slot type is always 2000 for compute SLED and ID "10099" is for chassis ID.
} Blink LED ] } } "Id":1000, "Name":"Device" Example response body { "Id": 0, "JobName": "Blink LED", "JobDescription": "Blink LED: N Minute(s) or Indefinitely", "Schedule": "startnow", "State": "Enabled", "JobType": { "Name": "DeviceAction_Task" }, "Targets": [ { "Id": 10043, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "identifyState", "Value": "2" // 2 = duration in minutes, -1= indefinitely }, { "Key": "durationLimit", "Value": "60" // 60= 1 minute, 600=10 m
{ "Key": "override", "Value": "true" }, { "Key": "powerState", "Value": "5" }, { } System reseat Example response body { } Reset iDRAC Monitor "Id": 0, "JobName": "System Reseat", "JobDescription": "Power Control Task: System Reseat", "State": "Enabled", "Schedule": "startnow", "JobType": { "Name": "DeviceAction_Task" }, "Targets": [ { "Id": 10043, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "operationName", "Value": "VIRTUAL_RESEAT" } ] Example response bo
} Configure Port Break Out ] } "TargetType": { "Id": 1000, "Name": "DEVICE" } Example response body { "JobName": "Breakout Port", "JobDescription": null, "Schedule": "startnow", "State": "Enabled", "JobType": { "Id": 3, "Name": "DeviceAction_Task", "Internal": false }, "Targets": [ { "Id": 10045, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ {"Key": "breakoutType", "Value": “FabricExpander"}, {"Key": "interfaceId", "Value": "DPM4XC1:portgroup1/1/1,DPM4XC1:port-group1/1/2"
Configure MTU Example response body { } Group Inventory Example response body { } Device Inventory Monitor "Id": 0, "JobName": "Default Inventory Task - All Devices ", "JobDescription": "Default Inventory Task - All Devices", "Schedule": "startnow", "State": "Enabled", "JobType": { "Name": "Inventory_Task" }, "Targets": [ { "Id": 500, "Data": "", "TargetType": { "Id": 6000, "Name": "GROUP" } } ] Example response body { 322 "JobName": "Update Maximum Transmission Unit", "JobDescription": null, "Sche
} Extracting device logs ] } Example response body { } Extracting SupportAssist collection } "Id": 0, "JobName": "Extract Log", "JobDescription": "Extract device log to CIFS location", "Schedule": "startnow", "State": "Enabled", "JobType": { "Id": 18, "Name": "DebugLogs_Task" }, "Targets": [ { "Id": 10036, "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" }, { "Key": "shareAddress", "Value": "100.69.127.
} "JobType":{ "Id":18, "Name":"DebugLogs_Task" }, "Targets":[ { "Id":10038, "TargetType":{ "Id":1000, "Name":"DEVICE" } } ], "Params":[ { "Key":"OPERATION_NAME", "Value":"EXTRACT_LOGS" }, { "Key":"shareType", "Value":"NFS" }, { "Key":"shareAddress", "Value":"1.2.3.4" }, { "Key":"shareName", "Value":"filepath" }, { "Key":"logSelector", "Value":"0,1,2" } ] Table 117. Attributes Attribute Description Target Id ID of the device.
Table 117. Attributes (continued) Attribute Description • 12 (Power Off - Soft Graceful)—Performs an orderly transition to "power off" state. The corresponding ACPI state is G2/S5, in which the system consumes a minimal amount of power. Override Ignores device state and performs the operation upInterfaceIds Id of the port that must be configured or toggled. If there are multiple ports these are separated by a "," in the parameter.
"CreatedBy": "admin", "UpdatedBy": null, "Visible": false, "Editable": false, "Builtin": true, "Targets": [ { "JobId": 10016, "Id": 500, "Data": "All-Devices", "TargetType": { "Id": 6000, "Name": "GROUP" } } ], "Params": [ { "JobId": 10016, "Key": "defaultInventoryTask", "Value": "TRUE" } ], "LastRunStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" }, "JobType": { "@odata.type": "#JobService.
Table 118. Attributes (continued) Attribute Description CreatedBy User who created the job. UpdatedBy User who updated the job. Visible Indicates whether the job is visible. Editable Indicates whether the job can be edited. BuiltIn Indicates if the job is internal. Targets Job targets. Params Parameters for the job. LastRunStatus Indicates the status of the last instance of the job execution. JobStatus Job completion status.
} Example response body { } ] } } "Id": 26097, "JobName": "Inventory Task", "JobDescription": "Inventory Task", "NextRun": null, "LastRun": "2018-09-14 15:31:13.
Table 119. Attributes (continued) Attribute Description JobName Name of the job type. DELETE method for Jobs(Id) This method deletes a specific job. Description Deletes a job. Privilege JOB_MANAGEMENT HTTP response codes 204 Table 120. Attributes Attribute Description Id ID of the job to be deleted. /api/JobService/JobStatuses This URI represents the status of all the jobs. GET method for JobStatuses This method returns the status of all the jobs. Description Returns status of all the jobs.
"@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2060)", "Id": 2060, "Name": "Completed" }, { } ] "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2070)", "Id": 2070, "Name": "Failed" }, { "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2080)", "Id": 2080, "Name": "New" }, { "@odata.type": "#JobService.JobStatus", "@odata.
HTTP response codes Example response body 200 { } "@odata.context": "/api/$metadata#JobService.JobStatus/$entity", "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2030)", "Id": 2030, "Name": "Queued" Table 122. Attributes Attribute Description Id ID of the job status. Name Name of the job status. /api/JobService/JobTypes This URI represents all the job types. GET method for JobTypes This method returns the details of all the job types.
"Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(18)", "Id": 18, "Name": "DebugLogs_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(20)", "Id": 20, "Name": "Restore_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(21)", "Id": 21, "Name": "Backup_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.
{ } ] } "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(42)", "Id": 42, "Name": "QuickDeploy_Task", "Internal": false Table 123. Attributes Attribute Description Id ID of the job type. Name Name of the job type. Internal Indicates if the job is internal. /api/JobService/JobTypes(Id) This URI represents the details of a job type. GET method for JobTypes(Id) This method returns the details of a specific job type. Description Returns details of a job type.
Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Collection(JobService.ExecutionHistory)", "@odata.count": 5, "value": [ { "@odata.type": "#JobService.ExecutionHistory", "@odata.id": "/api/JobService/Jobs(10016)/ExecutionHistories(18855)", "Id": 18855, "JobName": "Default Inventory Task", "Progress": "100", "StartTime": "2018-09-14 15:00:00.059", "EndTime": "2018-09-14 15:00:30.211", "LastUpdateTime": "2018-09-14 15:00:30.
{ "@odata.type": "#JobService.ExecutionHistory", "@odata.id": "/api/JobService/Jobs(10016)/ExecutionHistories(18729)", "Id": 18729, "JobName": "Default Inventory Task", "Progress": "100", "StartTime": "2018-09-14 13:30:00.079", "EndTime": "2018-09-14 13:30:29.333", "LastUpdateTime": "2018-09-14 13:30:29.333", "ExecutedBy": "admin", "JobId": 10016, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" }, "ExecutionHistoryDetails@odata.
/api/JobService/Jobs(Id)/ExecutionHistories(Id) This URI represents the execution history details for a job. GET method for ExecutionHistories(Id) This method returns the execution history details for a specific execution history. Description Returns details of a specific execution history. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(JobService.ExecutionHistoryDetail)", "@odata.count": 2, "value": [ { "@odata.type": "#JobService.
Table 126. Attributes (continued) Attribute Description 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. JobStatus Job execution history detail completion status. /api/JobService/Actions/JobService.EnableJobs POST method for JobService.EnableJobs This method enables the selected jobs. Description Enables the selected jobs.
• • • 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.RemoveJobs POST method for JobService.RemoveJobs This method deletes 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.
{ "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. Description Stops the selected jobs.
/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. Privilege JOB_MANAGEMENT HTTP response codes 201 Example response body { } "JobIds": [], "AllJobs": true, "Filters": { "Status": 2020, "State": "", "JobType": "", "StartTime": "", "EndTime": "" } /api/JobService/Actions/JobService.
Example response body { } "JobIds": [], "AllJobs": true, "Filters": { "Status": 2020, "State": "", "JobType": "", "StartTime": "", "EndTime": "" } /api/JobService/Actions/JobService.Pause This API represents information about jobs that are stopped momentarily. POST method for /api/JobService/Actions/JobService.Pause This method returns information about jobs that are stopped momentarily. Description Returns information about jobs that are stopped momentarily.
/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.ExecuteAction This method returns status jobs that are performed in the system. Description Returns status of jobs that are performed in the system.
11 Reset application Topics: • /api/ApplicationService/Actions/ApplicationService.ResetApplication /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.
12 Console version Topics: • /api/ApplicationService/Info /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 { } "@odata.context": "/api/$metadata#ApplicationService.Info", "@odata.type": "#ApplicationService.Info", "@odata.
13 Console capabilities Topics: • /api/ApplicationService/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 OpenManage Enterprise. These two management consoles have different capabilities. Description Returns the capabilities of the management console.
"@odata.type": "#ApplicationService.Capability", "Name": "SERVER_PORTS_NIC_TEAMING", "Description": "Capability bit to indicate that provided MX chassis supports server ports NIC teaming." }, { "@odata.type": "#ApplicationService.Capability", "Name": "OPTIMIZED_FABRIC_MANAGER_OPERATIONS", "Description": "Capability bit to indicate that provided MX chassis supports optimized fabric manager operations." } ] } Example of application capabilities of OpenManage Enterprise { "@odata.
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.
"_index": "OME-Modular", "_type": "tasks", "_id": "3864", "_score": 1, "_source": { "tskNm": "Device_Config_Task (1493523261197) - for Device with Id: 1864", "tskTyp": "Device Config Task", "tskStatus": "Task status is Failed", "tskDesc": "Device_Config_Task (1493523261197) - for Device with Id: 1864", } } ] } } "tskCreatedBy": "system", "tskId": "3864" Table 127. Attributes Attribute name Description QueryString String to search. FilterType Indexes to be searched for the query string.
15 Session Topics: • • • • • • /api/SessionService /api/SessionService/Sessions /api/SessionService/Sessions(Id) /api/SessionService/SessionConfiguration /api/SessionService/Actions/SessionService.SessionConfigurationUpdate /api/SessionService/Actions/SessionService.Logoff /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.
/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 130. Attributes Attribute Name Description UserName The Session user name.
} Example response body { } "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 131. Attributes Attribute Name Description Id The unique identifier of the SessionService. UserName The session user name. Password The session user password.
{ "@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.
/api/SessionService/Actions/ SessionService.Logoff This URI logs off your current session. POST method for session service log off This method log off the current session of the user. Description Logs off the current session of the user.
16 APIs specific to OpenManage Enterprise – Modular Edition Topics: • • • • • • • • • • • • • • /api/ApplicationService/Settings /api/ApplicationService/Network/CurrentAddressConfiguration /api/ApplicationService/Network/AddressConfiguration /api/ApplicationService/Actions/ApplicationService.GetConfiguration /api/ApplicationService/Actions/ApplicationService.
POST method for /api/ApplicationService/Settings This method returns the application service settings. Description Returns one or more application settings. You can get the name of the setting and the group, using this API. Privilege APPLIANCE_SETUP HTTP response codes 201 Example Response Body { "ConsoleSetting": [{ "Name": "WARRANTY_EXPIRY_SETTING", "DefaultValue": "90", "Value": "1", "DataType": "java.lang.
} "CurrentLinkLocalAddress": "", "UseDHCPForDNSServerNames": true, "CurrentPreferredDNSServer": "", "CurrentAlternateDNSServer": "" }, "DnsSetting": { "DnsFQDName": "dell.example.com", "DnsDomainName": "example.com" } Table 132. Attributes Attribute name Description Ipv4Setting.Enable IPv4 network settings status. Ipv4Setting.EnableDHCP Obtain IPv4 via DHCP server status. Ipv4Setting.CurrentIPAddress Current IPv4 address. Ipv4Setting.CurrentSubMask Current IPv4 subnet mask address. Ipv4Setting.
HTTP response codes Example response body 200 { } "@odata.context": "/api/$metadata#Network.AddressConfiguration/$entity", "@odata.type": "#Network.AddressConfiguration", "@odata.
} Example response body { "StaticSubnetMask": "", "StaticGateway": "", "UseDHCPForDNSServerNames": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "Ipv6Configuration": { "Enable": false, "EnableAutoConfiguration": true, "StaticIPAddress": "", "StaticPrefixLength": 0, "StaticGateway": "", "UseDHCPForDNSServerNames": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "ManagementVLAN": { "EnableVLAN": false, "Id": 1 }, "DnsConfiguration": { "RegisterWithDNS": fals
"Ipv6CurrentAlternateDNSServer": "", "FqdndomainName": "" } }, "Delay": 0 Table 133. Attributes Attribute name Description EnableNIC Network interface controller for public networking access. Ipv4Configuration.Enable Enable IPv4 network settings. Ipv4Configuration.EnableDHCP Obtain IPv4 via DHCP server. Ipv4Configuration.StaticIPAddress Set Static IPv4 address. Ipv4Configuration.StaticSubnetMask Set Static IPv4 subnet mask address. Ipv4Configuration.
Privilege VIEW HTTP response codes 200 Example Request Body [] or blank Example Response Body { "SystemConfiguration": { "Comments": [ "Export type is Normal,JSON" ], "Model": "POWEREDGE MX7000", "ServiceTag": "01PTCOME-Modular", "TimeStamp": "2018-09-25T13:39:10.933Z", "Components": [ { "FQDD": "MM.Embedded.1", "Attributes": [ { "Name": "WebServer.1#Timeout", "Value": 30 }, { "Name": "WebServer.1#HttpsPort", "Value": 443 }, { "Name": "WebServer.
"Name": "RemoteSystemLog.1#RemoteSyslogEnable", "Value": true }, { "Name": "RemoteSystemLog.1#destinationAddress", "Value": "10.36.0.167" }, { "Name": "RemoteSystemLog.1#Port", "Value": 514 }, { "Name": "RemoteSystemLog.2#RemoteSyslogEnable", "Value": false }, { "Name": "RemoteSystemLog.2#destinationAddress", "Value": null }, { "Name": "RemoteSystemLog.2#Port", "Value": 0 }, { "Name": "RemoteSystemLog.3#RemoteSyslogEnable", "Value": false }, { "Name": "RemoteSystemLog.
"Name": "SNMPAlerts.1#version", "Value": "SNMPV1" }, { "Name": "SNMPAlerts.1#CommunityString", "Value": "public" }, { "Name": "SNMPAlerts.2#Enable", "Value": false }, { "Name": "SNMPAlerts.2#DestinationIP", "Value": null }, { "Name": "SNMPAlerts.2#port", "Value": 0 }, { "Name": "SNMPAlerts.2#version", "Value": null }, { "Name": "SNMPAlerts.2#CommunityString", "Value": null }, { "Name": "SNMPAlerts.3#Enable", "Value": false }, { "Name": "SNMPAlerts.3#DestinationIP", "Value": null }, { "Name": "SNMPAlerts.
"Name": "TimeConfig.1#NTPEnable", "Value": false }, { "Name": "TimeConfig.1#NTPServer1", "Value": null }, { "Name": "TimeConfig.1#NTPServer2", "Value": null }, { "Name": "TimeConfig.1#NTPServer3", "Value": null }, { "Name": "TimeConfig.1#systemTime", "Value": "2018-09-25 08:39:07" }, { "Name": "LocalAccessConfiguration.1#EnableChassisPowerButton", "Value": true }, { "Name": "LocalAccessConfiguration.1#EnableKvmAccess", "Value": false }, { "Name": "LocalAccessConfiguration.
"Name": "EmailAlertsConf.1#Password", "Value": null }, { "Name": "SNMPService.1#Enable", "Value": true }, { "Name": "SNMPService.1#Port", "Value": 161 }, { "Name": "SNMPService.1#CommunityName", "Value": "public" }, { "Name": "SSH.1#Enable", "Value": true }, { "Name": "SSH.1#Port", "Value": 22 }, { "Name": "SSH.1#MaxSessions", "Value": 4 }, { "Name": "SSH.1#Timeout", "Value": 1800 }, { "Name": "Racadm.1#Enable", "Value": true }, { "Name": "Proxy.1#ipAddress", "Value": null }, { "Name": "Proxy.
"Name": "Network#Ipv4Settings#EnableIPv4", "Value": true }, { "Name": "Network#Ipv4Settings#EnableDHCP", "Value": true }, { "Name": "Network#Ipv4Settings#StaticIPAddress", "Value": "" }, { "Name": "Network#Ipv4Settings#StaticSubnetMask", "Value": "" }, { "Name": "Network#Ipv4Settings#StaticGateway", "Value": "" }, { "Name": "Network#Ipv4Settings#UseDHCPObtainDNSServerAddresses", "Value": true }, { "Name": "Network#Ipv4Settings#StaticPreferredDNSServer", "Value": "" }, { "Name": "Network#Ipv4Settings#StaticA
"Name": "Network#GeneralSettings#DnsName", "Value": "MX-01PTCOME-Modular1234" }, { "Name": "Network#GeneralSettings#UseDHCPForDomainName", "Value": true }, { "Name": "Network#GeneralSettings#DnsDomainName", "Value": "" }, { "Name": "Network#GeneralSettings#AutoNegotiation", "Value": true }, { "Name": "Network#GeneralSettings#NetworkSpeed", "Value": "100_MB" }, { "Name": "Network#GeneralSettings#Delay", "Value": 0 }, { "Name": "Users.1#userType", "Value": 1 }, { "Name": "Users.
}, { "Name": "Users.3#userType", "Value": 1 }, { "Name": "Users.3#SHA256Password", "Value": "$2a $10$dTg7igLe1neXnZthG9vzP.8ML.tcUOxyeP.i3XRD7eYfKMlJOqMDe" }, { "Name": "Users.3#Name", "Value": "ravi" }, { "Name": "Users.3#Privilege", "Value": "10" }, { "Name": "Users.3#Enable", "Value": true }, { "Name": "Users.3#Password", "Value": null }, { "Name": "Users.4#userType", "Value": 1 }, { "Name": "Users.4#SHA256Password", "Value": "$2a $10$ntDJPWAkaB5oemKyzLQPG.M5HliotxOby.
{ "Name": "Users.5#objectGuid", "Value": "d22005b6-0ce5-40ed-88d0-7f7759b52f25" }, { "Name": "Users.5#Password", "Value": null }, { "Name": "Users.5#directoryType", "Value": "AD" }, { "Name": "Users.5#directoryName", "Value": "dell.com" }, { "Name": "ActiveDirectory.1#name", "Value": "dell.com" }, { "Name": "ActiveDirectory.1#serverType", "Value": "MANUAL" }, { "Name": "ActiveDirectory.1#DomainController1", "Value": "10.170.15.214" }, { "Name": "ActiveDirectory.1#Domain", "Value": "dell.
{ } } ] } ] "Name": "LDAP.1#NetworkTimeout", "Value": 120 }, { "Name": "LDAP.1#SearchTimeout", "Value": 120 }, { "Name": "LDAP.1#CertValidationEnable", "Value": false }, { "Name": "LDAP.1#certificateFile", "Value": "" } Table 134. Attributes Attribute Description SystemConfiguration Parent tag that represents system configuration. Comments User-defined comments. Model Chassis model. ServiceTag Chassis Service Tag. TimeStamp Time stamp when the configuration is retrieved.
], "Model": "POWEREDGE MX7000", "ServiceTag": "01PTCOME-Modular", "TimeStamp": "2018-09-25T13:39:10.933Z", "Components": [ { "FQDD": "MM.Embedded.1", "Attributes": [ { "Name": "WebServer.1#Timeout", "Value": 30 }, { "Name": "WebServer.1#HttpsPort", "Value": 443 }, { "Name": "WebServer.1#WebserverEnable", "Value": true }, { "Name": "Preference.1#DeviceName", "Value": "SLOT_NAME" }, { "Name": "LoginSecurity.1#Id", "Value": "10" }, { "Name": "LoginSecurity.
{ "Name": "RemoteSystemLog.2#destinationAddress", "Value": null }, { "Name": "RemoteSystemLog.2#Port", "Value": 0 }, { "Name": "RemoteSystemLog.3#RemoteSyslogEnable", "Value": false }, { "Name": "RemoteSystemLog.3#destinationAddress", "Value": null }, { "Name": "RemoteSystemLog.3#Port", "Value": 0 }, { "Name": "RemoteSystemLog.4#RemoteSyslogEnable", "Value": false }, { "Name": "RemoteSystemLog.4#destinationAddress", "Value": null }, { "Name": "RemoteSystemLog.
{ "Name": "SNMPAlerts.2#port", "Value": 0 }, { "Name": "SNMPAlerts.2#version", "Value": null }, { "Name": "SNMPAlerts.2#CommunityString", "Value": null }, { "Name": "SNMPAlerts.3#Enable", "Value": false }, { "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.
{ "Name": "TimeConfig.1#systemTime", "Value": "2018-09-25 08:39:07" }, { "Name": "LocalAccessConfiguration.1#EnableChassisPowerButton", "Value": true }, { "Name": "LocalAccessConfiguration.1#EnableKvmAccess", "Value": false }, { "Name": "LocalAccessConfiguration.1#LcdAccess", "Value": "VIEW_AND_MODIFY" }, { "Name": "QuickSync.1#Access", "Value": "READ_WRITE" }, { "Name": "QuickSync.1#InactivityTimerEnable", "Value": true }, { "Name": "QuickSync.1#InactivityTimeout", "Value": 120 }, { "Name": "QuickSync.
{ "Name": "SSH.1#Enable", "Value": true }, { "Name": "SSH.1#Port", "Value": 22 }, { "Name": "SSH.1#MaxSessions", "Value": 4 }, { "Name": "SSH.1#Timeout", "Value": 1800 }, { "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#Ipv4Settings#StaticGateway", "Value": "" }, { "Name": "Network#Ipv4Settings#UseDHCPObtainDNSServerAddresses", "Value": true }, { "Name": "Network#Ipv4Settings#StaticPreferredDNSServer", "Value": "" }, { "Name": "Network#Ipv4Settings#StaticAlternateDNSServer", "Value": "" }, { "Name": "Network#Ipv6Settings#EnableIPv6", "Value": false }, { "Name": "Network#Ipv6Settings#EnableAutoconfiguration", "Value": true }, { "Name": "Network#Ipv6Settings#StaticIPv6Address", "Value": "" }, { "Name"
{ "Name": "Network#GeneralSettings#NetworkSpeed", "Value": "100_MB" }, { "Name": "Network#GeneralSettings#Delay", "Value": 0 }, { "Name": "Users.1#userType", "Value": 1 }, { "Name": "Users.1#SHA256Password", "Value": "$2a $10$0MAfJwXIdGRvp2wtQQMS6OzcdOH8aD9kiFrX8wy8Ltxb2UFaVP9GW" }, { "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.
"Name": "Users.3#Privilege", "Value": "10" }, { "Name": "Users.3#Enable", "Value": true }, { "Name": "Users.3#Password", "Value": null }, { "Name": "Users.4#userType", "Value": 1 }, { "Name": "Users.4#SHA256Password", "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.
}, { "Name": "ActiveDirectory.1#name", "Value": "dell.com" }, { "Name": "ActiveDirectory.1#serverType", "Value": "MANUAL" }, { "Name": "ActiveDirectory.1#DomainController1", "Value": "10.170.15.214" }, { "Name": "ActiveDirectory.1#Domain", "Value": "dell.com" }, { "Name": "ActiveDirectory.1#Port", "Value": 3269 }, { "Name": "ActiveDirectory.1#NetworkTimeout", "Value": 120 }, { "Name": "ActiveDirectory.1#SearchTimeout", "Value": 120 }, { "Name": "ActiveDirectory.
} Example response body { } } ] } ] } "JobId": 38758 Table 135. Attributes Attribute Description SystemConfiguration Parent tag that represents system configuration. Comments User-defined comments. Model Chassis model. 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.
"Manufacturer": "ManufacturerName", "BrandName": "Dell", "ManagementURI": "/management/uri/path", "SupportURI": "/support/uri/path", "CompanyLogo": "img/Dell_EMC.png", "ProductLogo": "img/Dell_EMC.png" "Theme": "", "LicenseInfo": "info/license.html", "OpenSourceLicenseInfo": "info/OpenSourceLicenseInfo.txt" } /api/ApplicationService/Actions/ ApplicationService.ActivateBrand This URI allows you to change the branding between the default brand or de-branded.
HTTP response codes 200 Example response body Output — Standalone chassis: { "@odata.context": "/api/ $metadata#ManagementDomainService.ManagementDomainService", "@odata.type": "#ManagementDomainService.ManagementDomainService", "@odata.id": "/api/ManagementDomainService", "GroupConfiguration": null, "Actions": null, "Domains@odata.navigationLink": "/api/ManagementDomainService/Domains", "PendingDomains@odata.navigationLink": "/api/ManagementDomainService/ PendingDomains", "DiscoveredDomains@odata.
}, { }, { }, { }, { }, { "ConfigType": "LocalAccessConfiguration", "Enabled": true "ConfigType": "Power", "Enabled": true "ConfigType": "ProxySettings", "Enabled": true "ConfigType": "TimeSettings", "Enabled": true "ConfigType": "SecuritySettings", "Enabled": true "ConfigType": "SessionConfiguration", "Enabled": true } ], "VirtualIPConfiguration": null, "LeadRedundancyStatus": 5000, "OpaquePLId": 10, "SyncFailureAlertTimeout": 30 }, "Actions": null, "Domains@odata.
Table 136. Attributes (continued) Attribute Description OpaquePLId Tracks the lead promotion cycle. The attribute gets incremented by 10 on each promotion. PUT method for ManagementDomainService This method creates a Multi-Chassis Management (MCM) domain or updates an existing domain. Description Creates or updates an MCM domain.
} Example request body Request for editing a group { } Example response body "GroupId": "91e0b654-9de4-4a62-b5b1-c0da11d81b70", "DeviceGroupId": 31436, --Optional "GroupName": "Example-Group", -Mandatory "GroupDescription": "Example-Group", Optional "JoinApproval": "Automatic", -Mandatory "ConfigReplication": [ { "ConfigType": "Power", "Enabled": false }, { "ConfigType": "UserAuthentication", "Enabled": true }, { "ConfigType": "AlertDestinations", "Enabled": false }, { "ConfigType": "TimeSettings", "Enab
}, { }, { }, { }, { }, { }, { } Example response body "ConfigType": "AlertDestinations", "Enabled": false "ConfigType": "LocalAccessConfiguration", "Enabled": false "ConfigType": "Power", "Enabled": false "ConfigType": "ProxySettings", "Enabled": false "ConfigType": "TimeSettings", "Enabled": false "ConfigType": "SecuritySettings", "Enabled": false } ], "VirtualIPConfiguration": { "IPv4": { "StaticIPv4Address":"10.35.155.155", "SubnetMask":"255.255.255.32", "Gateway":"10.35.2.
Table 137. Attributes (continued) Attribute Description DeviceGroupId The ID of the device group associated with the management domain. VirtualIPConfiguration The virtual IP that must be configured on the lead chassis. IPv4 Details of the virtual IPv4 address. StaticIPv4Address Static IPv4 that must be configured for the lead chassis. SubnetMask Subnet mask that must be configured for the lead chassis. Gateway Gateway that must be configured for the lead chassis.
], "Name": "MX-UTSKY88", "Description": "POWEREDGE MX7000", "Identifier": "UTSKY88", "DomainTypeId": 4000, "DomainTypeValue": "OME-Modular", "DomainRoleTypeId": 3001, "DomainRoleTypeValue": "MEMBER", "Version": "1" }, { } ] } "@odata.type": "#ManagementDomainService.DiscoveredDomain", "GroupId": "ed031327-889a-466f-931e-e603a1da6255", "GroupName": "Example-GroupName", "GroupDescription": "Example-GroupDescription", "PublicAddress": [ "10.36.0.
/api/ManagementDomainService/ConfigurationTypes This URI represents the configuration types supported on the management domain service. GET method for ConfigurationTypes This method returns the collection of configuration types supported on the management domain service. When creating a group, select from these configuration types. Description Returns the collection of supported configuration types. Privilege VIEW HTTP response code 200 Example response body { "@odata.
{ "@odata.type": "#ManagementDomainService.ConfigurationType", "@odata.id": "/api/ManagementDomainService/ConfigurationTypes(8)", "Id": 8, "Name": "SecuritySettings", "Description": "Security Settings" }, { "@odata.type": "#ManagementDomainService.ConfigurationType", "@odata.id": "/api/ManagementDomainService/ConfigurationTypes(9)", "Id": 9, "Name": "SessionConfiguration", "Description": "Session Configuration" } ] } Table 139. Attributes Attribute Description Id ID 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. GET method for Domains This method returns the role of this chassis domain, details of the backup-lead chassis compatibility, and health of the data synchronization.
}, { } ] } "PublicAddress": [ "100.69.115.194" ], "Name": "MX-C4XF1S2", "Description": "PowerEdge MX7000", "Identifier": "C4XF1S2", "DomainTypeId": 4000, "DomainTypeValue": "MSM", "DomainRoleTypeId": 3001, "DomainRoleTypeValue": "MEMBER", "Version": "1.20.00", "Local": false, "GroupId": "28bf881c-f736-440d-b327-2fb0b2d7fd55", "GroupName": "test", "BackupLead": false, "Capabilities": [ "LEADBACKUPCOMPATIBLE" ], "BackupLeadHealth": 2000 "@odata.type": "#ManagementDomainService.Domain", "@odata.
}, { } ] } "Local": true, "GroupId": "28bf881c-f736-440d-b327-2fb0b2d7fd55", "GroupName": "test", "BackupLead": false, "Capabilities": [ "LEADBACKUPCOMPATIBLE" ], "BackupLeadHealth": 2000 "@odata.type": "#ManagementDomainService.Domain", "@odata.id": "/api/ManagementDomainService/Domains(10231)", "Id": 10231, "DeviceId": 0, "PublicAddress": [ "100.69.115.
Table 141. Attributes (continued) Attribute Description Local • • TRUE—Indicates that this domain is the local domain where the API is run. FALSE—Indicates that this domain is the remote domain where the API is run. GroupId Unique identifier of the group across different domains. GroupName Group name for the MCM domain group. BackupLead Indicates if the domain is a backup lead. Capabilities Indicates the capabilities of the domain.
} "Local": true, "GroupId": "4e361023-07cc-4b98-af3f-ba7c2ef2f5b9", "GroupName": "DDD" Table 142. 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. DomainTypeValue Information for internal programmatic use. DomainRoleTypeId ID of the domain role.
} "@odata.count": 1, "value": [ { "@odata.type": "#ManagementDomainService.PendingDomain", "@odata.id": "/api/ManagementDomainService/PendingDomains(36197)", "Id": 36197, "JobId": 36196, "State": 1001, "PublicAddress": [ "10.35.224.67" ], "Name": "MX-MCM1", "Description": "POWEREDGE MX7000", "Identifier": "MCM1", "DomainType": "OME-Modular", "Version": "1.00.10" } ] Table 143. Attributes Attribute Description Id Record ID. JobId Job ID created for the operation. State Internal state of the request.
HTTP response codes 200 Example response body { "@odata.context": "$metadata#ManagementDomainService.PendingDomain/ $entity", "@odata.id": "/api/ManagementDomainService/PendingDomains(15964)", "Id": 15964, "JobId": 0, "State": 1001, "Address": "fde1:53ba:e9a0:de14:1a66:daff:fe76:4de5", "Name": "cmc-MEM123", "Description": "Chassis-MEM123", "Identifier": "MEM123", "DomainType": "OME-Modular", "Version": "VERSION", } Table 144. Attributes Attribute Description Id Record ID.
Privilege APPLIANCE_SETUP HTTP response codes 200 Example To get the GroupID of the domain, use the /ManagementDomainService/DiscoveredDomains API.
HTTP response codes Example request body 200 { } Example response body { } "GroupId": "671497bc-9d61-4067-afcd-48f9df5e8dd2" "JobId": 12764, "Status": "PENDING" Table 146. Attributes Attribute Description GroupId Group ID of the lead domain. JobId Job ID for tracking the status of the join operation. Status Status of the join request. /api/ManagementDomainService/Actions/ ManagementDomainService.Leave POST method for ManagementDomainService.
/api/ManagementDomainService/Actions/ ManagementDomainService.Delete POST method for ManagementDomainService.Delete This method removes a specific member chassis domain from an MCM domain group. This API is applicable only to LEAD domains. Description Removes a member chassis domain from an MCM domain group.
Example response body { } "JobId": 13514, "Status": "SUCCESS" Table 149. Attributes Attribute Description GroupId Group ID of the lead domain. JobId Job ID for the delete operation. NOTE: Use the Job API to poll the status of the delete JobId. After the job is complete, all the chassis domains in the group transition to STANDALONE type. Status Status of the delete operation. Possible values: • • SUCCESS FAILED After the job is successful, use the JobId to poll the delete group status.
/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 151.
Table 152. 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 154. 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.
Table 155. Attributes (continued) 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.
"Actions": null, "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.
"Status": "4000", "Issues": [ { "MessageId": "NFAB0017", "Message": "The SmartFabric is not healthy because all InterSwitch Links are not connected.", "MessageArgs": [], "Severity": "Warning", "Resolution": "Make sure that the VLTi cables for all ISLs are connected and operational as per the selected fabric design.", "Category": "Audit", "DetailedDescription": "The SmartFabric is not healthy because one or more VLTi links are not connected.
HTTP response codes Example request body 200 { } Example for creating fabric "Name": "Fabric 1", "Description": "update 01", "OverrideLLDPConfiguration": "Disabled", "ScaleVLANProfile": "Enabled", "FabricDesignMapping": [ { "DesignNode": "Switch-A", "PhysicalNode": "CBJXLN2" }, { "DesignNode": "Switch-B", "PhysicalNode": "F13RPK2" } ], "FabricDesign": { "Name": "2xMX9116n_Fabric_Switching_Engines_in_different_chassis" } Example response body { } { "Name": "Fabric11", "Description": "Fabric11", "Over
Table 156. Attributes (continued) Attribute Description default. To enable the scale VLAN configuration for existing fabrics, use the PUT method. /api/NetworkService/FabricDesigns This URI represents the fabric designs. GET method for FabricDesigns 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.
"NetworkLink": [ { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/37", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/37" }, { "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", "Destinati
} } ] "DestinationInterface": "ethernet1/1/39" ], "FabricDesignNode": [ { "NodeName": "Switch-A", "ChassisName": "Chassis-X", "Slot": "Slot-A1", "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.
{ "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-12T18:47:56Z" } ] }, "FabricDesignMapping": [ { "DesignNode": "Switch-A", "PhysicalNode": "41F2MN2" }, { "DesignNode": "Switch-B", "PhysicalNode": "41F4MN2" } ], "Switches@odata.
"DesignNode":" Switch-B", "PhysicalNode":"9KWYJRN1" } Example response body } ], "FabricDesign": { "Name":"2xMX9116n_Fabric_Switching_Engines_in_same_chassis " } TRUE Table 157. 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.
} "NetworkLink": [ { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/37", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/37" }, { "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", "Destin
"@odata.
"SubCategory": "ISLError", "Severity": "Severity1", "ChassisName": "MX-SKY002P1234567890123456789012345", "ChassisServiceTag": "SKY002P1234567890123456789012345", "Description": "Unable to validate the fabric because the design link ICL-1_REVERSE not connected as per design 2NodeHESameChassis.
"ProblemLink": { "SourceNode": "DPM4XC1", "SourceInterface": "DPM4XC1:ethernet1/1/42", "DestinationNode": "DPM4XC2", "DestinationInterface": "DPM4XC2:ethernet1/1/42" }, "RecommendedLink": { "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.
POST method for Uplinks for a specific fabric This method creates an uplink. Description Creates an uplink. Privilege FABRIC_MANAGEMENT HTTP response code 201 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 158.
"@odata.context": "/api/$metadata#NetworkService.Uplink/$entity", "@odata.type": "#NetworkService.Uplink", "@odata.id": "/api/NetworkService/ Fabrics('43be623e-0d74-4f6d-87b3-3ea40bf6372d')/Uplinks('bda43da9d6d8-4fc5-98b7-cb9030e8008e')", "Id": "bda43da9-d6d8-4fc5-98b7-cb9030e8008e", "Name": "test", "Description": "test", "MediaType": "Ethernet", "NativeVLAN": 0, "Summary": { "PortCount": 4, "NetworkCount": 2 }, "Ports@odata.
"Name": "Ether", "Description": "Ethernet_Uplink", "MediaType": "Ethernet", "NativeVLAN": 1, "Ports": [ { "Id": "8Z3D0T2:ethernet1/1/41" }, { "Id": "D23RPK2:ethernet1/1/41" } ], "Networks": [ { "Id": 12715 }, { "Id": 12717 } ] } Example response body Example for creating MAC pools TRUE Example response body { "Name":"New Identity Pool 4", "EthernetSettings": { "Mac": { "IdentityCount":55, "StartingMacAddress": "UFBQUFAA" } }, "IscsiSettings": { "Mac": { "IdentityCount":65, "StartingMacAddress": "YGBgYGAA
} } Table 159. 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. For more information, see /api/ NetworkService/UplinkTypes. NativeVLAN VLAN number, user intends to configure uplink with, as untagged network. Ports/Id The identifier associated to switch port (interface) that the user intends to associate with the given uplink.
"Description": "", "Type": "PhysicalEthernet", "MediaType": "Ethernet", "NodeServiceTag": "1ZB1XC2", "PortNumber": "ethernet1/1/41", "Status": "Down", "AdminStatus": "Enabled", "CurrentSpeed": "0", "MaxSpeed": "0", "ConfiguredSpeed": "0", "OpticsType": "NotPresent", "BlinkStatus": "OFF", "Role": "Uplink" }, { "@odata.type": "#NetworkService.Port", "@odata.
} ] } "ConfiguredSpeed": "0", "OpticsType": "NotPresent", "BlinkStatus": "OFF", "Role": "Uplink" /api/NetworkService/Fabrics(Id)/Uplinks(Id)/Networks This URI represents the network details of a specific uplink in a fabric. GET method for Networks for a specific uplink This method returns the network details of a specific uplink in a fabric. Description Returns the network details of a specific uplink. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
/api/NetworkService/Fabrics('Id')/ NetworkService.GetApplicableUplinkNetworks This API represents uplink network information. POST method for /api/NetworkService/Fabrics('Id')/ NetworkService.GetApplicableUplinkNetworks This method returns the uplinks network information. Description Returns uplink network information.
"value": [ { "@odata.type": "#DeviceService.Device", "@odata.id": "/api/DeviceService/Devices(10056)", "Id": 10056, "Type": 1000, "Identifier": "8YQ1B03", "DeviceServiceTag": "8YQ1B03", "ChassisServiceTag": "C4WK1S2", "Model": "PowerEdge MX740c", "PowerState": 17, "ManagedState": 3000, "Status": 1000, "ConnectionState": true, "AssetTag": null, "SystemId": 1893, "DeviceName": "Sled-7", "LastInventoryTime": "2020-04-25 13:00:51.343", "LastStatusTime": "2020-04-25 13:00:04.
}, { ] "ManagementId": 8609, "NetworkAddress": "[::]", "MacAddress": "4c:d9:8f:92:25:84", "ManagementType": 2, "InstrumentationName": "", "DnsName": "iDRAC-8YQ1B03", "ManagementProfile": [ { "ManagementProfileId": 8609, "ProfileId": "WSMAN_OOB", "ManagementId": 8609, "AgentName": "iDRAC", "Version": "4.00.00.00", "ManagementURL": "unknown", "HasCreds": 0, "Status": 1000, "StatusDateTime": "2020-04-25 13:00:51.343" } ] } ], "Actions": null, "InventoryDetails@odata.
"Identifier": "77BK1S2", "DeviceServiceTag": "77BK1S2", "ChassisServiceTag": "C4WK1S2", "Model": "PowerEdge MX840c", "PowerState": 17, "ManagedState": 3000, "Status": 1000, "ConnectionState": true, "AssetTag": null, "SystemId": 1894, "DeviceName": "Sled-5", "LastInventoryTime": "2020-04-25 13:00:54.618", "LastStatusTime": "2020-04-25 13:00:03.
"ManagementType": 2, "InstrumentationName": "", "DnsName": "iDRAC-77BK1S2", "ManagementProfile": [ { "ManagementProfileId": 8611, "ProfileId": "WSMAN_OOB", "ManagementId": 8611, "AgentName": "iDRAC", "Version": "4.20.20.20", "ManagementURL": "unknown", "HasCreds": 0, "Status": 1000, "StatusDateTime": "2020-04-25 13:00:54.618" } ] } ], "Actions": null, "InventoryDetails@odata.navigationLink": "/api/DeviceService/ Devices(10055)/InventoryDetails", "HardwareLogs@odata.
/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.
} ] } "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/44", "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/44" }, { "Id": "DPM4XC1:ethernet1/1/43", "
Table 160. Attributes Attribute name Description UplinkType ID of the uplink type. For more information, see /api/ NetworkService/UplinkTypes). api/NetworkService/Actions/ NetworkService.UpdateServerUntaggedVLAN This API allows you to update untagged network profiles on an existing interface profile for one or more target servers. POST method for updating untagged network profiles This method allows you to update untagged network profiles on an existing interface profile for one or more target servers.
HTTP response codes Example response body 200 { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 1, "value": [ { "@odata.
} ] } ] } /api/NetworkService/Fabrics(arg1)/Actions/ NetworkService.ReplaceSwitch This URI replaces the fabric switch. POST method for replacing network switch This method replaces the network switch. Description Replaces fabric switches.
"AssetTag": "7IUJMNBGJ", "SystemId": 0, "DeviceName": "ServerNode", "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.
HTTP response codes Example response body 200 { "@odata.context": "/api/$metadata#Collection(NetworkService.ISLLink)", "@odata.count": 4, "value": [ { "@odata.type": "#NetworkService.ISLLink", "@odata.
}, { } "ChassisName": "Chassis-19", "ChassisServiceTag": "GYFJ9N2", "Slot": "IOM-B2", "PortNumber": "41F4MN2:ethernet1/1/9", "PortName": null "@odata.type": "#NetworkService.ISLLink", "@odata.
/api/NetworkService/Fabrics(Id)/Topology/Nodes This URI represents the nodes for a fabric topology. GET method for Nodes This method returns all the nodes for a topology of a specific fabric. Description Returns the nodes for a fabric topology. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 1, "value": [ { "@odata.
} ], "InventoryTypes": { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/InventoryTypes" }, "Settings": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/Settings" } ] } ] } /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.
} ], "HardwareLogs": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/HardwareLogs" } ], "SubSystemHealth": [ { "@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.
/api/NetworkService/Actions/ NetworkService.RemoveUplinks POST method for NetworkService.RemoveUplinks This method deletes multiple fabric uplinks. Description Deletes multiple fabric uplinks.
"Slot": "IOM-B1", "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.
SKY002P1234567890123456789012345","ChassisServiceTag":"SKY002P123456789012345678901234 } ] }, { "Criterion": { "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.
/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 163. 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/Actions/ NetworkService.ApplyServersInterfaceProfiles This URI updates one or more server profile IDs at a time. You can also use this URI to set multiple server profiles at a time.
Table 165. 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. The supported options are: • • • NicBonded LACP Others NoTeaming Indicates if the given NIC port participates in the NIC teaming. It is a binary attribute.
Table 166. 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. The supported options are: • • • NicBonded LACP Others NoTeaming Indicates if the given NIC port participates in the NIC teaming. It is a binary attribute.
/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. To run this API, you must have a server profile with NICs that were deployed using the server deployment process, on the system.
}, { }, { }, { } ] } "@odata.type": "#NetworkService.FeatureCapability", "Name": "PortVLANConfiguration" "@odata.type": "#NetworkService.FeatureCapability", "Name": "FabricLLDPConfiguration" "@odata.type": "#NetworkService.FeatureCapability", "Name": "FCoEUplinkUntaggedVlanConfiguration" Port configuration in Fabrics /api/JobService/Jobs This URI enables you to configure the ports in fabrics. Port configuration operation The APIs in this group use the Job Service and leverage existing inputs.
] POST method for enabling or disabling auto-negotiation This method enables or disables auto-negotiation. Description Enables or disables auto-negotiation.
{ "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.
} } "Id": 3, "Name": "DeviceAction_Task", "Internal": false Table 167. 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. NOTE: Ensure that you see the right parameters in the provided Input snippet. For example, for configuring MTU speed, use Speed as the key and 1000 as the value.
[ } { ] } "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.
Privilege STORAGE_MANAGEMENT HTTP response codes 201 Example request body { } "JobName":"Storage Assignment Task 48", "JobDescription":"Storage Assignment Task", "Schedule":"startnow", "State":"Enabled", "JobType":{ "Id":3, "Name":"DeviceAction_Task" }, "Params":[ { "Key":"operationName", "Value":"ASSIGN_STORAGE" }, { "Key":"assignmentMode", "Value":"2" }, { "Key":"driveSlotIds", "Value": }, { "Key":"serverSlots", "Value":
} "Params":[ { "Key":"operationName", "Value":"CLEAR_STORAGE_ASSIGNMENT" }, { "Key":"assignmentMode", "Value":"2" }, { "Key":"driveSlotIds", "Value": } ], "Targets":[ { "Id":, "Data":"", "TargetType":{ "Id":1000, "Name":"DEVICE" } } ] Force-activate a SAS IOM POST method for force-activating a SAS IOM Description Creates a job to force-activate a SAS IOM.
} ] Clear configuration on SAS IOM POST method for clearing SAS IOM configuration Description Creates a job to clear the configuration on SAS IOM.
} "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.100" }, { "Key": "shareName", "Value": e.
} } "Name": "DEVICE" } ], "Params": [ { "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" }, { "Key": "shareAddress", "Value": e.g: "100.100.100.100" }, { "Key": "shareName", "Value": "/var/cifs" }, { "Key": "shareType", "Value": "CIFS" }, { "Key": "userName", "Value": "" }, { "Key": "password", "Value": "" }, { "Key": "domainName", "Value": "" } ] Quick Deploy /api/JobService/Jobs This URI represents Quick-Deploy jobs.
{ "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.0" }, { "Key":"networkTypeV6", "Value":"Static" }, { "Key":"protocolTypeV6", "Value":"true" }, { "Key":"prefixLength", "Value":"0" }, { "Key":"gatewayV6", "Value":"255.255.255.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "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.
Table 168. Attributes (continued) Attribute name Description 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. subnetMaskV4 IPv4 Subnetwork mask associated with the configuration. Applicable when static IPv4 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 170. 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.
ServerProfiles('PFSTN16')/ServerInterfaceProfiles/Networks(25076)", "Id": 25076, "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-a407e5118f1d85ba" }, … ] }, { "@odata.type": "#NetworkService.ServerInterfaceProfile", "@odata.id": "/api/NetworkService/ServerProfiles('PFSTN16')/ ServerInterfaceProfiles('NIC.
} "Networks": [] /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 172. 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. Template Service /api/TemplateService/Profiles This URI represents the profiles. NOTE: This API is not available in OpenManage Enterprise from version 3.4. GET method for Profiles This method returns the list of available profiles.
TemplateService/Profiles(40)",…}, {"@odata.type": "#TemplateService.Profile", TemplateService/Profiles(48)",…}, {"@odata.type": "#TemplateService.Profile", TemplateService/Profiles(38)",…}, {"@odata.type": "#TemplateService.Profile", TemplateService/Profiles(46)",…}, {"@odata.type": "#TemplateService.Profile", TemplateService/Profiles(37)",…} ] } "@odata.id": "/api/ "@odata.id": "/api/ "@odata.id": "/api/ "@odata.id": "/api/ /api/TemplateService/Profiles(Id) This URI represents a specific profile.
Example response body { "@odata.context": "/api/ $metadata#Collection(TemplateService.ProfileState)", "@odata.count": 8, "value": [ { "@odata.type": "#TemplateService.ProfileState", "Id": 1, "Name": "WaitingDeployment" }, { "@odata.type": "#TemplateService.ProfileState", "Id": 2, "Name": "DeploymentTaskCreated" }, { "@odata.type": "#TemplateService.ProfileState", "Id": 3, "Name": "DeploymentInProgress" }, { "@odata.type": "#TemplateService.
$metadata#Collection(TemplateService.ProfileUsage)", "@odata.count": 4, "value": [ { "@odata.type": "#TemplateService.ProfileUsage", "Id": 1, "Name": "Device" }, { "@odata.type": "#TemplateService.ProfileUsage", "Id": 2, "Name": "Slot" }, { "@odata.type": "#TemplateService.ProfileUsage", "Id": 3, "Name": "DeviceAndSlot" }, { "@odata.type": "#TemplateService.ProfileUsage", "Id": 4, "Name": "ServiceTag" } ] } /api/TemplateService/Actions/ TemplateService.
} } "ShutdownType":0, "TimeToWaitBeforeShutdown":300, "EndHostPowerState":1 /api/TemplateService/Actions/ TemplateService.UpdateProfile This API updates device-specific attributes in server profiles. NOTE: This API is not available in OpenManage Enterprise from version 3.4. POST method for updating profiles This method updates device-specific attributes in server profiles. Description Updates device-specific attributes in the server profile.
HTTP response code Example response body 201 { "SourceDeviceEntityId":1234, "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.
17 APIs specific to OpenManage Enterprise Topics: • • • • • • • • • • • • • • • • • Application settings Console update Mobile Console Preferences Alerts Incoming Alerts Warranty Network Configuration Troubleshoot service Query support service Groups service Profiles Devices Auto deploy Monitor Plugin Manager Power Metrics Application settings Console update /api/JobService/Jobs This URI updates the OpenManage Enterprise appliance.
[ { "Key":"connectionProfile", "Value":"0" } ], "Targets": [ { "Id":500, "Data":"", "TargetType": { "Id":6000, "Name":"GROUP" } } ] } /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.
GET method for UpdateBundleInfo This method returns the job status of the downloaded console update bundle of the OpenManage Enterprise appliance. Description Returns the update job status of the downloaded console update bundle of the OpenManage Enterprise appliance. Privilege VIEW HTTP response code 200 /api/ConsoleUpdateService/Actions/ ConsoleUpdateService.DeleteUpgradeBundle This URL deletes the downloaded console update bundle. NOTE: This API is available in OpenManage Enterprise 3.3.
Mobile /api/AlertService/MobileSubscriptions This URI returns all mobile subscriptions. GET method for MobileSubscriptions This method returns all the mobile subscriptions. Description Returns all the mobile subscriptions. Privilege VIEW HTTP response codes 200 Example Response Body { "@odata.context": "$metadata#Collection(AlertService.MobileSubscription)", "@odata.count": 1, "value": [ { "@odata.
"@odata.context": "$metadata#AlertService.SubscriptionNotificationService/$entity", "@odata.id": "/api/AlertService/SubscriptionNotificationService", "Id": 1, "Status": 2, "Enabled": false, "DateLastRegistration": "1970-01-01 00:00:00.0", "StatusMessage": "The notification service is disabled or is initializing.", "Token": "", "URL": null, "DateLastCommFailure": "2017-08-08 19:50:00.087", "CommFailuresBackoff": "2017-08-08 19:50:00.087" } /api/AlertService/Actions/ AlertService.
/api/AlertService/Actions/ AlertService.EnableSubscriptionNotificationService This URI enables the mobile subscription notifications. POST method for AlertService.EnableSubscriptionNotificationService This method enables notifications of mobile subscriptions. Description Enables notifications of mobile subscriptions. Privilege MONITORING_SETUP HTTP response codes 200 Example Request Body { "Enable":"false" } /api/AlertService/Actions/ AlertService.
"AlertDeviceAssetTag": null, "DefinitionId": -126170178, "CatalogName": "OMSA", "CategoryId": 1000, "CategoryName": "System Health", "SubCategoryId": 61, "SubCategoryName": "Redundancy", "StatusType": 2000, "StatusName": "Not-Acknowledged", "TimeStamp": "2018-09-10 17:45:46.967", "Message": "Redundancy has returned to normal.; Received from address: 10.210.137.100", "EemiMessage": "Instrumentation didn't provide any detailed description for this event.
"Name": "INVALID_DEVICE_HOSTNAME", "Value": "localhost,localhost.localdomain,not defined,pv132t,pv136t,default,dell,idrac-" }, { "Name": "COMMON_MAC_ADDRESSES", "Value": "00:53:45:00:00:00,33:50:6F:45:30:30,50:50:54:50:30:30,00:00:FF:FF:FF:FF,20:4 1:53:59:4E:FF,00:00:00:00:00:00,20:41:53:59:4e:ff,00:00:00:00:00:00" } ] } POST method for SMB settings Description Configures the OpenManage Enterprise SMB settings.
Example Request Body { "ConsoleSetting": [{ "Name": "REPORTS_MAX_RESULTS_LIMIT", "Value": "0", "DataType": "java.lang.Integer", "GroupName": "" } ] } /api/ApplicationService/Settings POST method for ReportSettings Description Configures the maximum limit for the reports. Privilege APPLIANCE_SETUP HTTP response codes 200 Example Request Body { } "ConsoleSetting": [ { "Name": "REPORTS_MAX_RESULTS_LIMIT", "DefaultValue": "1000", "Value": 998, "DataType": "java.lang.
POST method for TrapForwarding Description Configures the OpenManage Enterprise trap forwarding settings. Privilege APPLIANCE_SETUP HTTP response codes 200 Example Request Body { } "ConsoleSetting": [ { "Name": "TRAP_FORWARDING_SETTING", "DefaultValue": "false", "Value": "Normalized", "DataType": "", "GroupName": "" } ] /api/Console/UpdateConsoleSettings This URI enables the option to receive all alerts or alerts corresponding to chassis as an MX7000 chassis onboarding preference.
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 } /api/NetworkConfigurationService/Actions/ NetworkConfigurationService.ImportVLANFromTarget This URI imports the VLAN from the target chassis device. POST method for NetworkConfigurationService.ImportVLANFromTarget Description This method imports the VLAN from the target chassis device.
{ "Key":"deviceTypes", "Value":"1000" }, { "Key":"operationName", "Value":"SERVER_EXECUTE_TSR" }, { "Key":"fileName", "Value":"TSR" }, { "Key":"OPERATION_NAME", "Value":"SERVER_EXECUTE_TSR" }, { "Key":"ShareType", "Value":"2" }, { "Key":"DataSelectorArrayIn", "Value":"[3]" // Collect Logs types }, { "Key":"user_eula_Agreement", "Value":"true" }, { "Key":"ScheduledStartTime", "Value":"TIME_NOW" } ], "Targets": [ { "Id":25085, "Data":"", "TargetType": { "Id":25085, "Name":"SERVER" } } ] } Example to create
{ "Key":"operationName", "Value":"SERVER_DIAGNOSTIC" }, { "Key":"OPERATION_NAME", "Value":"SERVER_DIAGNOSTIC" }, { "Key":"ShareType", "Value":"2" }, { "Key":"RunMode", "Value":"0" }, { "Key":"RebootJobType", "Value":"2" }, { "Key":"ScheduledStartTime", "Value":"TIME_NOW" } ], "Targets": [ { "Id":3714, "Data":"", "TargetType": { "Id":3714, "Name":"SERVER" } } ] } /api/TroubleshootService/Files This URI returns TechSupport Report (TSR) or diagnostic log files.
"FilePath": "/shared/dell/omc/cifs/idrac/F3TPXK2/SERVER_EXECUTE_TSR/TSR/ TSR.zip" } ] Table 173. Attributes Attribute Description DeviceId Device ID of the output file. DeviceOperation 'SERVER_DIAGNOSTIC' to retrieve diagnostic files 'SERVER_EXECUTE_TSR' to retrieve TSR files /api/TroubleshootService/Actions/ TroubleshootService.GetTroubleshootDocument This URI represents TSR/Diagnostic job reports. POST method for TroubleshootService.
/api/TroubleShootService/Actions/ TroubleShootService.DeleteArchivedConsoleLogs This URI deletes archived console logs on the appliance. POST method for TroubleShootService.DeleteArchivedConsoleLogs This method deletes all available archived console logs on the appliance. This method ensures no archived logs are present on the file system.
"@odata.type": "#QuerySupportService.Query", "@odata.id": "/api/QuerySupportService/Queries(10007)", "Id": 10007, "Name": "Warranty Report", "UsageId": 2, "FilterText": "", "ContextId": 2, "Conditions": [], "ResultFields": [], "SortFields": [] } ] } /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.
/api/QuerySupportService/QueryContextSummaries This URI represents summary information for all query contexts. GET method for QueryContextSummaries This method returns summary information for all Query Contexts. A Query Context defines a hierarchical set of tables and fields that are used to define queries for dynamic groups (query groups) and reports. Description This method returns summary information for all Query Contexts. Privilege VIEW HTTP response codes 200 Example Response Body { "@odata.
/api/QuerySupportService/QueryContextSummary(Id) This URI represents summary information for a single query context. GET method for QueryContextSummary(Id) This method returns summary information for a specific query context. Description Returns summary information for a specific query context.. Privilege VIEW HTTP response codes 200 Example Response Body { "@odata.context": "/api/ $metadata#QuerySupportService.QueryContextSummary/$entity", "@odata.type": "#QuerySupportService.
"Name": "Alert", "Description": null, "ParentTableId": -1 } ], "Fields": [ { "Id": 17, "Name": "Device Name", "TableId": 5, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 18, "Name": "Device Global Status", "TableId": 5, "Description": null, "FieldTypeId": 4, "StrMaxLen": 0, "EnumOpts": [ { "Id": 1000, "Name": "Normal" }, { "Id": 2000, "Name": "Unknown" }, { "Id": 3000, "Name": "Warning" }, { "Id": 4000, "Name": "Critical" }, { "Id": 5000, "Name": "No Status" } ] }, { "I
} "EnumOpts": [] }, { "Id": 15, "Name": "Sub-Category Prefix", "TableId": 4, "Description": null, "FieldTypeId": 1, "StrMaxLen": 20, "EnumOpts": [] }, { "Id": 16, "Name": "Sub-Category Description", "TableId": 4, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 3, "Name": "Alert Status", "TableId": 1, "Description": null, "FieldTypeId": 4, "StrMaxLen": 0, "EnumOpts": [ { "Id": 1000, "Name": "Acknowledged" }, { "Id": 2000, "Name": "Not Acknowledged" } ] }, { "Id": 5, "Name"
/api/QuerySupportService/QueryContexts(Id)/ QuerySupportService.GetFiltersForContext This URI represents summary information for all filters (queries) defined by using a specific Query Context. GET method for QuerySupportService.GetFiltersForContext This method returns summary filter information for all queries defined by using a specific Query Context. For the QuerySupportService, the term 'filter' refers to the row selection conditions for a query—WHERE part of a SQL statement.
{ }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Id": 1016, "Name": "Hyper-V Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1011, "Name": "Linux Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1000, "Name": "Modular Systems", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1006, "Name": "Network Devices", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1025, "Name": "Non-Dell Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1023, "Name":
}, { }, { }, { }, { }, { ] } "Name": "Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1012, "Name": "Storage Devices", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1015, "Name": "VMware ESXi Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1018, "Name": "VxRAIL", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1024, "Name": "Windows Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1019, "Name": "XC", "UsageId": 1, "FilterText": "", "ContextId":
HTTP response codes Example Response Body 200 { "@odata.context": "/api/$metadata#QuerySupportService.OperatorInfo/$entity", "@odata.type": "#QuerySupportService.OperatorInfo", "@odata.
} 528 "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-Time", "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 ] } ] APIs specific to OpenManage Enterprise
/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.context": "/api/ $metadata#Collection(QuerySupportService.Filter)", "@odata.count": 23, "value": [ { "@odata.type": "#QuerySupportService.Filter", "@odata.
{ } ] } "@odata.type": "#QuerySupportService.Filter", "@odata.id": "/api/QuerySupportService/Filters(1006)", "Id": 1006, "Name": "Network Devices", "UsageId": 1, "FilterText": "", "ContextId": 2, "Conditions": [] /api/QuerySupportService/Filters(Id) This URI represents detailed information for a query filter. GET method for Filters(Id) This method returns detailed information for a specific query filter. Description Returns detailed information for a specific query filter.
"OperatorId": 1, "Value": "203", "RightParen": true } ] } Groups service NOTE: OData filtering does not work as expected when the following special characters are used: ,, \, _, %, #, ', +, ), and &. /api/GroupService/Groups This URI represents the groups. POST method for Groups This method creates a group. Description Creates a group.
/api/GroupService/Groups(Id)/SubGroups(Id) This URI represents a subgroup within a group. While using this URI, provide the ID of the parent group and the ID of the subgroup. DELETE method for SubGroups(Id) This method deletes a subgroup. Description Deletes a subgroup. Privilege DEVICE_CONFIGURATION HTTP response codes 204 Table 176. Attributes Attribute name Description Id—Groups(Id) ID of the parent group. Id—SubGroups(Id) ID of the subgroup.
/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. Privilege VIEW HTTP response codes 200 Example Response Body { } "@odata.context": "$metadata#Collection(GroupService.StatusSummary)", "@odata.
/api/GroupService/Groups(group id)/ EventSeveritySummary$filter=StatusType eq 1 This URL returns the count of all the alerts. GET method for EventSeveritySummary$filter=StatusType eq 1 Description This method returns the count of all the alerts. /api/GroupService/GroupAudits This URI represents the group hierarchy. GET method for GroupAudits This method returns device groups and groups hierarchy changes. Description Returns device groups and groups hierarchy changes.
}] } } /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. Privilege GROUP_MANAGEMENT HTTP response codes 200 Example Request Body { "GroupModel": { "Id":25003, "Name": "Name update", "MembershipTypeId": 12, "ParentId": 1021 } } /api/GroupService/Actions/GroupService.Clone This URI represents cloning of a group. POST method for GroupService.
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.AddMemberDevices This method adds devices to a group. Description Adds devices to a group.
/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. Privilege GROUP_MANAGEMENT HTTP response codes 204 Example Request Body { } "UserId" : 3864, "GroupIds" : [1314, 1264] Profiles /api/ProfileService/Profiles This URI is used to create one or more profiles. POST method for Profiles Description This method creates one or more profiles.
Privilege VIEW HTTP response codes 200 /api/ProfileService/Profiles(arg) This URI is used to update the profile information, such as name, description, attributes, and boot ISO. PUT method for Profiles(arg) Description This method updates the profile information, such as name, description, attributes, and boot ISO.
/api/ProfileService/Profiles(arg1)/AttributeDetails This URI retrieves the attribute information for a profile id. GET method for AttributeDetails Description This method retrieves the attribute information for a profile id. Privilege VIEW HTTP response codes 200 Example response body { } "ProfileId": 10079 /api/ProfileService/Actions/ProfileService.Rename This URI renames existing profiles. POST method for ProfileService.Rename Description This method renames existing profiles.
/api/ProfileService/Actions/ ProfileService.GetIdentityAttributes This URI retrieves the virtual identities associated with a profile id. POST method for ProfileService.GetIdentityAttributes Description This method retrieves the virtual identities associated with a profile id. Privilege VIEW HTTP response codes 200 Example request body { } "ProfileId": 10079 /api/ProfileService/Actions/ProfileService.AssignProfile This URI assigns a profile to a target device. POST method for ProfileService.
} } /api/ProfileService/Actions/ ProfileService.AssignProfileForAutoDeploy This URI assigns profiles to the auto-deploy identifier. POST method for ProfileService.AssignProfileForAutoDeploy Description This method assigns profiles to the auto-deploy identifier.
} "Schedule": { "RunNow": true, "RunLater": false, "Cron": "", "StartTime": "" }, "SelectAll": false, "Filters": "*" /api/ProfileService/Actions/ProfileService.MigrateProfile This URI migrates profiles from one device to another. POST method for ProfileService.MigrateProfile Description This method migrates profiles from one device to another.
/api/ProfileService/ProfileStates This URI retrieves the profile state information for all the profiles. GET method for ProfileStates Description This method retrieves the profile state information for all the profiles. Privilege VIEW HTTP response codes 200 /api/ProfileService/Actions/ProfileService.Delete This URI deletes the profiles. POST method for ProfileService.Delete Description This method deletes the profiles.
/api/ProfileService/Actions/ ProfileService.GetInvalidTargetsForDeployTemplate This URI provides the invalid targets for template deployment. POST method for ProfileService.GetInvalidTargetsForDeployTemplate Description This method provides the invalid targets for template deployment Privilege TEMPLATE_MANAGEMENT HTTP response codes 200 Example request body { } "Id":9 /api/ProfileService/Actions/ ProfileService.
"@odata.context": "/api/$metadata#Collection(DeviceService.HostKey)", "@odata.count": 1, "value": [ { "@odata.type": "#DeviceService.HostKey", "@odata.id": "/api/DeviceService/HostKeys(1)", "Id": 1, "Identifier": "1.1.1.
/api/DeviceService/Actions/ DeviceService.ScanAndAddKeys This URL automatically scans and adds the known keys. POST method for DeviceService.ScanAndAddKeys Description This method automatically scans and adds the known keys. Privilege DEVICE_CONFIGURATION HTTP response codes 200 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.
"CredentialProfile": { "CredentialProfileId": 0, "CredentialProfile": "{\"profileName\":\"\",\"profileDescription \":\"\", \"type\":\"MANAGEMENT\",\"credentials\":[{\"id\":0,\"type\":\"WSMAN\", \"authType\":\"Basic\",\"modified\":false,\"credentials\":{\"username \":\"asdf\", \"password\":\"sdf\",\"caCheck\":false,\"cnCheck\":false,\"port \":443,\"retries\":3, \"timeout\":60,\"isHttp\":false,\"keepAlive\":false}},{\"id\":0,\"type \":\"REDFISH\", "authType\":\"Basic\",\"modified\":false,\"credentials\":{\"us
} ] } "TemplateTypeId": 2, "TemplateName": "test-migrate", "GroupName": null, "IsBootToNetworkIso": false, "ShareIp": null, "ShareType": null, "IsoPath": null, "TaskId": 0, "TaskLastRunStatusId": 2200, "CreatedBy": "admin", "CreatedOn": "2019-05-15 17:24:29.411303" /api/AutoDeployService/Actions/ AutoDeployService.Verify This URL validates the identifiers. Post method for AutoDeployService.Verify Description This method validates the identifiers.
Table 177. Attributes Attribute name Description 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.Delete This URL deletes the list of autoDeployDevice IDs. POST method for 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.
}, { }, { }, { } 552 ] } "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 178. 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.
"DeviceType":[ 1000 ] } ], "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":[ { "DiscoveryConfigTarget
{ "DiscoveryConfigTargetId":0, "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\":
\":4,\"isHttp\":false,\"keepAlive\":false}}]}", "DeviceType":[ 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.
"DiscoveryConfigId": 916135421, "DiscoveryConfigDescription": "", "DiscoveryConfigStatus": "", "DiscoveryConfigTargets": [{ "DiscoveryConfigTargetId": 0, "NetworkAddressDetail": "x.x.x.x", "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\":
HTTP response codes 201 Example request body { fileName="abc.csv" } /api/DiscoveryConfigService/DiscoveryConfigGroups(groupId) This URI updates a discovery task. PUT method for DiscoveryConfigGroups(groupId) This method edits a discovery task. Description Edits a discovery task.
{ "DiscoveryConfigId": 331105536, "DiscoveryConfigDescription": "", "DiscoveryConfigStatus": "", "DiscoveryConfigTargets": [ { "DiscoveryConfigTargetId": 0, "NetworkAddressDetail": "xx.xx.xx.xx-xx.xx.xx.xx", "SubnetMask": null, "AddressType": 1, "Disabled": false, "Exclude": false } ], "ConnectionProfileId": 0, "ConnectionProfile": "{\"profileName\":\"\",\"profileDescription \":\"\",\"type\":\"DISCOVERY\",\"credentials\":[{\"id\":0,\"type\":\"REDFISH \",\"authType\":\"Basic\",\"modified\":false,\"credentia
Server-initiated discovery /api/DiscoveryConfigService/Actions/ DiscoveryConfigService.UploadNodeInfo This URI uploads or creates the server credentials to the OpenManage Enterprise console. POST method for ConfigService.UploadNodeInfo Description This method uploads the server credentials to the OpenManage Enterprise console.
/api/DiscoveryConfigService/Actions/ DiscoveryConfigService.DiscoverNodes This URI is used to discover the servers manually after the servers initiate contact with the OpenManage Enterprise console and the credentials of the servers are added to the console. POST method for DiscoveryConfigService.
"ServiceTag": "B600", "HasCredentials": true, "IpAddress": "10.35.0.50", "Status": "Discovered", "AnnouncedTime": "2019-12-17 11:56:30.998267", "DiscoveryTime": "2019-12-17 11:56:30.998267", "TaskId": 10096, "CreatedBy": "admin", "CreatedOn": "2019-12-17 11:56:30.998267" }, { "@odata.type": "#DiscoveryConfigService.AnnouncedTarget", "@odata.id": "/api/DiscoveryConfigService/SignaledNodes(26)", "Id": 26, "ServiceTag": "B700", "HasCredentials": true, "IpAddress": "10.35.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 180.
/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 181.
}, { "Sequence":3, "Name":"Software Component ID" "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.
"Conditions": [{ "LogicalOperatorId": 1, "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 182. Attributes Attribute name Description ID Report ID Name Report Name Description Definition of the report. FilterGroupId Group to filter the report output.
}, { "Id": 22, "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.
] } } "@odata.type": "#ReportService.ReportResultRow", "Values": [ "iDRAC-792B0M2", "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.
/api/ReportService/Actions/ReportService.DeleteReports This URI represents the reports deletion. POST method for ReportService.DeleteReports This method deletes all the reports. Description Deletes all the reports. Privilege REPORT_MANAGEMENT HTTP response codes 200 Example request body [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.
MIB import service /api/MIBImportService/MIBS This URI represents the MIB traps. GET method for MIBS This method returns the traps imported from all the MIBs. All the traps with information are listed and they an be grouped based on the catalog name. Description Returns the traps imported from all the MIBs. Privilege VIEW HTTP response codes 200 Example request body { "@odata.context": "/api/ $metadata#Collection(MIBImportService.GetTrapsPayload)", "@odata.count": 2269, "value": [{ "@odata.
HTTP response codes Example response body 200 [{ "EnterpriseOid": ".1.3.6.1.4.1.674.10892.1123123", "EventDefinition": { "EventCatalog": { "EventCatalogId": 1000, "Name": "MIB-Dell-10892", "ReleaseVersion": "7.4.
/api/MIBImportService/Actions/MIBImportService.Delete This URI represents the deletion of MIBs. POST method for MIBImportService.Delete This method deletes all the MIB files and the corresponding traps from the system. Description Deletes all the MIB files and the corresponding traps from the system. Privilege TRAP_MANAGEMENT HTTP response codes 200 Example request body [1005] /api/MIBImportService/MIBImportService/EventSeverities This URI represents the event severities.
"value": [{ "@odata.type": "#MIBImportService.MIBEventCatalog", "@odata.id": "/api/MIBImportService/EventCatalogs(1000)", "BuiltIn": true, "EventCatalogId": 1000, "CatalogName": "OMSA", "InternalName": "MIB-Dell-10892", "ReleaseVersion": "7.4.0" }] } /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.
{ "@odata.type": "#PluginService.Plugin", "@odata.id": "/api/PluginService/Plugins('2F6D05BE-EE4B-4B0EB873-C8D2F64A4625')", "Id": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625", "Auto": false, "Name": "Power Manager", "UpdateAvailable": false, "Installed": true, "Enabled": true, "Publisher": "DELL EMC", "CurrentVersion": "1.0.0.
/api/PluginService/Plugins('') This URL returns the individual plug-in information. GET method for Plugins('') Description This method returns the individual plug-in information. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#PluginService.Plugin", "@odata.type": "#PluginService.Plugin", "@odata.
HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(PluginService.VersionDetail)", "@odata.count": 1, "value": [ { "@odata.type": "#PluginService.VersionDetail", "Version": "1.0.0.9", "Description": "Dell EMC OpenManage Enterprise Power Manager is an extension to the Dell EMC OpenManage Enterprise console and uses finegrained instrumentation to provide increased visibility over power consumption, anomalies, and utilization.
Example request body { } "OmeVersion": "1.0.0", "Plugins": [ { "Id": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625", "Version": "1.0.0.9" } ] Response: { "Plugins": [ { "Id": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625", "Compatible": false } ] } Table 185. 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.
} Example response body ] } "Id": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4626", "Version": "1.1.0", "Action": "Install" 12098 Table 186. Attributes Attribute Description Id ID of the plug-in. Version Version of the plug-in. Action Plug-in Action—Install or Uninstall or Enable or Disable or Update. 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.
} Example response body ], "Duration": 0, "SortOrder":0 { "EntityId": 10397, "Value":[ { "Type": "1", "Value": "230.0", "Timestamp": "2019-07-02 13:45:05.147666" }, { "Type": "2", "Value": "177.0", "Timestamp": "2019-07-02 13:45:05.147666" }, { "Type": "3", "Value": "197.0", "Timestamp": "2019-07-02 13:45:05.147666" } ] } Table 187. Attributes Attribute Description PluginId ID of a plug-in. EntityType Type of entity—device or group. EntityId ID of an entity—device or group.
Table 187.
} Example response body "EntityType": 0, "DeviceType": 1000, "Duration": 8 { "PluginId": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625", "Value": [ { "Id": 10398, "Name": "SKCLUSN1.tejd.bdcsv.lab", "Value": "0.060" }, { "Id": 10397, "Name": "SKCLUSN1.tejd.bdcsv.lab", "Value": "0.060" }, { "Id": 10396, "Name": "SKCLUSN1.tejd.bdcsv.lab", "Value": "0.000" }, { "Id": 10395, "Name": "SKCLUSN1.tejd.bdcsv.lab", "Value": "0.000" } ] } Table 188. Attributes Attribute Description PluginId ID of plug-in.
Table 188. Attributes (continued) Attribute Description 10 One year /api/MetricService/EnergyConsumption This URL returns the energy consumption of the device. POST method for EnergyConsumption Description This method returns the energy consumption of the device in KWH. Privilege VIEW HTTP response codes 201 Example request body { } Example response body { } "PluginId": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625", "EntityType": 0, "EntityId": 10395, "Duration": 4 "TotalEnergy": "0.
/api/MetricService/MetricTypes This URL returns all the supported metric types. GET method for MetricTypes Description This method returns all the supported metric types. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Collection(MetricService.MetricType)", "@odata.count": 19, "value": [ { "@odata.type": "#MetricService.MetricType", "Id": 1, "Name": "MAX_POWER", "Description": "Maximum System Power Consumption" }, { "@odata.type": "#MetricService.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { } 586 ] } "Id": 9, "Name": "MAX_UTIL_CPU", "Description": "Maximum CPU uitilization" "@odata.type": "#MetricService.MetricType", "Id": 10, "Name": "MIN_UTIL_CPU", "Description": "Minimum CPU uitilization" "@odata.type": "#MetricService.MetricType", "Id": 11, "Name": "AVG_UTIL_CPU", "Description": "Average CPU utilization" "@odata.type": "#MetricService.
/api/MetricService/MetricsConsumption This URL represents the aggregated metrics of the device or group. POST method for MetricsConsumption Description This method returns the aggregated metrics of the device or group. Privilege VIEW HTTP response codes 201 Example request body { } Example response body { } "PluginId": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625", "EntityType": 0, "EntityId": 10397, "Duration": 1, "MetricTypes": [1,2,3] "Value": [ { "Type": "1", "Value": "242.
Table 190. Attributes (continued) Attribute Description 7 Three months 8 Six months 9 One year Metric Types 1 MAX_POWER 2 MIN_POWER 3 AVG_POWER /api/MetricService/Threshold This URL represents the threshold set for an entity. POST method for Threshold Description This method returns the threshold value for power and temperature.
Table 191. Attributes (continued) Attribute Description LowerCritical Lower limit threshold of state critical. /api/MetricService/TopOffenders This URL returns the highest power and temperature information of offenders. GET method for TopOffenders Description This method returns the highest power and temperature information of offenders. Privilege VIEW HTTP response codes 200 Example response body { ] } "@odata.context": "/api/$metadata#Collection(MetricService.TopOffender)", "@odata.
Table 192. Attributes (continued) Attribute Description UpperCritical Upper critical threshold value UpperWarning Upper warning threshold value LowerCritical Lower critical threshold value LowerWarning Lower warning threshold value Entity Type 1 Device 2 Group Threshold Type 3 Power 7 Temperature Violation State 1 Unknown 2 Normal 3 Warning 4 Critical /api/MetricService/Actions/MetricService.SaveThreshold This URL configures the threshold of the device or group.
} "LowerWarning": "20", "LowerCritical": "10" Table 193. 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.
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 194. 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 195. 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.
Table 197. Attributes (continued) 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.
} "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 198. Attributes Attribute name Description ID ID of the account service. Description Description of the account service. Name Name of the account service.
/redfish/v1/AccountService/Accounts/Members This URI represents a collection of all the accounts. GET method for Members This method returns a collection of all the accounts. Description Returns a collection of all the accounts. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/redfish/ v1/$metadata#Collection(ManagerAccount.v1_1_3.ManagerAccount)", "@odata.count": 2, "value":[ { "@odata.type": "#ManagerAccount.v1_1_3.ManagerAccount", "@odata.
Table 199. Attributes (continued) Attribute name Description Password Password for the user. This value is not displayed while retrieving the details. UserName User name of the account. RoleId Role for the account. Locked Indicates whether the account is locked. IsBuiltin Indicates whether the account is an integrated account. Enabled Indicates whether the account is enabled. POST method for Members This method creates an account. Description Creates an account.
Table 200. Attributes (continued) Attribute name Description UserName User name of the account. RoleId Role for the account. Locked Indicates whether the account is locked. IsBuiltin Indicates whether the account is an integrated account. Enabled Indicates whether the account is enabled. /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.
Table 201. Attributes (continued) Attribute name Description Locked Indicates whether the account is locked. IsBuiltin Indicates whether the account is an integrated account. Enabled Indicates whether the account is enabled. PUT method for Members(Id) This method changes the settings of an account. Description Modifies an account.
Table 202. Attributes (continued) Attribute name Description Locked Indicates whether the account is locked. IsBuiltin Indicates whether the account is an integrated account. Enabled Indicates whether the account is enabled. DELETE method for Members(Id) This method deletes an account. Description Deletes an account. Privilege SECURITY_SETUP HTTP response codes 204 Example Input: Output: Table 203. Attributes Attribute name Description Id ID of the account to be deleted.
AccountService/Roles/Members('12')",…}, {"@odata.type": "#Role.v1_2_2.Role", "@odata.id": "/redfish/v1/ AccountService/Roles/Members('15')",…}, { "@odata.type": "#Role.v1_2_2.Role", "@odata.id": "/redfish/v1/AccountService/Roles/Members('16')", "Id": "16", "Description": "Read-only privileges across the system", "Name": "VIEWER", "IsPredefined": true } ] } /redfish/v1/AccountService/Roles/Members(Id) This URI represents the role details of a specific account.
Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/redfish/ v1/$metadata#MessageRegistryFileCollection.MessageRegistryFileCollection", "@odata.type": "#MessageRegistryFileCollection.MessageRegistryFileCollection", "@odata.id": "/redfish/v1/Registries", "Name": "Message Registry File Collection", "Members@odata.count": 1, "Members": [ { "@odata.
}, { "Language": "ja", "Uri": "/redfish/v1/MessageRegistryCollection/ Members('EEMIRegistry.v1_0_0_ja')" }, { "Language": "es", "Uri": "/redfish/v1/MessageRegistryCollection/ Members('EEMIRegistry.v1_0_0_es')" }, { "Language": "de", "Uri": "/redfish/v1/MessageRegistryCollection/ Members('EEMIRegistry.v1_0_0_de')" }, { "Language": "ko", "Uri": "/redfish/v1/MessageRegistryCollection/ Members('EEMIRegistry.
/redfish/v1/Chassis This URI represents the chassis information. GET method for Chassis This method returns the chassis instances. Description Returns the details of the chassis. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/redfish/ v1/$metadata#ChassisCollection.ChassisCollection", "@odata.type": "#ChassisCollection.ChassisCollection", "@odata.id": "/redfish/v1/Chassis", "Name": "Chassis Collection", "Members@odata.count": 6, "Members": [ { "@odata.
"Name": "IOM-B2", "ChassisType": "Component", "Manufacturer": "Dell EMC", "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.
"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.
}, "PowerLimit":{ "LimitInWatts": 0, "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.
"@odata.id": "/redfish/v1/Chassis/Members('10057')/Thermal", "Id": "Thermal", "Description": "Chassis Thermal Information", "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.
Example response body { "@odata.context": "/redfish/v1/$metadata#Thermal.v1_0_0.Fan", "@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.
HTTP response code 202 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 205.
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.
{"@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.id": "/redfish/v1/CompositionService/ResourceBlocks/Members('7')"}, {"@odata.
"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.id": "/redfish/v1/Systems/Members('10055')/Storage" } } redfish/v1/Systems/Members(id)/Processors This API represents server processor information.
HTTP response code Example response body 200 { "@odata.context": "/redfish/v1/$metadata#Processor.v1_0_0.Processor", "@odata.type": "#Processor.v1_0_0.Processor", "@odata.id": "/redfish/v1/Systems/Members('10055')/Processors/ Members('9787')", "Id": "9787", "Name": "CPU.Socket.2", "Socket": "CPU.Socket.
Members('15679')" }, { "@odata.id": "/redfish/v1/Systems/Members('10189')/EthernetInterfaces/ Members('15680')" }, { "@odata.id": "/redfish/v1/Systems/Members('10189')/EthernetInterfaces/ Members('15681')" } ] } redfish/v1/Systems/Members(id)/EthernetInterfaces/ Members(id) This API represents server Ethernet interface information, by IDs. GET method for Ethernet Interfaces by ID This method returns the server Ethernet Interface information, by Ethernet interface ID.
HTTP response code Example response body 200 { "@odata.context": "/redfish/ v1/$metadata#SimpleStorageCollection.SimpleStorageCollection", "@odata.type": "#SimpleStorageCollection.SimpleStorageCollection", "@odata.id": "/redfish/v1/Systems/Members('10189')/SimpleStorage", "Name": "Simple Storage Collection", "Members@odata.count": 3, "Members":[ { "@odata.id": "/redfish/v1/Systems/Members('10189')/SimpleStorage/ Members('9807')" }, { "@odata.
{"@odata.type": "#SimpleStorage.v1_0_0.SimpleStorage", "@odata.id": "/ redfish/v1/Systems/Members('10055')/SimpleStorage/Members('10056')",…} ] } redfish/v1/Systems/Members(id)/SimpleStorage/ Members(id) This API represents the simple server storage details, by storage device ID. GET method for storage devices by ID This method returns the simple server storage details, by storage device ID. Description Returns the simple server storage details, by storage device ID.
Table 207. 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. Privilege VIEW HTTP response code 200 Example response body { "@odata.
Example response body { "@odata.context": "/redfish/ v1/$metadata#ResourceBlockCollection.ResourceBlockCollection", "@odata.type": "#ResourceBlockCollection.ResourceBlockCollection", "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks", "Description": "Resource Blocks in MX Chassis", "Name": "Resource Block Collection", "Members@odata.count": 24, "Members":[ { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Members('1')" }, { "@odata.
}, { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Members('48')" }, { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Members('49')" }, { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Members('50')" } ] } redfish/v1/CompositionService/ResourceBlocks/ Members() This API represents the power information of a device, by the device ID. GET method for ResourceBlocks by ID This API returns the power information of a device, by device ID.
{ "@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. Description Returns the power control information. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/redfish/v1/$metadata#ZoneCollection.ZoneCollection", "@odata.type": "#ZoneCollection.
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.type": "#Zone.v1_0_0.Zone", "@odata.
/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. Privilege DEVICE_CONFIGURATION HTTP response code 202 Example request body { "ResourceBlock": { "@odata.
