OpenManage Enterprise Version 3.0 and OpenManage Enterprise - Modular Edition Version 1.00.01 RESTful API Guide March 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 - 2019 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents 1 About this document................................................................................................................... 12 2 Overview....................................................................................................................................13 RESTful application programming interface..................................................................................................................... 13 OData...................................................
/api/AccountService/Roles.........................................................................................................................................43 /api/AccountService/Roles(Id)...................................................................................................................................44 /api/AccountService/ExternalAccountProvider.......................................................................................................
/api/AlertService/AlertPolicies(Arg1)/PolicyActions(Arg2)................................................................................... 99 /api/AlertService/AlertActionTemplates................................................................................................................. 100 /api/AlertService/AlertActionTemplates(Id)............................................................................................................101 /api/AlertService/Actions/AlertService.
Identity pools....................................................................................................................................................................... 151 /api/IdentityPoolService/IdentityPools.....................................................................................................................151 /api/IdentityPoolService/IdentityPools(Id)..............................................................................................................
GET method for BlinkStatus.......................................................................................................................................194 /api/DeviceService/Devices(Id)/PowerUsageByDevice.............................................................................................194 GET method for PowerUsageByDevice....................................................................................................................194 /api/DeviceService/Devices(Id)/DeviceBladeSlots.
GET method for GroupHierarchy.............................................................................................................................. 220 /api/GroupService/GroupTypes.................................................................................................................................... 220 GET method for GroupTypes....................................................................................................................................
14 Search.................................................................................................................................... 251 /api/SearchService/Actions/SearchService.Search................................................................................................... 251 POST method for SearchService.Search................................................................................................................. 251 /api/SearchService/Actions/SearchService.GetDocument.........
/api/NetworkService/Fabrics(Id)/Uplinks..............................................................................................................309 /api/NetworkService/Fabrics(Id)/Uplinks(Id)........................................................................................................ 310 /api/NetworkService/Fabrics(Id)/Uplinks(Id)/Ports.............................................................................................312 /api/NetworkService/Fabrics(Id)/Uplinks(Id)/Networks.........
/api/TroubleshootService/Actions/TroubleshootService.GetTroubleshootDocument....................................360 /api/TroubleShootService/Actions/TroubleShootService.GetArchivedConsoleLogs.......................................361 /api/TroubleShootService/Actions/TroubleShootService.DeleteArchivedConsoleLogs.................................. 361 Query support service............................................................................................................................................
1 About this document This document contains information about the resource models for OpenManage Enterprise (OME) 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 and do not work if used in OME - Modular and vice-versa. Table 1. Supported REST API versions Product Version OpenManage Enterprise - Modular Edition 1.00.01 OpenManage Enterprise 3.
2 Overview RESTful API support in OME and OME - Modular OME - Modular supports RESTful API. Support for APIs has also been improved for OME. 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. The APIs enable you to build console management tools based on common programming and scripting languages such as Python, Java, and C.
for growing businesses. A unified web and RESTful API interface manages all nodes including compute, storage, and networking. OME Modular helps reduce costs and learning curve, and consolidates multiple tools for ease of access and monitoring. Simplified administration helps deploy and monitor at scale, from one to many chassis, with support for remote management.
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 OME 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://10.35.0.133/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 Table 5.
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. HTTP methods HTTP method Description Example GET Used for retrieving the resource representation.
Filter devices by system ID /api/DeviceService/Devices?$filter=SystemId eq 123 Filter devices by model /api/DeviceService/Devices?$filter=Model eq 'PowerEdge MX740c' Filter devices by device type /api/DeviceService/Devices?$filter=Type eq 3000 or Type eq 5000 NOTE: For enumeration of Type, see /api/DeviceService/DeviceType. For more information about $filter, see OData Version 4.0 Part 1: Protocol at docs.oasis-open.org.
Table 7. Examples of request headers(continued) Request Header Description Example 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. For operations that take a long time, the server returns a status code of 202 along with an HTTP response header (Location). This response corresponds to the URI of the temporary resource that can be used to monitor the operation.
Table 9. Examples of response headers(continued) Response Header Description Example (using the Accept header), the server chooses the appropriate supported format. Keep-alive • • Timeout header parameter indicates the Timeout=5; max=150 time that a connection is allowed to remain idle before it is closed. Max header parameter indicates the maximum number of requests that are permitted before the connection is closed. Content-length The length of the request body in 8-bit bytes or octets.
4 Application settings Network /api/ApplicationService/Network This URI represents the collection of network application services. GET method for Network This method returns the network configuration details. Description Returns the network configuration details. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Network.Network/$entity", "@odata.id": "/api/ApplicationService/Network", "Actions": null, "ProxyConfiguration": { "@odata.
/api/ApplicationService/Network/ CurrentAddressConfiguration This URI represents the current network IP configuration. GET method for CurrentAddressConfiguration This method returns the current network IP configuration. Description Returns the current network IP configuration. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Network.CurrentAddressConfiguration/ $entity", "@odata.type": "#Network.CurrentAddressConfiguration", "@odata.
Table 10. Attributes(continued) Attribute name Description Ipv4Setting.CurrentPreferredDNSServer Current IPv4 DNS preferred server. Ipv4Setting.CurrentAlternateDNSServer Current IPv4 DNS alternate server. Ipv6Setting.Enable IPv6 network settings status. Ipv6Setting.EnableAutoConfiguration IPv6 via DHCP server status. Ipv6Setting.CurrentIPAddress Current IPv6 address. Ipv6Setting.CurrentGateway Current IPv6 prefix length. Ipv6Setting.CurrentLinkLocalAddress Current IPv6 gateway address.
} "StaticAlternateDNSServer": "" }, "ManagementVLAN": { "EnableVLAN": false, "Id": 1 }, "DnsConfiguration": { "RegisterWithDNS": false, "DnsName": "MX7000", "UseDHCPForDNSDomainName": false, "DnsDomainName": "" }, "Delay": 0 PUT method for AddressConfiguration This method updates the network configuration. Description Updates the network configuration. Privilege APPLIANCE_SETUP HTTP response codes 200 Example 28 Input: { "@odata.context": "/api/$metadata#Network.
Output: { "EnableNIC": true, "Ipv4Configuration": { "Enable": true, "EnableDHCP": true, "StaticIPAddress": "", "StaticSubnetMask": "", "StaticGateway": "", "UseDHCPForDNSServerNames": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "Ipv6Configuration": { "Enable": false, "EnableAutoConfiguration": true, "StaticIPAddress": "", "StaticPrefixLength": 0, "StaticGateway": "", "UseDHCPForDNSServerNames": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "ManagementVLA
Table 11. Attributes(continued) Attribute name Description Ipv6Configuration.StaticIPAddress Set Static IPv6 address. Ipv6Configuration.StaticPrefixLength Set Static IPv6 prefix length. Ipv6Configuration.StaticGateway Set Static IPv6 gateway address. Ipv6Configuration.UseDHCPForDNSServerNames Obtain IPv6 DNS servers via DHCP server options. Ipv6Configuration.StaticPreferredDNSServer Set Static IPv6 DNS preferred server. Ipv6Configuration.
HTTP response codes Example 200 Input: { "TimeOut": 4, "PortNumber": 8778, "EnableWebServer": true } Output: { "@odata.context": "$metadata#Network.WebServerConfiguration/$entity", "@odata.id": "/api/ApplicationService/Network/WebServerConfiguration", "TimeOut": 30, "PortNumber": 443, "EnableWebServer": true } /api/ApplicationService/Network/TimeConfiguration This URI represents the time-configuration-related application services.
} "SecondaryNTPAddress2": null, "SystemTime": "2017-35-23 21:35:18" Output: { "TimeZone": "TZ_ID_11", "EnableNTP": false, "PrimaryNTPAddress": null, "SecondaryNTPAddress1": null, "SecondaryNTPAddress2": null, "SystemTime": "2017-35-23 21:35:18" } Table 12. 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.
Table 13. Attributes Attribute Description Utcoffsetminutes The number of minutes this time zone is offset from UTC. Id The ID of the time zone. Name The name or location of the time zone. /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.
} "EnableProxy": false Table 14. Attributes Attribute name Description IpAddress Proxy Address, if HTTP Proxy Settings is enabled. PortNumber Port number, if HTTP Proxy Settings is enabled. EnableAuthentication Enable or disable Proxy Authentication. EnableProxy Enable or disable HTTP Proxy Settings. Username Username, if Proxy Authentication is enabled. Password Password, if Proxy Authentication is enabled.
} ], "Roles": [ { "@odata.id": "/api/AccountService/Roles" } ], "ExternalAccountProvider": { "@odata.id": "/api/AccountService/ExternalAccountProvider" } Table 15. 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.
} "Name": "Account Service", "Status": { "State": "Enabled", "HealthRollup": "OK", "Health": "OK" }, "ServiceEnabled": false, "AuthFailureLoggingThreshold": 3, "MinPasswordLength": 8, "MaxPasswordLength": 20, "AccountLockoutThreshold": 3, "AccountLockoutDuration": 30, "AccountLockoutCounterResetAfter": 900, "EnableIpRangeAddress": false, "IpRangeAddress": null, "ByUserName": false, "ByIPAddress": false Output: { "Id": "10", "Description": "MSM User Accounts", "Name": "Account Service", "Status": { "State"
Table 16. Attributes(continued) Attribute Description AccountLockoutThreshold The number of failed login attempts before a user account is locked for a specified duration. 0 indicates that the account is never locked. AccountLockoutDuration The time in seconds an account is locked for after the account lockout threshold is met. This value must equal to or higher than the AccountLockoutResetAfter value. 0 indicates that the account is never locked.
Table 17. Attributes Attribute Description Id Uniquely identifies the resource within the collection. UserTypeId Type of user. DirectoryServiceId Directory service ID. 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.
Table 18. Attributes Attribute Description Id Uniquely identifies the resource within the collection. UserTypeId Type of user. DirectoryServiceId Directory service ID. 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.
Table 19. Attributes Attribute Description Id Uniquely identifies the resource within the collection. UserTypeId Type of user. DirectoryServiceId Directory service ID. 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.
Table 20. Attributes Attribute Description Id Uniquely identifies the resource within the collection. UserTypeId Type of user. DirectoryServiceId Directory service ID. 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.
} "@odata.count": 1, "value": [ { "Id": 3214, "UserId": 3164, "RoleId": 10, "Entities": [ 64 ] } ] Table 22. 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.Enable This URI enables you to enable multiple accounts. POST method for AccountService.Enable This method enables multiple accounts.
HTTP response codes 204 Example Input: { "AccountIds":[3164,3264] } Output: Table 24. Attributes Attribute Description AccountIds Account IDs to be disabled. /api/AccountService/Actions/AccountService.Delete This URI enables you to delete multiple accounts. POST method for AccountService.Delete The method deletes multiple accounts. Description Deletes multiple accounts. Privilege SECURITY_SETUP HTTP response codes 204 Example Input: { "AccountIds":[3164,3264] } Output: Table 25.
"@odata.count": 5, "value": [ { "@odata.id": "/api/AccountService/Roles('10')", "Id": "10", "Description": "Privileges to do all operations", "Name": "CHASSIS_ADMINISTRATOR", "IsPredefined": true, "AssignedPrivileges": [], "OemPrivileges": [ "VIEW", "APPLIANCE_SETUP", "SECURITY_SETUP", "MONITORING_SETUP", "POWER_CONTROL", "DEVICE_CONFIGURATION", "OPERATING_SYSTEM_DEPLOYMENT", "DEVICE_UPDATE", "TEMPLATE_MANAGEMENT", "BASELINE_MANAGEMENT", "POWER_MANAGEMENT" ] } Table 26.
} "AssignedPrivileges": [], "OemPrivileges": [ "VIEW", "APPLIANCE_SETUP", "SECURITY_SETUP", "MONITORING_SETUP", "POWER_CONTROL", "DEVICE_CONFIGURATION", "OPERATING_SYSTEM_DEPLOYMENT", "DEVICE_UPDATE", "TEMPLATE_MANAGEMENT", "BASELINE_MANAGEMENT", "POWER_MANAGEMENT" ] Table 27. Attributes Attribute Description Id Role record ID. Description Role description. Name Name for the role. IsPredefined Indicates if the role is a predefined role. AssignedPrivileges List of assigned privileges.
ADAccountProvider" } ], "DirectoryServiceType": [ { "@odata.id": "/api/AccountService/ExternalAccountProvider/ DirectoryServiceType" } ] } Table 28. Attributes Attribute Description Id The identifier of the external account provider. DefaultLDAPPort The default LDAP port. DefaultADPort The default AD port. DefaultNetworkTimeOut The default network timeout. DefaultSearchTimeOut The default search timeout.
Table 29. Attributes(continued) Attribute Description 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, user name, timeouts, and port information. Description Returns the collection of Active Directory services.
HTTP response codes 200 Example Input: { "Name": "Starship", "Id":2, "ServerType": "DNS", "ServerName": ["10.35.195.1"], "UserName": "test", "Password": "test@123", "ServerPort": 3268, "NetworkTimeOut": 300, "SearchTimeOut": 300, "CertificateValidation": true, "CertificateFile": "" } Output: { "Id": 2714, "Name": "Starship", "ServerType": "DNS", "ServerName": [ "10.35.195.
/api/AccountService/ExternalAccountProvider/ ADAccountProvider(Id) This URI represents a specific Active Directory server. GET method for ADAccountProvider(Id) This method returns the details of a specific Active Directory server from the collection. Description Returns the details of a specific Active Directory server. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(ExternalAccountProvider.ADAccountProvider)", "@odata.
} "ServerType": "MANUAL", "ServerName": ["10.35.195.1"], "UserName": "Admin", "Password": null, "ServerPort": 3268, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": null Output: { "Id": 2714, "Name": "Starship", "ServerType": "MANUAL", "ServerName": ["10.35.195.1"], "UserName": "Admin", "Password": null, "ServerPort": 3268, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": null } Table 31.
Example Example for ServerType: MANUAL Input: { "Name": "Starship", "ServerType": "MANUAL", "ServerName": ["10.35.195.1", "10.35.195.2"], "UserName": "test", "Password": "test@123", "ServerPort": 3268, "NetworkTimeOut": 300, "SearchTimeOut": 300, "CertificateValidation": true, "CertificateFile": “” } Output: { "Id": 2714, "Name": "Starship", "ServerType": "MANUAL", "ServerName": ["10.35.195.
} ], "GroupDomain": "dell.com", "UserName": null, "Password": "", "ServerPort": 3269, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": "" Table 32. Attributes Attribute name Description Name Name of the directory service. Id ID of the AD or LDAP server. 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.
"ServerName": [ "10.35.195.1" ], "UserName": "Admin", "Password": "", "ServerPort": 3268, "BaseDistinguishedName": null, "AttributeUserLogin": null, "AttributeGroupMembership": null, "SearchFilter": null, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": null, "Groups": [ { "@odata.id": "/api/AccountService/ExternalAccountProvider/ LDAPAccountProvider(2814)/Groups" } ] } ] } POST method for LDAPAccountProvider This method adds an LDAP Directory Service.
} "CertificateValidation": false, "CertificateFile": "" Table 33. 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.
"ServerPort": 389, "BaseDistinguishedName": "dc=dell,dc=com", "AttributeUserLogin": null, "AttributeGroupMembership": null, "SearchFilter": null, "NetworkTimeOut": 300, "SearchTimeOut": 300, "CertificateValidation": false, "CertificateFile": "", "Groups": [ { "@odata.id": "/api/AccountService/ExternalAccountProvider/ LDAPAccountProvider(2914)/Groups" } ] } PUT method for LDAPAccountProvider(Id) This method updates the details of a server of the LDAP Directory Service.
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.
} "Id": 2914, "Name": "seaquest", "ServerType": "MANUAL", "ServerName": ["10.35.195.1"], "UserName": "Admin", "Password": null, "ServerPort": 636, "BaseDistinguishedName": "dc=dell,dc=com", "AttributeUserLogin": null, "AttributeGroupMembership": null, "SearchFilter": null, "NetworkTimeOut": 300, "SearchTimeOut": 300, "CertificateValidation": false, "CertificateFile": "" Example for ServerType: DNS Input: { "Name": "LDAP", "ServerType": "DNS", "ServerName": [ ], "DnsServer": [ "dell.
} "SearchFilter": null, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": "" Table 35. 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.
] } "DistinguishedName": "CN=ADMIN-GROUP,OU=DEV", "DomainComponent": [], "ObjectGuid": "87da9d36-116c-405d-ae3f-054574e91af4" Table 36. 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.
HTTP response codes 200 Example Input: [ { "UserTypeId": 2, "DirectortyServiceId": 0, "Description": "admin", "Name": "MSMMegatronTeam", "Password": "", "UserName": "MSMMegatronTeam", "RoleId": "10", "Locked": false, "Enabled": true, "ObjectGuid": "d22005b6-0ce5-40ed-88d0-7f7759b52f25" }, { "UserTypeId": 2, "DirectortyServiceId": 0, "Description": "admin", "Name": "MSMDevelopmentTeam", "Password": "", "UserName": "MSMDevelopmentTeam", "RoleId": "10", "Locked": false, "Enabled": true, "ObjectGuid": "21dd5
Table 38. Attributes(continued) Attribute name Description UserTypeId Type of user. DirectortyServiceId ID of the directory service. Description Description for this user. Name Name of the user. This value is the same as the user name. Password Password for the user. When retrieving the details, Password is not displayed. 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.
HTTP response codes 200 Example Input: Output: { "@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.
Table 39. Attributes(continued) Attribute name Description Value.ValidTo Date till which the certificate is valid. Value.IssuedBy Who the certificate is issued by. 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.
gYEAwTiSPpKcMV+rJM6lHhsAuW6LvQ4MMQmAqPnE75sJn9fV2sXQPpO1TzwlD5hu DdcCvVeU9nzAZ3oR0Xc2mp28zw/4oBbsje01dLAC0PxDFzQswLFhri9kCHrnGc4Q ZZjn06u+QFf9RRDyaXkX2bNpeAXGZBpG8KbSrk9chyLAyLMCAwEAAaAlMCMGCSqG SIb3DQEJBzEWExRBIGNoYWxsZW5nZSBwYXNzd29yZDANBgkqhkiG9w0BAQUFAAOB gQCxcBNjn5PYe5+NPmD+LjEF+XB34XCZvh4QrCsECyK6B2jRXLP39SxABFlxxd3w D+tddrxy6/8pDdSLMl8FqcV9HLrgJqFn5ue+pA3BLjtkZaM9cxVWHtFZst64WF4v hioJNM68xeFObTxWS99lKufKF8dWKkbQessaABq3yQMikw== -----END CERTIFICATE REQUEST----- Table 40.
Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AlertDestinations.SNMPConfiguration)", "@odata.count": 4, "value": [ { "Id": 1, "Enabled": true, "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } }, { "Id": 2, "Enabled": true, "DestinationAddress": "100.97.1.
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.ApplySNMPConfig POST method for AlertDestinations.ApplySNMPConfig This method configures SNMP. Description Configures SNMP. Privilege MONITORING_SETUP HTTP response codes 200 Example Input: [ { "Enabled": true, "DestinationAddress": "100.97.1.
}, "SnmpV3Credential": null }, { "Id": 2, "Enabled": true, "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" }, "SnmpV3Credential": null }, { ] "Id": 3, "Enabled": false, "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" }, "SnmpV3Credential": null }, { "Id": 4, "Enabled": true, "DestinationAddress": "100.97.1.
Example Input: Output: { "@odata.context": "$metadata#Collection(AlertDestinations.SyslogConfiguration)", "@odata.count": 4, "value": [ { "Id": 1, "Enabled": true, "DestinationAddress": "100.97.10.17", "PortNumber": 514 }, { "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.
Example Input: [ { "Enabled": true, "DestinationAddress": "PortNumber": 514 }, { "Enabled": true, "DestinationAddress": "PortNumber": 514 }, { "Enabled": true, "DestinationAddress": "PortNumber": 514 }, { "Enabled": true, "DestinationAddress": "PortNumber": 514 } ] Output: [ { "Id": 1, "Enabled": true, "DestinationAddress": "PortNumber": 514 }, { "Id": 2, "Enabled": true, "DestinationAddress": "PortNumber": 514 }, { "Id": 3, "Enabled": true, "DestinationAddress": "PortNumber": 514 }, { "Id": 4, "Enabled":
/api/AlertService/AlertDestinations/SMTPConfiguration This URI represents the SMTP configuration. GET method for SMTPConfiguration This method returns a collection of SMTP configuration. Description Returns a collection of SMTP configuration. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AlertDestinations.SMTPConfiguration)", "@odata.count": 1, "value": [ { "DestinationAddress": "10.35.12.
} "DestinationAddress": "10.35.12.7", "PortNumber": 25, "UseCredentials": false, "UseSSL": false, "Credential": null Table 46. Attributes Attribute name Description DestinationAddress Destination address of SMTP. PortNumber Port number of SMTP. UseCredentials Indicates if credentials are used. UseSSL Indicates if SSL is used. User User name Password Password /api/AlertService/AlertDestinations/Actions/ AlertDestinations.SendTestTrap POST method for AlertDestinations.
5 Alerts Alert logs /api/AlertService/Alerts This URI represents the alerts. Table 48. Filters Filter name Description Top Top records to return. Default value is 100. Skip Max records to skip. Default value is 0. Orderby Order to apply to the output. Id Filter by event ID. Default value is 0. AlertDeviceId Filter by device ID. Default value is 0. AlertDeviceIdentifier Filter by device identifier. AlertDeviceType Filter by device type. Default value is 0.
[ } ] { } "@odata.id": "/api/AlertService/Alerts(2)", "Id": 2, "SeverityType": 16, "SeverityName": "Critical", "AlertDeviceId": 1714, "AlertDeviceName": "localhost.smd.devops.dell.com", "AlertDeviceType": 1000, "AlertDeviceIpAddress": "10.36.0.
Table 49. Attributes(continued) Attribute name Description 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. AlertMessageType Type of message—Internal, SNMP, Redfish, and so on.
Table 50. Attributes(continued) Attribute name Description SeverityType ID of severity. SeverityName Name of severity. AlertDeviceId ID of device. AlertDeviceName Name of device. AlertDeviceType Device type ID. AlertDeviceIpAddress IP address of device. AlertDeviceMacAddress MAC address of device. AlertDeviceIdentifier Identifier or Service Tag of device. AlertDeviceAssetTag Asset tag of device. DefinitionId ID of the definition associated to the alert.
} "@odata.context": "$metadata#Collection(AlertService.AlertCategories)", "@odata.count": 3, "value": [ { "@odata.
/api/AlertService/AlertCategories('Name') This URI represents the alert categories for a specific catalog within the collection. GET method for AlertCategories('Name') This method returns the alert categories for a specific catalog. Description Returns the details of a specific alert category. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#AlertService.AlertCategories/$entity", "@odata.
/api/AlertService/AlertSeverities This URI represents the alert severities. GET method for AlertSeverities This method returns all the severities applicable to an alert. Description Returns all the severities applicable to an alert. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AlertService.AlertSeverity)", "@odata.count": 5, "value": [ { "@odata.
/api/AlertService/AlertSeverities(Id) This URI represents a specific alert severity. GET method for AlertSeverities(Id) This method returns the details of a specific alert severity. Description Returns the details of a specific alert severity. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#AlertService.AlertSeverity/$entity", "@odata.id": "/api/AlertService/AlertSeverities(1)", "Id": 1, "Name": "Unknown", "Description": "Unknown" } Table 54.
} ] } "Name": "Not-Acknowledged", "Description": "The event was not 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/AlertStatus(Id) This URI represents a specific alert status within the collection. GET method for AlertStatus(Id) This method returns the details of a specific alert status. Description Returns details of a specific alert status.
GET method for AlertCatalogs This method returns the catalogs applicable to events. Description Returns the catalogs applicable to events. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AlertService.AlertCatalog)", "@odata.count": 9, "value": [ { "@odata.id": "/api/AlertService/AlertCatalogs(1000)", "Id": 1000, "CatalogName": "iDRAC", "InternalName": "MIB-Dell-10892", "ReleaseVersion": "7.4.0", "IsBuiltIn": true, "IsVisible": true }, { "@odata.
/api/AlertService/AlertCatalogs(Id) This URI represents a specific alert catalog. GET method for AlertCatalogs(Id) This method returns the details of a specific alert catalog. Description Returns the details of a specific alert catalog. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#AlertService.AlertCatalog/$entity", "@odata.
} "Message": "The system board battery is low.", "MessageArgs": ["arg1", “arg2”], "MessageId": "BAT0000", "Severity": "Warning" Output: /api/AlertService/Actions/AlertService.Acknowledge POST method for AlertService.Acknowledge This method acknowledges the alerts. Description Acknowledges alerts.
Table 60. Attributes(continued) Attribute Description SourceName Source of the alert. Category Category ID associated to the alert. SubCategory Subcategory ID associated to the alert. Message Description of the issue. /api/AlertService/Actions/AlertService.Unacknowledge POST method for AlertService.Unacknowledge This method removes the acknowledgment from the alerts. Description Removes the acknowledgment from the alerts.
Table 61. Attributes(continued) Attribute Description EndDate End date and time when the alerts were raised. SourceName Source of the alert. Category Category ID associated to the alert. SubCategory Subcategory ID associated to the alert. Message Description of the issue. /api/AlertService/Actions/AlertService.RemoveAlerts POST method for AlertService.RemoveAlerts This method removes the alerts. Description Removes the alerts.
Table 62. Attributes(continued) Attribute Description StartDate Start date and time when the alerts were raised. EndDate End date and time when the alerts were raised. SourceName Source of the alert. Category Category ID associated to the alert. SubCategory Subcategory ID associated to the alert. Message Description of the issue. Alert policies /api/AlertService/AlertPolicies This URI represents the policies that are created. Table 63.
], "SubCategories": [ 0 ] } ] } } ], "Severities": [ 1, 2, 4, 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.
Table 64. Attributes(continued) Attribute name Description 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. If defined, this field is checked during policy evaluation. Severities List of severities associated to the policy. This field is checked during policy evaluation. Devices List of devices associated to the policy. This field is checked during policy evaluation.
{ "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.
"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.
"Type": "string", "TypeParams": [ { "Name": "maxLength", "Value": "255" } ] ] } } } ], "TemplateId": 50 }, "State": true /api/AlertService/AlertPolicies(Id) This URI represents a specific policy within the collection. GET method for AlertPolicies(Id) This method returns the details of a specific policy. Description Returns the details of a specific policy. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#AlertService.AlertPolicy/$entity", "@odata.
"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 65. Attributes Attribute name Description Id Event record ID. Name Name associated with the policy.
Table 65. Attributes(continued) Attribute name Description 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. CronString CRON string associated to the policy.
"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.
"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.
} "State": true /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. 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 criteria IDs. Default value is 0.
Table 67. Attributes(continued) Attribute name Description 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. GET method for PolicyCriteria(Arg2) This method returns 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 Name Name of the template. 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.
Table 71. Attributes(continued) Attribute name Description Disabled Indicates if template is enabled or disabled. ParameterDetails List of other parameter that the template can carry and apply. /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 Input: Output: { "@odata.context": "$metadata#Collection(AlertService.
} ] Table 72. Attributes Attribute name Description Id ID of the action template. Name Name of the action template. Description Description of the action template. Disabled Indicates if the template is enabled or disabled. 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.
/api/AlertService/Actions/ AlertService.EnableAlertPolicies POST method for AlertService.EnableAlertPolicies This method enables the selected alert policies. Description Enables the selected alert policies. Privilege MONITORING_SETUP HTTP response codes 201 Example Input: { "AlertPolicyIds": [100,200,300] } Or Input: { "AllPolicies": true } Output: /api/AlertService/Actions/ AlertService.DisableAlertPolicies POST method for AlertService.
/api/AlertService/Actions/ AlertService.RemoveAlertPolicies POST method for AlertService.RemoveAlertPolicies This method removes the selected set of alert policies or all the alert policies. Description Removes the selected alerts policies. Privilege MONITORING_SETUP HTTP response codes 201 Example Input: { "AlertPolicyIds": [100,200,300] } Or Input: { "AllPolicies": true } Output: Alert definitions /api/AlertService/AlertMessageDefinitions This URI represents the definitions for the alert messages.
Example Input: Output: { "@odata.context": "$metadata#Collection(AlertService.AlertMessageDefinition)", "@odata.count": 3, "value": [ { "@odata.id": "/api/AlertService/AlertMessageDefinitions('RAC9000')", "MessageId": "RAC9000", "Prefix": "RAC", "SequenceNo": 9000, "Message": "Device has become non compliant.", "RecommendedAction": "No response action is required.", "Severity": "Critical", "Category": "Configuration", "SubCategory": null, "DetailedDescription": "A device has become non compliant.
HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#AlertService.AlertMessageDefinition/$entity", "@odata.id": "/api/AlertService/AlertMessageDefinitions('RAC0600')", "MessageId": "RAC0600", "Prefix": "RAC", "SequenceNo": 600, "Message": "Unable to retrieve the temperature information.", "RecommendedAction": "Power on the server. If the server is already powered on, wait for a few minutes and refresh the page. If the problem persists, contact service provider.
{"@odata.type": "#AlertService.AlertMessageDefinitionCategory", "@odata.id": "/api/AlertService/AlertMessageDefinitionsCategories('Audit')", …}, {"@odata.type": "#AlertService.AlertMessageDefinitionCategory", "@odata.id": "/api/AlertService/ AlertMessageDefinitionsCategories('Configuration')",…}, {"@odata.type": "#AlertService.AlertMessageDefinitionCategory", "@odata.id": "/api/AlertService/ AlertMessageDefinitionsCategories('Storage')",…}, {"@odata.type": "#AlertService.
}, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Feature Card" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Group Manager" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Hardware Config" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "iDRAC Service Module" }, { "@odata.type": "#AlertService.
"@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "PCI Device" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Power Supply" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Power Usage" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Power Usage POW" }, { "@odata.type": "#AlertService.
} ] } "SubCategory": "Virtual Media" Alerts 109
6 Configure Firmware /api/UpdateService/Catalogs This URI represents the catalogs in the appliance. GET method for Catalogs This method returns the catalogs created in the appliance. Description Returns the list of catalogs. Privilege VIEW HTTP response codes 200 Example Input: { 110 Configure "@odata.context": "/api/$metadata#Collection(UpdateService.Catalogs)", "@odata.count": 1, "value": [ { "@odata.type": "#UpdateService.Catalogs", "@odata.
"BaselineId": 7, "BaselineName": "Test 100" }, { "BaselineId": 8, "BaselineName": "Test 2500+" } ] } } ], "Repository": { "@odata.type": "#UpdateService.Repository", "Id": 12, "Name": "Dell", "Description": "", "Source": "downloads.dell.com", "DomainName": null, "Username": null, "Password": null, "CheckCertificate": false, "RepositoryType": "DELL_ONLINE" } POST method for Catalogs This method creates a catalog. Description Creates a catalog.
HTTP response codes Example 200 Input: Output: { "@odata.context": "/api/$metadata#UpdateService.Catalogs/$entity", "@odata.type": "#UpdateService.Catalogs", "@odata.id": "/api/UpdateService/Catalogs(28)", "Id": 28, "Filename": "CatalogA00.xml", "SourcePath": "cifs/compute", "Status": "Completed", "TaskId": 26960, "BaseLocation": "", "ManifestIdentifier": "", "ReleaseIdentifier": "8217fadb-ec37-46a4-b7ba-56a353dbf3d2", "ManifestVersion": null, "ReleaseDate": "2018-05-21 05:33:25.
{ "@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.
Output: api/UpdateService/Baselines(Id) This URI represents a specific baseline. GET method for Baselines(Id) This method returns the details of a specific baseline. Description Returns details of a specific baseline. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#UpdateService.Baselines/$entity", "@odata.type": "#UpdateService.Baselines", "@odata.
}, { }, { }, { }, { } "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" } } ], "ComplianceSummary": { "ComplianceStatus": "OK", "NumberOfCritical": 0, "NumberOfWarning": 0, "NumberOfNormal": 9, "NumberOfDowngrade": 0 }, "DeviceComplianceReports@odata.
"value": [ { "@odata.type": "#UpdateService.DeviceComplianceReport", "@odata.id": "/api/UpdateService/Baselines(9)/ DeviceComplianceReports(9523)", "Id": 9523, "DeviceId": 25031, "ServiceTag": "JP00002", "DeviceModel": "PowerEdge MX740c", "DeviceTypeName": "SERVER", "DeviceName": "iDRAC-JP00002", "FirmwareStatus": "Compliant", "ComplianceStatus": "OK", "DeviceTypeId": 1000, "RebootRequired": false, "ComponentComplianceReports@odata.
/api/UpdateService/Baselines(Id)/ DeviceComplianceReports(Id)/ ComponentComplianceReports This URI represents the compliance reports for specific devices. GET method for ComponentComplianceReports This method returns the compliance report for a specific device. Description Returns the compliance report for a specific device from a specific baseline. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(UpdateService.
Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#UpdateService.ComponentComplianceReport/ $entity", "@odata.type": "#UpdateService.ComponentComplianceReport", "@odata.id": "/api/UpdateService/Baselines(8)/DeviceComplianceReports(190)/ ComponentComplianceReports(1597)", "Id": 1597, "Version": "10.4.0E.R3S.285", "CurrentVersion": "10.4.0E.R3S.285", "Path": "Network_Firmware_27PY3_WN64_10.4.0E.R3S.285_A00.
HTTP response codes Example 200 Input: { } "FileToken": "1481131455800" Output: /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 Input: { "CatalogIds":["12"] } Output: /api/UpdateService/Actions/ UpdateService.RemoveBaselines POST method for RemoveBaselines This method deletes baselines. Description Deletes baselines.
/api/UpdateService/Actions/ UpdateService.GetSingleDupDetails POST method for GetSingleDupDetails This method returns the details of a specific Dell Update Package (DUP). Description Returns the details of a specific DUP. Privilege DEVICE_UPDATE HTTP response codes 200 Example Input: { "FileToken": "1481131455800" } Output: { "Date": "2016-01-12 02:37:36.000", "VendorVersion": "1.4.3", "SchemaVersion": "1.0", "ReleaseDate": "2016-01-11 00:00:00.000", "ReleaseId": "G1JD51.4.
} "ComponentCurrentVersion": "2.10.10.10", "ComponentUriInformation": null, "DeviceTypeName": "SERVER", "ComponentVersion": "2.30.30.30", "ComponentCriticality": "Recommended", "DeviceId": "1674", "DeviceServiceTag": "JS8BDV1", "IsCompliant": "CRITICAL", "ComponentTargetIdentifier": "25227", "ComponentSourceName": "DCIM:INSTALLED#iDRAC.Embedded.
/api/UpdateService/Actions/ UpdateService.GetBaselinesReportByDeviceids POST method for GetBaselinesReportByDeviceids This method returns the baseline report for specific device IDs. Description Returns the baseline report for specific device IDs. Privilege BASELINE_MANAGEMENT HTTP response codes 200 Example Input: { "Ids":["Device ID"] } Response payload: [ { "Id": 6, "Name": "Baseline1", "Description": "", "LastRun": "2021-09-14 20:34:18.
] } /api/UpdateService/Actions/ UpdateService.GetCertDetails POST method for GetCertDetails This method returns the details of a certificate. Description Returns the details of a certificate. Privilege DEVICE_UPDATE HTTP response codes 200 Example Input: { "UriPath": "https://10.255.2.128:2607" } Output: { "Version": "3", "Subject": "ST=Texas, C=USA, O=Dell Inc., L=Round Rock, CN=OMEDEV-DAHIR", "SignatureAlgorithm": "SHA1withRSA", "SignatureAlgorithmOid": "1.2.840.113549.1.1.5", "PublicKey": "X.
{ } ] "@odata.id": "/api/TemplateService/TemplateTypes(0)", "Name": "None", "ConfigurationSections": [] }, { "@odata.id": "/api/TemplateService/TemplateTypes(2)", "Name": "Server", "ConfigurationSections": [] }, { "@odata.id": "/api/TemplateService/TemplateTypes(4)", "Name": "Chassis", "ConfigurationSections": [] }, { "@odata.
"@odata.id": "/api/TemplateService/TemplateViewTypes(3)", "Id": 3, "Description": "Inventory" }, { } ] } "@odata.id": "/api/TemplateService/TemplateViewTypes(4)", "Id": 4, "Description": "Sample" Table 78. Attributes Attribute Description Id Unique identifier for the template view type. Name Identifies the features that supports template operations. /api/TemplateService/Templates This URI represents the templates.
"CreationTime": "2017-11-30 19:02:11.200378", "LastUpdatedBy": null, "LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(1)/Views" } ] }, { "@odata.
"CreationTime": "2017-11-30 19:02:11.200378", "LastUpdatedBy": null, "LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(4)/Views" } ] }, { "@odata.
"CreatedBy": "system", "CreationTime": "2017-11-30 19:02:11.200378", "LastUpdatedBy": null, "LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(7)/Views" } ] }, { "@odata.
Table 80. Attributes Attribute Description Name Template name Description Definition for the template 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 to be created. Fqdds The FQDDs to copy from the reference device, as a commaseparated string.
[ } ] { } "@odata.id": "/api/TemplateService/Templates(10)/Views" Table 81. 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.
Input: { "Id": 12, "Name": "Example Compliance Template", "Attributes": [ { "Id": 3592, "Value": "Test OS Name", "IsIgnored": false } ] } Output: ID of the template DELETE method for Templates(Id) This method deletes a template. Description Deletes a specific template. Privilege DEVICE_CONFIGURATION HTTP response codes 204 Example Input: Output: /api/TemplateService/Templates(Id)/Views This URI represents the views of a specific template.
"@odata.id": "/api/TemplateService/Templates(1)/Views(1)/ AttributeViewDetails" }, " HYPERLINK "mailto:DeviceAttributeViewDetails@odata.navigationLink" DeviceAttributeViewDetails@odata.navigationLink": "/api/TemplateService/ Templates(1)/Views(1)/DeviceAttributeViewDetails" }, { "@odata.type": "#TemplateService.AttributeView", "@odata.
} ] Table 82. Attributes Attribute Description Id Unique identifier for a template view. Name The name of the view. Description Identifies the template data and its structure provided by this view. /api/TemplateService/Templates(Id)/Views(Id)/ AttributeViewDetails This URI represents the attribute details of a specific view of a template. GET method for AttributeViewDetails This method returns the details for all attributes applicable to a specific template view..
Restart", 134 Configure "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3561, "CustomId": 0, "AttributeEditInfoId": 1856, "DisplayName": "LCAttributes 1 VirtualAddressManagement", "Description": null, "Value": "Console", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3563, "CustomId": 0, "AttributeEditInfoId": 1858, "DisplayName": "LCAttributes 1 Provisioning Server", "Description": null, "Value": null, "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3559, "CustomId":
"IsIgnored": false }, { Requested", } ] "AttributeId": 3564, "CustomId": 0, "AttributeEditInfoId": 1859, "DisplayName": "LCAttributes 1 BIOS Reset To Defaults "Description": null, "Value": "False", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3565, "CustomId": 0, "AttributeEditInfoId": 1860, "DisplayName": "LCAttributes 1 Automatic Update Feature", "Description": null, "Value": "Disabled", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3566, "CustomId": 0, "AttributeEditInf
/api/TemplateService/Templates(Id)/Views(Id)/ AttributeViewDetails/TemplateEditInfoDetails This URI represents the editable attributes of a specific view of a template. GET method for TemplateEditInfoDetails This method returns the editable attributes of a specific view of a template. Description Returns the editable attributes of a view of a template. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#TemplateService.
} ] "ValueMin": 0, "ValueMax": 0, "DependencyText": null, "OptionSetId": 0, "DefaultOptionId": 0, "GenericNameId": 2255 }, { "Id": 2692, "DataType": 18, "Description": null, "IsReadOnly": true, "IsSecure": false, "TextMinLength": 0, "TextMaxLength": 32, "ValueMin": 0, "ValueMax": 0, "DependencyText": null, "OptionSetId": 0, "DefaultOptionId": 0 }, { "Id": 2693, "DataType": 12, "Description": null, "IsReadOnly": true, "IsSecure": false, "TextMinLength": 0, "TextMaxLength": 0, "ValueMin": 0, "ValueMax": 0,
Example Input: Output: { "@odata.context": "/api/$metadata#TemplateService.AttributeViewDetail/ $entity", "@odata.id": "/api/TemplateService/Templates(10)/Views(4)/ DeviceAttributeViewDetails(0)", "Id": 4, "Name": "NetworkSpecific", "Description": "The hierarchy consists of network related component classes, groups (from the attribute registry) and attributes.
] }, { } "Description": null, "Value": "0", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] "GroupNameId": 1, "DisplayName": "Port ", "Sub ttributeGroups": [ "GroupNameId": 2, "DisplayName": "P "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3350, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", "Description": null, "Value": "30", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3351, "CustomId": 0, "AttributeEditInfoId":
] }, { } "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] "GroupNameId": 1, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 4, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3388, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", "Description": null, "Value": "30", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3389, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName":
} }, { ] "IsIgnored": false }, { "AttributeId": 0, "CustomId": 47, "AttributeEditInfoId": 0, "DisplayName": "Vlan Tagged", "Description": null, "Value": null, "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 0, "CustomId": 47, "AttributeEditInfoId": 0, "DisplayName": "Vlan UnTagged", "Description": null, "Value": "0", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] "GroupNameId": 2, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 2, "DisplayName": "Partition ",
"Attributes": [ { "AttributeId": 3503, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", "Description": null, "Value": "20", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3504, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false } ] } ], "Attributes": [] }, { "GroupNameId": 2, "DisplayName": "Port ", "SubAttributeGroups": [ { "Gro
"@odata.id": "/api/TemplateService/Templates(10)/Views(4)/ DeviceAttributeViewDetails(0)/TemplateEditInfoDetails" } } /api/TemplateService/Profiles This URI represents the profiles. GET method for Profiles This method returns the list of available profiles. Description Returns list of profiles. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(TemplateService.Profile)", "@odata.count": 12, "value": [ {"@odata.type": "#TemplateService.
HTTP response codes Example 200 Input: Output: { "@odata.context": "/api/$metadata#TemplateService.Profile/$entity", "@odata.type": "#TemplateService.Profile", "@odata.id": "/api/TemplateService/Profiles(44)", "Id": 44, "ProfileName": "Slot3", "SourceTemplateId": 30, "AssociatedEntityId": 25580, "AssociationType": 1, "Status": 3, "CreatedBy": "root", "CreationTime": "2018-09-10 06:15:11.535552", "LastUpdatedBy": null, "LastUpdatedTime": "2018-09-10 06:06:44.
Privilege VIEW HTTP response codes 200 Example Input: { "TemplateId" : 13, "BaseEntityId" : 25010 } Output: The reply is a hierarchical structure for the cards, ports, and partitions for which identities were assigned, or that have boot options.
[ ] { "AttributeId": 0, "CustomId": 0, "AttributeEditInfoId": 0, "DisplayName": "Protocol", "Description": "", "Value": "iSCSI", "IsReadOnly": true, "IsIgnored": false }, { "AttributeId": 0, "CustomId": 0, "AttributeEditInfoId": 0, "DisplayName": "iSCSI IQN", "Description": "iSCSI IQN", "Value": "iqn.pool1.
Output: /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 Input: { "SourceTemplateId": 12, "NewTemplateName": "clone example", "ViewTypeId": 2 } Output: ID of cloned template /api/TemplateService/Actions/TemplateService.Export POST method for TemplateService.Export This method exports a template.
"ViewTypeId": 2 } /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 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.
} }, "Schedule": { "RunNow": true, "RunLater": false } Output: ID of created task /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. Privilege DEVICE_CONFIGURATION HTTP response codes 200 Example Updating the minimum and maximum bandwidth of the NICs, and the tagged and untagged VLANs.
}, { } } 150 Configure ] "Id": 3388, "Value": "30", "IsIgnored": false }, { "Id": 3389, "Value": "100", "IsIgnored": false }, { "Id": 3431, "Value": "20", "IsIgnored": false }, { "Id": 3432, "Value": "100", "IsIgnored": false }, { "Id": 3484, "Value": "30", "IsIgnored": false }, { "Id": 3485, "Value": "100", "IsIgnored": false }, { "Id": 3503, "Value": "20", "IsIgnored": false }, { "Id": 3504, "Value": "100", "IsIgnored": false }, { "Id": 3522, "Value": "30", "IsIgnored": false }, { "Id": 3523, "Value
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 Input: Output: { "@odata.context": "/api/ $metadata#Collection(IdentityPoolService.IdentityPool)", "@odata.count": 2, "value": [ { "@odata.type": "#IdentityPoolService.IdentityPool", "@odata.
"IdentityCount": 240, "StartingMacAddress": "FBQUFBQB" } }, "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.
{ "IdentityCount": 85, "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.
{ } } } "IdentityCount":85, "StartingAddress": "IAGAgICAgAA=" Output: /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 Input: Output: { "@odata.context": "/api/$metadata#IdentityPoolService.IdentityPool/ $entity", "@odata.type": "#IdentityPoolService.
"FcSettings": { "Wwnn": { "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.
}, "Wwpn": { } } } "IdentityCount": 85, "StartingAddress": "IAGAgICAgAA=" Output: DELETE method for IdentityPools(Id) This method deletes an identity pool. Description Deletes an identity pool. Privilege TEMPLATE_MANAGEMENT HTTP response codes 204 Example Input: Output: /api/IdentityPoolService/IdentityPools(Id)/UsageCounts This URI represents the summary of the usage of identity pools. GET method for UsageCounts This method returns the summary of the usage of identity pools.
"TotalDeployed": 0 }, { "IdentityTypeId": 3, "TotalRequested": 85, "TotalReserved": 3, "TotalDeployed": 0 }, { "IdentityTypeId": 4, "TotalRequested": 85, "TotalReserved": 3, "TotalDeployed": 0 }, { } ] } "IdentityTypeId": 7, "TotalRequested": 0, "TotalReserved": 14, "TotalDeployed": 0 /api/IdentityPoolService/IdentityPools(Id)/ UsageIdentitySets This URI represents the usage identity sets. GET method for UsageIdentitySets This method returns usage identity sets.
"@odata.type": "#IdentityPoolService.UsageIdentitySet", "@odata.id": "/api/IdentityPoolService/IdentityPools(4)/ UsageIdentitySets(3)", "IdentitySetId": 3, "Name": "FCoE", "Details@odata.navigationLink": "/api/IdentityPoolService/ IdentityPools(4)/UsageIdentitySets(3)/Details" }, { "@odata.type": "#IdentityPoolService.UsageIdentitySet", "@odata.id": "/api/IdentityPoolService/IdentityPools(4)/ UsageIdentitySets(4)", "IdentitySetId": 4, "Name": "FC", "Details@odata.
• To get the identifier for each identity set, use the API /IdentityPoolService/IdentityPools(Id)/ UsageIdentitySets. Description Returns the usage details for a specific identity pool and identity set. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(IdentityPoolService.UsageDetail)", "@odata.count": 2, "value": [ { "@odata.type": "#IdentityPoolService.
/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 Input: Output: { "@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 IdentityPoolService.DeleteIdentityPools This method deletes identity pools. Description Deletes identity pools. Privilege TEMPLATE_MANAGEMENT HTTP response codes 200 Example Input: { "IdentityPoolIds":[1,3,4] } Output: Network Configuration Service This resource enables you to access the network service and perform network-related tasks.
} ] "Type": 1, "CreatedBy": "root", "CreationTime": "1970-01-01 01:01:48.181", "UpdatedBy": null, "UpdatedTime": "1970-01-01 01:01:48.181", "InternalRefNWUUId": 0 }, { "@odata.id": "/api/NetworkConfigurationService/Networks(42414)", "Id": 42414, "Name": ""Network-3", "Description": null, "VlanMaximum": 9, "VlanMinimum": 9, "Type": 8, "CreatedBy": "root", "CreationTime": "1970-01-01 01:02:29.628", "UpdatedBy": null, "UpdatedTime": "1970-01-01 01:02:29.628", "InternalRefNWUUId": 0 } Table 84.
} "VlanMaximum": 19, "VlanMinimum": 19, "Type": 1 Output: { "@odata.context": "/api/$metadata#NetworkConfigurationService.Network/ $entity", "@odata.id": "/api/NetworkConfigurationService/Networks(43614)", "Id": 43614, "Name": "abc-1", "Description": "abc", "VlanMaximum": 19, "VlanMinimum": 19, "Type": 1, "CreatedBy": "root", "CreationTime": "1970-01-01 02:02:15.797", "UpdatedBy": null, "UpdatedTime": "1970-01-01 02:02:15.
HTTP response codes Example 200 Input: { "Id": 43614, "Name": "abc-1", "Description": "abc-updated", "VlanMaximum": 22, "VlanMinimum": 19, "Type": 1 } Output: { "Id": 43614, "Name": "abc-1", "Description": "abc-updated", "VlanMaximum": 22, "VlanMinimum": 19, "Type": 1, "CreatedBy": "root", "CreationTime": "1970-01-01 02:02:15.797", "UpdatedBy": "root", "UpdatedTime": "1970-01-01 02:02:15.797", "InternalRefNWUUId": 0 } DELETE method for Networks(Id) This method deletes a network from the system.
{ "@odata.id": "/api/NetworkConfigurationService/NetworkTypes(1)", "Id": 1, "Name": "General Purpose (Bronze)", "Description": "This is the network for general purpose traffic. QOS Priority : Bronze.", "VendorCode": "GeneralPurpose", "NetworkTrafficType": "Ethernet", "QosType": 4 }, . . { "@odata.id": "/api/NetworkConfigurationService/NetworkTypes(11)", "Id": 11, "Name": "VMWare FT Logging", "Description": "This is the network for VMware-specific Fault tolerance logging.
} "NetworkTrafficType": "Ethernet", "QosType": 4 /api/NetworkConfigurationService/QosTypes This URI represents the types of Quality-of-Service (QoS) that the system supports. GET method for QosTypes This method returns the types of Quality-of-Service (QoS) that the system supports. Description Returns the supported QoS. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(NetworkConfigurationService.QosType)", "@odata.
Example Input: Output: { "@odata.context": "/api/$metadata#NetworkConfigurationService.QosType/ $entity", "@odata.id": "/api/NetworkConfigurationService/QosTypes(1)", "Id": 1, "Name": "Platinum" } /api/NetworkConfigurationService/Actions/ NetworkConfigurationService.RemoveNetworks POST method for NetworkConfigurationService.RemoveNetworks This method deletes the specified networks from the system. Description Deletes the specified networks.
7 Devices /api/DeviceService This URI represents the device services. GET method for DeviceService This method returns a list of all the device services. Description Returns a list of device services. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#DeviceService.DeviceService", "@odata.id": "/api/DeviceService", "Actions": null, "Devices": [ { "@odata.id": "/api/DeviceService/Devices" } ], "DeviceStatuses": [ { "@odata.
/api/DeviceService/Devices This URI represents the devices. GET method for Devices This method returns a list of all the devices. Description Returns a list of all the devices. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 5, "value": [ { "@odata.
"SlotType": "2000" }, "DeviceManagement": [ { "ManagementId": 5003, "NetworkAddress": "10.35.0.201", "MacAddress": "18:66:da:a6:c2:1d", "ManagementType": 2, "InstrumentationName": "WIN-02GODDHDJTC", "DnsName": "iDRAC-SVCTG06", "ManagementProfile": [ { "ManagementProfileId": 5003, "ManagementId": 5003, "AgentName": "iDRAC", "Version": "3.20.20.20", "ManagementURL": "https://10.35.0.201", "Status": 1000, "StatusDateTime": "2017-09-05 04:46:57.807" } ] } ], "InventoryDetails": [ { "@odata.
} ], "Faults": [ { "@odata.id": "/api/DeviceService/Devices(3315)/Faults" } ], "DeviceBladeSlots": [ { "@odata.id": "/api/DeviceService/Devices(3315)/ DeviceBladeSlots" } ], "GraphicInfo": { "@odata.id": "/api/DeviceService/Devices(3315)/GraphicInfo" } }, {…}, {…}, {…}, {…} } /api/DeviceService/Devices(Id) This URI represents a specific device within the collection. GET method for Devices(Id) This method returns the details of a specific device. Description Returns the details of a specific device.
4, 7, 8, 9, 41, 11, 12, 13, 14, 15, 16, 17, 30, 31 ], "Actions": null, "DeviceSubscription": null, "DeviceSpecificData": null, "SlotConfiguration": { "ChassisId": "4165", "SlotNumber": "6", "SledBlockPowerOn": "None blocking", "ChassisName": "GUI PT", "SlotName": "Sled-6", "ChassisServiceTag": "SKY0028", "SlotType": "2000" }, "DeviceManagement": [ { "ManagementId": 5003, "NetworkAddress": "10.35.0.
} } "LogSeverities": { "@odata.id": "/api/DeviceService/Devices(3315)/LogSeverities" }, "Settings": [ { "@odata.id": "/api/DeviceService/Devices(3315)/Settings" } ], "Temperature": { "@odata.id": "/api/DeviceService/Devices(3315)/Temperature" }, "Power": { "@odata.id": "/api/DeviceService/Devices(3315)/Power" }, "BlinkStatus": { "@odata.id": "/api/DeviceService/Devices(3315)/BlinkStatus" }, "PowerUsageByDevice": [ { "@odata.
}, { }, { }, { }, { }, { }, { }, { }, 174 7 ] } "SlotNumber": "SMBus.Embedded.3-1", "Manufacturer": "Intel Corporation", "Description": "Lewisburg SMBus", "DatabusWidth": "Unknown", "SlotLength": "Unknown", "SlotType": "Unknown" "Id": 128, "SlotNumber": "P2PBridge.Embedded.1-1", "Manufacturer": "Intel Corporation", "Description": "Lewisburg PCI Express Root Port #1", "DatabusWidth": "Unknown", "SlotLength": "Unknown", "SlotType": "Unknown" "Id": 129, "SlotNumber": "HostBridge.Embedded.
{ "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('serverProcessors')", "InventoryType": "serverProcessors", "InventoryInfo": [ { "Id": 28, "Family": "Intel(R) Xeon(TM)", "MaxSpeed": 4000, "CurrentSpeed": 1600, "SlotNumber": "CPU.Socket.1", "Status": 2000, "NumberOfCores": 8, "NumberOfEnabledCores": 8, "BrandName": "Intel", "ModelName": "Genuine Intel(R) CPU 0000%@", "InstanceId": "CPU.Socket.1", "Voltage": "1.8" } ] }, { "@odata.
}, { ] } "MediaType": "Magnetic Drive", "RemainingReadWriteEndurance": "255", "SecurityState": "Not Capable" "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('serverRaidControllers')", "InventoryType": "serverRaidControllers", "InventoryInfo": [ { "Id": 20, "DeviceId": 0, "Name": "Lewisburg SATA Controller [AHCI mode]", "Fqdd": "AHCI.Embedded.
{ }, { }, { }, { }, { }, { }, { ] } "Id": 109, "PowerState": 2 "Id": 110, "PowerState": 5 "Id": 111, "PowerState": 8 "Id": 112, "PowerState": 10 "Id": 113, "PowerState": 11 "Id": 114, "PowerState": 12 "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('deviceLicense')", "InventoryType": "deviceLicense", "InventoryInfo": [ { "SoldDate": "2016-06-12 14:48:13.000", "LicenseBound": 4, "EvalTimeRemaining": 0, "AssignedDevices": "iDRAC.Embedded.
}, { }, { }, { }, { }, { }, { assigned Storage" }, { }, { }, { 178 7 } "Description": "Retrieve historical temperature data" "Id": 369, "CapabilityType": { "CapabilityId": 14, "Name": "POWER_HISTORY", "Description": "Retrieve historical power data" } "Id": 370, "CapabilityType": { "CapabilityId": 13, "Name": "TSR", "Description": "Tech Support Report" } "Id": 371, "CapabilityType": { "CapabilityId": 12, "Name": "DIAGS", "Description": "Diagnostics" } "Id": 372, "CapabilityType": { "CapabilityId
"Name": "SENSOR_DETAILS", "Description": "Get Sensor Info, sub system health details" }, { }, { }, { }, { }, { }, { }, { ] } } "Id": 378, "CapabilityType": { "CapabilityId": 3, "Name": "POWER_CONTROL_RESET", "Description": "Power reset hard/graceful" } "Id": 379, "CapabilityType": { "CapabilityId": 2, "Name": "POWER_CONTROL_OFF", "Description": "Power Down hard/graceful" } "Id": 380, "CapabilityType": { "CapabilityId": 1, "Name": "POWER_CONTROL_ON", "Description": "Power up" } "Id": 381, "Capabili
}, { ] "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('deviceLocation')", "InventoryType": "deviceLocation", "InventoryInfo": [ { "Id": 19, "Rack": "78", "Aisle": "Lakeln", "Datacenter": "AlladiaAnoop" } ] }, { "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('deviceManagement')", "InventoryType": "deviceManagement", "InventoryInfo": [ { "ManagementId": 5003, "IpAddress": "10.35.0.
Controller", "InstallationDate": "NA", "Status": "Available", "SoftwareType": "FRMW", "ComponentId": "25227", "DeviceDescription": "Integrated Dell Remote Access "InstanceId": "DCIM:PREVIOUS#iDRAC.Embedded.1-1#IDRACinfo" }, { "Version": "0.3.0", "InstallationDate": "2017-06-16T01:22:28Z", "Status": "Installed", "SoftwareType": "BIOS", "ComponentId": "159", "DeviceDescription": "BIOS", "InstanceId": "DCIM:INSTALLED#741__BIOS.Setup.
}, { ] } "InstallationDate": "2017-06-16T00:54:12Z", "Status": "Installed", "SoftwareType": "FRMW", "ComponentId": "27763", "DeviceDescription": "System CPLD", "InstanceId": "DCIM:INSTALLED#803__CPLD.Embedded.1" "@odata.
"@odata.
HTTP response codes Example 200 Input: /api/DeviceService/Devices(25004)/InventoryDetails('deviceSoftware') Output: { "@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.
"LogCategory": "Audit", "DateFormat": "CIM" }, { "LogTimestamp": "20170907060147.000000-300", "LogSequenceNumber": 286449, "LogSeverity": 1000, "LogComment": "[set comment here]", "LogMessageId": "LOG007", "LogMessage": "The previous log entry was repeated 1 times.", "LogId": "DCIM:LifeCycleLog:286449", "LogCategory": "Audit", "DateFormat": "CIM" }, { "LogTimestamp": "20170907053540.
{ "SubSystem": "System", "RollupStatus": "1000" }, { "SubSystem": "SEL/Misc", "RollupStatus": "2000" }, { } ] "SubSystem": "Battery", "RollupStatus": "1000" }, { "SubSystem": "Voltage", "RollupStatus": "1000" }, { "SubSystem": "Current", "RollupStatus": "1000" }, { "SubSystem": "Processor", "RollupStatus": "2000" }, { "SubSystem": "Memory", "RollupStatus": "2000" }, { "SubSystem": "Temperature", "RollupStatus": "1000" } /api/DeviceService/Devices(Id)/RecentActivity This URI represents the recent act
"ExecutionHistoryId": 561, "TaskId": 10265, "TaskType": 3 }, { "Id": 9, "Progress": "100", "StartTime": "2017-09-05 04:48:37.080", "EndTime": "2017-09-05 04:48:37.856", "TaskStatusId": 2070, "Key": "WIN-02GODDHDJTC", "Value": "Running\nSlot ID passed null cannot perform Quick Deploy.\nTask Failed.
/api/DeviceService/Devices(Id)/LogSeverities This URI represents the log severities for a specific device. GET method for LogSeverities This method returns the log-severity details for a specific device. Description Returns the log-severity details for a specific device. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#DeviceService.LogSeverities/$entity", "@odata.
/api/DeviceService/Devices(Id)/Settings('Type') This URI represents a specific type of setting for a device. The settings differ depending on the type of device. To see the list of available settings, use the Get method on the Device(Id)/Settings URI.
} } Example for network settings for Chassis Input: Output: { "@odata.context": "/api/$metadata#DeviceService.DeviceSetting/$entity", "@odata.type": "#DeviceService.DeviceSetting", "@odata.
} "MgmtVLANId": "", "EnableMgmtVLANId": false, "IomIPv4Settings": { "EnableIPv4": true, "EnableDHCP": true, "StaticIPAddress": "10.35.176.185", "StaticSubnetMask": "255.255.255.0", "StaticGateway": "10.35.176.1" }, "IomIPv6Settings": { "EnableIPv6": true, "StaticIPv6Address": "::", "StaticPrefixLength": "0", "StaticGateway": "::", "UseDHCPv6": true }, "IomDNSSettings": { "PrimaryDNS": "", "SecondaryDNS": "", "TertiaryDNS": "" } Output: { "@odata.
} "StaticIPAddress": "", "StaticSubnetMask": "", "StaticGateway": "", "UseDHCPObtainDNSServerAddresses": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "Ipv6Settings": { "EnableIPv6": false, "EnableAutoconfiguration": true, "StaticIPv6Address": "", "StaticPrefixLength": "0", "StaticGateway": "", "UseDHCPv6ObtainDNSServerAddresses": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "GeneralSettings": { "EnableNIC": true, "RegisterDNS": false, "DnsName": "MX7000
/api/DeviceService/Devices(Id)/Temperature This URI represents the temperature settings of a specific device. GET method for Temperature This method returns the temperature details of a specific device. Description Returns the temperature details of a specific device. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#DeviceService.TemperatureResponseModel/ $entity", "@odata.
} "peakPowerUnit": "watt", "minimumPowerUnit": "watt" /api/DeviceService/Devices(Id)/BlinkStatus This URI represents the LED-blink status of a specific device. GET method for BlinkStatus This method returns the LED-blink status of a specific device. Description Returns the LED-blink status of a specific device. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#DeviceService.BlinkStatusResponseModel/ $entity", "@odata.
} "Since": "20170414145039.000000-300", "peakPowerTimeStamp": "20170414145039.000000-300", "power": "0", "peakPowerUnit": "watt", "minimumPowerUnit": "watt" /api/DeviceService/Devices(Id)/DeviceBladeSlots This URI represents the slot details of a specific device. GET method for DeviceBladeSlots This method returns the details of the slot that the device is installed in. NOTE: For a chassis, details of only the compute sleds are returned. Description Returns the slot details of a specific device.
/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 Input: Output: { "@odata.context": "$metadata#DeviceService.GraphicInfo/$entity", "@odata.id": "/api/DeviceService/Devices(3265)/GraphicInfo", "Svg": "
HTTP response codes Example 200 Input: Output: { "@odata.context": "$metadata#Collection(DeviceService.PowerState)", "@odata.count": 3, "value": [ { "PowerState": 1, "Name": "UNKNOWN", "Description": "Unknown" }, { "PowerState": 17, "Name": "ON", "Description": "On" }, { "PowerState": 18, "Name": "OFF", "Description": "Off" } ] } /api/DeviceService/DeviceStatuses This URI represents the statuses that the devices can be in.
"Name": "CRITICAL", "Description": "The device is in critical state." }, { } ] } "GlobalStatus": 5000, "Name": "NOSTATUS", "Description": "The device/group does not have a valid status." /api/DeviceService/DeviceType This URI represents the device types. GET method for DeviceType This method returns a list of devices types. Description Returns a list of devices types. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(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 Input: Output: { "@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.
"Count": 1 }, { ] "StatusType": 3000, "Count": 0 }, { "StatusType": 4000, "Count": 0 }, { "StatusType": 5000, "Count": 0 } }, { } ] } "@odata.id": "/api/DeviceService/DeviceSummary(8000)", "DeviceType": 8000, "TotalCount": 1, "DeviceStatusSummary": [ { "StatusType": 1000, "Count": 0 }, { "StatusType": 2000, "Count": 0 }, { "StatusType": 3000, "Count": 1 }, { "StatusType": 4000, "Count": 0 }, { "StatusType": 5000, "Count": 0 } ] /api/DeviceService/DeviceSlotType This URI represents the slot types.
} "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." }, { "SlotType": 4000, "SlotName": "IO Module Slot", "Description": "This is IO Module Slot type." }, { "SlotType": 5000, "SlotName": "Chassis Manager Slot", "Description": "This is Chassis Manager Slot type.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Key": "GRID_REDUNDANCY", "Value": "GRID Redundancy", "Description": "Redundancy policy type is GRID redundancy" "Id": 3000, "Property": "duplexMode", "Key": "HALF", "Value": "Half", "Description": "Duplex Mode is half." "Id": 4000, "Property": "duplexMode", "Key": "FULL", "Value": "Full", "Description": "Duplex Mode is full.
}, { }, { }, { }, { }, { }, { }, { } ] } "Description": "QuickSyncAccess is read only" "Id": 13000, "Property": "quickSyncAccess", "Key": "READ_WRITE", "Value": "Read-Write", "Description": "QuickSyncAccess is read write" "Id": 14000, "Property": "timeoutLimitUnit", "Key": "SECONDS", "Value": "Seconds", "Description": "Time out limit unit is seconds" "Id": 15000, "Property": "timeoutLimitUnit", "Key": "MINUTES", "Value": "Minutes", "Description": "Time out limit unit is minutes" "Id": 16000, "Prop
Example Output: { "@odata.context": "$metadata#Collection(DeviceService.GlobalExclude)", "@odata.count": 4, "value": [ { "@odata.id": "/api/DeviceService/GlobalExcludes(1)", "Id": 1, "Identifier": "9PKM9Z1", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 1, "NetworkAddress": "10.35.0.111" } ] }, { "@odata.id": "/api/DeviceService/GlobalExcludes(2)", "Id": 2, "Identifier": null, "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 2, "NetworkAddress": "10.35.0.92" } ] }, { "@odata.
Example Input: {"DeviceIds": [2464,2614,2514]} Output: 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 Input: { } "Id": 0, "Identifier": "IPRange2", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 0, "NetworkAddress": "10.37.0.
} ] } "Id": 0, "NetworkAddress": "10.37.0.101-10.37.0.255" /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 Input: {"Ids": [1,2,3,4,5,6]} /api/DeviceService/Actions/ DeviceService.ValidateExcludes This URI validates global exclusion.
] } 208 Devices
8 Diagnostic /api/DeviceService/Devices(Id)/Actions/ DeviceService.Diagnostic This URI allows you to execute supported diagnostic commands. POST method for DeviceService.Diagnostic This method executes the supported diagnostics commands. Description Executes supported diagnostic commands.
9 Groups /api/GroupService/Groups This URI represents the groups. GET method for Groups This method returns a list of groups. Description Returns a list of groups. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(GroupService.Group)", "@odata.count": 1, "value": [ { "@odata.id": "/api/GroupService/Groups(64)", "Id": 64, "Name": "All Devices", "Description": "Group associated to all devices.
} ] } ] } "@odata.id": "/api/GroupService/Groups(64)/GroupDevicesSummary" Table 87. Attributes Attribute name Description Id ID of the group. Name Name of the group. Description Description of the group. GlobalStatus Global status of the group. Indicates the health of the group. ParentId Parent ID of the group. If the group is a root group, ParentId is 0. CreationTime Date and time when the group was created. UpdatedTime Date and time when the group was updated.
Table 88. Filters(continued) Attribute name Description Type Filter by group type. MembershipType Filter by group membership type. GlobalStatus Filter by group global status. DefinitionId Filter by group definition ID. DefinitionDescription Filter by group definition description. Visible Filter by group visibility. CreatedBy Filter by the entity that created the group. UpdatedBy Filter by the entity that updated the group.
{ } } "@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.id": "/api/GroupService/Groups(64)/GroupDevicesSummary" } ] Table 89. Attributes Attribute name Description Id ID of the group. Name Name of the group. Description Description of the group. GlobalStatus Global status of the group.
Table 89. Attributes(continued) Attribute name Description GroupDevicesSummary Group link to display a summary of all group devices. PUT method for Groups(Id) This method updates the settings of a group within the collection. Description Updates the settings of a group.
Table 90. 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. Description Returns the list of devices within a group. NOTE: For more information about the properties for device responses, see DeviceService. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.
"ManagementId": 5003, "NetworkAddress": "fe80::f68e:38ff:fecf:15ba", "MacAddress": "", "ManagementURL": "https://10.36.0.30", "ManagementType": 2, "InstrumentationName": "WIN-02GODDHDJTC", "DnsName": "idrac-SVCTAG", "Status": 1000 }, { "ManagementId": 5002, "NetworkAddress": "10.36.0.30", "MacAddress": "f4:8e:38:cf:15:ba", "ManagementURL": "https://10.36.0.30", "ManagementType": 2, "InstrumentationName": "WIN-02GODDHDJTC", "DnsName": "idrac-SVCTAG", "Status": 1000 } ], "InventoryDetails": [ { "@odata.
] } } "@odata.id": "/api/DeviceService/Devices(1614)/DeviceBladeSlots" } ], "GraphicInfo": { "@odata.id": "/api/DeviceService/Devices(1614)/GraphicInfo" } Table 91. Attributes Attribute name Description Id ID of the group. /api/GroupService/Groups(Id)/ GroupDevicesSummary This URI represents the device summary for a group. GET method for GroupDevicesSummary This method returns the device summary of a group. The summary contains the device types and their status.
} ] } Table 92. Attributes Attribute name Description Id ID of the group. /api/GroupService/Groups(Id)/SubGroups This URI represents the subgroups of a specific group. GET method for SubGroups This method returns the list of subgroups of a specific group. Description Returns the list of subgroups. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(GroupService.Group)", "@odata.count": 1, "value": [ { "@odata.
} ] } ], "GroupDevicesSummary": [ { "@odata.id": "/api/GroupService/Groups(19164)/GroupDevicesSummary" } ] Table 93. Attributes Attribute name Description Id ID of the group. Name Name of the group. Description Description of the group. GlobalStatus Global status of the group. Indicates the health of the group. ParentId Parent ID of the group. If the group is a root group, ParentId is 0. CreationTime Date and time when the group was created.
/api/GroupService/Groups(Id)/GroupHierarchy This URI represents the hierarchy of the subgroup within a group. GET method for GroupHierarchy This method returns the hierarchy of the subgroups within a group. Description Returns the hierarchy of the subgroups. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(GroupService.GroupHierarchy)", "@odata.count": 1, "value": [ { "ParentGroupId": 64, "ChildGroupId": 19164 } ] } Table 94.
"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.id": "/api/GroupService/GroupTypes(3000)", "Id": 3000, "Name": "User Defined", "Description": "Information for this group comes from user input." }, { "@odata.
operation." } Table 96. 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. GET method for MembershipTypes This method returns all the membership types. Description Returns all membership types. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(GroupService.
/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 Input: Output: { "@odata.context": "$metadata#GroupService.MembershipType/$entity", "@odata.
"ChildGroupId": 114 }, { "ParentGroupId": 0, "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 Input: { "GroupId": 100, "MemberDeviceIds" : [1414, 1464, 1214, 1264] } Output: /api/GroupService/Actions/ GroupService.
} "Privileges": [ "TEMPLATE_MANAGEMENT", "SECURITY_SETUP", "DEVICE_UPDATE", "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.
10 Monitor Audit logs /api/ApplicationService/AuditLogs This URI represents a collection of audit logs of the system. GET method for AuditLogs This method returns a collection of audit logs of the system. Description Returns a collection of audit logs. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(ApplicationService.AuditLog)", "@odata.count": 7, "value": [ { "@odata.
/api/ApplicationService/AuditLogs(Id) This URI represents a specific audit log within the collection. GET method for AuditLogs(Id) This method returns the details of a specific event or error message. Description Returns the details of a specific event or error message. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(ApplicationService.AuditLog)", "@odata.count": 7, "value": [ { "@odata.
Jobs /api/JobService/Jobs This URI represents all the jobs. GET method for Jobs This method returns the details of all the jobs. Description Returns details of all the jobs. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(JobService.Job)", "@odata.count": 1, "value": [ { "@odata.type": "#JobService.Job", "@odata.
}, "JobType": { "@odata.type": "#JobService.JobType", "Id": 8, "Name": "Inventory_Task", "Internal": false }, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2020, "Name": "Scheduled" }, "ExecutionHistories@odata.navigationLink": "/api/JobService/ Jobs(10016)/ExecutionHistories" } ] } Table 100. Filters Filter name Description Top Top records to return. Default value is 100. Skip Max records to skip. Default value is 0. JobType/Id Filter by job type. JobStatus/Id Filter by job status.
Table 101. Attributes(continued) Attribute Description 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.
} ] Output: { "Id": 26097, "JobName": "Inventory Task Device", "JobDescription": "Inventory Task Device", "NextRun": null, "LastRun": null, "StartTime": null, "EndTime": null, "Schedule": "startnow", "State": "Enabled", "CreatedBy": "root", "UpdatedBy": null, "LastRunStatus": { "Id": 2200, "Name": "NotRun" }, "JobType": { "Id": 8, "Name": "Inventory_Task", "Internal": false }, "JobStatus": { "Id": 2080, "Name": "New" }, "Targets": [ { "JobId": 26097, "Id": 25915, "Data": "", "TargetType": { "Id": 1000, "N
Output: { "@odata.context": "/api/$metadata#JobService.Job/$entity", "@odata.type": "#JobService.Job", "@odata.id": "/api/JobService/Jobs(10016)", "Id": 10016, "JobName": "Default Inventory Task", "JobDescription": "Default Inventory Task", "NextRun": "2018-09-14 15:30:00.0", "LastRun": "2018-09-14 15:00:00.
Table 102. Attributes(continued) Attribute Description JobDescription Description of the job. JobType Type of the job. NextRun The next time when the job will be executed. LastRun The last time when the job was executed. StartTime Start time of the job. EndTime End time of the job. Schedule Job schedule (cron string). State Indicates whether the job is enabled or disabled. CreatedBy User who created the job. UpdatedBy User who updated the job.
} "Schedule":"startnow", "State":"Enabled", "JobType": { "Id":8, "Name":"Inventory_Task" }, "Targets": [ { "Id": 25915, "Data": "", "TargetType": { "Id":1000, "Name":"DEVICE" } } ] Output: { "Id": 26097, "JobName": "Inventory Task", "JobDescription": "Inventory Task", "NextRun": null, "LastRun": "2018-09-14 15:31:13.
Table 103. Attributes Attribute Description Id ID of the job to be updated. DELETE method for Jobs(Id) This method deletes a specific job. Description Deletes a job. Privilege JOB_MANAGEMENT HTTP response codes 204 Example Input: Output: Table 104. 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.
}, { "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2050)", "Id": 2050, "Name": "Running" }, { } ] "@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.
/api/JobService/JobStatuses(Id) This URI represents the status of a job. GET method for JobStatuses(Id) This method returns the details of a specific job status. Description Returns details of a specific job status. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#JobService.JobStatus/$entity", "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2030)", "Id": 2030, "Name": "Queued" } Table 106.
"Id": 5, "Name": "Update_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(8)", "Id": 8, "Name": "Inventory_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(15)", "Id": 15, "Name": "RollbackSoftware_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(18)", "Id": 18, "Name": "DebugLogs_Task", "Internal": false }, { "@odata.
"Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(39)", "Id": 39, "Name": "MCMGroupCreation_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(41)", "Id": 41, "Name": "ProfileUpdate_Task", "Internal": false }, { } ] } "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(42)", "Id": 42, "Name": "QuickDeploy_Task", "Internal": false Table 107.
Table 108. Attributes(continued) Attribute Description Name Name of the job type. Internal Indicates whether the job is internal. /api/JobService/Jobs(Id)/ExecutionHistories This URI represents all the execution histories for a job. GET method for ExecutionHistories This method returns the details of all the execution histories for a job. Description Returns details of all executions histories for a job. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.
}, { "@odata.type": "#JobService.ExecutionHistory", "@odata.id": "/api/JobService/Jobs(10016)/ExecutionHistories(18774)", "Id": 18774, "JobName": "Default Inventory Task", "Progress": "100", "StartTime": "2018-09-14 14:00:00.526", "EndTime": "2018-09-14 14:00:29.312", "LastUpdateTime": "2018-09-14 14:00:29.312", "ExecutedBy": "admin", "JobId": 10016, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" }, "ExecutionHistoryDetails@odata.
Table 109. Attributes(continued) Attribute Description Progress Percentage of completion. StartTime The start time of job execution. EndTime The end time of job execution. Schedule Job schedule (cron string). State Indicates whether the job is enabled or disabled. LastUpdatedTime Timestamp when the job-execution history was last updated. ExecutedBy Details of who executed the job. JobId Job associated with the execution history. JobStatus Job execution history detail completion status.
] } } "Id": 7137, "Progress": "100", "StartTime": "2018-09-14 13:00:00.324", "EndTime": "2018-09-14 13:00:11.948", "Key": "MX-MSMDNH1", "Value": "Running\nCompleted", "ExecutionHistoryId": 18683, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" } Table 110. Attributes Attribute Description Id Job execution history detail ID. Progress Percentage of completion. StartTime The start time of job execution. EndTime The end time of job execution.
} } "StartTime": "2017-06-06 10:00:00.00", "EndTime": "2017-06-07 10:00:00.00" Or Input: { "AllJobs": true, } Output: /api/JobService/Actions/JobService.DisableJobs POST method for JobService.DisableJobs This method disables the selected jobs. Description Disables the selected jobs.
/api/JobService/Actions/JobService.RemoveJobs POST method for JobService.RemoveJobs This method deletes the selected jobs. Description Deletes the selected jobs.
Or Input: { "Filters": { "Status": 2020, "State": "", "JobType": "AlertSubscription_Task", "StartTime": "2017-06-06 10:00:00.00", "EndTime": "2017-06-07 10:00:00.00" } } Or Input: { "AllJobs": true, } Output: /api/JobService/Actions/JobService.StopJobs POST method for JobService.StopJobs This method stops the selected jobs. Description Stops the selected jobs.
11 Reset application /api/ApplicationService/Actions/ ApplicationService.ResetApplication This URI resets the application and select between resetting all data or only resetting the configuraiton. POST method for ResetApplication This method resets the application. You can either reset only the configuration or also clear all the data. Description Resets the application by clearing only the configuration, or by clearing the configuration and the data.
12 Console version /api/ApplicationService/Info This URI represents the product information. GET method for Info This method returns the product information. Description Returns the product information. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#ApplicationService.Info/$entity", "@odata.type": "#ApplicationService.Info", "@odata.
13 Console capabilities /api/ApplicationService/Capabilities This URI represents the capabilities of the management console—OME or OME - Modular. GET method for Capabilities This method returns the capabilities of the management console—OME or OME - Modular. These two management consoles have different capabilities. Description Returns the capabilities of the management console. Privilege VIEW HTTP response codes 200 Example Input: Output: Example of application capabilities of OME - Modular.
$metadata#Collection(ApplicationService.Capability)", "@odata.count": 7, "value": [ { "@odata.type": "#ApplicationService.Capability", "Name": "DEVICE_MANAGEMENT", "Description": "This capability tells whether the console is capable of restricting execution of tasks based on onboarded and not-onboarded devices" }, { "@odata.type": "#ApplicationService.Capability", "Name": "BOOT_TO_NETWORK_ISO", "Description": "This capability is for booting devices from network iso." }, { "@odata.
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.GetDocument /api/SearchService/Actions/ SearchService.Search POST method for SearchService.
"_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 111. Attributes Attribute name Description QueryString String to search. FilterType Indexes to be searched for the query string.
/api/SearchService/Actions/ SearchService.GetDocument POST method for SearchService.GetDocument This method searches for the document name you provide and returns the document that you can save. Description Returns the document corresponding to the search string. Privilege VIEW HTTP response codes 200 Example Input: { "FileName":"Whitepaper-PCSV-1.0.pdf" } Output: A window appears prompting you to select the location for saving the file. Table 112.
15 Session /api/SessionService This URI represents the collection of session services. GET method for SessionService This method returns a collection of the sessions services. Description Returns a collection of session services. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#SessionService.SessionService", "@odata.
/api/SessionService/Sessions This URI represents a collection of active session services. GET method for Sessions This method returns the collection of active session service. Description Returns a collection of active session services. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(SessionService.Session)", "@odata.count": 1, "value": [ { "@odata.
HTTP response codes Example 200 Input: { "UserName":"root", "Password":"linux", "SessionType":"API" } Output: { "Id": "7b723932-a119-4843-a5b7-7a122e4def99", "Description": "root", "Name": "API", "UserName": "root", "Password": null, "Roles": [ "ADMINISTRATOR" ], "IpAddress": "10.210.136.38", "StartTimeStamp": "2017-04-17 20:07:12.357", "LastAccessedTimeStamp": "2017-04-17 20:07:12.357" } Table 115. Attributes Attribute Name Description UserName The Session user name.
} "UserName":"root", "Password":"linux", "SessionType":"API" Output: { "Id": "7b723932-a119-4843-a5b7-7a122e4def99", "Description": "root", "Name": "API", "UserName": "root", "Password": null, "Roles": [ "ADMINISTRATOR" ], "IpAddress": "10.210.136.38", "StartTimeStamp": "2017-04-17 20:07:12.357", "LastAccessedTimeStamp": "2017-04-17 20:07:12.357" } Table 116. Attributes Attribute Name Description Id The unique identifier of the SessionService. UserName The session user name.
16 APIs specific to OpenManage Enterprise Modular Edition /api/ApplicationService/Actions/ ApplicationService.GetConfiguration POST method for ApplicationService.GetConfiguration This method returns a collection of all the settings of the system or a group of settings. Description Returns a collection of settings.
{ "Name": "LoginSecurity.1#LockoutFailCountTime", "Value": 30 }, { "Name": "LoginSecurity.1#LockoutPenaltyTime", "Value": 900 }, { "Name": "LoginSecurity.1#IPRangeAddr", "Value": null }, { "Name": "LoginSecurity.1#LockoutByUsernameEnable", "Value": false }, { "Name": "LoginSecurity.1#LockoutByIPEnable", "Value": true }, { "Name": "LoginSecurity.1#IPRangeEnable", "Value": false }, { "Name": "RemoteSystemLog.1#RemoteSyslogEnable", "Value": true }, { "Name": "RemoteSystemLog.
{ "Name": "ChassisPower.1#SystemInputPowerCap", "Value": "6763" }, { "Name": "ChassisPower.1#RedundancyPolicy", "Value": "NO_REDUNDANCY" }, { "Name": "ChassisPower.1#EnablePowerCap", "Value": true }, { "Name": "SNMPAlerts.1#Enable", "Value": true }, { "Name": "SNMPAlerts.1#DestinationIP", "Value": "10.36.0.167" }, { "Name": "SNMPAlerts.1#port", "Value": 162 }, { "Name": "SNMPAlerts.1#version", "Value": "SNMPV1" }, { "Name": "SNMPAlerts.1#CommunityString", "Value": "public" }, { "Name": "SNMPAlerts.
{ "Name": "SNMPAlerts.4#Enable", "Value": false }, { "Name": "SNMPAlerts.4#DestinationIP", "Value": null }, { "Name": "SNMPAlerts.4#port", "Value": 0 }, { "Name": "SNMPAlerts.4#version", "Value": null }, { "Name": "SNMPAlerts.4#CommunityString", "Value": null }, { "Name": "TimeConfig.1#TimeZone", "Value": "TZ_ID_11" }, { "Name": "TimeConfig.1#NTPEnable", "Value": false }, { "Name": "TimeConfig.1#NTPServer1", "Value": null }, { "Name": "TimeConfig.1#NTPServer2", "Value": null }, { "Name": "TimeConfig.
{ "Name": "QuickSync.1#WifiEnable", "Value": true }, { "Name": "EmailAlertsConf.1#DestinationEmailAddress", "Value": "10.36.0.167" }, { "Name": "EmailAlertsConf.1#portNumber", "Value": 25 }, { "Name": "EmailAlertsConf.1#useCredentials", "Value": false }, { "Name": "EmailAlertsConf.1#useSSL", "Value": false }, { "Name": "EmailAlertsConf.1#user", "Value": null }, { "Name": "EmailAlertsConf.1#Password", "Value": null }, { "Name": "SNMPService.1#Enable", "Value": true }, { "Name": "SNMPService.
{ "Name": "Proxy.1#password", "Value": null }, { "Name": "Proxy.1#enableAuthentication", "Value": false }, { "Name": "Proxy.
{ "Name": "Network#Ipv6Settings#StaticGateway", "Value": "" }, { "Name": "Network#Ipv6Settings#UseDHCPv6ObtainDNSServerAddresses", "Value": true }, { "Name": "Network#Ipv6Settings#StaticPreferredDNSServer", "Value": "" }, { "Name": "Network#Ipv6Settings#StaticAlternateDNSServer", "Value": "" }, { "Name": "Network#GeneralSettings#EnableNIC", "Value": true }, { "Name": "Network#GeneralSettings#RegisterDNS", "Value": true }, { "Name": "Network#GeneralSettings#DnsName", "Value": "MX-01PTCMSM1234" }, { "Nam
}, { "Name": "Users.2#userType", "Value": 1 }, { "Name": "Users.2#SHA256Password", "Value": "$2a $10$zpVUzQIfE3nCOpodYXiz9.A.rr6SAkYcovyTEd49hxL7N83ZeqkqK" }, { "Name": "Users.2#Name", "Value": "ravi2" }, { "Name": "Users.2#Privilege", "Value": "10" }, { "Name": "Users.2#Enable", "Value": true }, { "Name": "Users.2#Password", "Value": null }, { "Name": "Users.3#userType", "Value": 1 }, { "Name": "Users.3#SHA256Password", "Value": "$2a $10$dTg7igLe1neXnZthG9vzP.8ML.tcUOxyeP.
{ "Name": "Users.4#Password", "Value": null }, { "Name": "Users.5#userType", "Value": 2 }, { "Name": "Users.5#SHA256Password", "Value": "$2a $10$H0cK06cAnceieSNuaI3JT.TI8DfX49XkdVcNbHC4G2X92lAhCAstS" }, { "Name": "Users.5#Name", "Value": "MSMMegatronTeam" }, { "Name": "Users.5#Privilege", "Value": "10" }, { "Name": "Users.5#Enable", "Value": true }, { "Name": "Users.5#objectGuid", "Value": "d22005b6-0ce5-40ed-88d0-7f7759b52f25" }, { "Name": "Users.5#Password", "Value": null }, { "Name": "Users.
}, { "Name": "ActiveDirectory.1#certificateFile", "Value": "" }, { } } ] } ] "Name": "LDAP.1#name", "Value": "LDAP Dell" }, { "Name": "LDAP.1#serverType", "Value": "MANUAL" }, { "Name": "LDAP.1#DomainController1", "Value": "10.36.0.167" }, { "Name": "LDAP.1#Port", "Value": 636 }, { "Name": "LDAP.1#BaseDN", "Value": "dc=dell,dc=com" }, { "Name": "LDAP.1#NetworkTimeout", "Value": 120 }, { "Name": "LDAP.1#SearchTimeout", "Value": 120 }, { "Name": "LDAP.
/api/ApplicationService/Actions/ ApplicationService.ApplyConfiguration POST method for ApplicationService.ApplyConfiguration This method updates the system settings. Description Updates the system settings. Privilege APPLIANCE_SETUP HTTP response codes 200 Example 268 Input: { "SystemConfiguration": { "Comments": [ "Export type is Normal,JSON" ], "Model": "POWEREDGE MX7000", "ServiceTag": "01PTCMSM", "TimeStamp": "2018-09-25T13:39:10.933Z", "Components": [ { "FQDD": "MM.Embedded.
{ "Name": "LoginSecurity.1#LockoutByIPEnable", "Value": true }, { "Name": "LoginSecurity.1#IPRangeEnable", "Value": false }, { "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.
{ "Name": "SNMPAlerts.1#DestinationIP", "Value": "10.36.0.167" }, { "Name": "SNMPAlerts.1#port", "Value": 162 }, { "Name": "SNMPAlerts.1#version", "Value": "SNMPV1" }, { "Name": "SNMPAlerts.1#CommunityString", "Value": "public" }, { "Name": "SNMPAlerts.2#Enable", "Value": false }, { "Name": "SNMPAlerts.2#DestinationIP", "Value": null }, { "Name": "SNMPAlerts.2#port", "Value": 0 }, { "Name": "SNMPAlerts.2#version", "Value": null }, { "Name": "SNMPAlerts.
{ "Name": "SNMPAlerts.4#CommunityString", "Value": null }, { "Name": "TimeConfig.1#TimeZone", "Value": "TZ_ID_11" }, { "Name": "TimeConfig.1#NTPEnable", "Value": false }, { "Name": "TimeConfig.1#NTPServer1", "Value": null }, { "Name": "TimeConfig.1#NTPServer2", "Value": null }, { "Name": "TimeConfig.1#NTPServer3", "Value": null }, { "Name": "TimeConfig.1#systemTime", "Value": "2018-09-25 08:39:07" }, { "Name": "LocalAccessConfiguration.
{ "Name": "EmailAlertsConf.1#useSSL", "Value": false }, { "Name": "EmailAlertsConf.1#user", "Value": null }, { "Name": "EmailAlertsConf.1#Password", "Value": null }, { "Name": "SNMPService.1#Enable", "Value": true }, { "Name": "SNMPService.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.
{ "Name": "Network#MgmtVLANId", "Value": "1" }, { "Name": "Network#EnableVLAN", "Value": false }, { "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"
{ }, { "Name": "Network#GeneralSettings#EnableNIC", "Value": true "Name": "Network#GeneralSettings#RegisterDNS", "Value": true }, { "Name": "Network#GeneralSettings#DnsName", "Value": "MX-01PTCMSM1234" }, { "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#Gene
"Value": "10" }, { "Name": "Users.2#Enable", "Value": true }, { "Name": "Users.2#Password", "Value": null }, { "Name": "Users.3#userType", "Value": 1 }, { "Name": "Users.3#SHA256Password", "Value": "$2a $10$dTg7igLe1neXnZthG9vzP.8ML.tcUOxyeP.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.
}, { "Name": "Users.5#Privilege", "Value": "10" }, { "Name": "Users.5#Enable", "Value": true }, { "Name": "Users.5#objectGuid", "Value": "d22005b6-0ce5-40ed-88d0-7f7759b52f25" }, { "Name": "Users.5#Password", "Value": null }, { "Name": "Users.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.
}, { } } ] } ] "Name": "LDAP.1#Port", "Value": 636 }, { "Name": "LDAP.1#BaseDN", "Value": "dc=dell,dc=com" }, { "Name": "LDAP.1#NetworkTimeout", "Value": 120 }, { "Name": "LDAP.1#SearchTimeout", "Value": 120 }, { "Name": "LDAP.1#CertValidationEnable", "Value": false }, { "Name": "LDAP.1#certificateFile", "Value": "" } Output: { "JobId": 38758 } Table 118. Attributes Attribute Description SystemConfiguration Parent tag that represents system configuration. Comments User-defined comments.
Brand /api/ApplicationService/Actions/ ApplicationService.BrandInfo This URI represents the brand information. POST method for BrandInfo This method returns the brand information. Description Returns the brand information. Privilege VIEW HTTP response codes 200 Example Input: Output: { "BrowserTitle": "globalNavigation.consoleBrowserTitle", "ConsoleTitle": "globalNavigation.
Example Imput: { "BrandType":"DEBRANDED" } OR { "BrandType":"DEFAULT" } Output: { 200 OK } Multichassis management /api/ManagementDomainService This method represents the role of the chassis in a Multi-Chassis Management (MCM)domain. GET method for ManagementDomainService This method returns the role of the chassis in a MCM domain. Description Returns the role of the chassis in a MCM domain. Privilege VIEW HTTP response codes 200 Example Input: Output — Standalone chassis: { "@odata.
ConfigurationTypes" } Output — Lead chassis: { "@odata.context": "/api/ $metadata#ManagementDomainService.ManagementDomainService", "@odata.type": "#ManagementDomainService.ManagementDomainService", "@odata.
Table 119. Attributes(continued) Attribute Description GroupName Name of the group. GroupDescription Description of the group. JoinApproval Join approval • • Automatic: Join requests from a standalone chassis are automatically approved. Manual: Join requests from a standalone chassis are queued on the lead for administrator's approval. Onboarding of the remote chassis does not get initiated until approved. ConfigReplication Configuration that is replicated when a new domain joins this group.
{ } ] } "ConfigType": "LocalAccessConfiguration", "Enabled": false Output: { "JobId": 36183, "Status": "Success" } Example for editing a group Input: { "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": "
Table 120. Attributes(continued) Attribute Description GroupName Name of the group. GroupDescription Description of the group. JoinApproval Join approval • • Automatic: Join requests from a standalone chassis are automatically approved. Manual: Join requests from a standalone chassis are queued on the lead for administrator's approval. Onboarding of the remote chassis does not get initiated until approved. ConfigReplication Configuration that is replicated when a new domain joins this group.
"Version": "1" }, { } ] "@odata.type": "#ManagementDomainService.DiscoveredDomain", "GroupId": "8e5c5534-8435-47f9-bf79-65498caf7b54", "GroupName": "Example-GroupName", "GroupDescription": "Example-GroupDescription", "PublicAddress": [ "10.35.155.91" ], "Name": "MX-UTSKY88", "Description": "POWEREDGE MX7000", "Identifier": "UTSKY88", "DomainTypeId": 4000, "DomainTypeValue": "MSM", "DomainRoleTypeId": 3001, "DomainRoleTypeValue": "MEMBER", "Version": "1" }, { "@odata.type": "#ManagementDomainService.
Table 121. Attributes(continued) Attribute Description • • • Version LEAD MEMBER STANDALONE Version of OME - Modular. /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.
/api/ManagementDomainService/ConfigurationTypes(Id) This URI represents a specific configuration type supported on the management domain service. GET method for ConfigurationTypes(Id) This method returns the details of a specific configuration type supported on the domain service. Description Returns the details of a specific configuration type. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#ManagementDomainService.ConfigurationType/ $entity", "@odata.
Output — Standalone chassis: { "@odata.context": "/api/ $metadata#Collection(ManagementDomainService.Domain)", "@odata.count": 1, "value": [ { "@odata.type": "#ManagementDomainService.Domain", "@odata.id": "/api/ManagementDomainService/Domains(25025)", "Id": 25025, "DeviceId": 25007, "PublicAddress": [ "10.35.0.
} ] } "Identifier": "01PTCMSM", "DomainTypeId": 4000, "DomainTypeValue": "MSM", "DomainRoleTypeId": 3000, "DomainRoleTypeValue": "LEAD", "Version": "1", "Local": false, "GroupId": "8e5c5534-8435-47f9-bf79-65498caf7b54", "GroupName": "Example-GroupName" Output — Lead chassis: { "@odata.context": "/api/ $metadata#Collection(ManagementDomainService.Domain)", "@odata.count": 2, "value": [ { "@odata.type": "#ManagementDomainService.Domain", "@odata.
Table 124. Attributes(continued) Attribute Description 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. Possible value: • • • DomainRoleTypeValue 3000 — LEAD 3001 — MEMBER 3002 — STANDALONE Type of domain role.
} "@odata.id": "/api/ManagementDomainService/Domains(2714)", "Id": 2714, "DeviceId": 2664, "Address": "fde1:53ba:e9a0:de14:1a66:daff:fe76:4ebc", "Name": "cmc-LEAD123", "Description": "Chassis-LEAD123", "Identifier": "LEAD123", "DomainTypeId": 4000, "DomainTypeValue": "MSM", "DomainRoleTypeId": 3000, "DomainRoleTypeValue": "LEAD", "Version": "VERSION", "Port": "443", "Local": true, "GroupId": "4e361023-07cc-4b98-af3f-ba7c2ef2f5b9", "GroupName": "DDD" Table 125.
/api/ManagementDomainService/PendingDomains This URI represents the pending domain-related requests. GET method for PendingDomains This method returns a list of pending requests that are made for joining an MCM domain group. Description Returns a list of pending requests that are made for joining an MCM domain group. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(ManagementDomainService.PendingDomain)", "@odata.
Table 126. Attributes(continued) Attribute Description Description Description of the onboarding chassis. Identifier Service tag of the onboarding chassis. Domain type Information for internal programmatic use. Version Version of OME - Modular of the onboarding chassis. /api/ManagementDomainService/PendingDomains(Id) This URI represents a specific pending domain-related requests in the collection of pending requests.
Table 127. Attributes(continued) Attribute Description Name Name of the onboarding chassis. Description Description of the onboarding chassis. Identifier Service tag of the onboarding chassis. Domain type Information for internal programmatic use. Version Version of OME - Modular of the onboarding chassis. /api/ManagementDomainService/Actions/ ManagementDomainService.Domains POST method for ManagementDomainService.Domains This method adds a chassis domain to the MCM domain group.
Table 128. Attributes Attribute Description JobId Job ID created for the operation. Status Status of the operation. NOTE: The Status is always displayed as APPROVED. To track the status of the job, use the JobID. /api/ManagementDomainService/Actions/ ManagementDomainService.Join POST method for ManagementDomainService.Join This method allows a standalone chassis (OME - Modular) to join an MCM domain group. Description Allows a standalone chassis (OME - Modular) to join an MCM domain group.
Example Input: Output: { "JobId": 13664, "Status": "SUCCESS" } Table 130. Attributes Attribute Description JobId Job ID created for the operation. Status Status of the operation. NOTE: The Status is always displayed as SUCCESS. To track the status, use the JobId. /api/ManagementDomainService/Actions/ ManagementDomainService.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.
/api/ManagementDomainService/Actions/ ManagementDomainService.DeleteGroup POST method for ManagementDomainService.DeleteGroup This method deletes an MCM domain group. Description Deletes an MCM domain group. Privilege APPLIANCE_SETUP HTTP response codes 200 Example Input: { "GroupId": "671497bc-9d61-4067-afcd-48f9df5e8dd2" } Output: { "JobId": 13514, "Status": "SUCCESS" } Table 132. Attributes Attribute Description GroupId Group ID of the lead domain. JobId Job ID for the delete operation.
{ ] } "Id": 15964, "Approval":true Output: { "Status": "SUCCESS" } Approving or rejecting multiple pending requests Input: [ { "Id": 36197, "Approval": true }, { "Id": 36198, "Approval": false } ] Output: { "Status": "SUCCESS" } Table 133. Attributes Attribute name Description Id ID of the pending domain that requested to join the group. Approval Indicates if the request is approved or rejected. Possible values: • • Status true: Approved false: Rejected Status of the operation.
$entity", "@odata.type": "#ApplicationService.FIPSModeConfiguration", "@odata.id": "/api/ApplicationService/Security/SecurityConfiguration", "FipsMode": "OFF" } Fabric management /api/NetworkService This URI represents the network services. GET method for NetworkService This method returns the details of the network services. Description Returns the details of the network services. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#NetworkService.
Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(NetworkService.Fabric)", "@odata.count": 1, "value": [ { "@odata.type": "#NetworkService.Fabric", "@odata.id": "/api/NetworkService/Fabrics('0bebadec-b61b-4b16b354-5196396a4a18')", "Id": "0bebadec-b61b-4b16-b354-5196396a4a18", "Name": "Fabric-1", "Description": "This is a fabric.
"DesignNode": "Switch-B", "PhysicalNode": "DPM4XC2" } ], "Switches@odata.navigationLink": "/api/NetworkService/ Fabrics('0bebadec-b61b-4b16-b354-5196396a4a18')/Switches", "Servers@odata.navigationLink": "/api/NetworkService/Fabrics('0bebadecb61b-4b16-b354-5196396a4a18')/Servers", "FabricDesign": { "@odata.id": "/api/NetworkService/Fabrics('0bebadec-b61b-4b16b354-5196396a4a18')/FabricDesign" }, "ValidationErrors@odata.
/api/NetworkService/FabricDesign This URI represents the fabric designs. GET method for FabricDesign This method returns a list of the fabric designs. Description Returns a list of fabric designs. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(NetworkService.FabricDesign)", "@odata.count": 3, "value": [ { "@odata.type": "#NetworkService.FabricDesign", "@odata.
}, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/38", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/38" }, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/40", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/40" }, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/39", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/39" } ], "FabricDesignNode": [ { "NodeName": "Switch-A", "ChassisName": "Chassis-X", "Slot
"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. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.
"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.navigationLink": "/api/NetworkService/ Fabrics('31db245a-9865-4a23-9697-4902cd2d5421')/Switches", "Servers@odata.
{ } "Name":"2xMX9116n_Fabric_Switching_Engines_in_same_chassis " } Output: TRUE Table 134. Attributes Attribute name Description ID The identifier of the fabric. Name The fabric name. Description The fabric name description. DesignNode DesignNode must be identical to the name provided in the selected fabric design. PhysicalNode Service Tag of the switch that you want to configure for the given fabric. FabricDesign Name (FabricDesign) The fabric design name.
} "Name": "2NodeHERedundant", "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
[ { "@odata.type": "#NetworkService.ValidationError", "@odata.
NotFound-Issue", "MessageId": "NFAB0012", "Category": "FabricError", "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.
"ChassisServiceTag": "SKY00201234567890123456789012345", "Description": "Unable to validate the fabric because the design link ICL-1_FORWARD not connected as per design 2NodeHESameChassis.
} ] POST method for Uplinks for a specific fabric This method creates an uplink. Description Creates an uplink. Privilege FABRIC_MANAGEMENT HTTP response codes 201 Example Input: { "Name":"Fabric-1", "Description":"This is a fabric.", "MediaType":"Ethernet", "Ports": [ { "Id":"8KWYERN1:e102-009-0" } ], "Networks": [ { "Id":8756 } ] } Output: Uplink Id Table 135. Attributes Attribute name Description ID The identifier of the fabric. Name The fabric name.
Example Input: Output: { "@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.
HTTP response codes Example 204 Input: Output: /api/NetworkService/Fabrics(Id)/Uplinks(Id)/Ports This URI represents the uplink ports of a specific uplink in a fabric. GET method for Ports for a specific uplink This method returns the uplink ports of a specific uplink in a fabric. Description Returns the uplink ports. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(NetworkService.Port)", "@odata.count": 4, "value": [ { "@odata.
"OpticsType": "NotPresent", "BlinkStatus": "OFF", "Role": "Uplink" }, { "@odata.type": "#NetworkService.Port", "@odata.
"@odata.context": "/api/ $metadata#Collection(NetworkConfigurationService.Network)", "@odata.count": 2, "value": [ { "@odata.type": "#NetworkConfigurationService.Network", "@odata.id": "/api/NetworkService/ Fabrics('43be623e-0d74-4f6d-87b3-3ea40bf6372d')/Uplinks('bda43da9d6d8-4fc5-98b7-cb9030e8008e')/Networks(25375)", "Id": 25375, "Name": "1", "Description": "1", "VlanMaximum": 11, "VlanMinimum": 11, "Type": 1, "CreatedBy": "root", "CreationTime": "2018-07-11 03:35:11.
"Id": 0, "Type": 4000, "Identifier": "8KWYERN1", "ChassisServiceTag": "9FHJSUIK1", "Model": null, "PowerState": 2, "Status": 1000, "AssetTag": "8KWYERN1", "SystemId": 0, "DeviceName": "Weaver1Node", "LastInventoryTime": null, "DeviceCapabilities": [], "DeviceSubscription": { "@odata.id": null }, "DeviceSpecificData": { "@odata.id": null }, "DeviceManagement": [], "InventoryDetails": [ { "@odata.
/api/NetworkService/Fabrics(Id)/Servers This URI represents the servers of a specific fabric. GET method for Servers for a specific fabric This method returns the details of the severs of a specific fabric. Description Returns the servers that are part of a specific fabric. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 1, "value": [ { "@odata.
"@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/RecentActivity" } ], "InventoryTypes": { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/InventoryTypes" }, "Settings": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/Settings" } ] } ] } /api/NetworkService/Fabrics(Id)/ISLLinks This URI represents the ISL links of a specific fabric.
"@odata.id": "/api/NetworkService/ Fabrics('31db245a-9865-4a23-9697-4902cd2d5421')/ ISLLinks('41F4MN2%3Aethernet1%2F1%2F10%3A1')", "Id": "41F4MN2:ethernet1/1/10:1", "Source": { "ChassisName": "Chassis-19", "ChassisServiceTag": "GYFJ9N2", "Slot": "IOM-B2", "PortNumber": "41F4MN2:ethernet1/1/10:1", "PortName": null }, "Destination": { "ChassisName": "Chassis-19", "ChassisServiceTag": "GYFJ9N2", "Slot": "IOM-B1", "PortNumber": "41F2MN2:ethernet1/1/10:1", "PortName": null } }, { "@odata.type": "#NetworkService.
/api/NetworkService/Fabrics(Id)/Topology This URI represents the topology of the nodes and switches. GET method for Topology for a fabric This method returns the topology of all the nodes and switches in a fabric. Description Returns a topology of the nodes and switches. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#NetworkService.Topology/$entity", "@odata.type": "#NetworkService.Topology", "@odata.
"@odata.id": null }, "DeviceSpecificData": { "@odata.id": null }, "DeviceManagement": [], "InventoryDetails": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/InventoryDetails" } ], "HardwareLogs": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/HardwareLogs" } ], "SubSystemHealth": [ { "@odata.
Output: { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 1, "value": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)", "Id": 0, "Type": 1000, "Identifier": "7IUJMNBGJ", "ChassisServiceTag": "9FHJSUIK1", "Model": "ServerModel1", "PowerState": 2, "Status": 3000, "AssetTag": "7IUJMNBGJ", "SystemId": 0, "DeviceName": "ServerNode", "LastInventoryTime": null, "DeviceCapabilities": [], "DeviceSubscription": { "@odata.
} ] /api/NetworkService/Fabrics(Id)/Topology/Nodes(Id)/ ChildNodes This URI represents the child nodes for a specific node of a fabric topology. GET method for ChildNodes This method returns the child nodes for a specific node of a fabric topology. Description Returns the child nodes. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(NetworkService.Node)", "@odata.count": 2, "value": [ { "@odata.type": "#NetworkService.Node", "@odata.
"ServiceTag": "DPM4XC1", "DeviceId": 25005, "Model": "MX9116n Fabric Engine", "Slot": "IOM-B2", "SwitchMode": "Fabric", "PowerState": 17, "Name": "IOM-B2" }, "ChildNodes@odata.navigationLink": "/api/NetworkService/ Fabrics('43be623e-0d74-4f6d-87b3-3ea40bf6372d')/Topology/Nodes('Switch %3ADPM4XC1')/ChildNodes" } ] } /api/NetworkService/Actions/ NetworkService.RemoveFabrics POST method for NetworkService.RemoveFabrics This method deletes multiple fabrics. Description Deletes multiple fabrics.
{ } "id1": true, "id2": true /api/NetworkService/FabricDesigns(Id)/ NetworkService.GetApplicableNodes POST method for GetApplicableNodes This method returns the available nodes applicable to a fabric design. Description Returns applicable nodes.
/api/NetworkService/Fabrics(Id)/ NetworkService.GetApplicableUplinkPorts POST method for GetApplicableUplinkPorts This method returns the available uplink ports applicable to a fabric design. Description Returns applicable uplink ports.
{ } ] } ] "Id": "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", "Name": "", "Description": "", "PortN
/api/NetworkService/UplinkTypes This URI represents the uplink types. GET method for UplinkTypes This method returns the uplink types. Description Returns the uplink types. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(NetworkService.UplinkType)", "@odata.count": 4, "value": [ { "@odata.type": "#NetworkService.UplinkType", "Id": 1, "Name": "Ethernet" }, { "@odata.type": "#NetworkService.UplinkType", "Id": 2, "Name": "FCoE" }, { "@odata.
} "value": [ { "@odata.type": "#NetworkService.NodeType", "Id": 1, "Name": "CHASSIS" }, { "@odata.type": "#NetworkService.NodeType", "Id": 2, "Name": "NWIOM" }, { "@odata.type": "#NetworkService.NodeType", "Id": 3, "Name": "PORT" } ] /api/NetworkService/FabricActivityTypes This URI represents the activities that can be performed using fabrics. GET method for FabricActivityTypes This method returns the list of activities that can be performed using fabrics.
} ] } /api/NetworkService/FabricActivityStatuses This URI represents the possible status values of the fabric activities. GET method for FabricActivityStatuses This method returns the possible status values of the fabric activities or jobs. Description Returns the possible status values of fabric activities or jobs. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.
{ "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2100", "Name": "Aborted" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2101", "Name": "Paused" }, { } ] "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2102", "Name": "Stopped" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2103", "Name": "Canceled" } /api/NetworkService/FabricHealthStatuses This URI represents the possible health states of the fabric.
} ] } "@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. Description Provides access to the multi-chassis topology and validation errors. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.id": "/api/NetworkService/MultiChassisDomain", "Topology": { "@odata.
/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. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(NetworkService.Node)", "@odata.count": 2, "value": [ { "@odata.type": "#NetworkService.Node", "@odata.
} ] } /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. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#NetworkService.Node/$entity", "@odata.type": "#NetworkService.Node", "@odata.
Example Input: Output: { "@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 Input: Output: { "@odata.context": "/api/ $metadata#Collection(NetworkService.ValidationError)", "@odata.count": 5, "value": [ { "@odata.type": "#NetworkService.
"Description": "Unable to validate the network fabric because the HE IOMs are in the same chassis.", "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.
"DestinationNode": "DPM4XC1", "DestinationInterface": "DPM4XC1:ethernet1/1/41" }, "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.
{ "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.count": 3, "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.
/api/NetworkService/PortRoles This URI represents the possible roles of the ports. GET method for PortRoles This method returns the possible roles of a port. Description Returns the possible statuses of a port. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.count": 5, "value": [ { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Spinner", "Name": "Spinner" }, { "@odata.
POST method for configuring MTU This method configures the MTU range. Description Configures the minimum and maximum MTU values.
[ ] { } "Id":2664, "Data":"", "TargetType": { "Id":4000, "Name":"DEVICE" } Output: POST method for updating port name and description This method updates the port name and description. Description Updates port name and description.
HTTP response codes Example 201 Input: "Params": [ { "Key":"operationName", "Value":"CONFIGURE_PORT_SPEED" }, { "Key":"interfaceId", "Value":"GF86XC2:1/1/9,GF86XC2:1/1/10" }, { "Key":"speed", "Value":"100000" } ], "Targets": [ { "Id":2664, "Data":"", "TargetType": { "Id":4000, "Name":"DEVICE" } } ] Output: Table 137. Attributes Attribute name Description TargetType (Id) Network IOM device ID. InterfaceId Port name. Key Operation name.
Example Input: { "JobName":"Storage Assignment", "JobDescription":"Storage Assignment Job", "Schedule":"startnow", "State":"Enabled", "JobType": { "Id":3, "Name":"DeviceAction_Task" }, "Params": [ { "Key":"operationName", "Value":"ASSIGN_STORAGE" }, { "Key":"assignmentMode", "Value":"1" }, { "Key":"serverSlots", "Value":
{ "Key":"assignmentMode", "Value":"1" } ], "Targets":[ { "Id":, "Data":"", "TargetType":{ "Id":1000, "Name":"DEVICE" } } ] } Output: Assign drives POST method for drive assignment Description Creates a job to assign individual storage drives to server slots.
} Output: Clear drive assignment POST method for clearing drive assignment Description Creates a job to clear drive assignments to server slots.
Example Input: { "JobName": "Force Active", "JobDescription": "Force Active IOM", "Schedule": "startnow", "State": "Enabled", "JobType": { "Id": 3, "Name": "DeviceAction_Task" }, "Params": [ { "Key": "operationName", "Value": "FORCE_ACTIVE" } ], "Targets": [ { "Id":, "Data":"", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ] } Output: Clear configuration on SAS IOM POST method for clearing SAS IOM configuration Description Creates a job to clear the configuration on SAS IOM.
} ] } "TargetType": { "Id": 1000, "Name": "DEVICE" } Output: Extract SAS IOM logs to NFS share POST method for exporting SAS IOM logs to NFS share Description Creates a job to extract logs from SAS IOM to a NFS share.
Extract SAS IOM logs to CIFS share POST method for exporting SAS IOM logs to CIFS share Description Creates a job to extract logs from SAS IOM to an CIFS share. Privilege STORAGE_MANAGEMENT HTTP response codes 201 Example 348 Input: { "Id": 0, "JobName": "Extract Log", "JobDescription": "Extract device log to CIFS location", "Schedule": "startnow", "State": "Enabled", "JobType": { "Id": 18, "Name": "DebugLogs_Task" }, "Targets": [ { "Id": e.
Quick Deploy /api/JobService/Jobs This URI represents Quick-Deploy jobs. POST method for Quick-Deploy Jobs This method creates a Quick-Deploy job. Description Creates a Quick-Deploy job.
}, { "Key":"gatewayV6", "Value":"255.255.255.0" }, { "Key":"SlotId=1", "Value":"SlotSelected=true;SlotType=3000;IPV4Address=10.27.0.1;IPV6Address=ax0" }, { "Key":"SlotId=2", "Value":"SlotSelected=true;SlotType=2000;IPV4Address=10.35.0.
}, { "Value": "255.255.255.0" "Key": "SlotId=1", "Value": "SlotSelected=true;SlotType=3000;IPV4Address=10.27.0.1;IPV6Address=ax0" }, { "Key": "SlotId=2", "Value": "SlotSelected=true;SlotType=2000;IPV4Address=10.35.0.25;IPV6Address=" } ] } Table 138. Attributes Attribute name Description Id ID of job. The default ID for POST is 0. JobName Name of the Quick-Deploy Job. JobDescription Description of the Quick-Deploy Job. Schedule The schedule to start the Job. Quick-Deploy is startnow.
Table 138. Attributes(continued) Attribute name Description • • • • • 352 SlotSelected=true or false. Indicates if the slot is selected for applying Quick Deploy. SlotType = The type of slot. Sled type is 2000. IPV4Address = IPV4 address to be set at slot level. PV6Address = IPV6 address to be set at slot level.
17 APIs specific to OpenManage Enterprise Application settings Console update /api/JobService/Jobs This URI updates the OpenManage Enterprise appliance. POST method for Jobs This method updates the OpenManage Enterprise appliance. Description Updates the OpenManage Enterprise appliance.
/api/ConsoleUpdateService/Updates?$filter= Auto eq true This URI represents the update job status of the OpenManage Enterprise appliance. GET method for Updates?$filter= Auto eq true This method returns the update job status of OpenManage Enterprise. Description Returns the update job status of OpenManage Enterprise. Privilege VIEW HTTP response code 200 Example Output: { "@odata.context": "/api/$metadata#Collection(ConsoleUpdateService.Update)", "@odata.count": 1, "value": [ { "Version": "3.0.0.
"APA91bF944FuE2F5wIJQFEX6Uz1N29OvOXvASzGPtfCtOg3sZEPuFezjerOYuBaykTtXl0WWnAcItLYKHvE5E Ek9_BvS1TGFEVbIPr37DCGCbNUQBrE3Op8yGNwSZx8JYrI7f", "Description": "Samsung Quasi-Stellar Object", "LastConnection": "2017-09-18 14:24:51.997", "Created": "2017-09-18 14:24:51.997", "LastError": "1970-01-01 00:00:00.0", "LastPush": "1970-01-01 00:00:00.0", "NewAlertCount": 0, "StatusMessage": "OK" } ] } /api/AlertService/SubscriptionNotificationService This URI represents the subscription service details.
"AlertPolicyId": 414, "Token": "APA91bEbGmqbAy7nMxDOI0rAS3RVCUGv3szsCi5uQUlyIApwzTGYbgZ_CRy54McKZKP3MUSbcfxovqlpDx39L "Description": "Samsung Quasi-Stellar Object" } /api/AlertService/Actions/AlertService.DeleteMobileSubscription This URI represents the deletion of mobile subscriptions. POST method for AlertService.DeleteMobileSubscription This method deletes the specified mobile subscriptions. Description Deletes the specified mobile subscriptions.
"Skip": 1 } Output: { "@odata.context": "/api/$metadata#Collection(AlertService.Alert)", "@odata.count": 1, "value": [ { "@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(1)", "Id": 1, "SeverityType": 2, "SeverityName": "Info", "AlertDeviceId": 0, "AlertDeviceName": "10.210.137.100", "AlertDeviceType": 0, "AlertDeviceIpAddress": "10.210.137.
/api/JobService/Jobs This URI is used to create a TSR or diagnostic job. POST method for Jobs This method creates a TSR or diagnostic job. Description Creates a TSR or diagnostic job.
} } Example to create a diagnostic job } ] Input: { "Id":0, "JobName":"FinalTest", "JobDescription":"amit612", "Schedule":"startnow", "State":"Enabled", "JobType": { "Id":25, "Name":"Diagnostic_Task" }, "Params": [ { "Key":"deviceTypes", "Value":"1000" }, { "Key":"fileName", "Value":"FinalTest" }, { "Key":"operationName", "Value":"SERVER_DIAGNOSTIC" }, { "Key":"OPERATION_NAME", "Value":"SERVER_DIAGNOSTIC" }, { "Key":"ShareType", "Value":"2" }, { "Key":"RunMode", "Value":"0" }, { "Key":"RebootJobType", "
/api/TroubleshootService/Files This URI returns TechSupport Report (TSR) or diagnostic log files. GET method for Files This method returns TechSupport Report (TSR) or diagnostic log files. Description Returns TechSupport Report (TSR) or diagnostic log files.
"FilePath":"/shared/dell/omc/cifs/idrac/F3TPXK2/SERVER_EXECUTE_TSR/TSR/ TSR.zip" } /api/TroubleShootService/Actions/ TroubleShootService.GetArchivedConsoleLogs This URI retrieves the appliance service logs. POST method for TroubleShootService.GetArchivedConsoleLogs This method retrieves the appliance service log files as a .ZIP file. Description Retrieves the appliance service log files. Privilege VIEW HTTP response codes 200 Example Output: java.io.
Example Output: { "@odata.context": "/api/$metadata#Collection(QuerySupportService.Query)", "@odata.count": 6, "value": [ { "@odata.type": "#QuerySupportService.Query", "@odata.id": "/api/QuerySupportService/Queries(10001)", "Id": 10001, "Name": "Device Overview Report", "UsageId": 2, "FilterText": "", "ContextId": 2, "Conditions": [], "ResultFields": [], "SortFields": [] }, { "@odata.type": "#QuerySupportService.Query", "@odata.
[ "FilterText": "", "ContextId": 2, "Conditions": { "LogicalOperatorId": 0, "LeftParen": true, "FieldId": 52, "OperatorId": 11, "Value": "PowerEdge", "RightParen": true } ], "ResultFields": [ 50, 53, 52 ], "SortFields": [] } /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.
}, { } "@odata.type": "#QuerySupportService.QueryContextSummary", "@odata.id": "/api/QuerySupportService/QueryContextSummaries(2)", "Id": 2, "Name": "Devices", "Description": null, "BaseCategoryId": 1 }, { "@odata.type": "#QuerySupportService.QueryContextSummary", "@odata.
"@odata.type": "#QuerySupportService.QueryContext", "@odata.
"TableId": 5, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 20, "Name": "Device Service Tag", "TableId": 5, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 23, "Name": "Device Asset Tag", "TableId": 5, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 15, "Name": "Sub-Category Prefix", "TableId": 4, "Description": null, "FieldTypeId": 1, "StrMaxLen": 20, "EnumOpts": [] }, { "Id": 16, "Name": "Sub-Categor
} ] "Name": "Alert Message", "TableId": 1, "Description": null, "FieldTypeId": 1, "StrMaxLen": 2048, "EnumOpts": [] } /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.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 368 "Id": 1017, "Name": "HCI Appliances", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1014, "Name": "Hypervisor Systems", "UsageId": 1, "FilterText": "", "ContextId": 2 "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
}, { }, { }, { }, { }, { }, { }, { ] } "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1004, "Name": "PowerEdge VRTX", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1009, "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 "
/api/QuerySupportService/OperatorInfo This URI represents the supported logical operators of a query. GET method for OperatorInfo This method returns a list of supported logical operators for each field type. Description Returns a list of supported logical operators for each field type. Privilege VIEW HTTP response codes 200 Example 370 Output: { "@odata.context": "/api/$metadata#QuerySupportService.OperatorInfo/$entity", "@odata.type": "#QuerySupportService.OperatorInfo", "@odata.
"Id": 13, "Name": "before" }, { "Id": 14, "Name": "after" } ], "FieldTypes": [ { "FieldTypeId": 1, "Name": "String", "OperatorIds": [ 1, 2, 3, 4, 5, 6, 11, 12, 7, 8, 9, 10 ] }, { "FieldTypeId": 2, "Name": "Number", "OperatorIds": [ 1, 2, 3, 4, 5, 6, 9, 10 ] }, { "FieldTypeId": 3, "Name": "Date-Time", "OperatorIds": [ 1, 2, 13, 14, 9, 10 ] }, { "FieldTypeId": 4, "Name": "Enum", "OperatorIds": [ 1, 2, 9, 10 ] }, { "FieldTypeId": 5, "Name": "Boolean", "OperatorIds": APIs specific to OpenManage Enterprise 371
[ 1, 2, 9, 10 ] } } ] /api/QuerySupportService/Filters This URI represents summary information for all filters. GET method for Filters This method returns summary information for all filters. Description Returns summary information for all filters. Privilege VIEW HTTP response codes 200 Example 372 Output: { "@odata.context": "/api/ $metadata#Collection(QuerySupportService.Filter)", "@odata.count": 23, "value": [ { "@odata.type": "#QuerySupportService.Filter", "@odata.
}, { }, { } ] } "ContextId": 2, "Conditions": [] "@odata.type": "#QuerySupportService.Filter", "@odata.id": "/api/QuerySupportService/Filters(1000)", "Id": 1000, "Name": "Modular Systems", "UsageId": 1, "FilterText": "", "ContextId": 2, "Conditions": [] "@odata.type": "#QuerySupportService.Filter", "@odata.
}, { "LogicalOperatorId": 2, "LeftParen": true, "FieldId": 59, "OperatorId": 1, "Value": "202", "RightParen": true }, { "LogicalOperatorId": 2, "LeftParen": true, "FieldId": 59, "OperatorId": 1, "Value": "203", "RightParen": true } ] } Groups service /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 Example Input: Output: Table 142. 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 Input: Output: { "@odata.context": "$metadata#Collection(GroupService.StatusSummary)", "@odata.
Example Input { "GroupModel": { "Id": 0, "Name": "00000", "Description": "GroupPermissionTest", "GlobalStatus": 0, "DefinitionId": 0, "MembershipTypeId":24, "ParentId": 0 }, "GroupModelExtension" :{ "FilterId":0, "ContextId":2, "Conditions":[{ "LogicalOperatorId":1, "LeftParen":false, "FieldId":9, "OperatorId":1, "Value":"1000", "RightParen":false }] } } /api/GroupService/Actions/GroupService.UpdateGroup This URI represents the updates to a group. PUT method for GroupService.
HTTP response codes Example 200 Input: { "Id": 3164, "Name": "Test Group-My122-cloned", "Description": "Test Group123-4", "GlobalStatus": 0, "DefinitionId": 0, "ParentId": 12 } /api/GroupService/Actions/GroupService.DeleteGroup This URI represents deleting a group. POST method for GroupService.DeleteGroup This method deletes group(s). Description Deletes group(s). Privilege GROUP_MANAGEMENT HTTP response codes 204 Example Input: {"GroupIds": [5114]} /api/GroupService/Actions/ GroupService.
/api/GroupService/Actions/ GroupService.RemoveMemberDevices This URI represents removing devices from a group. POST method for GroupService.RemoveMemberDevices This method removes device(s) from a group. Description Removes device(s) from a group. Privilege GROUP_MANAGEMENT HTTP response codes 204 Example Input: { "GroupId":2614, "MemberDeviceIds" : [2514] } /api/GroupService/Actions/ GroupService.AddUserToGroups This URI represents adding users to groups. POST method for GroupService.
HTTP response codes Example 380 200 Output: { "@odata.context": "/api/ $metadata#Collection(DiscoveryConfigService.DiscoveryJob)", "@odata.count": 5, "value": [ { "@odata.type": "#DiscoveryConfigService.DiscoveryJob", "@odata.id": "/api/DiscoveryConfigService/Jobs(25249)", "JobId": 25249, "JobName": "Discovery-2017033110553636", "JobDescription": "Discovery-2017033110553636", "JobSchedule": "", "JobStartTime": "2018-09-14 01:24:25.
}, { }, { } ] } "DiscoveryConfigGroupId": 6, "DiscoveryConfigExpectedDeviceCount": 101, "DiscoveryConfigDiscoveredDeviceCount": 0, "DiscoveryConfigEmailRecipient": null, "DiscoveredDevicesByType": [] "@odata.type": "#DiscoveryConfigService.DiscoveryJob", "@odata.id": "/api/DiscoveryConfigService/Jobs(25116)", "JobId": 25116, "JobName": "Discovery-2018091310582929", "JobDescription": "Discovery-2018091310582929", "JobSchedule": "", "JobStartTime": "2018-09-13 15:59:08.
Table 143. Attributes(continued) Attribute Description JobStatusId Status of the discovery job. For example, Complete, Failed, and so on. JobNextRun If discovery job is scheduled, returns the next schedule time. LastUpdateTime Last updated time of the discovery job. DiscoveryConfigExpectedDeviceCount Total number of devices expected to be discovered by the job. DiscoveryConfigDiscoveredDeviceCount Total number of devices discovered by the job.
Example to run discovery job at a later time Example to schedule a discovery job Input: { "DiscoveryConfigGroupName":"Discovery-2017091613542121", "DiscoveryConfigGroupDescription":"null", "DiscoveryConfigModels":[ { "DiscoveryConfigId":916135421, "DiscoveryConfigDescription":"", "DiscoveryConfigStatus":"", "DiscoveryConfigTargets":[ { "DiscoveryConfigTargetId":0, "NetworkAddressDetail":"10.35.0.0", "AddressType":30, "Disabled":false, "Exclude":false } ], "ConnectionProfileId":0, "ConnectionProfile":"{\"p
} Example to run discovery job with multiple protocols 384 "Schedule":{ "RunNow":false, "RunLater":true, "Cron":"0 * */10 * * ? *", "StartTime":"", "EndTime":"" }, "CreateGroup":true, "TrapDestination":false Input: { "DiscoveryConfigGroupName":"Discovery-2017091614032525", "DiscoveryConfigGroupDescription":"null", "DiscoveryConfigModels":[ { "DiscoveryConfigId":916140325, "DiscoveryConfigDescription":"", "DiscoveryConfigStatus":"", "DiscoveryConfigTargets":[ { "DiscoveryConfigTargetId":0, "NetworkAddress
/api/DiscoveryConfigService/Actions/ DiscoveryConfigService.RemoveDiscoveryGroup This URI represents removing a discovery group. POST method for DiscoveryConfigService.RemoveDiscoveryGroup This method removes a discovery group. Description Removes a discovery group. Privilege DISCOVERY_MANAGEMENT HTTP response codes 204 Example Input: { "DiscoveryGroupIds":[1,2,3] } /api/DiscoveryConfigService/Actions/DiscoveryConfigService.Parse This URI represents discovery ranges parsed from a .CSV file.
"DiscoveryConfigTargetId": 0, "NetworkAddressDetail": "10.35.0.0-10.35.0.255", "AddressType": 30, "Disabled": false, "Exclude": false }], "ConnectionProfile":"{\"profileName\":\"\",\"profileDescription \":\"\",\"type\":\"DISCOVERY\",\"credentials\":[{\"id\":0,\"type\":\"REDFISH \",\"authType\":\"Basic\",\"modified\":false,\"credentials\":{\"username \":\"root\",\"password\":\"calvin\",\"caCheck\":false,\"cnCheck \":false,\"port\":443,\"retries\":2,\"timeout\":4,\"isHttp \":false,\"keepAlive\":false}}]}", "D
"RunNow": false, "RunLater": false, "Recurring": null, "Cron": "startnow", "StartTime": null, "EndTime": null } }, "TrapDestination": false, "ChassisIdentifier": null Warranty service /api/WarrantyService/Warranties This URI represents the retrieval of warranty information from OpenManage Enterprise. GET method for Warranties This method returns warranty information from OpenManage Enterprise. Description Returns warranty information from OpenManage Enterprise.
Table 144.
Example Output: { "@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 145.
}, { "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 }] } } /api/ReportService/ReportDefs(Id)/ReportResults This URI represents the results of a report. GET method for ReportResults This method returns results of a report. Description Returns results of a report.
"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.navigationLink": "/api/ReportService/ReportDefs(10031)/ ReportResults/ResultRows" } /api/ReportService/ReportDefs(Id)/ReportResults/ResultRows This URI represents the rows of the report results.
/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 Input: { "ReportDefId":1564, "FilterGroupId":0 } /api/ReportService/Actions/ReportService.DownloadReport The URI represents the download of reports. POST method for ReportService.DownloadReport This method downloads all the reports.
/api/ReportService/Actions/ReportService.CloneReport This URI represents cloning of a report. POST method for ReportService.CloneReport This method clones a report. Description Clones a group. Privilege REPORT_MANAGEMENT HTTP response codes 200 Example Input: { "ReportDefId":"25074", "ReportDefName":"new clone report" } 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.
"Description": "Critical" }, "EventDefinitionId": 1098064858, "Description": "Memory device status is non-recoverable." }, "FormatString": "$3", "GenericTrapId": 6, "SnmpEventId": 1000, "SpecificTrapId": 5405 }] } /api/MIBImportService/Actions/MIBImportService.Save This URI represents the saved traps from MIBs. POST method for MIBImportService.Save This method saves parsed traps from MIB in the appliance. This URI provides functionality to save traps already parsed from the MIB.
/api/MIBImportService/Actions/MIBImportService.Parse This URI represents the trap information by parsing MIBs. POST method for MIBImportService.Parse This method parses MIB files to get trap information. This URI accepts absolute file paths of the MIB file that need to be parsed. Description Parses MIB files to get trap information. Privilege TRAP_MANAGEMENT HTTP response codes 200 Example Input: ["/tmp/parseMib/10892.mib"] /api/MIBImportService/Actions/MIBImportService.
/api/MIBImportService/MIBImportService/EventCatalogs This URI represents the event catalogs. GET method for EventCatalogs This method returns the event catalogs. Description Returns the event catalogs. Privilege VIEW HTTP response codes 200 Example Output: { "@odata.context": "/api/ $metadata#Collection(MIBImportService.MIBEventCatalog)", "@odata.count": 46, "value": [{ "@odata.type": "#MIBImportService.MIBEventCatalog", "@odata.
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.
} ] Table 146. 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. /redfish/v1/SessionService/Sessions/Members This URI represents the active session services. GET method for Members This method returns a collection of the active session services. Description Returns a collection of the active session services.
Table 147. Attributes(continued) Attribute name Description 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.
HTTP response codes Example 200 URI: /api/SessionService/Sessions/Sessions(‘7b723932-a119-4843a5b7-7a122e4def99’) Input: { "UserName":"root", "Password":"linux", "SessionType":"API" } Output: { "Id": "7b723932-a119-4843-a5b7-7a122e4def99", "Description": "root", "Name": "API", "UserName": "root", "Password": null, "Roles": [ "ADMINISTRATOR" ], "IpAddress": "10.210.136.38", "StartTimeStamp": "2017-04-17 20:07:12.357", "LastAccessedTimeStamp": "2017-04-17 20:07:12.
Example Input: Output: { "@odata.context": "$metadata#AccountService.v1_0_2.AccountService", "@odata.
Table 149. Attributes(continued) Attribute name Description AccountLockoutDuration Number of seconds for which an account is locked after the account lockout threshold is met. This value must be equal to or greater than the value for AccountLockoutResetAfter. 0 indicates that the account is never locked. AccountLockoutCounterResetAfter Number of seconds after which the lockout threshold counter is reset to zero. The duration is counted from the last failed login attempt.
} "EnableIpRangeAddress": false Table 150. Attributes Attribute name Description ID ID of the account service. Description Description of the account service. Name Name of the account service. ByUserName Indicates if the service is configured by user name. ByIPAddress Indicates if the service is configured by IP address. State Indicates the known state of the resource. HealthRollup Health roll-up status Health Health of the resource. MinPasswordLength Minimum length of the password.
{ "@odata.context": "$metadata#Collection(ManagerAccount.v1_0_2.ManagerAccount)", "@odata.count": 1, "value": [ { "@odata.id": "/redfish/v1/AccountService/Accounts/Members('1814')", "Oem": { "Dell": { "UserTypeId": 1, "DirectortyServiceId": 0, "IsBuiltin": true } }, "Id": "1814", "Description": "root", "Name": "root", "Password": null, "UserName": "root", "RoleId": "10", "Locked": false, "Enabled": true, "Links": null } ] } Table 151. Attributes Attribute name Description Id ID of the account.
} "UserName": "user2", "RoleId": "10", "Locked": false, "Enabled": true Output: { "Id": "3064", "UserTypeId": 1, "DirectortyServiceId": 0, "Name": "user2", "Password": null, "UserName": "user2", "Description": "user2 description", "Oem": null, "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true } Table 152. Attributes Attribute name Description Id ID of the account. UserTypeId ID of the type of user. DirectortyServiceId ID of the directory service.
} "@odata.id": "/redfish/v1/AccountService/Accounts/Members('1814')", "Oem": { "Dell": { "UserTypeId": 1, "DirectortyServiceId": 0, "IsBuiltin": true } }, "Id": "1814", "Description": "root", "Name": "root", "Password": null, "UserName": "root", "RoleId": "10", "Locked": false, "Enabled": true, "Links": null Table 153. Attributes Attribute name Description Id ID of the account. UserTypeId ID of the type of user. DirectortyServiceId ID of the directory service. Description Description of the user.
Output: { "Id": "3064", "UserTypeId": 1, "DirectortyServiceId": 0, "Name": "user2", "Password": null, "UserName": "user2", "Description": "user2 description", "Oem": null, "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true } Table 154. Attributes Attribute name Description Id ID of the account. UserTypeId ID of the type of user. DirectortyServiceId ID of the directory service. Description Description of the user. Name Name of the user. This value is the same as user name.
/redfish/v1/AccountService/Roles/Members(Id) This URI represents the role details of a specific account. GET method for Members(Id) This method returns the details of the role for a specific account. Description Returns the details of a role. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Role.Role/$entity", "@odata.
} "Name": "Registry File Collection", "Description": "Registry Repository", "Base.1.0.0": [ { "@odata.id": "/redfish/v1/Registries/Base.1.0.0" } ], "Dellv1_0_0": [ { "@odata.id": "/redfish/v1/Registries/Dellv1_0_0" } ] Redfish — Chassis This resource enables you to access the chassis details. Using this resource, you can retrieve details such as chassis health, chassis rollup health, and so on. Use the URIs in this resource to access the chassis details.
}, { "@odata.id": "/redfish/v1/Chassis/Members('25010')" }, { } ] "@odata.id": "/redfish/v1/Chassis/Members('25009')" } Redfish — Systems /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 Input: Output: { "@odata.context": "/redfish/ v1/$metadata#ComputerSystemCollection.ComputerSystemCollection", "@odata.
