OpenManage Enterprise Version 3.6 and OpenManage Enterprise - Modular Edition Version 1.30.00 RESTful API Guide June 2021 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 -2021 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Revision history Date Document revision Description of changes April 2021 A00 v1.30.00 - Updates for new features and enhancements July 2021 A01 v1.30.10 - Updates for DC power supply July 2021 A02 OME Release 3.
Contents Revision history..........................................................................................................................................................................3 Chapter 1: About this document...................................................................................................19 Chapter 2: Overview....................................................................................................................22 RESTful application programming interface....
/api/AccountService/Actions/AccountService.GetPrivileges........................................................................ 52 /api/AccountService/Actions/AccountService.GetPrivilegesForUser......................................................... 53 /api/AccountService/Actions/AccountService.GetUserDetail.......................................................................53 /api/AccountService/Actions/AccountService.Enable.............................................................................
Chapter 5: Alerts.........................................................................................................................89 Alert logs............................................................................................................................................................................. 89 /api/AlertService/Alerts...........................................................................................................................................
/api/UpdateService/Baselines(Id)/DeviceComplianceReports..................................................................... 176 /api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id).............................................................. 178 /api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)/ComponentComplianceReports.. 179 /api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)/ ComponentComplianceReports(Id).....................................................................
/api/NetworkConfigurationService/Networks..................................................................................................234 /api/NetworkConfigurationService/Networks(Id)...........................................................................................237 /api/NetworkConfigurationService/NetworkTypes........................................................................................ 238 /api/NetworkConfigurationService/NetworkTypes(Id)..........................................
/api/DeviceService/Devices(Id)/Temperature...................................................................................................... 325 GET method for Temperature............................................................................................................................... 325 /api/DeviceService/Devices(Id)/BlinkStatus......................................................................................................... 326 GET method for LED blink status......................
POST method for DeviceService.EditNetworkRange...................................................................................... 344 /api/DeviceService/Actions/DeviceService.RemoveFromExclusion................................................................ 345 POST method for DeviceService.RemoveFromExclusion...............................................................................345 /api/DeviceService/Actions/DeviceService.ValidateExcludes.........................................................
/api/GroupService/Actions/GroupService.GroupsPrivilegesAction................................................................. 392 POST method for GroupService.GroupsPrivilegesAction............................................................................... 392 /api/GroupService/Actions/GroupService.GroupsByPrivilegesAction.............................................................392 POST method for GroupService.GroupsByPrivilegesAction.................................................................
/api/SessionService/Sessions(Id)..............................................................................................................................453 GET method for Sessions(Id)................................................................................................................................ 453 DELETE method for Sessions(Id)......................................................................................................................... 453 /api/SessionService/CurrentUser...
/api/ApplicationService/Security/SecurityConfiguration...............................................................................510 Fabric management.........................................................................................................................................................510 api/NetworkService/Actions/NetworkService.CreateFabric........................................................................ 510 /api/NetworkService/Actions/NetworkService.UpdateFabric...............
/api/NetworkService /ServerProfiles(arg1)...................................................................................................... 568 /api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles........................................................ 569 /api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)..............................................571 /api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)/Networks.........................
/api/ConsoleUpdateService/UpdateBundleInfo............................................................................................... 607 /api/ConsoleUpdateService/Actions/ConsoleUpdateService.DeleteUpgradeBundle............................ 608 /api/ConsoleUpdateService/Actions/ConsoleUpdateService.DownloadBundle......................................608 /api/ConsoleUpdateService/LastUpdateResult............................................................................................... 609 Mobile....
/api/QuerySupportService/OperatorInfo...........................................................................................................643 /api/QuerySupportService/Filters....................................................................................................................... 645 /api/QuerySupportService/Filters(Id)................................................................................................................ 646 Groups service.........................................
Discovery service...................................................................................................................................................... 668 Server-initiated discovery....................................................................................................................................... 677 Warranty service.......................................................................................................................................................
redfish/v1/Systems/Members(id)/SimpleStorage/Members(id)................................................................ 749 redfish/v1/Systems/Members(id)/Actions/ComputerSystem.Reset.........................................................749 Redfish—CompositionService.....................................................................................................................................750 redfish/v1/CompositionService...........................................................................
1 About this document This document contains information about the resource models for OpenManage Enterprise and OpenManage Enterprise Modular Edition (OME–Modular). Each RESTful API specification includes the URI, method, parameters, request codes, and response codes. Some of the APIs are available only in OME–Modular and do not work if used in OME–Modular and the opposite way. Table 1. Supported REST API versions Product Date of release What's new OpenManage Enterprise – Modular Edition July 2021 1.
Table 1. Supported REST API versions (continued) Product Date of release What's new ● /api/AccountService/ExternalAccountProvider/ OpenIDConnectProviders ● /api/AccountService/ExternalAccountProvider / OpenIDConnectProvider(‘ID’) ● /api/AccountService/ ExternalAccountProvider/Actions/ ExternalAccountProvider.EnableOIDCProviders ● /api/AccountService/ ExternalAccountProvider/Actions/ ExternalAccountProvider.
Table 1. Supported REST API versions (continued) Product Date of release What's new ○ /api/AccountService/ ExternalAccountProvider/Actions/ ExternalAccountProvider.EnableOIDCProviders on page 74 ○ /api/AccountService/ ExternalAccountProvider/Actions/ ExternalAccountProvider.TestOIDCProvider on page 76 ○ /api/AccountService/ExternalAccountProvider/ Actions/ ExternalAccountProvider.TestOIDCProviderRegistr ationStatus on page 76 OpenManage Enterprise – Modular Edition August 2020 1.20.
2 Overview RESTful API support in OpenManage Enterprise, OpenManage Enterprise and OME–Modular OME–Modular supports RESTful API. Support for APIs has also been improved for OpenManage Enterprise. Improved support for APIs on these products enhances the systems management capabilities. The RESTful interface is provided over HTTPS in JSON format based on ODATA v4 usable by clients, scripts, and browser-based GUIs.
OpenManage Enterprise – Modular Edition OpenManage Enterprise – Modular Edition (OME–Modular) is the systems management software that runs on the Dell EMC PowerEdge MX-series chassis. OME–Modular shares a common codebase with OpenManage Enterprise and delivers an agile, reliable, and comprehensive platform to manage PowerEdge MX-series servers, storage, and networking products. OME–Modular boosts services delivery and restores IT agility for growing businesses.
● ● ● ● ● ● ● ● ● ● 24 Architecture is delivered as a virtual appliance—ESXi, Hyper-V, and KVM Engineered on CentOS with PostgreSQL database No operating system and database licenses are required End-to-end server life cycle management that includes inventory, monitoring, reporting, configuration, and deployment Northbound API that helps you automate and integrate with existing solutions Simplified discovery processes that enable devices to automatically register themselves with the console Intuitive inte
3 Key integration concepts This section describes the key integration concepts that are applicable to the use cases and resource model.
Resource tree for OME–Modular OEM scheme Figure 1.
Resource tree for OpenManage Enterprise OEM scheme Figure 2.
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.
Basic authentication The authorization header in the request has the base-64 encoding of the credentials—username and password. If you do not provide the credentials, a 401—Authorization Failure error is returned. Basic Authentication is supported only when SSL/TLS is used for the transport. 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.
OME - Modular Table 3. Privilege descriptions OME-Modular Privilege Description VIEW View all data, report execution and management, and so on. APPLIANCE_SETUP Global appliance/OME - Modular settings that involve setup of the appliance. SECURITY_SETUP User management, security policies, proxy, and firewall setup. MONITORING_SETUP Alerting policies, forwarding, SupportAssist, and so on. POWER_CONTROL Reboot or power-cycle device.
Table 4. Roles and associated privileges for OME - Modular (continued) Privilege Roles CHASSIS_ADMIN ISTRATOR COMPUTE_MAN AGER POWER_MANAGE MENT Y Y JOB_MANAGEME NT Y Y ALERT_MANAGEM ENT Y FABRIC_MANAGE MENT Y NETWORK_MANA GEMENT Y STORAGE_MANA GER FABRIC_MANAG ER Y Y VIEWER Y Y Y OME - Modular Table 5.
Resource addressing Each managed resource must be uniquely addressable using a distinct URI. The URI syntax must be intuitive and should indicate the relationships with a parent resource. There are several ways to address specific resources either as instances of specific resource classes or within an associated parent context.
Security considerations For performing update and delete operations, you must be authorized to perform the operations on the resource. If you do not have the required permission, an Unauthorized error is returned. Performance considerations The expected time taken to run individual APIs for retrieving data from a database is a few seconds. When data is retrieved from multiple servers by enumeration for generating reports, it may take ample time to run multiple iterations with multiple queries per server.
Data pagination The console software provides pagination options on certain URIs that return a collection of entities. The pagination options enable the clients to get paginated results. If a URI supports pagination, the relevant URI sections indicate it.
Table 8.
Table 9.
4 Application settings Topics: • • • • • Network Security and user management Security and certificate management Monitoring and alert notifications api/ApplicationService/SystemResourceUsage 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.
} } /api/ApplicationService/Network/WebServerConfiguration This URI represents the web-server configuration. GET method for WebServerConfiguration This method returns the web server configuration, including the status, port number, and session timeout duration. Description Returns the web-server configuration, including the status of the web server, port number, and session timeout duration. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Network.
Table 10. Attributes (continued) Attribute name Description PortNumber Port number of the web server configurations EnableWebServer Status of web server /api/ApplicationService/Network/TimeConfiguration This URI represents the time-configuration-related application services. GET method for TimeConfiguration This method returns the current time-related configuration. Description Returns the time-related configuration. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.
Example response body { } "TimeZone": "TZ_ID_11", "EnableNTP": false, "PrimaryNTPAddress": null, "SecondaryNTPAddress1": null, "SecondaryNTPAddress2": null, "SystemTime": "2017-35-23 21:35:18" Table 11. Attributes Attribute name Description TimeZone The timezone to use. EnableNTP Specify whether to enable or disable NTP. PrimaryNTPAddress The primary NTP address. SecondaryNTPAddress1 The first secondary NTP address. SecondaryNTPAddress2 The second secondary NTP address.
Table 12. Attributes (continued) Attribute Description 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. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Network.
} "EnableProxy": false Table 13. 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.
"DirectoryServiceId": 0, "Description": null, "Name": "admin", "Password": null, "UserName": "admin", "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true, "IsVisible": true, "Permissions@odata.navigationLink": "/api/AccountService/ Accounts('12258')/Permissions" }, { "@odata.type": "#AccountService.Account", "@odata.
"DirectoryServiceId": 0, "Description": null, "Name": "view", "Password": null, "UserName": "view", "RoleId": "16", "Locked": false, "IsBuiltin": false, "Enabled": true, "IsVisible": true, "Permissions@odata.navigationLink": "/api/AccountService/ Accounts('12266')/Permissions" } ] } Table 14. Attributes Attribute Description Description Description for the Account service. Name Name given for Account service. State Indicates the known state of the resource. HealthRollup Health rollup status.
HTTP response codes Example request body 200 { } Example response body { } "Id": "10", "Description": "OME-Modular User Accounts", "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"
Table 15. Attributes (continued) Attribute Description AuthFailureLoggingThreshold Number of authorization failures that need to occur before the failure attempt is logged to the manager log. MinPasswordLength Minimum password length. MaxPasswordLength Maximum password length. AccountLockoutThreshold The number of failed login attempts before a user account is locked for a specified duration. 0 indicates that the account is never locked.
"IsVisible": true, "Permissions@odata.navigationLink": "/api/AccountService/ Accounts('10042')/Permissions" }, { "@odata.type": "#AccountService.Account", "@odata.id": "/api/AccountService/Accounts('10566')", "Id": "10566", "UserTypeId": 2, "DirectoryServiceId": 10564, "Description": null, "Name": "NGMou1gp1", "Password": null, "UserName": "NGMou1gp1", "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true, "IsVisible": true, "Permissions@odata.
"IsVisible": true, "Permissions@odata.navigationLink": "/api/AccountService/ Accounts('10572')/Permissions" }, { "@odata.type": "#AccountService.Account", "@odata.id": "/api/AccountService/Accounts('10574')", "Id": "10574", "UserTypeId": 2, "DirectoryServiceId": 10564, "Description": null, "Name": "NGMou1gp5", "Password": null, "UserName": "NGMou1gp5", "RoleId": "16", "Locked": false, "IsBuiltin": false, "Enabled": true, "IsVisible": true, "Permissions@odata.
} Example response body "UserTypeId": 1, "DirectoryServiceId": 0, "Description": "user1 description", "Name": "user1", "Password": "Dell123$", "UserName": "user1", "RoleId": "10", "Locked": false, "Enabled": true { } "Id": "2964", "UserTypeId": 1, "DirectoryServiceId": 0, "Name": "user1", "Password": null, "UserName": "user1", "Description": "user1 description", "Oem": null, "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true Table 17.
HTTP response codes 200 Example response body { } "@odata.context": "$metadata#AccountService.Account/$entity", "@odata.id": "/api/AccountService/Accounts('1814')", "Id": "1814", "UserTypeId": 1, "DirectoryServiceId": 0, "Description": "root", "Name": "root", "Password": null, "UserName": "root", "RoleId": "10", "Locked": false, "IsBuiltin": true, "Enabled": true, "Permissions": [ { "@odata.id": "/api/AccountService/Accounts('1814')/Permissions" } ] Table 18.
} Example response body { } "Id": "2964", "UserTypeId": 1, "DirectoryServiceId": 0, "Name": "user1", "Password": "Dell123$", "UserName": "user1", "Description": "user1 description", "RoleId": "10", "Locked": false, "Enabled": true "Id": "2964", "UserTypeId": 1, "DirectoryServiceId": 0, "Name": "user1", "Password": null, "UserName": "user1", "Description": "user1 description", "Oem": null, "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true Table 19.
Table 20. Attributes Attribute Description Id Uniquely identifies the resource within the collection. /api/AccountService/Accounts(userId)/Permissions This URI represents the permissions for an account. GET method for Permissions This method lists the permissions for an account. Description Lists the permissions for an account. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(AccountService.Permission)", "@odata.
HTTP response codes Example Response Body 201 payload { "Type":"Fan Slot", "Location":"slot301"} Returns mapped privileges /api/AccountService/Actions/ AccountService.GetPrivilegesForUser This API represents user privileges and MAC address information for a particular user. POST method for /api/AccountService/Actions/ AccountService.GetPrivilegesForUser This method provides a list of user privileges for the user id and device mac address that is provided in the payload.
/api/AccountService/Actions/AccountService.Enable This URI enables you to enable multiple accounts. POST method for AccountService.Enable This method enables multiple accounts. Description Enables multiple accounts. Privilege SECURITY_SETUP HTTP response codes 204 Example request body { } "AccountIds":[3164,3264] Table 22. Attributes Attribute Description AccountIds Account IDs to be enabled. /api/AccountService/Actions/AccountService.Disable This URI enables you to disable multiple accounts.
/api/AccountService/Actions/AccountService.Delete This URI enables you to delete multiple accounts. POST method for AccountService.Delete The method deletes multiple accounts. Description Deletes multiple accounts. Privilege SECURITY_SETUP HTTP response codes 204 Example request body { } "AccountIds":[3164,3264] Table 24. Attributes Attribute Description AccountIds Account IDs to be deleted. /api/AccountService/Roles This URI represents the user roles.
} ] "OPERATING_SYSTEM_DEPLOYMENT", "DEVICE_UPDATE", "TEMPLATE_MANAGEMENT", "BASELINE_MANAGEMENT", "POWER_MANAGEMENT" Table 25. Attributes Attribute Description Id Role record ID. Description Role description. Name Name for the role. IsPredefined Indicates if the role is a predefined role. AssignedPrivileges List of assigned privileges. OemPrivileges List of OEM privileges for the role. /api/AccountService/Roles(Id) This URI represents the details of a user role.
Table 26. Attributes Attribute Description Id Role record ID. Description Role description. Name Name for the role. IsPredefined Indicates if the role is a predefined role. AssignedPrivileges List of assigned privileges. OemPrivileges List of OEM privileges for the role. /api/AccountService/ExternalAccountProvider This URI represents the collection of external account providers.
/api/AccountService/ExternalAccountProvider/ DirectoryServiceType This URI represents the collection of directory types. GET method for DirectoryServiceType This method returns the collection of directory types. Description Returns a collection of directory types. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(ExternalAccountProvider.DirectoryServiceType)", "@odata.
} "@odata.count": 0, "value": [] POST method for ADAccountProvider This method adds an Active Directory service. Description Adds an Active Directory service. Privilege SECURITY_SETUP HTTP response codes 200 Example request body : { } Example response body { } "Name": "Starship", "Id":2, "ServerType": "DNS", "ServerName": ["10.35.195.
Table 29. Attributes (continued) Attribute Description CertificateValidation Enable or disable certificate validation for the directory service. CertificateFile Certificate file for authentication. /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.
Privilege SECURITY_SETUP HTTP response codes 200 Example request body { } Example response body { } "Name": "Starship", "Id": 2714, "ServerType": "MANUAL", "ServerName": ["10.35.195.1"], "UserName": "Admin", "Password": null, "ServerPort": 3268, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": null "Id": 2714, "Name": "Starship", "ServerType": "MANUAL", "ServerName": ["10.35.195.
/api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.TestADConnection This URI enables you to test the Directory Service connection. POST method for ExternalAccountProvider.TestADConnection This method tests the Active Directory Service connection. Description Tests the Active Directory Service connection.
} "CertificateFile": "" Example for Example response body ServerType: DNS { "Name": "AD", "ServerType": "DNS", "ServerName": [ "ausdcdell1.dell.com", "rdudc12dell01.dell.com", "pendc12dell01.dell.com", "ausdc12dell02.dell.com", "ausdc12dell01.dell.com", "limdc12dell01.dell.com", "ausdc12dell05.dell.com", "ausdc12dell06.dell.com", "rdudc12dell02.dell.com", "ausdc12dell03.dell.com" ], "DnsServer": [ "dell.com" ], "GroupDomain": "dell.
/api/AccountService/ExternalAccountProvider/ LDAPAccountProvider This URI represents the collection of LDAP Directory Services. GET method for LDAPAccountProvider This method returns the collection of LDAP Directory Service. Description Returns the collection of LDAP Directory Service. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(ExternalAccountProvider.LDAPAccountProvider)", "@odata.count": 1, "value": [ { "@odata.
} Example response body { } "Name": "seaquest", "Id":1, "ServerType": "DNS", "ServerName": ["10.35.195.1"], "UserName": "Admin", "Password": "XXXXX", "ServerPort": 0, "BaseDistinguishedName" : "dc=dell,dc=com", "AttributeUserLogin": null, "AttributeGroupMembership": null, "NetworkTimeOut": 300, "SearchTimeOut": 300, "CertificateValidation": false, "CertificateFile": "" "Id": 2914, "Name": "seaquest", "ServerType": "DNS", "ServerName": [ "10.35.195.
/api/AccountService/ExternalAccountProvider/ LDAPAccountProvider(Id) This URI represents a specific LDAP server within the collection of LDAP Directory Service. GET method for LDAPAccountProvider(Id) This method returns the details of a single server of the LDAP Directory Service. Description Returns the details of a single LDAP server. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#ExternalAccountProvider.LDAPAccountProvider/$entity", "@odata.
"Password": "test@123", "ServerPort": 3268, "BaseDistinguishedName" : "dc=dell,dc=com", "NetworkTimeOut": 300, "SearchTimeOut": 300, "CertificateValidation": false, "CertificateFile": "" } Example response body { } "Id": 2964, "Name": "seaquest", "ServerType": "DNS", "ServerName": [ "10.35.195.
/api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.TestLDAPConnection This URI enables you to test the LDAP Directory Service connection. POST method for ExternalAccountProvider.TestLDAPConnection This method tests the LDAP Directory Service connection. Description Tests the LDAP Directory Service connection.
} ], "UserName": null, "Password": "", "ServerPort": 636, "BindDN": null, "BindPassword": "", "BaseDistinguishedName": "dc=dell,dc=com", "AttributeUserLogin": null, "AttributeGroupMembership": null, "SearchFilter": null, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": "" Example for Example response body ServerType: DNS { "Name": "LDAP", "ServerType": "DNS", "ServerName": [ "ausdcdell1.dell.com", "rdudc12dell01.dell.com", "pendc12dell01.dell.
Table 34. Attributes (continued) Attribute name Description AttributeUserLogin User login details. AttributeGroupMembership Group member information. SearchFilter Search type. NetworkTimeOut Network timeout value. SearchTimeOut Search timeout value. CertificateValidation Enable or disable certificate validation for the directory service. CertificateFile Certificate file for authentication. /api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.
/api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.DeleteExternalAccountProvider This URI enables you to delete an Active Directory or an LDAP Directory Service. POST method for ExternalAccountProvider.DeleteExternalAccountProvider This method deletes an Active Directory or LDAP Directory Service. Description Deletes an Active Directory or LDAP Directory Service.
"Name": "OME-ModularDevelopmentTeam", "Password": "", "UserName": "OME-ModularDevelopmentTeam", "RoleId": "10", "Locked": false, "Enabled": true, "ObjectGuid": "21dd5985-602f-48a2-bde5-dde50eefb422" } ] Example Response Body [ { }, { ] } "Id": "4664", "UserTypeId": 2, "DirectoryServiceId": 0, "Name": "test456", "Password": null, "UserName": "test456", "Description": "admin", "Oem": null, "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true, "ObjectGuid": null "Id": "4764", "UserTypeI
Table 37. Attributes (continued) Attribute name Description ObjectGuid Unique group ID for directory service. /api/AccountService/ExternalAccountProvider/ OpenIDConnectProvider This URI creates an OpenID Connect (OIDC) provider in OpenManage Enterprise and OME-Modular. POST method for OpenIDConnectProvider Description Creates an OIDC provider in OpenManage Enterprise and OME-Modular.
HTTP response codes Example request body 200 { "Id": 2, "Name": "ODICone", "DiscoveryURI": "Discovery URI of OpenID" Server", "AuthType": "USERNAME"/"TOKEN", "UserName": "username", "Password": "password", "Token": "Initialized Access Token", (This field is required only when AuthType is Token) "Enabled": true, "CertificateFile":"Content of TrustStore File" } GET method for OpenIDConnectProvider('ID') Description Retrieves a specific OpenID Connect provider information.
/api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.DisableOIDCProviders This URI disables multiple OIDC providers in OpenManage Enterprise or OME-Modular. POST method for ExternalAccountProvider.DisableOIDCProviders Description Disables multiple OIDC providers in OpenManage Enterprise or OME-Modular.
/api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.TestOIDCProvider This URI tests the OpenID provider discovery URI connection in OpenManage Enterprise or OME-Modular. POST method for ExternalAccountProvider.TestOIDCProvider Description Tests the OpenID provider discovery URI connection in OpenManage Enterprise or OME-Modular.
Security and certificate management /api/ApplicationService/Security This URI represents the security information. GET method for Security This method returns the security information for the system. Description Returns the security information. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#ApplicationService.Security/$entity", "@odata.type": "#ApplicationService.Security", "@odata.
/api/ApplicationService/Certificate This URI represents the certificates resource. GET method for Certificate This method returns the details of the certificates. Description Returns the details of the security certificates. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(ApplicationService.CertInfo)", "@odata.count": 1, "value": [ { "@odata.type": "#ApplicationService.
Table 38. Attributes (continued) Attribute name Description Value.IssuedBy.State State of the certificate issuer. Value.IssuedBy.Country Country of the certificate issuer. Value.IssuedBy.Email Email from which the certificate is issued. Value.IssuedTo.DistinguishedName Distinguished name to whom the certificate is issued. Value.IssuedTo.DepartmentName The department to which the certificate is issued. Value.IssuedTo.BusinessName Business name to which the certificate is issued. Value.IssuedTo.
Table 39. Attributes Attribute name Description DistinguishedName Name of the certificate issuer. DepartmentName Department name that issued the certificate. BusinessName Business name that issued the certificate. Locality Locality. State State. Country Country. Email Email associated with the issuer. KeySize Size of the certificate. The possible values are: ● 2048 ● 4096 San Subject Alternative Name. You can use a maximum of four subject alternative names.
Privilege VIEW HTTP response code 202 Example request body { } Example response body { } "DirectoryServerId": “10430”, "Type": "AD", "DirectoryServerId": 10430, "Type": "AD", "SerialNumber": "401413413584593270254610161813845066096050178", "IssuerCN": "Dell Root Certificate Authority 2015", "SubjectCN": "Dell Issuing Certificate Authority 101", "ValidFrom": "Aug 14 2015 22:04:36", "ValidTo": "Aug 14 2022 22:14:36" Monitoring and alert notifications api/AlertService/AlertDestinations/SNMPConfigura
}, { }, { } ] } "Id": 3, "Enabled": false, "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } "Id": 4, "Enabled": true, "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } Table 40. Attributes Attribute name Description Id ID of the SNMP configuration. Enabled Indicates if the SNMP send trap is enabled or disabled.
{ }, { }, { ] } }, } "Enabled": true, "DestinationAddress": "100.97.1.185", "PortNumber": "162", "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } "Enabled": false, "DestinationAddress": "100.97.1.185", "PortNumber": "162", "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } "Enabled": true, "DestinationAddress": "100.97.1.
] } "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" }, "SnmpV3Credential": null Table 41. Attributes Attribute name Description Id ID of the SNMP configuration. Enabled Indicates if the SNMP send trap is enabled or disabled. DestinationAddress SNMP destination address. PortNumber SNMP port number. Version SNMP version. Community SNMP community.
} ] } "Enabled": true, "DestinationAddress": "100.97.1.23", "PortNumber": 514 Table 42. Attributes Attribute name Description Id ID of the syslog configuration. Enabled Indicates if syslog is enabled or disabled. DestinationAddress Destination address of syslog. PortNumber Port number of syslog. NOTE: By default, you can configure up to four destinations for syslog/SNMP and the responses are sent to each destination. If there is no information in the response, PortNumber is displayed as 0.
}, { }, { }, { ] } "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. Attributes Attribute name Description Id ID of the syslog. Enabled Indicates if syslog is enabled or disabled.
Table 44. 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. POST method for SMTPConfiguration This method configures SMTP to send emails. Description Configures SMTP. Privilege APPLIANCE_SETUP HTTP response codes 200 Example request body { } Example response body { } "DestinationAddress":"10.35.12.
/api/AlertService/AlertDestinations/Actions/ AlertDestinations.SendTestTrap POST method for AlertDestinations.SendTestTrap This method sends an SNMP trap to the destination address. Description Sends an SNMP trap to the destination address. Privilege APPLICATION_SETUP HTTP response codes 200 Example request body { } "Enabled":"true", "DestinationAddress":"10.35.12.7", "PortNumber":162, "Version":"SNMPV1", "SnmpV1V2Credential": { "Community":"public" } Table 46.
5 Alerts Topics: • • • Alert logs Alert policies Alert definitions Alert logs /api/AlertService/Alerts This URI represents the alerts. Table 47. Filters Filter name Description Top Top records to return. Default value is 100. Skip Max records to skip. Default value is 0. Orderby Order to apply to the output. Id Filter by event ID. Default value is 0. AlertDeviceId Filter by device ID. Default value is 0. AlertDeviceIdentifier Filter by device identifier.
Example response body { } "@odata.context": "$metadata#Collection(AlertService.Alert)", "@odata.count": 11, "value": [ { "@odata.id": "/api/AlertService/Alerts(2)", "Id": 2, "SeverityType": 16, "SeverityName": "Critical", "AlertDeviceId": 1714, "AlertDeviceName": "localhost.smd.devops.dell.com", "AlertDeviceType": 1000, "AlertDeviceIpAddress": "xx.xx.xx.
Table 48. Attributes (continued) Attribute name Description StatusType ID of status type. StatusName Name of status type. TimeStamp Date and time when the alert was raised. Message Message describing the issue. EemiMessage Event and Error Message describing the issue, if applicable. RecommendedAction Recommended action for the alert. AlertMessageId Event and Alert Message ID associated with the issue. AlertVarBindDetails List of variable bindings of the alert, if applicable.
{ "@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4592)", "Id": 4592, "SeverityType": 2, "SeverityName": "Info", "AlertDeviceId": 10056, "AlertDeviceName": "Sled-5", "AlertDeviceType": 1000, "AlertDeviceIpAddress": "100.97.211.
{"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4587)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4586)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4585)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4584)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4583)",…}, {"@odata.type": "#AlertService.Alert", "@odata.
{"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4551)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4550)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4549)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4548)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4547)",…}, {"@odata.type": "#AlertService.Alert", "@odata.
{"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4515)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4514)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4513)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4512)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4511)",…}, {"@odata.type": "#AlertService.Alert", "@odata.
"value":[ { "@odata.type": "#AlertService.Alert", "@odata.
"@odata.id": "/api/AlertService/Alerts(4299)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4298)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4297)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4296)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4293)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4292)",…}, {"@odata.
"@odata.id": "/api/AlertService/Alerts(4065)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4064)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4063)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4062)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4061)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4060)",…}, {"@odata.
"@odata.id": "/api/AlertService/Alerts(3755)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(3754)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(3753)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(3752)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(3751)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(3750)",…}, {"@odata.
"@odata.count": 0, "value":[ ] } /api/AlertService/Alerts(Id) This URI represents a specific alert. GET method for Alerts(Id) This method returns the details of a specific alert. Description Returns the details of a specific alert. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#AlertService.Alert/$entity", "@odata.
Table 49. Attributes (continued) Attribute name Description 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. CatalogName Catalog name associated to alert. CategoryId Category ID associated to alert. CategoryName Category name associated to alert.
{ "@odata.type": "#AlertService.AlertCategory", "Id": 4, "Name": "Audit", "CatalogName": "Application", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 90, "Name": "Devices", "Description": "Devices" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 10, "Name": "Generic", "Description": "Generic" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 151, "Name": "Power Configuration", "Description": "Power Configuration" }, { "@odata.type": "#AlertService.
"#AlertService.AlertSubCategory", "Id": 10, "Name": "Generic", "Description": "Generic" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 84, "Name": "Groups", "Description": "Groups" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 47, "Name": "Job", "Description": "Job" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 118, "Name": "Metrics", "Description": "Metrics" }, { "@odata.type": "#AlertService.
}, { ] } "Name": "Users", "Description": "Users" "@odata.type": "#AlertService.AlertCategory", "Id": 7, "Name": "Miscellaneous", "CatalogName": "Application", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 20, "Name": "Miscellaneous", "Description": "Miscellaneous" } ] }, { "@odata.type": "#AlertService.AlertCategory", "Id": 2, "Name": "Storage", "CatalogName": "Application", "SubCategoryDetails": [ { "@odata.type": "#AlertService.
{ "@odata.type": "#AlertService.AlertCategory", "Id": 3, "Name": "Updates", "CatalogName": "Application", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 85, "Name": "Application", "Description": "Application" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 112, "Name": "Firmware", "Description": "Firmware" } ] } ] }, { "@odata.type": "#AlertService.AlertCategories", "@odata.
"@odata.id": "/api/AlertService/AlertCategories('iDRAC')", "Name": "iDRAC", "IsBuiltIn": true, "CategoriesDetails": [ { "@odata.type": "#AlertService.AlertCategory", "Id": 4, "Name": "Audit", "CatalogName": "iDRAC", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 41, "Name": "Auto System Reset", "Description": "Auto System Reset" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 54, "Name": "BIOS Management", "Description": "BIOS Management" }, { "@odata.
}, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 15, "Name": "Management Module", "Description": "Management Module" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 96, "Name": "OS Event", "Description": "OS Event" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 7700, "Name": "Other", "Description": "Other" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 81, "Name": "PCI Device", "Description": "PCI Device" }, { "@odata.type": "#AlertService.
{ "@odata.type": "#AlertService.AlertSubCategory", "Id": 52, "Name": "Software Change", "Description": "Software Change" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 39, "Name": "Software Config", "Description": "Software Config" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 92, "Name": "Support Assist", "Description": "Support Assist" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 71, "Name": "System Info", "Description": "System Info" }, { "@odata.
"@odata.type": "#AlertService.AlertSubCategory", "Id": 59, "Name": "Certificate Management", "Description": "Certificate Management" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 51, "Name": "Firmware Download", "Description": "Firmware Download" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 53, "Name": "Group Manager", "Description": "Group Manager" }, { "@odata.type": "#AlertService.
}, { "Id": 19, "Name": "Log Event", "Description": "Log Event" "@odata.type": "#AlertService.AlertSubCategory", "Id": 15, "Name": "Management Module", "Description": "Management Module" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 80, "Name": "Memory", "Description": "Memory" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 102, "Name": "NIC Configuration", "Description": "NIC Configuration" }, { "@odata.type": "#AlertService.
}, { "Name": "Security Event", "Description": "Security Event" "@odata.type": "#AlertService.AlertSubCategory", "Id": 39, "Name": "Software Config", "Description": "Software Config" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 18, "Name": "Storage", "Description": "Storage" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 113, "Name": "Storage Controller", "Description": "Storage Controller" }, { "@odata.type": "#AlertService.
}, { ] } "@odata.type": "#AlertService.AlertCategory", "Id": 2, "Name": "Storage", "CatalogName": "iDRAC", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 108, "Name": "Battery Event", "Description": "Battery Event" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 106, "Name": "Fan Event", "Description": "Fan Event" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 11, "Name": "Hardware Config", "Description": "Hardware Config" }, { "@odata.
{ "@odata.type": "#AlertService.AlertSubCategory", "Id": 52, "Name": "Software Change", "Description": "Software Change" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 119, "Name": "Software Defined Storage", "Description": "Software Defined Storage" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 99, "Name": "SSD Devices", "Description": "SSD Devices" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 18, "Name": "Storage", "Description": "Storage" }, { "@odata.
"@odata.type": "#AlertService.AlertSubCategory", "Id": 41, "Name": "Auto System Reset", "Description": "Auto System Reset" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 108, "Name": "Battery Event", "Description": "Battery Event" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 75, "Name": "BIOS POST", "Description": "BIOS POST" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 89, "Name": "Cable", "Description": "Cable" }, { "@odata.type": "#AlertService.
}, { "Id": 3, "Name": "Link Status", "Description": "Link Status" "@odata.type": "#AlertService.AlertSubCategory", "Id": 19, "Name": "Log Event", "Description": "Log Event" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 15, "Name": "Management Module", "Description": "Management Module" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 80, "Name": "Memory", "Description": "Memory" }, { "@odata.type": "#AlertService.
}, { "Description": "Power Usage" "@odata.type": "#AlertService.AlertSubCategory", "Id": 61, "Name": "Processor", "Description": "Processor" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 68, "Name": "Processor Absent", "Description": "Processor Absent" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 103, "Name": "PSU Absent", "Description": "PSU Absent" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 109, "Name": "RAC Event", "Description": "RAC Event" }, { "@odata.
}, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 29, "Name": "System Event Log", "Description": "System Event Log" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 71, "Name": "System Info", "Description": "System Info" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 13, "Name": "System Performance Event", "Description": "System Performance Event" }, { "@odata.type": "#AlertService.
"@odata.type": "#AlertService.AlertSubCategory", "Id": 40, "Name": "Voltage", "Description": "Voltage" } ] }, { "@odata.type": "#AlertService.AlertCategory", "Id": 3, "Name": "Updates", "CatalogName": "iDRAC", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 51, "Name": "Firmware Download", "Description": "Firmware Download" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 24, "Name": "Firmware Update Job", "Description": "Firmware Update Job" }, { "@odata.
"@odata.type": "#AlertService.AlertSubCategory", "Id": 54, "Name": "BIOS Management", "Description": "BIOS Management" } ] } ] }, { "@odata.type": "#AlertService.AlertCategories", "@odata.id": "/api/AlertService/AlertCategories('IF-MIB')", "Name": "IF-MIB", "IsBuiltIn": true, "CategoriesDetails": [ { "@odata.type": "#AlertService.AlertCategory", "Id": 1, "Name": "System Health", "CatalogName": "IF-MIB", "SubCategoryDetails": [ { "@odata.type": "#AlertService.
}, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 23, "Name": "Power Usage", "Description": "Power Usage" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 29, "Name": "System Event Log", "Description": "System Event Log" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 71, "Name": "System Info", "Description": "System Info" } ] }, { "@odata.type": "#AlertService.AlertCategory", "Id": 5, "Name": "Configuration", "CatalogName": "MM", "SubCategoryDetails": [ { "@odata.
}, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 89, "Name": "Cable", "Description": "Cable" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 106, "Name": "Fan Event", "Description": "Fan Event" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 11, "Name": "Hardware Config", "Description": "Hardware Config" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 105, "Name": "IO Virtualization", "Description": "IO Virtualization" }, { "@odata.type": "#AlertService.
"@odata.type": "#AlertService.AlertSubCategory", "Id": 78, "Name": "Power Supply", "Description": "Power Supply" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 23, "Name": "Power Usage", "Description": "Power Usage" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 44, "Name": "Redundancy", "Description": "Redundancy" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 25, "Name": "Security Event", "Description": "Security Event" }, { "@odata.type": "#AlertService.
}, { ] } ] } "Id": 40, "Name": "Voltage", "Description": "Voltage" "@odata.type": "#AlertService.AlertCategories", "@odata.id": "/api/AlertService/ AlertCategories('Networking')", "Name": "Networking", "IsBuiltIn": true, "CategoriesDetails": [ { "@odata.type": "#AlertService.AlertCategory", "Id": 1, "Name": "System Health", "CatalogName": "Networking", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 7700, "Name": "Other", "Description": "Other" } ] } ] }, { "@odata.
}, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 25, "Name": "Security Event", "Description": "Security Event" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 71, "Name": "System Info", "Description": "System Info" } ] }, { "@odata.type": "#AlertService.AlertCategory", "Id": 1, "Name": "System Health", "CatalogName": "OMSA", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 67, "Name": "Amperage", "Description": "Amperage" }, { "@odata.
{ "@odata.type": "#AlertService.AlertSubCategory", "Id": 78, "Name": "Power Supply", "Description": "Power Supply" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 23, "Name": "Power Usage", "Description": "Power Usage" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 61, "Name": "Processor", "Description": "Processor" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 44, "Name": "Redundancy", "Description": "Redundancy" }, { "@odata.type": "#AlertService.
}, { ] "@odata.type": "#AlertService.AlertCategories", "@odata.id": "/api/AlertService/ AlertCategories('OpenManage%20Enterprise')", "Name": "OpenManage Enterprise", "IsBuiltIn": true, "CategoriesDetails": [ { "@odata.type": "#AlertService.AlertCategory", "Id": 1, "Name": "System Health", "CatalogName": "OpenManage Enterprise", "SubCategoryDetails": [ { "@odata.type": "#AlertService.
}, { }, { ] } ] } "Id": 7700, "Name": "Other", "Description": "Other" "@odata.type": "#AlertService.AlertCategory", "Id": 6, "Name": "Work Notes", "CatalogName": "OpenManage Essentials", "SubCategoryDetails": [] "@odata.type": "#AlertService.AlertCategories", "@odata.id": "/api/AlertService/ AlertCategories('Power%20Manager')", "Name": "Power Manager", "IsBuiltIn": true, "CategoriesDetails": [ { "@odata.type": "#AlertService.
"Name": "System Health", "CatalogName": "SNMPv2-MIB", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 7700, "Name": "Other", "Description": "Other" } ] } ] }, { "@odata.type": "#AlertService.AlertCategories", "@odata.id": "/api/AlertService/AlertCategories('VMWare')", "Name": "VMWare", "IsBuiltIn": true, "CategoriesDetails": [ { "@odata.type": "#AlertService.AlertCategory", "Id": 1, "Name": "System Health", "CatalogName": "VMWare", "SubCategoryDetails": [ { "@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 response body { } "@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 response body { } "@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 response body { } "@odata.context": "$metadata#AlertService.AlertSeverity/$entity", "@odata.id": "/api/AlertService/AlertSeverities(1)", "Id": 1, "Name": "Unknown", "Description": "Unknown" Table 53.
} ] } "Description": "The event was not acknowledged" Table 54. Attributes Attribute name Description Id ID of the alert status. Name Name of the alert status Description Description of the alert status. /api/AlertService/AlertStatuses(Id) This URI represents a specific alert status within the collection. GET method for AlertStatuses(Id) This method returns the details of alert statuses. 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 response body { } "@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.
/api/AlertService/AlertCatalogs(Id) This URI represents a specific alert catalog. GET method for AlertCatalogs(Id) This method returns the details of a specific alert catalog. Description Returns the details of a specific alert catalog. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#AlertService.AlertCatalog/$entity", "@odata.
} "MemberId": "bbdbfb20-ae33-11e6-a44b-1866da78fcba", "Message": "The system board battery is low.", "MessageArgs": ["arg1", “arg2”], "MessageId": "BAT0000", "Severity": "Warning" /api/AlertService/Actions/AlertService.Acknowledge POST method for AlertService.Acknowledge This method acknowledges the alerts. Description Acknowledges alerts.
Table 59. 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.Unacknowledge POST method for AlertService.Unacknowledge This method removes the acknowledgment from the alerts. Description Removes the acknowledgment from the alerts.
Table 60. Attributes (continued) Attribute Description StatusType ID of status type. StartDate Start date and time when the alerts were raised. EndDate End date and time when the alerts were raised. 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.
Table 61. Attributes (continued) Attribute Description Severity ID of severity. StatusType ID of status type. StartDate Start date and time when the alerts were raised. EndDate End date and time when the alerts were raised. 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.
"CatalogName": "iDRAC", "Categories": [ 3300 ], "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 63. Attributes (continued) Attribute name Description CatalogName Name of the catalogs associated with the policy. This field is checked during policy evaluation. Categories Name of the categories associated with the policy. This field is checked during policy evaluation. SubCategories Name of the subcategories associated with the policy. If defined, this field is checked during policy evaluation. Severities List of severities associated to the policy.
"Enabled": true, "DefaultPolicy": false, "PolicyData": { "Catalogs": [ { "CatalogName": "iDRAC", "Categories": [0], "SubCategories": [0] }, { "CatalogName": "Application", "Categories": [0], "SubCategories": [0] } ], "Severities": [16, 1, 2, 4, 8], "Devices": [1714], "Groups": [], "DeviceTypes": [1000], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.
}, { ], "SubCategories": [ 0 ] "CatalogName": "Application", "Categories": [ 0 ], "SubCategories": [ 0 ] } ], "Severities": [ 16, 1, 2, 4, 8 ], "Devices": [ 1714 ], "DeviceTypes": [ 1000 ], "Groups": [], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.
}, { "Name": "message", "Value": "Event occurred for Device Name: $name, IP Address: $ip, Service Tag: $identifier, Time: $time, $severity, $message", "Type": "string", "TypeParams": [ { "Name": "maxLength", "Value": "255" } ] } ], "TemplateId": 50 } ] }, "State": true } Device Severity: /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.
"Devices": [], "DeviceTypes": [], "Groups": [ 4 ], "Schedule": { "StartTime": null, "EndTime": null, "CronString": null }, "Actions": [ { "Id": 1, "Name": "OnDemandHealth", "ParameterDetails": [], "TemplateId": 80 } ] } }, "State": true, "Visible": true, "PolicyActions": [ { "@odata.id": "/api/AlertService/AlertPolicies(314)/PolicyActions" } ], "PolicyCriteria": [ { "@odata.id": "/api/AlertService/AlertPolicies(314)/PolicyCriteria" } ] Table 64.
Table 64. Attributes (continued) Attribute name Description Schedule StartTime Start event-time to verify. This value indicates the start date and time for policy validity. If defined. This field is checked during policy evaluation. EndTime End event-time to verify. This value indicates the end date and time for policy validity. If defined. This field is checked during policy evaluation. CronString CRON string associated to the policy.
"DeviceTypes": [1000], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.000", "CronString": "* * * ? * * *" }, "Actions": [ { "TemplateId": 50, "Name": "Email", "ParameterDetails": [ { "Name": "subject", "Value": "Device Name: $name, Device IP Address: $ip, Severity: $severity" }, { "Name": "to", "Value": "test@dell.com" }, { "Name": "from", "Value": "MCSIApplication@Dell.
1, 2, 4, 8 ], "Devices": [ 1914 ], "DeviceTypes": [ 1000 ], "Groups": [], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.000", "CronString": "* * * ? * * *" }, "Actions": [ { "Id": 3, "Name": "Email", "ParameterDetails": [ { "Name": "subject", "Value": "Device Name: $name, Device IP Address: $ip, Severity: $severity", "Type": "string", "TypeParams": [ { "Name": "maxLength", "Value": "255" } ] }, { "Name": "to", "Value": "test@dell.
] } } }, "State": true Table 65. Attributes Attribute name Description ID Event record ID. Name Name associated with the policy. Description Description associated with the policy. Enabled Indicates if the policy is enabled or disabled. DefaultPolicy Indicates if the policy is the default policy or pre-seeded. State State associated with the policy. Visible Indicate if the policy is visible or hidden.
Table 65. Attributes (continued) Attribute name Description PolicyCriteria Link to the criteria for the evaluation of the alert contents with the policy contents. This evaluation determines if the policy is valid and if any actions are triggered. /api/AlertService/AlertPolicies(Arg1)/PolicyCriteria This URI represents the criteria used for matching the policy with incoming events. The criteria determine if the policy can trigger any actions. Table 66.
Table 67. Attributes Attribute name Description Id ID of the criteria. PolicyId ID of policy with which the criteria is associated. Parameter Any extra parameter that can be used in the criteria. Value Expression that is used during policy evaluation with events. Type ID of the criteria type. TypeName Name of the criteria type. ComparisonType ID of comparison type. ComparisonTypeName Name of comparison type.
Table 68. Attributes (continued) Attribute name Description ComparisonTypeName Name of comparison type. /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.
Table 70. Attributes (continued) Attribute name Description Parameters Extra parameter that can be added to the action. TemplateId ID of the action template associated with the action. Template Id ID of the template. Name Name of the template. Description Additional description of the template. Disabled Indicates if template is enabled or disabled. ParameterDetails List of other parameter that the template can carry and apply.
Table 71. Attributes (continued) Attribute name Description Id ID of the template. Name Name of the template. Description Extra 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/AlertActionTemplates This URI represents the alert-action templates. GET method for AlertActionTemplates This method returns the alert-action templates.
} ] } "@odata.id": "/api/AlertService/AlertActionTemplates(100)", "Id": 100, "Name": "Ignore", "Description": "Ignore", "Disabled": false, "ParameterDetails": [] Table 72. Attributes Attribute name Description Id ID of the action template. Name Name of the action template. Description Description of the action template. Disabled Indicates if the template is enabled or disabled. ParameterDetail Extra parameter that the template can carry and apply.
/api/AlertService/Actions/AlertService.EnableAlertPolicies POST method for AlertService.EnableAlertPolicies This method enables the selected alert policies. Description Enables the selected alert policies. Privilege MONITORING_SETUP HTTP response codes 201 Example request body { } "AlertPolicyIds": [100,200,300] Or { } "AllPolicies": true /api/AlertService/Actions/AlertService.DisableAlertPolicies POST method for AlertService.DisableAlertPolicies This method disables the selected alert policies.
Privilege MONITORING_SETUP HTTP response codes 201 Example request body { } "AlertPolicyIds": [100,200,300] Or { } "AllPolicies": true Alert definitions /api/AlertService/AlertMessageDefinitions This URI represents the definitions for the alert messages. Table 74. Filters Filter name Description Top Top records to return. Default value is 100. Skip Maximum records to skip. Default value is 0. MessageId Filter by message ID. Category Filter by event ID. SubCategory Filter by subcategory.
}, { "Prefix": "RAC", "SequenceNo": 9000, "Message": "Device has become non compliant.", "RecommendedAction": "No response action is required.", "Severity": "Critical", "Category": "Configuration", "SubCategory": null, "DetailedDescription": "A device has become non compliant." "@odata.id": "/api/AlertService/ AlertMessageDefinitions('LOG9000')", "MessageId": "LOG9000", "Prefix": "LOG", "SequenceNo": 9000, "Message": "Event definition not found for Event.
"MessageId": "RAC0600", "Prefix": "RAC", "SequenceNo": 600, "Message": "Unable to retrieve the temperature information.", "RecommendedAction": "Power on the server. If the server is already powered on, wait for a few minutes and refresh the page. If the problem persists, contact service provider.", "Severity": "Warning", "Category": "Configuration", "SubCategory": null, "DetailedDescription": "" } Table 76. Attributes Attribute Description MessageId ID of message definition.
"#AlertService.AlertMessageDefinitionCategory", "@odata.id": "/api/ AlertService/AlertMessageDefinitionsCategories('System%20Health')",…}, {"@odata.type": "#AlertService.AlertMessageDefinitionCategory", "@odata.id": "/api/ AlertService/AlertMessageDefinitionsCategories('Updates')",…}, {"@odata.type": "#AlertService.AlertMessageDefinitionCategory", "@odata.
"@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Hardware Config" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "iDRAC Service Module" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Interface" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "IP Address" }, { "@odata.type": "#AlertService.
}, { "SubCategory": "Power Usage" "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Power Usage POW" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "RAC Event" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Redundancy" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Server" }, { "@odata.type": "#AlertService.
6 Configure Topics: • • • • Firmware Template Service Identity pools Network Configuration Service Firmware /api/UpdateService/Catalogs This URI represents the catalogs in the appliance. GET method for Catalogs This method returns the catalogs that are created in the appliance. Description Returns the list of catalogs. NOTE: Driver updates are applicable only to OpenManage Enterprise. Privilege VIEW HTTP response codes 200 Example request body { 162 Configure "@odata.
{ }, { }, { }, { }, { } Example request body ] } "BaselineId": 9, "BaselineName": "Single" "BaselineId": 11, "BaselineName": "500" "BaselineId": 6, "BaselineName": "Test" "BaselineId": 7, "BaselineName": "Test 100" "BaselineId": 8, "BaselineName": "Test 2500+" } ], "Repository": { "@odata.type": "#UpdateService.Repository", "Id": 12, "Name": "Dell", "Description": "", "Source": "downloads.dell.
Table 77. Attributes (continued) Attribute Description SourcePath Relative path of the catalog file from the repository (for example: downloads.dell.com/catalog/catalog.gz) Status Status of creating the catalog. TaskId The identifier of the task or job that is created to download the catalog. BaseLocation The repository location for the catalog (for example for online catalogs, the location is downloads.dell.com) ManifestIdentifier Catalog manifest identifier *.
} "Repository": { "Name":"HTTPS-again", "Description":"HTTPS Desc", "RepositoryType":"HTTPS", "Source":"10.255.2.128:2607", "DomainName":"", "Username":"", "Password":"", "CheckCertificate":false } /api/UpdateService/Catalogs(Id) This URI represents a specific catalog. GET method for Catalogs(Id) This method returns the details of a specific catalog. Description Returns the details of a specific catalog. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
} } PUT method for Catalogs(Id) This method updates the catalog details. Description Updates details of a specific catalog. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#UpdateService.Catalogs/$entity", "@odata.type": "#UpdateService.Catalogs", "@odata.id": "/api/UpdateService/Catalogs(28)", "Id": 28, "Filename": "CatalogA00.
GET method for Baselines This method returns the baselines. Description Returns the baselines. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(UpdateService.Baselines)", "@odata.count": 4, "value": [ { "@odata.type": "#UpdateService.Baselines", "@odata.
} "Name": "GROUP" } ], "ComplianceSummary": { "ComplianceStatus": "OK", "NumberOfCritical": 0, "NumberOfWarning": 0, "NumberOfNormal": 34, "NumberOfDowngrade": 0, "NumberOfUnknown": 0 }, "DeviceComplianceReports@odata.navigationLink": "/api/ UpdateService/Baselines(7)/DeviceComplianceReports" }, { "@odata.type": "#UpdateService.Baselines", "@odata.
} ], "ComplianceSummary": { "ComplianceStatus": "OK", "NumberOfCritical": 0, "NumberOfWarning": 0, "NumberOfNormal": 34, "NumberOfDowngrade": 0, "NumberOfUnknown": 0 }, "DeviceComplianceReports@odata.navigationLink": "/api/ UpdateService/Baselines(9)/DeviceComplianceReports" } ] } Table 78. Attributes Attribute Description Name Name of the Baseline. Description Description of the Baseline. CatalogId ID of the catalog. RepositoryId ID of the repository.
HTTP response codes Example request body 201 { "Name": "HTTP", "Description": "HTTP", "CatalogId": 22, "RepositoryId": 12, "RepositoryName": "HTTP", "RepositoryType": "HTTP", "DowngradeEnabled": true, "Is64Bit": true, "Targets": [ { "Id": 500, "Type": { "Id": 6000, "Name": "GROUP" } } ] } { 170 Configure "Name": "HTTP1", "Description": "HTTP1", "CatalogId": 22, "RepositoryId": 12, "RepositoryName": "HTTP", "RepositoryType": "HTTP", "DowngradeEnabled": true, "Is64Bit": true, "Targets": [ { "Id": 25015
}, { }, { }, { }, { }, { } ] } ] } "Id": 25022, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25023, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25032, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25033, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25035, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25038, "Type": { "Id": 1000, "Name": "DEVICE" } Table 79.
Table 79. Attributes (continued) Attribute Description You can determine GroupIDs through /api/ GroupService/Groups. Type Id ID for the device type. You can determine the DeviceType IDs can be determined through /api/DeviceService/ DeviceType Name Type of the target (DEVICE or GROUP). 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.
Table 80. Attributes Attribute Description Id Identifier for the device in the appliance. TaskId Identifier of the job. ComplianceStatus Shows the compliance status. The possible options are: ● CRITICAL ● WARNING ● DOWNGRADE ● OK ● UNKNOWN PUT method for Baselines(Id) This method updates the baseline details. Description Returns the baseline details. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Collection(UpdateService.Baselines)", "@odata.
} ] /api/UpdateService/Actions/ UpdateService.GetBaselinesForDevices This API represents the firmware compliance baselines for specific devices. POST method for /api/UpdateService/Actions/ UpdateService.GetBaselinesForDevices This method returns the firmware compliance baseline information for specific devices. Description Returns the firmware compliance for specific devices.
/api/UpdateService/Actions/ UpdateService.CheckBaselinesAssociation This API represents baseline association information. Post method for checking baseline association This method returns information about baseline associations. Description Returns information about baseline associations. Privilege VIEW HTTP response code 201 Example request body { } “Ids”: [] /api/UpdateService/ComplianceStatuses This UR returns compliance status information.
}, { } ] } "@odata.type": "#UpdateService.ComplianceStatus", "@odata.id": "/api/UpdateService/ComplianceStatuses(5)", "StatusId": 5, "StatusName": "UNKNOWN" /api/UpdateService/Baselines(Id)/DeviceComplianceReports This URI represents the compliance reports for baselines. GET method for DeviceComplianceReports This method returns the compliance report for a specific baseline. Description Returns the compliance report for a baseline.
}, { ] } "Uri": "", "RebootRequired": false, "ComplianceStatus": "UNKNOWN", "ComplianceDependencies": [], "ComponentType": "FIRMWARE", "DependencyUpgradeRequired": false "@odata.type": "#UpdateService.DeviceComplianceReport", "@odata.
Table 81. Attributes (continued) Attribute Description ● Download ● Ok ● Unknown ComplianceStatus Shows the compliance status. The possible options are: ● CRITICAL ● WARNING ● DOWNGRADE ● OK ● UNKNOWN DeviceTypeId Numeric value for the device type such as server(1000). RebootRequired Indicates if a reboot is required to make the device compliant. Link Link to the component compliance report, identifying the software components on the device and if they match up against the catalog.
} ] } "TargetIdentifier": "", "UpdateAction": "UNKNOWN", "SourceName": "IOM.Slot.A1", "PrerequisiteInfo": "", "ImpactAssessment": "", "Uri": "", "RebootRequired": false, "ComplianceStatus": "UNKNOWN", "ComplianceDependencies": [], "ComponentType": "FIRMWARE", "DependencyUpgradeRequired": false Table 82. Attributes Attribute Description DeviceId Identifier for the device in the appliance. ServiceTag Service Tag of the device. DeviceModel Model of the device.
"@odata.count": 1, "value": [ { "@odata.type": "#UpdateService.ComponentComplianceReport", "@odata.id": "/api/UpdateService/Baselines(8)/ DeviceComplianceReports(5)/ComponentComplianceReports(13)", "Id": 13, "Version": "Not updatable through catalog", "CurrentVersion": "10.5.0.7.745", "Path": "", "Name": "IOM Firmware", "Criticality": "Unknown", "UniqueIdentifier": "", "TargetIdentifier": "", "UpdateAction": "UNKNOWN", "SourceName": "IOM.Slot.
} "Version": "Not updatable through catalog", "CurrentVersion": "10.5.0.7.745", "Path": null, "Name": "IOM Firmware", "Criticality": "Unknown", "UniqueIdentifier": null, "TargetIdentifier": null, "UpdateAction": "UNKNOWN", "SourceName": "IOM.Slot.A2", "PrerequisiteInfo": null, "ImpactAssessment": null, "Uri": null, "RebootRequired": false, "ComplianceStatus": "UNKNOWN", "ComplianceDependencies": [], "ComponentType": null, "DependencyUpgradeRequired": false Table 84.
HTTP response codes Example request body 200 { "FileToken": "1481131455800" } /api/UpdateService/Actions/UpdateService.RefreshCatalogs This API refreshes catalog information. POST method for /api/UpdateService/Actions/ UpdateService.RefreshCatalogs This method refreshes catalogs by checking for and downloading newer versions. Description Refreshes catalogs by checking for and downloading newer versions of catalogs.
/api/UpdateService/Actions/UpdateService.RemoveBaselines POST method for RemoveBaselines This method deletes baselines. Description Deletes baselines. Privilege BASELINE_MANAGEMENT HTTP response codes 204 Example request body { } "BaselineIds":[13] /api/UpdateService/RollbackSoftwares This URI returns software rollback information. GET method for rollback software This method returns the software rollback information. Description Returns the software rollback information.
/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 request body { } Example response body { } "FileToken": "1481131455800" "Date": "2016-01-12 02:37:36.000", "VendorVersion": "1.4.3", "SchemaVersion": "1.0", "ReleaseDate": "2016-01-11 00:00:00.000", "ReleaseId": "G1JD51.4.
"DeviceTypeId": "1000", "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 request body { } Example response body 186 Configure [ "Ids":["Device ID"] { "Id": 7, "Name": "IOM", "Description": "", "LastRun": "2020-07-23 17:22:26.
"Version": "10.5.0.7.745", "CurrentVersion": "10.5.0.7.745", "Path": "OperatingSystem_Firmware_1JX0K_WN64_10.5.0.7.745_A00.EXE", "Name": "MX9116N", "Criticality": "Recommended", "UniqueIdentifier": "bea4daa0-302c-4af4-a08bc39702d3199b", "TargetIdentifier": "106551", "UpdateAction": "EQUAL", "SourceName": "IOM.Slot.A1", "Uri": "http://www.dell.
] } ], "DeviceComplianceReports": [ { "Id": 4, "DeviceId": 10067, "ServiceTag": "CJ2J5Z2", "DeviceModel": "MX9116n Fabric Engine", "DeviceTypeId": 4000, "DeviceTypeName": "NETWORK_IOM", "DeviceName": "IOM-A1", "FirmwareStatus": "Unknown", "ComplianceStatus": "UNKNOWN", "RebootRequired": false, "ComponentComplianceReports": [ { "Id": 12, "Version": "Not updatable through catalog", "CurrentVersion": "10.5.0.7.
"SignatureAlgorithm": "SHA1withRSA", "SignatureAlgorithmOid": "1.2.840.113549.1.1.5", "PublicKey": "X.509", "ValidityFrom": "Wed Sep 17 12:49:56 UTC 2014", "ValidityTo": "Tue Sep 18 12:49:56 UTC 2074", "Issuer": "ST=Texas, C=USA, O=Dell Inc., L=Round Rock, CN=OMEDEVDAHIR", "SerialNumber": "1183094576064516206207594277304256693" } Template Service /api/TemplateService/TemplateTypes This URI represents the types of templates.
Table 85. Attributes (continued) Attribute Description Name The type of device for which this template type holds configuration attributes. /api/TemplateService/TemplateViewTypes This URI represents the different features that support template operations. GET method for TemplateViewTypes This method returns the features that support template operations. Description Returns the features that support templates operations. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
/api/TemplateService/Templates This URI represents the templates. GET method for Templates This method returns the details of all available templates. Table 87. Filters Filter name Description Top Top records to return. Default value is 100. Skip Maximum records to skip. Default value is 0. Orderby Order to apply to the output. SearchFilter Search type. Description Returns the details of all templates. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
}, { "HasIdentityAttributes": false, "Status": 0, "IdentityPoolId": 0, "IsBuiltIn": true, "CreatedBy": "system", "CreationTime": "2017-11-30 19:02:11.200378", "LastUpdatedBy": null, "LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(2)/Views" } ] "@odata.
}, { }, { "HasIdentityAttributes": false, "Status": 0, "IdentityPoolId": 0, "IsBuiltIn": true, "CreatedBy": "system", "CreationTime": "2017-11-30 19:02:11.200378", "LastUpdatedBy": null, "LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(5)/Views" } ] "@odata.
} ] } "TypeId": 2, "ViewTypeId": 4, "TaskId": 0, "HasIdentityAttributes": false, "Status": 0, "IdentityPoolId": 0, "IsBuiltIn": true, "CreatedBy": "system", "CreationTime": "2017-11-30 19:02:11.200378", "LastUpdatedBy": null, "LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(8)/Views" } ] NOTE: For information about template attributes, see the Attributes table under GET method for Templates(Id).
Table 88. Attributes (continued) Attribute Description ● ● ● ● ● ● ● ● To iDRAC BIOS System NIC Lifecycle Controller RAID EventFilters Fibre Channel get the entire device configuration, use All. POST method for IOA Templates This method creates an IOA template. Description Creates an IOA template. Privilege TEMPLATE_MANAGEMENT HTTP response codes 201 Example request body { "Name": "Switch-FJM0Y42", "TypeId": 3, "ViewTypeId": 2, "SourceDeviceId": 10173, "Fqdds": "" } Table 89.
/api/TemplateService/Templates(Id) This URI represents a specific template. GET method for Templates(Id) This method returns the details of a specific template. Description Returns the details of a specific template. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#TemplateService.Template/$entity", "@odata.
Table 90. Attributes (continued) Attribute Description Status Status of the action. IdentityPoolId The ID of the identify pool associated with the template. If an identity pool is not associated, this value is 0. IsBuiltIn Indicates whether the template is a preinstalled template or customer-defined. CreatedBy The name of the user who created the template. CreationTime Timestamp indicating when this template was created. Last UpdatedBy The name of the user who last modified this template.
Table 91. Attributes (continued) Attribute name Description Attribute Id Attribute Id Value Status of the Value attribute IsIgnored Whether the attribute id Ignored or Not DELETE method for Templates(Id) This method deletes a template. Description Deletes a specific template. Privilege DEVICE_CONFIGURATION HTTP response codes 204 api/TemplateService/Templates(26) This URL represents the template configuration content.
0/8\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/9\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/10\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/11\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/12\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/13\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEtherne
"IsStatelessAvailable": false, "IsBuiltIn": false, "CreatedBy": "admin", "CreationTime": "2019-01-24 15:15:13.509153", "LastUpdatedBy": "admin", "LastUpdatedTime": "2019-01-24 15:15:13.509153", "Views@odata.navigationLink": "/api/TemplateService/Templates(10)/ Views" } Table 92. Attributes Attribute Description Id Unique identifier for referencing a template. Name Template name. Description Definition for the template.
Example response body { "@odata.context": "/api/ $metadata#Collection(TemplateService.AttributeView) HYPERLINK "mailto:\", \"@odata.count" ", "@odata.count": 2, "value": [ { "@odata.type": "#TemplateService.AttributeView", "@odata.id": "/api/TemplateService/Templates(1)/Views(1)", "Id": 1, "Name": "TemplateSpecific", "Description": "The hierarchy consists of template specific component classes, groups (from the attribute registry) and attributes.", "AttributeViewDetails": { "@odata.
"@odata.context": "/api/$metadata#TemplateService.AttributeView/ $entity", "@odata.id": "/api/TemplateService/Templates(10)/Views(1)", "Id": 1, "Name": "DefaultModel", "Description": "The default hierarchical model of a template. The hierarchy consists of component classes, groups (from the attribute registry) and attributes.", "AttributeViewDetails": { "@odata.id": "/api/TemplateService/Templates(10)/Views(1)/ AttributeViewDetails" }, "DeviceAttributeViewDetails": [ { "@odata.
classes, groups (from the attribute registry) and attributes.
}, { } { Restart", }, { Requested", }, { }, { ] } "Value": "Enabled", "IsReadOnly": false, "IsIgnored": true "AttributeId": 3560, "CustomId": 0, "AttributeEditInfoId": 1855, "DisplayName": "LCAttributes 1 IPChangeNotifyPS", "Description": null, "Value": "Off", "IsReadOnly": false, "IsIgnored": false "AttributeId": 3557, "CustomId": 0, "AttributeEditInfoId": 1642, "DisplayName": "LCAttributes 1 Collect System Inventory on "Description": null, "Value": "Enabled", "IsReadOnly": false, "IsIgnored": fal
Table 94. Attributes Attribute Description AttributeId Unique identifier for an attribute. AttributeEditInfoId Identifier for editing-related info for the attribute. DisplayName Text for displaying the name of the attribute. Description Attribute definition. Value The current value for the attribute. IsReadOnly Indicates whether the attribute value can be modified. IsIgnored Indicates whether the attribute should be ignored or included when the template is deployed to another device.
}, { "IsReadOnly": false, "IsSecure": false, "TextMinLength": 0, "TextMaxLength": 223, "ValueMin": 0, "ValueMax": 0, "DependencyText": null, "OptionSetId": 0, "DefaultOptionId": 0, "GenericNameId": 2258 "Id": 3637, "DataType": 4308, "Description": "Specify the iSCSI Qualified Name (IQN) of the fifth iSCSI storage target.
/api/TemplateService/Templates(Id)/Views(Id)/ DeviceAttributeViewDetails(Id) This URI represents the device-specific attributes for a view of a template. GET method for DeviceAttributeViewDetails(Id) This method returns the device-specific attributes for a view of a template. Description Returns the device-specific attributes for a view of a template. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#TemplateService.
}, { }, { ] }, { }, { 208 Configure } "IsIgnored": false "AttributeId": 0, "CustomId": 43, "AttributeEditInfoId": 0, "DisplayName": "Vlan Tagged", "Description": null, "Value": null, "IsReadOnly": false, "IsIgnored": false "AttributeId": 0, "CustomId": 43, "AttributeEditInfoId": 0, "DisplayName": "Vlan UnTagged", "Description": null, "Value": "0", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] "GroupNameId": 1, "DisplayName": "Port ", "Sub ttributeGroups": [ "GroupNameId": 2, "Displa
{ }, { ] }, { } "AttributeId": 3369, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", "Description": null, "Value": "20", "IsReadOnly": false, "IsIgnored": false "AttributeId": 3370, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] "GroupNameId": 1, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId":
"AttributeId": 3431, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", }, { Bandwidth", }, { }, { ] }, { Bandwidth", } Configure "AttributeId": 3432, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false "AttributeId": 0, "CustomId": 47, "AttributeEditInfoId": 0, "DisplayName": "Vlan Tagged", "Description": null, "Value": null, "IsReadOnly": false,
"DisplayName": "Partition n Maximum TX Bandwidth", ] }, { Bandwidth", } } ], "Attributes": [] "GroupNameId": 2, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 3, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3503, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX }, { Bandwidth", ] }, { Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false } "Description": null, "Valu
{ Bandwidth", ] } "AttributeId": 3523, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] } ], "Attributes": [] } ], "Attributes": [] } ], "TemplateEditInfoDetails": { "@odata.
] } } ] } "AttributeEditInfoId": 0, "DisplayName": "IOA.Hostname", "Value": "dell-openmanage enterprise-c3", "IsReadOnly": false, "IsIgnored": false /api/TemplateService/Actions/TemplateService.AssignIdentities POST method for TemplateService.AssignIdentities This method reserves virtual identities for target devices based on the configuration in a specified template. Identities are reserved from the identity pool associated with the specified template.
} Example response body The reply is a hierarchical structure for the cards, ports, and partitions for which identities were assigned, or that have boot options.
}, { }, { } ] } ] } ] } ] } ] } "IsReadOnly": true, "IsIgnored": false "AttributeId": 0, "CustomId": 0, "AttributeEditInfoId": 0, "DisplayName": "iSCSI IQN", "Description": "iSCSI IQN", "Value": "iqn.pool1.
/api/TemplateService/Actions/TemplateService.Clone POST method for TemplateService.Clone This method creates a clone of a template. Description Clones a template. Privilege DEVICE_CONFIGURATION HTTP response codes 200 Example request body { } Example response body "SourceTemplateId": 12, "NewTemplateName": "clone example", "ViewTypeId": 2 ID of cloned template /api/TemplateService/Actions/TemplateService.Export POST method for TemplateService.Export This method exports a template.
"ContentType": "xml", "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 that is created from a device. The text must use the same structure as SCP files. Description Creates a template from a specified configuration text in SCP XML format.
\n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/8\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/9\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/10\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/11\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/12\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/13\n auto vlan\n
/api/TemplateService/Actions/TemplateService.Deploy POST method for TemplateService.Deploy This method creates a template-deployment job. Description Creates a template-deployment job. Privilege DEVICE_CONFIGURATION HTTP response code 200 Example request body { } "Id" : , "TargetIds" : [ ,...
} "Attributes":[ { "DeviceId":0, "Attributes":[ { "Id":2536, "IsIgnored":true } ] } ], "Options":{ "ShutdownType":0, "TimeToWaitBeforeShutdown":300, "EndHostPowerState":1 } Example response body ID of created task Deployment using Boot to ISO method { ], } }, ], }, } "Id":9, "TargetIds":[ "10135" "NetworkBootIsoModel":{ "BootToNetwork":true, "ShareType":"CIFS", "IsoPath":"CentOS-8.1.1911-x86_64-boot.iso", "IsoTimeout":4, "ShareDetail":{ "IpAddress":"X.X.X.
Example request body { } "Id": 10, "TargetIds": [10173,10175], "Attributes": [ { "DeviceId": "10173", "Attributes": [ { "Id": 18968, "Value": "hostname-1", "IsIgnored": false } ] }, { "DeviceId": "18968", "Attributes": [ { "Id": 9000, "Value": "hostname-2", "IsIgnored": false } ] } ], "Options": { "ShutdownType": 0, "TimeToWaitBeforeShutdown": 300, "EndHostPowerState": 1, "PrecheckOnly": false, "ContinueOnWarning": true }, "Schedule": { "RunNow": true, "RunLater": false } /api/TemplateService/Actions/ T
} ], "VlanAttributes": [ { "ComponentId": 56, "Untagged": 10218, "Tagged": [ 10219 ], "IsNicBonded": false }, { "ComponentId": 57, "Tagged": [], "IsNicBonded": false }, { "ComponentId": 58, "Untagged": 10220, "Tagged": [ 10221 ], "IsNicBonded": false }, { "ComponentId": 55, "Tagged": [], "IsNicBonded": false } ] Table 96.
/api/TemplateService/Actions/TemplateService.Remediate POST method for TemplateService.Remediate Description This method ensures that the device is compliant to a baseline. Privilege TEMPLATE_MANAGEMENT HTTP response codes 200 Example request body { } "id": 1, "targetIds": [5864] api/TemplateService/Actions/TemplateService.IsSocRunning POST method for TemplateService.IsSoC Running Description Returns true if Summary of Compliance (SoC) is running against the given template.
Identity pools /api/IdentityPoolService/IdentityPools This URI represents the identity pools. GET method for IdentityPools This method returns the details of all identity pools. Description Returns identity pools. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(IdentityPoolService.IdentityPool)", "@odata.count": 2, "value": [ { "@odata.type": "#IdentityPoolService.IdentityPool", "@odata.
} "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.
} } }, "Wwpn": { "IdentityCount":85, "StartingAddress": "IAGAgICAgAA=" } /api/IdentityPoolService/IdentityPools(Id) This URI represents a specific identity pool. GET method for IdentityPools(Id) This method returns the details of a specific identity pool. Description Returns a specific identity pool. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#IdentityPoolService.IdentityPool/ $entity", "@odata.type": "#IdentityPoolService.
} }, "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.
{ "IdentityCount": 85, "StartingAddress": "IACAgICAgAA=" }, "Wwpn": { } } } "IdentityCount": 85, "StartingAddress": "IAGAgICAgAA=" Table 97.
Example response body { "@odata.context": "/api/$metadata#IdentityPoolService.UsageCounts/ $entity", "@odata.type": "#IdentityPoolService.UsageCounts", "@odata.
"@odata.count": 4, "value": [ { "@odata.type": "#IdentityPoolService.UsageIdentitySet", "@odata.id": "/api/IdentityPoolService/IdentityPools(4)/ UsageIdentitySets(1)", "IdentitySetId": 1, "Name": "Ethernet", "Details@odata.navigationLink": "/api/IdentityPoolService/ IdentityPools(4)/UsageIdentitySets(1)/Details" }, { "@odata.type": "#IdentityPoolService.UsageIdentitySet", "@odata.id": "/api/IdentityPoolService/IdentityPools(4)/ UsageIdentitySets(2)", "IdentitySetId": 2, "Name": "iSCSI", "Details@odata.
"Details@odata.navigationLink": "/api/IdentityPoolService/ IdentityPools(4)/UsageIdentitySets(1)/Details" } /api/IdentityPoolService/IdentityPools(Id)/ UsageIdentitySets(Id)/Details This URI represents usage details for a specific identity pool and identity set (protocol). GET method for Details of UsageIdentitySets(Id) This method returns the usage details for a specific identity pool and identity set or protocol.
} ] } } "ChassisName": "MX-LCX", "SlotNumber": "7", "ServerName": "idrac-SRVC333", "ManagementIp": "10.215.2.134" /api/IdentityPoolService/IdentityStates This URI represents the identity states for the identities in an identity pool. GET method for IdentityStates This method returns the identity states, such as Reserved and Assigned, for the identities in an identity pool. Description Returns identity states. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
Example response body { "@odata.context": "/api/$metadata#IdentityPoolService.IdentityState/ $entity", "@odata.type": "#IdentityPoolService.IdentityState", "@odata.id": "/api/IdentityPoolService/IdentityStates(1)", "Id": 1, "Name": "Reserved", "Description": "Assigned to a profile; deployment pending." } /api/IdentityPoolService/Actions/ IdentityPoolService.DeleteIdentityPools POST method for deleting identity pools This method deletes identity pools. Description Deletes identity pools.
$metadata#Collection(NetworkConfigurationService.Network)", "@odata.count": 3, "value": [ { "@odata.type": "#NetworkConfigurationService.Network", "@odata.id": "/api/NetworkConfigurationService/ Networks(10133)", "Id": 10133, "Name": "asd", "Description": "", "VlanMaximum": 2, "VlanMinimum": 2, "Type": 3, "CreatedBy": "system", "CreationTime": "1970-01-31 00:12:56.376", "UpdatedBy": null, "UpdatedTime": "1970-01-31 00:12:56.376", "InternalRefNWUUId": "00bc07d7-5d3c-429e-96a3-5c6600230851" }, { "@odata.
Table 98. Attributes (continued) Attribute name Description NOTE: To define a profile which is not in a range, the VlanMaximum and VlanMinimum need to be same. Type Network profile definition type. For more information, see /api/ NetworkConfigurationService/NetworkTypes. CreatedBy The user who created the network. CreationTime Date and time when the network was created. UpdatedBy The user who last updated the network. UpdatedTime Date and time when the network was last updated.
/api/NetworkConfigurationService/Networks(Id) This URI represents a specific network within the collection. GET method for Networks(Id) This method returns the details of a specific network from the collection. Description Returns the details of a specific network. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#NetworkConfigurationService.Network/ $entity", "@odata.
} "UpdatedBy": "root", "UpdatedTime": "1970-01-01 02:02:15.797", "InternalRefNWUUId": 0 Table 99. Attributes Attribute name Description ID The identifier of the target network profile. Name Name of the network. Description Description of the network. VlanMaximum VLan can be defined as either a range or a single value. If a single value is defined, the same value is assigned to both VlanMaximum and VlanMinimum. VlanMinimum VLan can be defined as either a range or a single value.
"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.", "VendorCode": "VMFTLog", "NetworkTrafficType": "Ethernet", "QosType": 1 } ] } Table 100.
} "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 response body { "@odata.context": "/api/ $metadata#Collection(NetworkConfigurationService.QosType)", "@odata.count": 4, "value": [ { "@odata.
Example response body { "@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 removing networks This method deletes the specified networks from the system. Description Deletes the specified networks.
] } "Name":"3", "Description": "", "VlanMinimum": 20, "VlanMaximum": 30, "Type": 1 Table 102. Attributes Attribute name Description Id Unique identifier of the network. Name Name of the network. Description Description of the network. VlanMaximum VLan can be defined as either a range or a single value. If a single value is defined, the same value is assigned to both VlanMaximum and VlanMinimum. VlanMinimum VLan can be defined as either a range or a single value.
api/NetworkConfigurationService/Actions/ NetworkConfigurationService.ValidateNetworkDefinitionFile This URI validates the network profiles, which you want to import. POST method for validating network profiles This method validates the network profiles that you want to import. Description Validates the network profiles that you want to import.
/api/NetworkConfigurationService/ReplicableChassisSettings This URI represents replicable chassis settings. GET method for replicable chassis settings This method fetches the replicable chassis settings. Description Fetches replicable chassis settings. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#NetworkConfigurationService.ReplicableChassisSettingsResponseModel", "@odata.type": "#NetworkConfigurationService.
7 Devices Topics: • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • /api/DeviceService /api/DeviceService/Devices /api/DeviceService/Devices?$filter=Type eq 1000 /api/DeviceService/Devices(Id) /api/DeviceService/Devices(Id)/InventoryDetails /api/DeviceService/Devices(Id)/InventoryDetails(InventoryType) /api/DeviceService/Devices(Device_ID)/InventoryDetails('deviceManagement') /api/DeviceService/Devices(Id)/Settings('ReplicableChassisConfigurations') /api/DeviceService/
/api/DeviceService This URI represents the device services. GET method for DeviceService This method returns a list of all the device services. Description Returns a list of device services. Privilege VIEW HTTP response codes 200 Example Response Body { "@odata.context": "/api/$metadata#DeviceService.DeviceService", "@odata.type": "#DeviceService.DeviceService", "@odata.id": "/api/DeviceService", "Actions": null, "Devices@odata.navigationLink": "/api/DeviceService/Devices", "DeviceStatuses@odata.
"PowerState": 17, "ManagedState": 3000, "Status": 1000, "ConnectionState": true, "AssetTag": null, "SystemId": 2031, "DeviceName": "MX-7BU0772", "LastInventoryTime": "2020-12-30 16:00:21.595", "LastStatusTime": "2020-12-30 10:30:07.395", "DeviceSubscription": null, "DeviceCapabilities": [ 18, 8, 201, 202, 206 ], "SlotConfiguration": { "ChassisName": null }, "DeviceManagement": [ { "ManagementId": 5398, "NetworkAddress": "100.97.208.
"@odata.id": "/api/DeviceService/Devices(10074)/ InventoryTypes" }, "LogSeverities": { "@odata.id": "/api/DeviceService/Devices(10074)/ LogSeverities" }, "Settings@odata.navigationLink": "/api/DeviceService/ Devices(10074)/Settings", "Temperature": { "@odata.id": "/api/DeviceService/Devices(10074)/ Temperature" }, "Power": { "@odata.id": "/api/DeviceService/Devices(10074)/Power" }, "SystemUpTime": { "@odata.id": "/api/DeviceService/Devices(10074)/ SystemUpTime" }, "BlinkStatus": { "@odata.
18, 30, 31 ], "SlotConfiguration": { "ChassisName": "MX-7BU0772", "SlotId": "10094", "DeviceType": "1000", "ChassisId": "10074", "SlotNumber": "1", "SledBlockPowerOn": "None blocking", "SlotName": "Sled-1_PF_NVDIMM_SLED_!@#$%^&*()`1234567_+! @#$%^&*()`1234567_+!@#$%^&*()`1234567_+!@#$%^&*()`1234567_+1!@#$ %^&*()`1234567_+1!@#$%^&*()`1234567_+!@#$%^&*()`1234567_+!@#$ %^&*()`1234567_+!@#$%^&*()`1234567_+!@#$%^&*()`1234567_+!@#$ %^&*()`1234567_+!@#$%^&*()`", "ChassisServiceTag": "7BU0772", "SlotType": "2000"
Devices(10075)/SubSystemHealth", "RecentActivity@odata.navigationLink": "/api/DeviceService/ Devices(10075)/RecentActivity", "InventoryTypes": { "@odata.id": "/api/DeviceService/Devices(10075)/ InventoryTypes" }, "LogSeverities": { "@odata.id": "/api/DeviceService/Devices(10075)/ LogSeverities" }, "Settings@odata.navigationLink": "/api/DeviceService/ Devices(10075)/Settings", "Temperature": { "@odata.id": "/api/DeviceService/Devices(10075)/ Temperature" }, "Power": { "@odata.
14, 15, 17, 18, 30, 31 ], "SlotConfiguration": { "ChassisName": "MX-7BU0772", "SlotId": "10098", "DeviceType": "1000", "ChassisId": "10074", "SlotNumber": "5", "SledBlockPowerOn": "None blocking", "SlotName": "Sled-5", "ChassisServiceTag": "7BU0772", "SlotType": "2000" }, "DeviceManagement": [ { "ManagementId": 5351, "NetworkAddress": "100.97.208.
"RecentActivity@odata.navigationLink": "/api/DeviceService/ Devices(10076)/RecentActivity", "InventoryTypes": { "@odata.id": "/api/DeviceService/Devices(10076)/ InventoryTypes" }, "LogSeverities": { "@odata.id": "/api/DeviceService/Devices(10076)/ LogSeverities" }, "Settings@odata.navigationLink": "/api/DeviceService/ Devices(10076)/Settings", "Temperature": { "@odata.id": "/api/DeviceService/Devices(10076)/ Temperature" }, "Power": { "@odata.
15, 16, 17, 18, 30, 31 ], "SlotConfiguration": { "ChassisName": "MX-7BU0772", "SlotId": "10095", "DeviceType": "1000", "ChassisId": "10074", "SlotNumber": "2", "SledBlockPowerOn": "None blocking", "SlotName": "Sled-2_LOM_!@#$%^&*()`1234567_+!@#$ %^&*()`1234567_+!@#$%^&*()`1234567_+!@#$%^&*()`1234567_+!@#$ %^&*()`1234567_+!@#$%^&*()`1234567_+!@#$%^&*()`1234567_+!@#$ %^&*()`1234567_+!@#$%^&*()`1234567_+!@#$%^&*()`1234567_+!@#$ %^&*()`1234567_+!@#$%^&*()`1234567_+!@#$", "ChassisServiceTag": "7BU0772", "SlotTy
Devices(10077)/HardwareLogs", "SubSystemHealth@odata.navigationLink": "/api/DeviceService/ Devices(10077)/SubSystemHealth", "RecentActivity@odata.navigationLink": "/api/DeviceService/ Devices(10077)/RecentActivity", "InventoryTypes": { "@odata.id": "/api/DeviceService/Devices(10077)/ InventoryTypes" }, "LogSeverities": { "@odata.id": "/api/DeviceService/Devices(10077)/ LogSeverities" }, "Settings@odata.navigationLink": "/api/DeviceService/ Devices(10077)/Settings", "Temperature": { "@odata.
12, 13, 14, 15, 16, 17, 18, 30, 31 ], "SlotConfiguration": { "ChassisName": "MX-7BU0772", "SlotId": "10096", "DeviceType": "1000", "ChassisId": "10074", "SlotNumber": "3", "SledBlockPowerOn": "None blocking", "SlotName": "Sled-3", "ChassisServiceTag": "7BU0772", "SlotType": "2000" }, "DeviceManagement": [ { "ManagementId": 5382, "NetworkAddress": "100.97.209.
"SubSystemHealth@odata.navigationLink": "/api/DeviceService/ Devices(10078)/SubSystemHealth", "RecentActivity@odata.navigationLink": "/api/DeviceService/ Devices(10078)/RecentActivity", "InventoryTypes": { "@odata.id": "/api/DeviceService/Devices(10078)/ InventoryTypes" }, "LogSeverities": { "@odata.id": "/api/DeviceService/Devices(10078)/ LogSeverities" }, "Settings@odata.navigationLink": "/api/DeviceService/ Devices(10078)/Settings", "Temperature": { "@odata.
13, 14, 15, 16, 17, 18, 30, 31 ], "SlotConfiguration": { "ChassisName": "MX-7BU0772", "SlotId": "10097", "DeviceType": "1000", "ChassisId": "10074", "SlotNumber": "4", "SledBlockPowerOn": "None blocking", "SlotName": "Sled-4_!@#$%^&*()`1234567_+!@#$ %^&*()`1234567_+!@#$%^&*()`1234567_+!@#$%^&*()`1234567_+!@#$ %^&*()`1234567_+!@#$%^&*()`1234567_+!@#$%^&*()`1234567_+!@#$ %^&*()`1234567_+!@#$%^&*()`1234567_+!@#$%^&*()`1234567_+!@#$ %^&*()`1234567_+!@#$%^&*()`1234567_+!@#$%^&*", "ChassisServiceTag": "7BU0772",
"Enabled": true, "Actions": null, "InventoryDetails@odata.navigationLink": "/api/DeviceService/ Devices(10079)/InventoryDetails", "HardwareLogs@odata.navigationLink": "/api/DeviceService/ Devices(10079)/HardwareLogs", "SubSystemHealth@odata.navigationLink": "/api/DeviceService/ Devices(10079)/SubSystemHealth", "RecentActivity@odata.navigationLink": "/api/DeviceService/ Devices(10079)/RecentActivity", "InventoryTypes": { "@odata.
7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 30, 31 ], "SlotConfiguration": { "ChassisName": "MX-7BU0772", "SlotId": "10099", "DeviceType": "1000", "ChassisId": "10074", "SlotNumber": "6", "SledBlockPowerOn": "None blocking", "SlotName": "Sled-6", "ChassisServiceTag": "7BU0772", "SlotType": "2000" }, "DeviceManagement": [ { "ManagementId": 5337, "NetworkAddress": "100.97.208.
"Actions": null, "InventoryDetails@odata.navigationLink": "/api/DeviceService/ Devices(10080)/InventoryDetails", "HardwareLogs@odata.navigationLink": "/api/DeviceService/ Devices(10080)/HardwareLogs", "SubSystemHealth@odata.navigationLink": "/api/DeviceService/ Devices(10080)/SubSystemHealth", "RecentActivity@odata.navigationLink": "/api/DeviceService/ Devices(10080)/RecentActivity", "InventoryTypes": { "@odata.id": "/api/DeviceService/Devices(10080)/ InventoryTypes" }, "LogSeverities": { "@odata.
8, 9, 10, 11, 12, 13, 14, 15, 17, 18, 30, 31 ], "SlotConfiguration": { "ChassisName": "MX-7BU0772", "SlotId": "10100", "DeviceType": "1000", "ChassisId": "10074", "SlotNumber": "7", "SledBlockPowerOn": "None blocking", "SlotName": "Sled-7", "ChassisServiceTag": "7BU0772", "SlotType": "2000" }, "DeviceManagement": [ { "ManagementId": 5370, "NetworkAddress": "100.97.208.
Devices(10081)/InventoryDetails", "HardwareLogs@odata.navigationLink": "/api/DeviceService/ Devices(10081)/HardwareLogs", "SubSystemHealth@odata.navigationLink": "/api/DeviceService/ Devices(10081)/SubSystemHealth", "RecentActivity@odata.navigationLink": "/api/DeviceService/ Devices(10081)/RecentActivity", "InventoryTypes": { "@odata.id": "/api/DeviceService/Devices(10081)/ InventoryTypes" }, "LogSeverities": { "@odata.id": "/api/DeviceService/Devices(10081)/ LogSeverities" }, "Settings@odata.
"SlotConfiguration": { "ChassisName": "MX-7BU0772", "SlotId": "10088", "DeviceType": "4000", "ChassisId": "10074", "SlotNumber": "1", "SledBlockPowerOn": "null", "SlotName": "IOM-A1", "ChassisServiceTag": "7BU0772", "SlotType": "4000" }, "DeviceManagement": [], "Enabled": true, "Actions": null, "InventoryDetails@odata.navigationLink": "/api/DeviceService/ Devices(10082)/InventoryDetails", "HardwareLogs@odata.navigationLink": "/api/DeviceService/ Devices(10082)/HardwareLogs", "SubSystemHealth@odata.
"ConnectionState": true, "AssetTag": "PTM_A2_25G", "SystemId": 2031, "DeviceName": "IOM-A2", "LastInventoryTime": "2020-12-30 21:30:13.309", "LastStatusTime": "2020-12-30 10:30:14.
DeployRequired" } }, { "@odata.type": "#DeviceService.Device", "@odata.id": "/api/DeviceService/Devices(10084)", "Id": 10084, "Type": 4000, "Identifier": "0W875HA00CNFCP0089K000Q", "DeviceServiceTag": null, "ChassisServiceTag": "7BU0772", "Model": "PowerEdge MX 10GbT PTM", "PowerState": 17, "ManagedState": 3000, "Status": 1000, "ConnectionState": true, "AssetTag": "PTM_B1_10G", "SystemId": 2031, "DeviceName": "IOM-B1", "LastInventoryTime": "2020-12-30 21:30:11.718", "LastStatusTime": "2020-12-30 10:30:13.
BlinkStatus" }, "BlinkStatus": { "@odata.id": "/api/DeviceService/Devices(10084)/ }, "PowerUsageByDevice@odata.navigationLink": "/api/ DeviceService/Devices(10084)/PowerUsageByDevice", "DeviceBladeSlots@odata.navigationLink": "/api/DeviceService/ Devices(10084)/DeviceBladeSlots", "GraphicInfo": { "@odata.id": "/api/DeviceService/Devices(10084)/ GraphicInfo" }, "DeployRequired": { "@odata.id": "/api/DeviceService/Devices(10084)/ DeployRequired" } }, { "@odata.type": "#DeviceService.Device", "@odata.
"@odata.id": "/api/DeviceService/Devices(10085)/ LogSeverities" }, "Settings@odata.navigationLink": "/api/DeviceService/ Devices(10085)/Settings", "Temperature": { "@odata.id": "/api/DeviceService/Devices(10085)/ Temperature" }, "Power": { "@odata.id": "/api/DeviceService/Devices(10085)/Power" }, "SystemUpTime": { "@odata.id": "/api/DeviceService/Devices(10085)/ SystemUpTime" }, "BlinkStatus": { "@odata.id": "/api/DeviceService/Devices(10085)/ BlinkStatus" }, "PowerUsageByDevice@odata.
"SlotName": "IOM-C1", "ChassisServiceTag": "7BU0772", "SlotType": "4000" }, "DeviceManagement": [], "Enabled": true, "Actions": null, "InventoryDetails@odata.navigationLink": "/api/DeviceService/ Devices(10086)/InventoryDetails", "HardwareLogs@odata.navigationLink": "/api/DeviceService/ Devices(10086)/HardwareLogs", "SubSystemHealth@odata.navigationLink": "/api/DeviceService/ Devices(10086)/SubSystemHealth", "RecentActivity@odata.
"DeviceCapabilities": [ 1, 801, 2, 18, 3, 803, 804, 5, 7, 8, 9 ], "SlotConfiguration": { "ChassisName": "MX-7BU0772", "SlotId": "10093", "DeviceType": "8000", "ChassisId": "10074", "SlotNumber": "6", "SledBlockPowerOn": "null", "SlotName": "IOM-C2", "ChassisServiceTag": "7BU0772", "SlotType": "4000" }, "DeviceManagement": [], "Enabled": true, "Actions": null, "InventoryDetails@odata.navigationLink": "/api/DeviceService/ Devices(10087)/InventoryDetails", "HardwareLogs@odata.
}, { "@odata.type": "#DeviceService.Device", "@odata.id": "/api/DeviceService/Devices(10340)", "Id": 10340, "Type": 3000, "Identifier": "MX70001", "DeviceServiceTag": "MX70001", "ChassisServiceTag": "7BU0772", "Model": "PowerEdge MX5016s", "PowerState": 17, "ManagedState": 3000, "Status": 1000, "ConnectionState": true, "AssetTag": "1abcdefgh_storage", "SystemId": 2031, "DeviceName": "Storage Sled 8", "LastInventoryTime": "2020-12-30 21:30:16.923", "LastStatusTime": "2020-12-30 10:30:14.
BlinkStatus" "@odata.id": "/api/DeviceService/Devices(10340)/ }, "PowerUsageByDevice@odata.navigationLink": "/api/ DeviceService/Devices(10340)/PowerUsageByDevice", "DeviceBladeSlots@odata.navigationLink": "/api/DeviceService/ Devices(10340)/DeviceBladeSlots", "GraphicInfo": { "@odata.id": "/api/DeviceService/Devices(10340)/ GraphicInfo" }, "DeployRequired": { "@odata.id": "/api/DeviceService/Devices(10340)/ DeployRequired" } } ] } NOTE: The devices order is not guaranteed for multiple device API calls.
{ "@odata.type": "#DeviceService.Device", "@odata.id": "/api/DeviceService/Devices(10074)", "Id": 10074, "Type": 1000, "Identifier": "GMGR064", "DeviceServiceTag": "GMGR064", "ChassisServiceTag": "GMGR064", "Model": "PowerEdge R840", "PowerState": 17, "ManagedState": 3000, "Status": 1000, "ConnectionState": true, "AssetTag": null, "SystemId": 2044, "DeviceName": "WIN-02GODDHDJTC", "LastInventoryTime": "2019-12-02 16:01:33.
VirtualSession" }, "Baselines": { "@odata.id": "/api/DeviceService/Devices(10074)/ Baselines" }, "InventoryDetails@odata.navigationLink": "/api/DeviceService/ Devices(10074)/InventoryDetails", "HardwareLogs@odata.navigationLink": "/api/DeviceService/ Devices(10074)/HardwareLogs", "SubSystemHealth@odata.navigationLink": "/api/DeviceService/ Devices(10074)/SubSystemHealth", "RecentActivity@odata.navigationLink": "/api/DeviceService/ Devices(10074)/RecentActivity", "InventoryTypes": { "@odata.
1, 2, 3, 4, 5, 6, 7, 8, 9, 41, 11, 12, 13, 14, 15, 1009, 17, 50, 18, 30, 31 ], "SlotConfiguration": { "ChassisName": null }, "DeviceManagement": [ { "ManagementId": 5012, "NetworkAddress": "XX.XX.X.XX", "MacAddress": "50:9a:4c:b2:f6:16", "ManagementType": 2, "InstrumentationName": "WIN-02GODDHDJTC", "DnsName": "idrac-gmgr075.smd.devops.dell.com", "ManagementProfile": [ { "ManagementProfileId": 5012, "ManagementId": 5012, "AgentName": "iDRAC", "Version": "3.36.36.36", "ManagementURL": "https://XX.XX.X.
LogSeverities" }, "Settings@odata.navigationLink": "/api/DeviceService/ Devices(10079)/Settings", "Temperature": { "@odata.id": "/api/DeviceService/Devices(10079)/ Temperature" }, "Power": { "@odata.id": "/api/DeviceService/Devices(10079)/Power" }, "SystemUpTime": { "@odata.id": "/api/DeviceService/Devices(10079)/ SystemUpTime" }, "BlinkStatus": { "@odata.id": "/api/DeviceService/Devices(10079)/ BlinkStatus" }, "PowerUsageByDevice@odata.
31 ], "SlotConfiguration": { "ChassisName": null }, "DeviceManagement": [ { "ManagementId": 5028, "NetworkAddress": "XX.XX.X.XX", "MacAddress": "84:7b:eb:d6:6c:1e", "ManagementType": 2, "InstrumentationName": "idrac-SVCTAG", "DnsName": "idrac-svctag.smd.devops.dell.com.", "ManagementProfile": [ { "ManagementProfileId": 5028, "ManagementId": 5028, "AgentName": "iDRAC", "Version": "3.30.30.30", "ManagementURL": "https://XX.XX.X.XX:XXX", "HasCreds": 0, "Status": 1000, "StatusDateTime": "2019-12-02 16:01:47.
DeviceService/Devices(10085)/PowerUsageByDevice", "DeviceBladeSlots@odata.navigationLink": "/api/DeviceService/ Devices(10085)/DeviceBladeSlots", "GraphicInfo": { "@odata.id": "/api/DeviceService/Devices(10085)/ GraphicInfo" }, "DeployRequired": { "@odata.id": "/api/DeviceService/Devices(10085)/ DeployRequired" } } ] } /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.
{ "ManagementId": 5484, "NetworkAddress": "100.97.211.95", "MacAddress": "D0:94:66:91:98:4C", "ManagementType": 2, "InstrumentationName": "MX-MX70005", "DnsName": "", "ManagementProfile":[ { "ManagementProfileId": 5484, "ProfileId": "OME-Modular_BASE", "ManagementId": 5484, "ManagementURL": "https://100.97.211.95:443", "HasCreds": 0, "Status": 1000, "StatusDateTime": "2019-09-06 06:42:47.
NOTE: The attributes values may be displayed as blank, based on the device supportability. /api/DeviceService/Devices(Id)/InventoryDetails This URI represents the inventory details of a specific device. GET method for InventoryDetails This method returns the inventory details of a specific device. Description Returns the inventory details of a specific device. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(DeviceService.
}, { mode]", }, { }, { mode]", }, { ] } "SlotNumber": "ISABridge.Embedded.1-1", "Manufacturer": "Intel Corporation", "Description": "Lewisburg LPC Controller", "DatabusWidth": "Unknown", "SlotLength": "Unknown", "SlotType": "Unknown" "Id": 132, "SlotNumber": "AHCI.Embedded.1-1", "Manufacturer": "Intel Corporation", "Description": "Lewisburg SSATA Controller [AHCI "DatabusWidth": "Unknown", "SlotLength": "Unknown", "SlotType": "Unknown" "Id": 133, "SlotNumber": "P2PBridge.Embedded.
}, { ] } "Hostname": "WIN-02GODDHDJTC" "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('serverVirtualFlashes')", "InventoryType": "serverVirtualFlashes", "InventoryInfo": [] }, { "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('serverPowerSupplies')", "InventoryType": "serverPowerSupplies", "InventoryInfo": [] }, { "@odata.
}, { ] } "PciSlot": 0 "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('serverMemoryDevices')", "InventoryType": "serverMemoryDevices", "InventoryInfo": [ { "Id": 19, "Name": "DIMM.Socket.
}, { ] } "LicenseBound": 4, "EvalTimeRemaining": 0, "AssignedDevices": "iDRAC.Embedded.1", "LicenseStatus": 3000, "EntitlementId": "PX1234567", "LicenseDescription": "iDRAC9 Enterprise License", "LicenseType": { "Name": "Perpetual", "LicenseId": 1 } "@odata.
}, { }, { assigned Storage" }, { capability.
}, { }, { }, { ] } "CapabilityType": { "CapabilityId": 32, "Name": "REMOTE_SSH", "Description": "14G specific features" } "Id": 382, "CapabilityType": { "CapabilityId": 31, "Name": "REMOTE_IPMI", "Description": "14G specific features" } "Id": 383, "CapabilityType": { "CapabilityId": 30, "Name": "REMOTE_RACADM", "Description": "14G specific features" } "@odata.
}, { ] } "EndPointAgents": [ { "ManagementProfileId": 5003, "ProfileId": "", "AgentName": "iDRAC", "Version": "3.20.20.20", "ManagementURL": "https://[ IP Address ]", "Status": 1000, "StatusDateTime": 1504586817807 } ] "@odata.
Controller", "InstallationDate": "2017-06-16T00:54:04Z", "Status": "Installed", "SoftwareType": "FRMW", "ComponentId": "25227", "DeviceDescription": "Integrated Dell Remote Access "InstanceId": "DCIM:INSTALLED#iDRAC.Embedded.1-1#IDRACinfo" }, { "Version": "0", "InstallationDate": "2017-06-16T00:54:12Z", "Status": "Installed", "SoftwareType": "APAC", "ComponentId": "101734", "DeviceDescription": "OS Collector", "InstanceId": "DCIM:INSTALLED#802__OSCollector.Embedded.
}, { }, { }, { }, { } Example response body 288 Devices { ] } ] } "Id": 148, "Status": 1000, "SubsystemName": "batteryRollupStatus" "Id": 149, "Status": 3000, "SubsystemName": "licensingRollupStatus" "Id": 150, "Status": 1000, "SubsystemName": "storageRollupStatus" "Id": 151, "Status": 1000, "SubsystemName": "tempRollupStatus" "Id": 152, "Status": 2000, "SubsystemName": "intrusionRollupStatus" "@odata.context": "/api/ $metadata#Collection(DeviceService.InventoryDetail)", "@odata.
{ }, { }, { }, { }, { ] } "Id": 0, "DeviceId": 10064, "Name": "PSU.Slot.3", "EnableState": "Present", "StateStr": "Present", "HealthState": 1000, "PowerSupplyType": "AC", "PartNumber": "0H7TFGA01", "CapacityWatts": 3000, "InputVoltage": 228, "PowerStatus": "17", "MemberId": "PSU.Slot.3", "InputCurrent": "1.011719Amps" "Id": 0, "DeviceId": 10064, "Name": "PSU.Slot.
}, { }, { }, { }, 290 Devices "Number": "1", "DeviceType": 4000, "VlanId": 0, "IsPrimarySlot": "True", "Occupied": "True", "SlotIdentifier": "0221FRA00CNFCP008B20021", "ServiceTag": "", "SlotDeviceId": 10072, "SlotDeviceName": "IOM-A1", "HealthStatus": 1000, "PowerState": 17, "Model": "PowerEdge MX 25GbE PTM", "Type": 4000, "VlanCapable": false "Id": 10084, "DeviceId": 10064, "Name": "IOM-A2", "Number": "2", "DeviceType": 4000, "VlanId": 0, "IsPrimarySlot": "True", "Occupied": "True", "SlotIdentifier"
{ }, { }, { "Id": 10089, "DeviceId": 10064, "Name": "IOM-C1", "Number": "5", "DeviceType": 8000, "VlanId": 0, "IsPrimarySlot": "True", "Occupied": "True", "SlotIdentifier": "0PG5NRX30CNFCP007BH000S", "ServiceTag": "", "SlotDeviceId": 10077, "HealthStatus": 1000, "PowerState": 17, "Model": "PowerEdge MX5000s", "Type": 4000, "VlanCapable": false "Id": 10090, "DeviceId": 10064, "Name": "IOM-C2", "Number": "6", "DeviceType": 8000, "VlanId": 0, "IsPrimarySlot": "True", "Occupied": "True", "SlotIdentifier": "0
}, { "IsPrimarySlot": "True", "SledBlockPowerOn": "None blocking", "Occupied": "True", "SlotIdentifier": "73K002V", "ServiceTag": "73K002V", "SlotDeviceId": 10066, "SlotDeviceName": "WIN-CVED6GV1QP3", "HealthStatus": 1000, "PowerState": 17, "Model": "PowerEdge MX740c", "DnsName": "iDRAC-73K002V", "Type": 2000, "VlanCapable": true "Id": 10093, "DeviceId": 10064, "Name": "Sled-3_LOM_PF_SLED_1234567890!@#$ %^&*(SLED_1234567890!@#$%^&*(SLED_1234567890!@#$%^&*(SLED_1234567890!@#$ %^&*(SLED_1234567890!@#$%^&*(S
}, { "VlanId": 1, "IsPrimarySlot": "True", "SledBlockPowerOn": "None blocking", "Occupied": "True", "SlotIdentifier": "83S00PD", "ServiceTag": "83S00PD", "SlotDeviceId": 10069, "HealthStatus": 1000, "PowerState": 17, "Model": "PowerEdge MX740c", "DnsName": "idrac-83S00PD", "Type": 2000, "VlanCapable": true "Id": 10096, "DeviceId": 10064, "Name": "Sled-6_ESXI_PF_SLEDSLED_1234567890!@#$ %^&*(SLED_1234567890!@#$%^&*(SLED_1234567890!@#$%^&*(SLED_1234567890!@#$ %^&*(SLED_1234567890!@#$%^&*(SLED_1234567890!@#$%
}, { }, { }, { }, { 294 Devices "SlotIdentifier": "MX70001", "ServiceTag": "MX70001", "SlotDeviceId": 10080, "HealthStatus": 1000, "PowerState": 17, "Model": "PowerEdge MX5016s", "Type": 2000, "VlanCapable": true "Id": 10125, "DeviceId": 10064, "Name": "1", "Number": "1", "DeviceType": 0, "VlanId": 0, "IsPrimarySlot": "True", "Occupied": "True", "SlotIdentifier": "Fan.Slot.
}, { }, { }, { }, { }, { "Id": 10129, "DeviceId": 10064, "Name": "5", "Number": "5", "DeviceType": 0, "VlanId": 0, "IsPrimarySlot": "True", "Occupied": "True", "SlotIdentifier": "Fan.Slot.5", "SlotDeviceId": 0, "HealthStatus": 1000, "PowerState": 17, "Type": 3000, "VlanCapable": false "Id": 10130, "DeviceId": 10064, "Name": "6", "Number": "6", "DeviceType": 0, "VlanId": 0, "IsPrimarySlot": "True", "Occupied": "True", "SlotIdentifier": "Fan.Slot.
}, { }, { }, { }, { 296 Devices "IsPrimarySlot": "True", "Occupied": "True", "SlotIdentifier": "Fan.Slot.9", "SlotDeviceId": 0, "HealthStatus": 1000, "PowerState": 17, "Type": 3000, "VlanCapable": false "Id": 10134, "DeviceId": 10064, "Name": "1", "Number": "1", "DeviceType": 0, "VlanId": 0, "IsPrimarySlot": "True", "Occupied": "True", "SlotIdentifier": "PSU.Slot.
}, { }, { }, { ] } "Id": 10138, "DeviceId": 10064, "Name": "5", "Number": "5", "DeviceType": 0, "VlanId": 0, "IsPrimarySlot": "True", "Occupied": "True", "SlotIdentifier": "PSU.Slot.5", "SlotDeviceId": 0, "HealthStatus": 1000, "PowerState": 17, "Type": 6000, "VlanCapable": false "Id": 10139, "DeviceId": 10064, "Name": "6", "Number": "6", "DeviceType": 0, "VlanId": 0, "IsPrimarySlot": "True", "Occupied": "True", "SlotIdentifier": "PSU.Slot.
{ }, { }, { }, { }, { }, { 298 Devices "Id": 0, "DeviceId": 10064, "Name": "Front Fan 1", "MemberId": "Fan.Slot.1", "FirmwareVersion": "01.00.01", "HardwareVersion": "1", "Status": 1000, "Speed": 4366, "SpeedUnits": "RPM", "Pwm": "23", "PwmUnits": "Percent", "State": "17" "Id": 0, "DeviceId": 10064, "Name": "Front Fan 2", "MemberId": "Fan.Slot.2", "FirmwareVersion": "01.00.
}, { }, { }, { }, { ] } "DeviceId": 10064, "Name": "Rear Fan 2", "MemberId": "Fan.Slot.6", "FirmwareVersion": "01.00.01", "HardwareVersion": "1", "Status": 1000, "Speed": 4720, "SpeedUnits": "RPM", "Pwm": "32", "PwmUnits": "Percent", "State": "17" "Id": 0, "DeviceId": 10064, "Name": "Rear Fan 3", "MemberId": "Fan.Slot.7", "FirmwareVersion": "01.00.
}, { }, { }, { }, { }, { }, { }, { 300 Devices "Id": 0, "LowerThresholdCritical": "-7", "LowerThresholdNoncritical": "3", "UpperThresholdCritical": "42", "UpperThresholdNoncritical": "39", "SensorName": "Sled 1 Inlet Temperature", "MemberId": "System.Modular.
}, { ] } "UpperThresholdNoncritical": "43", "SensorName": "Sled 7 Inlet Temperature", "MemberId": "System.Modular.7", "Status": "1000", "ReadingCelsius": "22" "@odata.type": "#DeviceService.InventoryDetail", "@odata.id": "/api/DeviceService/Devices(10064)/ InventoryDetails('deviceLicense')", "InventoryType": "deviceLicense", "InventoryInfo": [] }, { "@odata.type": "#DeviceService.InventoryDetail", "@odata.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 302 Devices "PartNumber": "0H7TFGA01", "SerialNumber": "CNDED008AI02HV" "Id": 2684, "Manufacturer": "", "Name": "Rear Fan 5", "PartNumber": "0FHH0KX30", "SerialNumber": "CNFCP007AR01EI" "Id": 2682, "Manufacturer": "", "Name": "PSU.Slot.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { ] } "Id": 2686, "Manufacturer": "", "Name": "Rear Fan 3", "PartNumber": "0FHH0KX30", "SerialNumber": "CNFCP007AR00WG" "Id": 2674, "Manufacturer": "", "Name": "Front Fan 4", "PartNumber": "0FHH0KX30", "SerialNumber": "CNFCP007AR02HO" "Id": 2688, "Manufacturer": "", "Name": "Front Fan 1", "PartNumber": "0FHH0KA00", "SerialNumber": "CNFCP009AC0047" "Id": 2683, "Manufacturer": "", "Name": "Rear Fan 1", "PartNumber": "0FHH0KX30", "SerialNumber": "CNFC
}, { "@odata.type": "#DeviceService.InventoryDetail", "@odata.id": "/api/DeviceService/Devices(10064)/ InventoryDetails('deviceManagement')", "InventoryType": "deviceManagement", "InventoryInfo": [ { "ManagementId": 5667, "IpAddress": "100.97.208.
}, { }, { }, { }, { }, { }, { }, { ] } "Status": "Installed", "SoftwareType": "FRMW", "ComponentId": "104849", "DeviceDescription": "PSU.Slot.5", "InstanceId": "PSU.Slot.5" "Version": "00.68.5F", "InstallationDate": "NA", "Status": "Installed", "SoftwareType": "FRMW", "ComponentId": "104849", "DeviceDescription": "PSU.Slot.6", "InstanceId": "PSU.Slot.6" "Version": "00.68.5F", "InstallationDate": "NA", "Status": "Installed", "SoftwareType": "FRMW", "ComponentId": "104849", "DeviceDescription": "PSU.
InventoryDetails('chassisStackMemberList')", "InventoryType": "chassisStackMemberList", "InventoryInfo": [ { "ChassisModel": "", "ChassisName": "", "LinkState": "Up", "NeighborChassisMAC": "", "NeighborChassisType": "TOR", "NeighborMgmtIPv4": "", "NeighborMgmtIPv6": "", "NeighborPortName": "", "ServiceTag": "", "SystemID": "", "LinkSpeed": "unknown", "NeighborChassisId": "GBE.
Individual filters You can also use individual filters in this URI. Example response body GET for the following URI: /api/DeviceService/Devices(3315)/ InventoryDetails('subsystemRollupStatus') Output: { "@odata.context": "$metadata#DeviceService.InventoryDetail/$entity", "@odata.
/api/DeviceService/Devices(Id)/ InventoryDetails(InventoryType) This URI represents the details of a specific inventory type for a specific device. GET method for inventory details by inventory type This method returns the details of a specific inventory type. NOTE: If a PSU is absent, this method reports the status as follows: ● Presence: Absent ● Health: Ok ● Power state: Off Description Returns details of a specific inventory type.
"SubVendorId": "1077", "ComponentId": "0", "PciDeviceId": "8070", "DeviceDescription": "QLogic 2x25GE QL41262HMKR CNA 34:80:0D:86:9A:AF", "InstanceId": "DCIM:INSTALLED#701__NIC.Mezzanine.1A-2-1" }, { "Version": "15.00.14", "InstallationDate": "2020-11-19 18:08:35.
"PciDeviceId": "", "DeviceDescription": "Disk 0 in Backplane 0 of Integrated RAID Controller 1", "InstanceId": "DCIM:INSTALLED#304_C_Disk.Bay.0:Enclosure.Internal.0-0:RAID.Integrated.1 -1" }, { "Version": "4.40.10.00", "InstallationDate": "2020-12-29 08:37:00.000", "Status": "Installed", "SoftwareType": "APAC", "VendorId": "", "SubDeviceId": "", "SubVendorId": "", "ComponentId": "28897", "PciDeviceId": "", "DeviceDescription": "Lifecycle Controller", "InstanceId": "DCIM:INSTALLED#802__USC.Embedded.1:LC.
Controller", }, { } Example request body Example response body ] } "PciDeviceId": "", "DeviceDescription": "Integrated Dell Remote Access "InstanceId": "DCIM:INSTALLED#iDRAC.Embedded.1-1#IDRACinfo" "Version": "25.5.6.0009", "InstallationDate": "2020-11-12 20:42:45.000", "Status": "Installed", "SoftwareType": "FRMW", "VendorId": "1000", "SubDeviceId": "1FD1", "SubVendorId": "1028", "ComponentId": "0", "PciDeviceId": "005D", "DeviceDescription": "PERC H730P MX", "InstanceId": "DCIM:INSTALLED#301_C_RAID.
"ModelNumber": "SSDSC2KB480G8R", "SerialNumber": "BTYF9411094Y480BGN", "SasAddress": "4433221107000000", "Revision": "XCV1DL67", "ManufacturedDay": 0, "ManufacturedWeek": 0, "ManufacturedYear": 0, "EncryptionAbility": false, "FormFactor": "2500", "PartNumber": "CN0VPP5PPESIT9AH00WKA01", "PredictiveFailureState": "No", "EnclosureId": "Disk.Bay.0:Enclosure.Internal.0-0:RAID.Integrated.1-1", "Channel": 0, "Size": "446.62GB", "FreeSpace": "0 bytes", "UsedSpace": "446.
} ] } ] } "ProfileId": "", "AgentName": "iDRAC", "HasCreds": 2, "Version": "3.20.20.20", "ManagementURL": "https://100.69.115.107:443", "Status": 1000, "StatusDateTime": "09-28-2020 15:00:00.000" /api/DeviceService/Devices(Id)/ Settings('ReplicableChassisConfigurations') This URI retrieves the chassis time and alert destination settings and applies the settings to the IOM.
/api/DeviceService/Devices(DEVICE_ID)/ Settings('NetworkServices') This URI represents the network services configuration. PUT method for network services settings This method configures the network services settings. Description Configures the network services settings.
} "SettingType": "LocalAccessConfiguration", "EnableChassisPowerButton": true, "EnableKvmAccess": true, "LedPresence": "Absent", "QuickSync": { "QuickSyncHardware": "Absent", "QuickSyncAccess": "READ_WRITE", "EnableInactivityTimeout": true, "TimeoutLimit": 120, "TimeoutLimitUnit": "SECONDS", "EnableReadAuthentication": true, "EnableQuickSyncWifi": true }, "EnableChassisDirect": true, "LcdAccess": "VIEW_AND_MODIFY", "LcdPresence": "Present", "LcdCustomString": "My Custom String", "LcdLanguage": "en", "LcdOv
"QuickSyncAccess": "READ_WRITE", "EnableInactivityTimeout": true, "TimeoutLimit": 120, "TimeoutLimitUnit": "SECONDS", "EnableReadAuthentication": true, "EnableQuickSyncWifi": true } }, "EnableChassisDirect": true, "LcdAccess": "VIEW_AND_MODIFY", "LcdPresence": "Present", "LcdCustomString": "", "LcdLanguage": "en" Disabling Chassis Direct feature Example request body { } Example response body { } Enabling LCD Override pin Devices "SettingType": "LocalAccessConfiguration", "EnableChassisPowerButton":
"EnableKvmAccess": true, "LedPresence": "Absent", "QuickSync": { "QuickSyncHardware": "Absent", "QuickSyncAccess": "READ_WRITE", "EnableInactivityTimeout": true, "TimeoutLimit": 120, "TimeoutLimitUnit": "SECONDS", "EnableReadAuthentication": true, "EnableQuickSyncWifi": true }, "EnableChassisDirect": true, "LcdAccess": "VIEW_AND_MODIFY", "LcdPresence": "Present", "LcdCustomString": "", "LcdLanguage": "en", } /api/DeviceService/Devices(Id)/HardwareLogs This URI represents the hardware logs of a specific dev
"LogMessageId": "USR0030", "LogMessage": "Successfully logged in using root, from 10.32.19.194 and wsman.", "LogId": "DCIM:LifeCycleLog:286412", "LogCategory": "Audit", "DateFormat": "CIM" }, { "LogTimestamp": "20170907053540.000000-300", "LogSequenceNumber": 286411, "LogSeverity": 1000, "LogComment": "[set comment here]", "LogMessageId": "USR0030", "LogMessage": "Successfully logged in using root, from 10.32.22.88 and wsman.
}, { }, { } ] } "SubSystem": "Memory", "RollupStatus": "2000" "SubSystem": "Temperature", "RollupStatus": "1000" /api/DeviceService/Devices(Id)/RecentActivity This URI represents the recent activities for a specific device. GET method for RecentActivity This method returns the recent activities for a specific device. Description Returns the recent activities for a specific device. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
/api/DeviceService/Devices(Id)/InventoryTypes This URI represents the inventory types for a specific device. GET method for InventoryTypes This method returns the inventory types for a specific device. Description Returns the inventory types for a specific device. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#DeviceService.InventoryTypes/$entity", "@odata.
} "Info": 1000 NOTE: The severity "Unknown": 5000 is not displayed by REST. To view logs in Unknown state, use the web interface. /api/DeviceService/Devices(Id)/Settings This URI represents the settings of a specific device. GET method for Settings This method returns the details of the settings of a specific device. Description Returns the details of the settings of a specific device. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
GET method for device settings by type This method returns the available attributes under a specific setting type. Description Returns the available attributes under a specific setting type. Privilege VIEW HTTP response codes 200 Example for network settings for IOM Example response body { } Example for network settings for Chassis 322 Devices "@odata.context": "/api/$metadata#DeviceService.DeviceSetting/$entity", "@odata.type": "#DeviceService.DeviceSetting", "@odata.
"EnableAutoconfiguration": true, "StaticIPv6Address": "", "StaticPrefixLength": "0", "StaticGateway": "", "UseDHCPv6ObtainDNSServerAddresses": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" } }, "GeneralSettings": { "EnableNIC": true, "RegisterDNS": false, "DnsName": "MX7000", "UseDHCPForDomainName": false, "DnsDomainName": "", "AutoNegotiation": true, "NetworkSpeed": "1_GB", "Delay": 0 } PUT method for device settings by type This method updates the attributes under a specific sett
Example for network settings for IOM Example response body { } Example for IOM names Example response body { Example for network settings for Chassis 324 Devices "@odata.id": "/api/DeviceService/Devices(25773)/Settings('Network')", "EnableMgmtVLANId": false, "@odata.context": "/api/$metadata#DeviceService.
{ } Example for network settings for Chassis } "EnableNIC": true, "RegisterDNS": false, "DnsName": "MX7000", "UseDHCPForDomainName": false, "DnsDomainName": "", "AutoNegotiation": true, "NetworkSpeed": "1_GB", "Delay": 0 Example response body { } "SettingType": "Network", "DhcpProvisioning": null, "MgmtVLANId": "1", "EnableVLAN": false, "Ipv4Settings": { "EnableIPv4": true, "EnableDHCP": true, "StaticIPAddress": "", "StaticSubnetMask": "", "StaticGateway": "", "UseDHCPObtainDNSServerAddresses": true,
HTTP response codes 200 Example response body { "@odata.context": "$metadata#DeviceService.TemperatureResponseModel/ $entity", "@odata.id": "/api/DeviceService/Devices(3265)/Temperature", "peakTemperatureUnit": "celsius", "avgTemperatureUnit": "celsius", "DateFormat": "CIM", "instantaneousTemperatureUnit": "celsius", "avgTemperatureTimeStamp": "20170907071015.
Example response body { } "@odata.context": "$metadata#DeviceService.PowerResponseModel/$entity", "@odata.id": "/api/DeviceService/Devices(3265)/Power", "avgPower": "0", "systemEnergyConsumptionUnit": "killowatt-hour", "systemEnergyConsumptionTimeStamp": "20170907071147.450000-300", "powerUnit": "watt", "minimumPowerTimeStamp": "19691231180000.000000-360", "avgPowerUnit": "watt", "minimumPower": "65535", "peakPower": "73", "DateFormat": "CIM", "systemEnergyConsumption": "0.000", "Since": "20170414145039.
} ] } "Id": 4465, "SlotName": "Sled-3", "PowerState": 18, "SlotType": 2000, "DeviceName": "" /api/DeviceService/Devices(Id)/GraphicInfo This URI represents the graphics information of a specific device. GET method for GraphicInfo This method returns the graphics-related information of a specific device. Description Returns the graphics-related information of a specific device. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#DeviceService.
/api/DeviceService/Devices(Id)/DeployRequired This API represents the device deployment results. GET method for deployment by device IDs This method returns the results for deployment on devices by IDs. Description Returns the results for deployment on devices by IDs. Privilege HTTP response code Example response body 200 { "@odata.context": "/api/$metadata#DeviceService.DeployRequired", "@odata.type": "#DeviceService.DeployRequired", "@odata.
/api/DeviceService/Actions/ DeviceService/Devices(Id)Actions/ DeviceService.UploadFSDCertificate This API represents Field Service Debug (FSD) certificate information. POST method for uploading FSD certificate This method returns information about the FSD certificate upload process. Description Returns information about the FSD certificate upload process.
/api/DeviceService/DeviceStatuses This URI represents the statuses that the devices can be in. GET method for DeviceStatuses This method returns a list of statuses for the devices. Description Returns a list of statuses for the devices. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(DeviceService.DeviceStatus)", "@odata.count": 5, "value": [ { "GlobalStatus": 1000, "Name": "NORMAL", "Description": "The device is running normal.
Example response body { } "@odata.context": "$metadata#Collection(DeviceService.DeviceType)", "@odata.
/api/DeviceService/Actions/DeviceService/ Devices(Id)Actions/DeviceService.GetTermState This API represents term state information for devices. POST method for getting term state This method returns term state information. Description Returns term state information. Privilege DEVICE_CONFIGURATION HTTP response codes 202 Table 106. Attributes Attribute name Description Id—Devices(Id) ID of the device. /api/DeviceService/Actions/DeviceService/ Devices(Id)Actions/DeviceService.
Privilege VIEW HTTP response codes 200 Example response body 334 Devices { "@odata.context": "$metadata#Collection(DeviceService.DeviceSummary)", "@odata.count": 6, "value": [ { "@odata.id": "/api/DeviceService/DeviceSummary(1000)", "DeviceType": 1000, "TotalCount": 2, "DeviceStatusSummary": [ { "StatusType": 1000, "Count": 1 }, { "StatusType": 2000, "Count": 0 }, { "StatusType": 3000, "Count": 0 }, { "StatusType": 4000, "Count": 1 }, { "StatusType": 5000, "Count": 0 } ] }, { "@odata.
}, { }, { }, { }, { }, { }, { ] } "Count": 0 "StatusType": 2000, "Count": 0 "StatusType": 3000, "Count": 0 "StatusType": 4000, "Count": 0 "StatusType": 5000, "Count": 0 "@odata.id": "/api/DeviceService/DeviceSummary(4000)", "DeviceType": 4000, "TotalCount": 0, "DeviceStatusSummary": [ { "StatusType": 1000, "Count": 0 }, { "StatusType": 2000, "Count": 0 }, { "StatusType": 3000, "Count": 0 }, { "StatusType": 4000, "Count": 0 }, { "StatusType": 5000, "Count": 0 } ] "@odata.
}, { } ] } ] "@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/DeviceSummary(Type) This API represents the device summary information by device status type.
"StatusType": 3000, "Count": 0 }, { "@odata.type": "#DeviceService.DeviceStatusSummary", "StatusType": 4000, "Count": 0 }, { "@odata.type": "#DeviceService.DeviceStatusSummary", "StatusType": 5000, "Count": 0 } ] } api/DeviceService/Actions/ DeviceService.DevicesPrivilegesAction This API represents the device privilege information that users have for devices. POST method for api/DeviceService/Actions/ DeviceService.
HTTP response code Example request body 201 { "Privileges": [] } Example response body { “Privileges”: [“VIEW”,”CHASSIS_ADMINISTRATOR”] } /api/DeviceService/Actions/ DeviceService.ExecuteAction This API represents the remote console preview information. POST method /api/DeviceService/Actions/ DeviceService.ExecuteAction This method returns the remote console preview information. Description Returns the remote console preview information.
}, { }, { }, { }, { }, { } ] } "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.
}, { }, { }, { }, { }, { }, { }, { }, { }, { 340 Devices "Property": "redundancyPolicy", "Key": "GRID_REDUNDANCY", "Value": "GRID Redundancy", "Description": "Redundancy policy type is GRID redundancy" "@odata.type": "#DeviceService.DeviceSettingsMetadata", "Id": 5000, "Property": "dhcpProvisioning", "Key": "DISABLED", "Value": "Disabled", "Description": "Dhcp Provisioning is disable" "@odata.type": "#DeviceService.
}, { }, { }, { }, { }, { }, { }, { }, { }, { "Property": "timeoutLimitUnit", "Key": "SECONDS", "Value": "Seconds", "Description": "Time out limit unit is seconds" "@odata.type": "#DeviceService.DeviceSettingsMetadata", "Id": 15000, "Property": "timeoutLimitUnit", "Key": "MINUTES", "Value": "Minutes", "Description": "Time out limit unit is minutes" "@odata.type": "#DeviceService.
}, { }, { }, { }, { ] } } "Property": "lcdLanguage", "Key": "fr", "Value": "French", "Description": "French" "@odata.type": "#DeviceService.DeviceSettingsMetadata", "Id": 19005, "Property": "lcdLanguage", "Key": "de", "Value": "German", "Description": "German" "@odata.type": "#DeviceService.DeviceSettingsMetadata", "Id": 19006, "Property": "lcdLanguage", "Key": "es", "Value": "Spanish", "Description": "Spanish" "@odata.type": "#DeviceService.
{ }, { }, { }, { } ] } ] } "Id": 1, "NetworkAddress": "xx.xx.xx.xx" "@odata.id": "/api/DeviceService/GlobalExcludes(2)", "Id": 2, "Identifier": null, "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 2, "NetworkAddress": "xx.xx.xx.xx" } ] "@odata.id": "/api/DeviceService/GlobalExcludes(3)", "Id": 3, "Identifier": "R930PR0", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 3, "NetworkAddress": "xx.xx.xx.xx" } ] "@odata.
/api/DeviceService/Actions/ DeviceService.AddNetworkRange This URI adds ranges to the globally excluded range. POST method for DeviceService.AddNetworkRange This method adds ranges to global exclusion. Description Adds network ranges to global exclusion. Privilege APPLIANCE_SETUP HTTP response codes 204 Example request body { } "Id": 0, "Identifier": "IPRange2", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 0, "NetworkAddress": "xx.xx.xx.xx-xx.xx.xx.
/api/DeviceService/Actions/ DeviceService.RemoveFromExclusion This URI removes ranges from Global Exclusion. POST method for DeviceService.RemoveFromExclusion This method removes ranges in global exclusion. Description Removes ranges in global exclusion. Privilege APPLIANCE_SETUP HTTP response codes 204 Example request body {"Ids": [1,2,3,4,5,6]} /api/DeviceService/Actions/ DeviceService.ValidateExcludes This URI validates global exclusion. POST method for DeviceService.
/api/DeviceService/Actions/ DeviceService.RemoveDevices This URI deletes an array of devices. POST method for DeviceService.RemoveDevices Description Deletes an array of devices.
8 Diagnostic Topics: • /api/DeviceService/Devices(Id)/Actions/DeviceService.Diagnostic /api/DeviceService/Devices(Id)/Actions/ DeviceService.Diagnostic This URI allows you to execute supported diagnostic commands. POST method for DeviceService.Diagnostic This method executes the supported diagnostics commands. Description Executes supported diagnostic commands.
9 Groups Topics: • • • • • • • • • • • • • • • • • • /api/GroupService/Groups /api/GroupService/Groups(Id) /api/GroupService/Groups(Id)/Devices /api/GroupService/Groups(Id)/GroupDevicesSummary /api/GroupService/Groups(group id)/AllLeafDeviceSummaries /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000 /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0 /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25
} ] } "UpdatedBy": "", "Visible": true, "DefinitionId": 500, "DefinitionDescription": "Root group for all Types of Devices.", "TypeId": 2000, "MembershipTypeId": 24, "Devices": [ { "@odata.id": "/api/GroupService/Groups(64)/Devices" } ], "AllLeafDevices": [ { "@odata.id": "/api/GroupService/Groups(64)/AllLeafDevices" } ], "GroupHierarchy": [ { "@odata.id": "/api/GroupService/Groups(64)/GroupHierarchy" } ], "SubGroups": [ { "@odata.
Table 107. Attributes (continued) Attribute name Description MembershipTypeId Group membership type. ● 12 — Static ● 24 — Dynamic Link Devices Group link to list group devices. AllLeafDevices Group link to list all group sub groups devices. GroupHierarchy Group link to list the group hierarchy. SubGroup Group link to display the list of sub groups of this group. GroupDevicesSummary Group link to display a summary of all group devices. Table 108.
Example response body { } "@odata.context": "$metadata#GroupService.Group/$entity", "@odata.id": "/api/GroupService/Groups(64)", "Id": 64, "Name": "All Devices", "Description": "Group associated to all devices.", "GlobalStatus": 5000, "ParentId": 0, "CreationTime": "2017-06-08 18:48:27.069", "UpdatedTime": "2017-06-08 21:15:01.746", "CreatedBy": "system", "UpdatedBy": "", "Visible": true, "DefinitionId": 500, "DefinitionDescription": "Root group for all Types of Devices.
Table 109. Attributes (continued) Attribute name Description DefinitionDescription Definition description of the group. TypeId Group type. ● 1000 — Internal ● 2000 — Predefined ● 3000 — User defined ● 4000 — Discovery defined ● 5000 — MCM group MembershipTypeId Group membership type. ● 12 — Static ● 24 — Dynamic Link Devices Group link to list group devices. AllLeafDevices Group link to list all group sub groups devices. GroupHierarchy Group link to list the group hierarchy.
} "DefinitionDescription": "" DELETE method for Groups(Id) This method deletes a group from the collection. Description Deletes a group. Privilege DEVICE_CONFIGURATION HTTP response codes 204 Example request body { } "Id": 1564 Table 110. 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.
"DeviceName": "WIN-02GODDHDJTC", "LastInventoryTime": "2017-06-08 14:10:43.965", "LastStatusTime": "2017-06-08 21:31:41.
"Settings": [ { "@odata.id": "/api/DeviceService/Devices(1614)/Settings" } ], "Temperature": { "@odata.id": "/api/DeviceService/Devices(1614)/Temperature" }, "Power": { "@odata.id": "/api/DeviceService/Devices(1614)/Power" }, "BlinkStatus": { "@odata.id": "/api/DeviceService/Devices(1614)/BlinkStatus" }, "PowerUsageByDevice": [ { "@odata.id": "/api/DeviceService/Devices(1614)/ PowerUsageByDevice" } ], "Faults": [ { "@odata.id": "/api/DeviceService/Devices(1614)/Faults" } ], "DeviceBladeSlots": [ { "@odata.
"$metadata#Collection(GroupService.GroupDevicesSummary)", "@odata.count": 1, "value": [ { "DeviceType": 1000, "TotalCount": 55, "GroupDevicesStatusSummary": [ { "StatusType": 1000, "Count": 29 }, { "StatusType": 2000, "Count": 5 }, { "StatusType": 3000, "Count": 4 }, { "StatusType": 4000, "Count": 17 }, { "StatusType": 5000, "Count": 0 } ] } ] } Table 112. Attributes Attribute name Description Id ID of the group.
}, { "Model": "PowerEdge FM120", "Identifier": "8FWV992d", "DeviceServiceTag": "8FWV992", "Type": 1000, "Status": 1000, "PowerState": 18, "ConnectionState": true, "ManagedState": 3000, "DeviceCapabilities": [ 1, 12, 5, 41, 2, 30, 8, 9, 1009, 10, 14, 4, 6, 3, 18, 15, 7, 31, 13, 50 ], "DeviceManagement": [ { "DeviceId": 14164, "ManagementId": 5000, "NetworkAddress": "XXX.XX.XXX.
12, 1, 31, 10, 1009, 9, 2, 41, 8, 7, 6, 5, 50 }, { ], "DeviceManagement": [ { "DeviceId": 14214, "ManagementId": 5001, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "74:86:7a:e5:c5:fc", "InstrumentationName": "idrac-2476qm2.fwtestwin.com", "ManagementProfile": [ { "ManagementProfileId": 5001, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.63.60.62", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
"DeviceId": 14264, "ManagementId": 5002, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "74:86:7a:e5:c5:f8", "InstrumentationName": "idrac-8FWV992a", "ManagementProfile": [ { "ManagementProfileId": 5002, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.63.60.62", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] }, { } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
}, { "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
1001, 18, 41 }, { ], "DeviceManagement": [ { "DeviceId": 15112, "ManagementId": 5010, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "64:00:6a:c4:13:a8", "InstrumentationName": "MINWINPC", "ManagementProfile": [ { "ManagementProfileId": 5010, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.61.60.60", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
"@odata.type": "#DeviceService.DeviceMinModel", "@odata.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(15132)", "Id": 15132, "DeviceName": "100.97.133.
}, { "ManagedState": 3000, "DeviceCapabilities": [ 16, 4, 5, 30, 50, 6, 41, 7, 2, 8, 33, 1009, 9, 10, 11, 31, 12, 1, 13, 18, 14, 15, 17, 3 ], "DeviceManagement": [ { "DeviceId": 15133, "ManagementId": 5299, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:8c:ec:7a", "InstrumentationName": "idrac-4598BS2", "ManagementProfile": [ { "ManagementProfileId": 5299, "ManagementId": 0, "AgentName": "iDRAC", "Version": "3.36.36.36", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.
30, 6, 2, 1, 12, 17, 1009, 33, 3, 15, 8, 1006, 14, 18, 31, 50 }, { ], "DeviceManagement": [ { "DeviceId": 15136, "ManagementId": 5073, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:8e:a9:d1", "InstrumentationName": "idrac-GGWD9V2", "ManagementProfile": [ { "ManagementProfileId": 5073, "ManagementId": 0, "AgentName": "iDRAC", "Version": "3.36.36.36", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
}, { "DeviceServiceTag": "6FP7F2S", "Type": 1000, "Status": 2000, "PowerState": 1, "ConnectionState": false, "ManagedState": 3000, "DeviceCapabilities": [ 9, 3, 2, 7, 10, 31, 41, 1, 12, 6, 13, 30, 5, 14, 4, 15, 18, 1009, 8 ], "DeviceManagement": [ { "DeviceId": 15230, "ManagementId": 5176, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "5c:f9:dd:d6:9d:54", "InstrumentationName": "idrac-6FP7F2S", "ManagementProfile": [ { "ManagementProfileId": 5176, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.
5, 8, 4, 15, 33, 18, 30, 7, 1, 12, 6, 10 }, { ], "DeviceManagement": [ { "DeviceId": 15231, "ManagementId": 5178, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "10:98:36:9b:03:7f", "InstrumentationName": "localhost", "ManagementProfile": [ { "ManagementProfileId": 5178, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.63.60.61", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
{ }, { "DeviceId": 15232, "ManagementId": 5180, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "10:98:36:9a:62:c1", "InstrumentationName": "idrac-1LPSG52", "ManagementProfile": [ { "ManagementProfileId": 5180, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.63.60.61", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
}, { "Id": 15251, "DeviceName": "100.97.133.57", "Model": "PowerEdge MX740c", "Identifier": "17YFBS2", "DeviceServiceTag": "17YFBS2", "Type": 1000, "Status": 1000, "PowerState": 17, "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 4, 16, 12, 1009, 8, 11, 7, 1, 14, 2, 9, 3, 10, 18, 17, 15, 41, 13, 33 ], "DeviceManagement": [ { "DeviceId": 15251, "ManagementId": 5211, "NetworkAddress": "XXX.XX.XXX.
6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 30, 31, 33, 41, 50, 1001, 1009 }, { ], "DeviceManagement": [ { "DeviceId": 15252, "ManagementId": 5303, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:8b:4d:b3", "InstrumentationName": "WIN-FP7P1J8GN1B", "ManagementProfile": [ { "ManagementProfileId": 5303, "ManagementId": 0, "AgentName": "iDRAC", "Version": "3.36.36.36", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.
{ }, { ] } "ManagementProfileId": 5294, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http://XXX.XX.XXX.XX" "DeviceId": 15253, "ManagementId": 5295, "NetworkAddress": "2607:f2b1:f083:133::2b6", "MacAddress": "20:04:0F:13:3C:E2", "InstrumentationName": "MX5108n Ethernet Switch", "ManagementProfile": [ { "ManagementProfileId": 5295, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http:// [2607:f2b1:f083:133::2b6]" } ] } ], "IpAddress": "XXX.XX.XXX.
3, 7, 2, 18, 8 ], "DeviceManagement": [ { "DeviceId": 15255, "ManagementId": 5292, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "20:04:0F:12:DF:62", "InstrumentationName": "MX5108n Ethernet Switch", "ManagementProfile": [ { "ManagementProfileId": 5292, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http://XXX.XX.XXX.
}, { "Id": 15382, "DeviceName": "100.97.135.63", "Model": "PowerEdge M620", "Identifier": "4T36G2S", "DeviceServiceTag": "4T36G2S", "Type": 1000, "Status": 3000, "PowerState": 17, "ConnectionState": true, "ManagedState": 3000, "DeviceCapabilities": [ 1009, 7, 1001, 2, 6, 4, 5, 50, 12, 15, 14, 10, 31, 18, 1, 30, 9, 3, 13, 41, 8 ], "DeviceManagement": [ { "DeviceId": 15382, "ManagementId": 5222, "NetworkAddress": "XXX.XX.XXX.
14, 13, 12, 31, 11, 1, 10, 9, 33, 41, 8, 7, 6, 50, 5, 4, 17, 3, 1009, 2, 18 }, { ], "DeviceManagement": [ { "DeviceId": 15388, "ManagementId": 5306, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:8b:49:4f", "InstrumentationName": "WIN-8U5E5RHPHL0", "ManagementProfile": [ { "ManagementProfileId": 5306, "ManagementId": 0, "AgentName": "iDRAC", "Version": "3.36.36.36", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.
10, 11, 31, 2, 12, 16, 13, 14 }, { ], "DeviceManagement": [ { "DeviceId": 15389, "ManagementId": 5301, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:87:af:3c", "InstrumentationName": "idrac-4RKG9V2", "ManagementProfile": [ { "ManagementProfileId": 5301, "ManagementId": 0, "AgentName": "iDRAC", "Version": "3.36.36.36", "ManagementURL": "https://XXX.XX.XXX.XX:xxx" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
} ] /api/GroupService/Groups(group id)/ AllLeafDeviceSummaries?$filter=Type eq 4000 This URL returns the device data by specifying the device type. Get method for AllLeafDeviceSummaries?$filter=Type eq 4000 Description Returns the device data specified by device type. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(DeviceService.DeviceMinModel)", "@odata.count": 5, "value": [ { "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
}, { "DeviceId": 15253, "ManagementId": 5295, "NetworkAddress": "2607:f2b1:f083:133::2b6", "MacAddress": "20:04:0F:13:3C:E2", "InstrumentationName": "MX5108n Ethernet Switch", "ManagementProfile": [ { "ManagementProfileId": 5295, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http:// [2607:f2b1:f083:133::2b6]" } ] } ], "IpAddress": "XXX.XX.XXX.XX" }, { "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
}, { "DeviceId": 15255, "ManagementId": 5292, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "20:04:0F:12:DF:62", "InstrumentationName": "MX5108n Ethernet Switch", "ManagementProfile": [ { "ManagementProfileId": 5292, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http://XXX.XX.XXX.
} ] } "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 7, 3, 5, 9, 8, 2, 1 ], "DeviceManagement": [ { "DeviceId": 15390, "ManagementId": 5296, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "88:94:71:DB:E8:98", "InstrumentationName": "MXG610s FC Switch 2SFP", "ManagementProfile": [ { "ManagementProfileId": 5296, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http://XXX.XX.XXX.XX" } ] } ], "IpAddress": "XXX.XX.XXX.
"@odata.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(15253)", "Id": 15253, "DeviceName": "MX5108n Ethernet Switch", "Model": "MX5108n Ethernet Switch", "Identifier": "8Y280T2", "DeviceServiceTag": "8Y280T2", "Type": 4000, "Status": 1000, "PowerState": 17, "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 18, 1, 3, 8, 2, 9, 7, 5 ], "DeviceManagement": [ { "DeviceId": 15253, "ManagementId": 5294, "NetworkAddress": "XXX.XX.XXX.
}, { "ManagedState": 7000, "DeviceCapabilities": [ 2, 7, 9, 5, 1, 3 ], "DeviceManagement": [], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
}, { "@odata.type": "#DeviceService.DeviceMinModel", "@odata.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(15256)", "Id": 15256, "DeviceName": "IOM-B1", "Model": "MX7116n Fabric Expander Module", "Identifier": "902B0T2", "DeviceServiceTag": "902B0T2", "Type": 4000, "Status": 1000, "PowerState": 17, "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 3, 9, 1, 2, 7, 5 ], "DeviceManagement": [], "IpAddress": "XXX.XX.XXX.XX" }, { "@odata.type": "#DeviceService.
} /api/GroupService/Groups(group id)/ AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0&$orderby=Identifier asc This URL returns the device data by specifying the order—ascending or descending. GET method for AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0&$orderby=Identifier asc Description Returns the device data by specifying the order—ascending or descending. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
} }, { ] } "ManagementURL": "http://XXX.XX.XXX.XX" ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
"Id": 15253, "DeviceName": "MX5108n Ethernet Switch", "Model": "MX5108n Ethernet Switch", "Identifier": "8Y280T2", "DeviceServiceTag": "8Y280T2", "Type": 4000, "Status": 1000, "PowerState": 17, "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 18, 1, 3, 8, 2, 9, 7, 5 ], "DeviceManagement": [ { "DeviceId": 15253, "ManagementId": 5294, "NetworkAddress": "XXX.XX.XXX.
2, 7, 9, 5, 1, 3 }, { ], "DeviceManagement": [], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
"CreationTime": "2017-06-08 21:34:42.681", "UpdatedTime": "2017-06-08 21:34:42.681", "CreatedBy": "root", "UpdatedBy": "", "Visible": true, "DefinitionId": 400, "DefinitionDescription": "UserDefined", "TypeId": 3000, "MembershipTypeId": 12, "Devices": [ { "@odata.id": "/api/GroupService/Groups(19164)/Devices" } ], "AllLeafDevices": [ { "@odata.id": "/api/GroupService/Groups(19164)/AllLeafDevices" } ], "GroupHierarchy": [ { "@odata.
Table 113. Attributes (continued) Attribute name Description ● 4000 — Discovery defined ● 5000 — MCM group MembershipTypeId Group membership type. ● 12 — Static ● 24 — Dynamic Link Devices Group link to list group devices. AllLeafDevices Group link to list all group sub groups devices. GroupHierarchy Group link to list the group hierarchy. SubGroup Group link to display the list of sub groups of this group. GroupDevicesSummary Group link to display a summary of all group devices.
/api/GroupService/GroupTypes This URI represents the group types. GET method for GroupTypes This method returns a list of all the group types. Description Returns all the group types. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(GroupService.GroupType)", "@odata.count": 5, "value": [ { "@odata.id": "/api/GroupService/GroupTypes(1000)", "Id": 1000, "Name": "Internal Group", "Description": "Internal group.
/api/GroupService/GroupTypes(Id) This URI represents a group type within the collection. GET method for GroupTypes(Id) This method returns the details of a specific group from the collection. Description Returns the details of a specific group. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#GroupService.GroupType/$entity", "@odata.id": "/api/GroupService/GroupTypes(1000)", "Id": 1000, "Name": "Internal Group", "Description": "Internal group.
} ] } "@odata.id": "/api/GroupService/MembershipTypes(24)", "Id": 24, "Name": "Dynamic", "Description": "Dynamic type" Table 117. Attributes Attribute name Description Id ID of the membership type. Name Name of the membership type. Description Description of the membership type. /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.
/api/GroupService/AllGroupsHierarchy This URI represents the hierarchy of all the groups and subgroups. GET method for AllGroupsHierarchy This method returns the hierarchy of all the groups and subgroups. Description Returns the hierarchy of all the groups and subgroups. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(GroupService.GroupHierarchy)", "@odata.
/api/GroupService/Actions/ GroupService.GroupsPrivilegesAction POST method for GroupService.GroupsPrivilegesAction This method returns the group privileges for the logged-in user. Description Returns the group privileges for the user. To view the privileges of multiple groups, provide the group IDs separated by a comma.
“Privileges”: [[] // ex. [“DEVICE_UPDATE”] } Example response body List of groups on which the user the specified privilege.
10 Monitor Topics: • • Audit logs Jobs Audit logs /api/ApplicationService/AuditLogs This URI represents a collection of audit logs of the system. GET method for AuditLogs This method returns a collection of audit logs of the system. Description Returns a collection of audit logs. Privilege VIEW HTTP response codes 200 Example response body { } 394 Monitor "@odata.context": "$metadata#Collection(ApplicationService.AuditLog)", "@odata.count": 7, "value": [ { "@odata.
/api/ApplicationService/AuditLogCategories This API represents information about audit log categories. GET method for /api/ApplicationService/AuditLogCategories This method returns the audit log categories. Description Returns the audit log categories. Privilege HTTP response code Example response body 200 { "@odata.context": "/api/ $metadata#Collection(ApplicationService.AuditLogCategories)", "@odata.count": 1, "value":[ { "@odata.type": "#ApplicationService.
"Severity": "1000", "Message": "Successfully logged in.", "Category": "Audit", "UserName": "root", "IpAddress": "xx.xx.xx.xx", "MessageArgs": "root || xx.xx.xx.xx", "MessageID": "CUSR0001", "CreatedDate": "2017-04-26 16:13:57.880" } Table 119. Attributes Attribute Description Id Identifier of the SessionService. Severity Severity of the event or error message. Possible values are Critical, Warning, and Informational. Message Message text. Category Category of the message.
"StartTime": null, "EndTime": null, "Schedule": "0 0/30 * 1/1 * ? *", "State": "Enabled", "CreatedBy": "admin", "UpdatedBy": null, "Visible": false, "Editable": false, "Builtin": true, "Targets": [ { "JobId": 10016, "Id": 500, "Data": "All-Devices", "TargetType": { "Id": 6000, "Name": "GROUP" } } ], "Params": [ { "JobId": 10016, "Key": "defaultInventoryTask", "Value": "TRUE" } ], "LastRunStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" }, "JobType": { "@odata.
Table 120. Filters (continued) Filter name Description Visible Filter by group visibility NextRunBegin Filter by job next run time start. NextRunEnd Filter by next run time end. LastRunBegin Filter by last run time start. LastRunEnd Filter by last run time end. Table 121. Attributes Attribute Description Id ID of the job. JobName Name of the job. JobDescription Description of the job. JobType Type of the job. NextRun The next time when the job will be performed.
POST method for Jobs This method creates a job. Description Creates a job.
"JobId": 26097, "Id": 25915, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } } ], "Params": [], "Visible": true, "Editable": true, "Builtin": false Table 122. Attributes Attribute Description Target Id ID of the device. SlotNumber The supported slot numbers are: ● 1-8 for computes ● 1-6 for IOMs Slot Type The supported slot types are: ● 2000 for computes ● 4000 for IOM PowerState The supported values are: ● 2 (Power On)—Transitions the system to "power on" state.
Table 122.
"Targets": [{"Id":, "Data":";", "TargetType":{"Id":1000, "Name":"Device"}}, {"Id":, "Data":";", "TargetType":{"Id":1000, "Name":"Device"}}, ........
} ], "Params": [ { "Key": "slotConfig", "Value": "1|1000|SLED1" }, { "Key": "operationName", "Value": "UPDATE_SLOT_DATA" } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task" } POST method for quick deploy of sleds Example response body { "JobName": "Quick Deploy", "JobDescription": "New Quick Deploy Configuration", "Schedule": "startnow", "State": "Enabled", "Targets": [], "Params": [ { "Key": "slotId=5", "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.
"Key": "slotId=2", "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1" }, { "Key": "slotId=4", "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1" }, { "Key": "slotId=1", "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { } ] } "Key": "gatewayV4", "Value": "" "Key": "networkTypeV6", "Value": "" "Key": "protocolTypeV6", "Value": "" "Key": "prefixLength", "Value": "" "Key": "gatewayV6", "Value": "" "Key": "slotId=1", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" "Key": "slotId=2", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" "Key": "slotId=3", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" "Key": "slotId=4", "Val
{ }, { }, { } ] } "Key": "operationName", "Value": "CONFIGURE_FEC_OPTICS" "Key": "interfaceId", "Value": "53F2PK2:ethernet1/1/10:1" "" "Key": "fecValue", "Value": "xx" "" POST method for IOM power off operation Example response body { "JobName": "Power Off (Non-graceful)", "JobDescription": "Power Control Task: Power Off (Non-graceful)", "Schedule": "startnow", "State": "Enabled", "Targets": [ { "Id": 10660, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE"
} "Name":"RollbackSoftware_Task" }, "Params":[ { "Key":"operationName", "Value":"INSTALL_FIRMWARE" }, { "Key":"stagingValue", "Value":"false" }, { "Key":"signVerify", "Value":"true" } ], "Targets":[ { "Id":, "Data": "available=", "TargetType":{ "Id":1000, "Name":"Device" } } ] POST method for rolling back firmware update using catalog method Example response body { } "JobName":"Rollback Firmware", "Schedule":"", "State":"Enabled", "JobType":{ "Id": 15, "Name":
POST method for rolling back firmware update using browse method Example response body { } "JobName":"Rollback Firmware", "Schedule":"", "State":"Enabled", "JobType":{ "Id": 15, "Name":"RollbackSoftware_Task" }, "Params":[ { "Key":"operationName", "Value":"INSTALL_FIRMWARE" }, { "Key":"stagingValue", "Value":"false" }, { "Key":"signVerify", "Value":"true" } ], "Targets":[ { "Id":, "Data": "unavailable= <13 Digit File Token>|", "TargetType":{ "Id":1000, "Name":"D
POST method for chassis backup Chassis backup Example response body { "Id": 0, "JobName": "Backup Task", "JobDescription": "Create a Backup of the chassis", "Schedule": "startnow", "State": "Enabled", "Targets": [], "Params": [ { "Key": "shareName", "Value": "Floder_Name" }, { }, { }, { }, { }, { }, { }, { } "Key": "backup_filename", "Value": "backup file name.
}, { }, { }, { }, { }, { }, { }, { ], } "Value": "" "Key": "backup_filename", "Value": "
{ }, { }, { }, { }, { }, { "JobId": 13286, "Key": "shareType", "Value": "CIFS" "JobId": 13286, "Key": "profile_option", "Value": "export" "JobId": 13286, "Key": "password", "Value": "EQ32BUg9RN+PoY31J3690IXthTHKwHOXAShI2vnN9xA=" "JobId": 13286, "Key": "userName", "Value": "administrator" "JobId": 13286, "Key": "shareName", "Value": "/share" "JobId": 13286, "Key": "shareAddress", "Value": "100.97.204.81" } ], "LastRunStatus": { "@odata.type": "#JobService.
{ }, { }, { ], { } } } "Key": "ShareNetworkFilePath", "Value": "" "Key": "shareAddress", "Value": "" "Key": "testShareWriteAccess", "Value": "true" "JobType": "Id": 56, "Name": "ValidateNWFileShare_Task" POST method for chassis extract logs—local share Example response body { } 412 Monitor "JobName": "Extract Log", "JobDescription": "Extract device log", "Schedule": "startnow", "State": "Enabled", "Targets": [ { "Id": 25016, "Data": "", "TargetType": { "Id": 1000, "Name"
POST method for chassis extract logs NFS share Example response body { } "JobName": "Extract Log", "JobDescription": "Extract device log to NFS location", "Schedule": "startnow", "State": "Enabled", "Targets": [ { "Id": 25016, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "shareAddress", "Value": "2607:f2b1:f083:218::1f2" }, { "Key": "shareName", "Value": "share" }, { "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" }, { "Key": "shareType", "Value": "NFS" }, { "Key"
{ }, { }, { }, { }, { }, { } "Key": "password", "Value": "sharepass" "Key": "userName", "Value": "administrator" "Key": "shareType", "Value": "CIFS" "Key": "shareName", "Value": "cifs" "Key": "shareAddress", "Value": "2607:f2b1:f083:218::1f2" "Key": "maskSensitiveInfo", "Value": "FALSE" } ], "JobType": { "Id": 18, "Name": "DebugLogs_Task" } POST method for device based reseat for compute storage or IOM Example response body 414 Monitor { "JobName": "Virtual_Reseat", "JobDescription": " Virtual_Reseat
POST method for slot based reseat for compute storage or IOM Example response body { "JobName": "Slot Based Virtual Reseat", "JobDescription": "Virtual_Reseat_Slot_based", "Schedule": "startnow", "State":"Enabled", "Targets": [ { "Id": 25045, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "slotType", "Value": "2000" }, { "Key": "operationName", "Value": "VIRTUAL_RESEAT" }, { "Key": "slotNumber", "Value": "6" } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task", "Inte
"Key": "deviceTypes", "Value": "1000" } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task", "Internal": false } } POST method for blade server or sled power off operation Example response body { "JobName": "Power Off (Non-graceful)", "JobDescription": "Power Control Task: Power Off (Non-graceful)", "Schedule": "startnow", "State": "Enabled", "Targets": [ { "Id": 10771, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } }], "Params": [ { "Key": "override", "Value": "true" }, { "Key": "powerState"
} } "Id": 1000, "Name": "DEVICE" ], "Params": [ { "Key": "slotNumber", "Value": "2" }, { "Key": "operationName", "Value": "RESET_IDRAC" }, { "Key": "slotType", "Value": "2000" } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task", "Internal": false } } Where Slot type is always 2000 for compute SLED and ID "10099" is for chassis ID.
POST method for blink LED Example response body { "Id": 0, "JobName": "Blink LED", "JobDescription": "Blink LED: N Minute(s) or Indefinitely", "Schedule": "startnow", "State": "Enabled", "JobType": { "Name": "DeviceAction_Task" }, "Targets": [ { "Id": 10043, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "identifyState", "Value": "2" // 2 = duration in minutes, -1= indefinitely }, { "Key": "durationLimit", "Value": "60" // 60= 1 minute, 600=10 minutes, 1800=30 minutes
}, { }, { }, { } ] } "Key": "powerState", "Value": "5" "Key": "operationName", "Value": "POWER_CONTROL" "Key": "deviceTypes", "Value": "1000" POST method for system reseat Example response body { } "Id": 0, "JobName": "System Reseat", "JobDescription": "Power Control Task: System Reseat", "State": "Enabled", "Schedule": "startnow", "JobType": { "Name": "DeviceAction_Task" }, "Targets": [ { "Id": 10043, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "operationNam
{ } ] } "Id": 10043, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } POST method for configure port breakout Example response body { "JobName": "Breakout Port", "JobDescription": null, "Schedule": "startnow", "State": "Enabled", "JobType": { "Id": 3, "Name": "DeviceAction_Task", "Internal": false }, "Targets": [ { "Id": 10045, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ {"Key": "breakoutType", "Value": “FabricExpander"}, {"Key": "interfaceId", "Value": "DPM4
} ] {"Key": "upInterfaceIds", "Value": "DPM4XC1:port-group1/1/1"}, {"Key": "operationName", "Value": "TOGGLE_PORT_STATUS"} POST method for group inventory Example response body { } "Id": 0, "JobName": "Default Inventory Task - All Devices ", "JobDescription": "Default Inventory Task - All Devices", "Schedule": "startnow", "State": "Enabled", "JobType": { "Name": "Inventory_Task" }, "Targets": [ { "Id": 500, "Data": "", "TargetType": { "Id": 6000, "Name": "GROUP" } } ] POST method for device inventory
"Id": 18, "Name": "DebugLogs_Task" } }, "Targets": [ { "Id": 10036, "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" }, { "Key": "shareAddress", "Value": "100.69.127.105" }, { "Key": "shareName", "Value": "\\cifs\\share" }, { "Key": "shareType", "Value": "CIFS" }, { "Key": "userName", "Value": "user-provided-user-name" }, { "Key": "password", "Value": "user-provided-password" }, { "Key": "domainName", "Value": "org-domain-name" }, { "Key":
} ], "Params":[ { "Key":"OPERATION_NAME", "Value":"EXTRACT_LOGS" }, { "Key":"shareType", "Value":"NFS" }, { "Key":"shareAddress", "Value":"1.2.3.
"Id":3, "Name":"DeviceAction_Task"} , "Params":[{"Key":"operationName", "Value":"CONFIGURE_VLAN_ON_PORTS"} , {"Key":"InterfaceId","Value":"HRA0013:ethernet1/1/43"}, {"Key":"NativeVlan","Value":"99"}, {"Key": "Networks","Value": "31256,31258"}], "Targets":[{"Id":19301,"Data":"","TargetType": {"Id":4000,"Name":"DEVICE"}}] } /api/JobService/Jobs(Id) This URI represents the details of a job. GET method for Jobs(Id) This method returns the details of a specific job. Description Returns details of a job.
"LastRunStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" }, "JobType": { "@odata.type": "#JobService.JobType", "Id": 8, "Name": "Inventory_Task", "Internal": false }, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2020, "Name": "Scheduled" }, "ExecutionHistories@odata.navigationLink": "/api/JobService/ Jobs(10016)/ExecutionHistories" } Table 123. Attributes Attribute Description Id ID of the job. JobName Name of the job.
Table 123. Attributes (continued) Attribute Description ● ● ● ● ● Links 2090 — Warning 2100 — Aborted 2101 — Paused 2102 — Stopped 2103 — Canceled Link to access all execution histories. PUT method for Jobs(Id) This method updates a specific job. Description Updates a job.
} "JobType": { "Id": 8, "Name": "Inventory_Task", "Internal": false }, "JobStatus": { "Id": 2080, "Name": "New" }, "Targets": [ { "JobId": 26097, "Id": 25915, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [], "Visible": true, "Editable": true, "Builtin": false Table 124. Attributes Attribute Description Id ID of the job. JobName Name for the job. JobDescription Description for the job. Schedule The schedule to start the job. State Enabled state for the job.
/api/JobService/JobStatuses This URI represents the status of all the jobs. GET method for JobStatuses This method returns the status of all the jobs. Description Returns status of all the jobs. Privilege VIEW HTTP response codes 200 Example response body 428 Monitor { "@odata.context": "/api/$metadata#Collection(JobService.JobStatus)", "@odata.count": 12, "value": [ { "@odata.type": "#JobService.JobStatus", "@odata.
{ }, { }, { }, { } ] } "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2100)", "Id": 2100, "Name": "Aborted" "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2101)", "Id": 2101, "Name": "Paused" "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2102)", "Id": 2102, "Name": "Stopped" "@odata.type": "#JobService.JobStatus", "@odata.
/api/JobService/JobTypes This URI represents all the job types. GET method for JobTypes This method returns the details of all the job types. Description Returns details of all job types. Privilege VIEW HTTP response codes 200 Example response body 430 Monitor { "@odata.context": "/api/$metadata#Collection(JobService.JobType)", "@odata.count": 15, "value": [ { "@odata.type": "#JobService.JobType", "@odata.
}, { }, { }, { }, { }, { }, { }, { }, { } ] } "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(22)", "Id": 22, "Name": "ChassisProfile_Task", "Internal": false "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(25)", "Id": 25, "Name": "SettingsUpdate_Task", "Internal": false "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(50)", "Id": 50, "Name": "Device_Config_Task", "Internal": false "@odata.type": "#JobService.
/api/JobService/JobTypes(Id) This URI represents the details of a job type. GET method for JobTypes(Id) This method returns the details of a specific job type. Description Returns details of a job type. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#JobService.JobType/$entity", "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(5)", "Id": 5, "Name": "Update_Task", "Internal": false Table 129.
"StartTime": "2018-09-14 15:00:00.059", "EndTime": "2018-09-14 15:00:30.211", "LastUpdateTime": "2018-09-14 15:00:30.211", "ExecutedBy": "admin", "JobId": 10016, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" }, "ExecutionHistoryDetails@odata.navigationLink": "/api/JobService/ Jobs(10016)/ExecutionHistories(18855)/ExecutionHistoryDetails" }, { "@odata.type": "#JobService.ExecutionHistory", "@odata.
"Name": "Completed" }, "ExecutionHistoryDetails@odata.navigationLink": "/api/JobService/ Jobs(10016)/ExecutionHistories(18729)/ExecutionHistoryDetails" }, { "@odata.type": "#JobService.ExecutionHistory", "@odata.id": "/api/JobService/Jobs(10016)/ ExecutionHistories(18683)", "Id": 18683, "JobName": "Default Inventory Task", "Progress": "100", "StartTime": "2018-09-14 13:00:00.122", "EndTime": "2018-09-14 13:00:29.769", "LastUpdateTime": "2018-09-14 13:00:29.
HTTP response codes Example response body 200 { "@odata.context": "/api/ $metadata#Collection(JobService.ExecutionHistoryDetail)", "@odata.count": 2, "value": [ { "@odata.type": "#JobService.ExecutionHistoryDetail", "@odata.id": "/api/JobService/Jobs(10016)/ ExecutionHistories(18683)/ExecutionHistoryDetails(7138)", "Id": 7138, "Progress": "100", "StartTime": "2018-09-14 13:00:00.324", "EndTime": "2018-09-14 13:00:29.728", "Key": "Sled-1", "Value": "Running\nCompleted", "ExecutionHistoryId": 18683, "JobSt
/api/JobService/Actions/JobService.EnableJobs POST method for JobService.EnableJobs This method enables the selected jobs. Description Enables the selected jobs.
} Or { } "Filters": { "Status": 2020, "State": "", "JobType": "AlertSubscription_Task", "StartTime": "2017-06-06 10:00:00.00", "EndTime": "2017-06-07 10:00:00.00" } Or { } "AllJobs": true, /api/JobService/Actions/JobService.RemoveJobs POST method for JobService.RemoveJobs This method deletes the selected jobs. Description Deletes the selected jobs.
/api/JobService/Actions/JobService.Schedule This API represents the job schedule information. POST method for job schedule This method returns the job schedule information. Description Returns information about job schedules. Privilege JOB_MANAGEMENT HTTP response codes 201 Example response body { } "JobIds": [], "AllJobs": true, "Filters": { "Status": 2020, "State": "", "JobType": "", "StartTime": "", "EndTime": "" } /api/JobService/Actions/JobService.RunJobs POST method for JobService.
{ } Example request body "AllJobs": true, To check the firmware compliance {"JobIds":[10205],"AllJobs":false} /api/JobService/Actions/JobService.StopJobs POST method for JobService.StopJobs This method stops the selected jobs. Description Stops the selected jobs.
/api/JobService/Actions/JobService.Schedule This API represents the job schedule information. POST method for job schedule This method returns the job schedule information. Description Returns information about job schedules. Privilege JOB_MANAGEMENT HTTP response codes 201 Example response body { } "JobIds": [], "AllJobs": true, "Filters": { "Status": 2020, "State": "", "JobType": "", "StartTime": "", "EndTime": "" } /api/JobService/Actions/JobService.
/api/JobService/Actions/JobService.Cancel This API represents information about jobs that are canceled. POST method for canceled jobs This method returns information about jobs that are canceled. Description Returns information about a canceled job. Privilege DEVICE_CONFIGURATION HTTP response codes 201 Example response body { } "JobIds": [], "AllJobs": true, "Filters": { "Status": 2020, "State": "", "JobType": "", "StartTime": "", "EndTime": "" } /api/JobService/Actions/JobService.
/api/JobService/Actions/JobService.Resume This API returns information about jobs that are resumed. POST method for resumed jobs This method returns information about jobs that are resumed. Description Returns information about jobs that are resumed. Privilege DEVICE_CONFIGURATION HTTP response codes 201 Example response body { } "JobIds": [], "AllJobs": true, "Filters": { "Status": 2020, "State": "", "JobType": "", "StartTime": "", "EndTime": "" } /api/JobService/Actions/JobService.
"JobType": { "Id":3, "Name":"DeviceAction_Task" } } Monitor 443
11 Reset application Topics: • /api/ApplicationService/Actions/ApplicationService.ResetApplication /api/ApplicationService/Actions/ ApplicationService.ResetApplication This URI resets the application and select between resetting all data or only resetting the configuraiton. POST method for ResetApplication This method resets the application. You can either reset only the configuration or also clear all the data.
12 Console version Topics: • /api/ApplicationService/Info /api/ApplicationService/Info This URI represents the product information. GET method for Info This method returns the product information. Description Returns the product information. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#ApplicationService.Info", "@odata.type": "#ApplicationService.Info", "@odata.
13 Console capabilities Topics: • /api/ApplicationService/Capabilities /api/ApplicationService/Capabilities This URI represents the capabilities of the management console—OpenManage Enterprise or OME–Modular. GET method for Capabilities This method returns the capabilities of the management console—OME-Modular or OpenManage Enterprise. These two management consoles have different capabilities. Description Returns the capabilities of the management console.
{ "@odata.type": "#ApplicationService.Capability", "Name": "SERVER_PORTS_NIC_TEAMING", "Description": "Capability bit to indicate that provided MX chassis supports server ports NIC teaming." }, { "@odata.type": "#ApplicationService.Capability", "Name": "OPTIMIZED_FABRIC_MANAGER_OPERATIONS", "Description": "Capability bit to indicate that provided MX chassis supports optimized fabric manager operations." } ] } Example of application capabilities of OpenManage Enterprise { "@odata.
14 Search This resource enables you to search for navigation links and documents using query strings. Use the URIs in this resource to search for navigation links and documents by providing search query strings. Topics: • /api/SearchService/Actions/SearchService.Search /api/SearchService/Actions/SearchService.Search POST method for SearchService.Search This method performs a search using the query string that you provide and returns links to the corresponding navigation pages.
Example response body { "took": 87, "timed_out": false, "_shards": { "total": 1, "successful": 1, "failed": 0 }, "hits":{ "total": 11, "max_score": 10, "hits": [ { "_index": "OME-Modular", "_type": "tasks", "_id": "3864", "_score": 1, "_source": { "tskNm": "Device_Config_Task (1493523261197) - for Device with Id: 1864", "tskTyp": "Device Config Task", "tskStatus": "Task status is Failed", "tskDesc": "Device_Config_Task (1493523261197) - for Device with Id: 1864", "tskCreatedBy": "system", "tskId": "3864"
15 Session Topics: • • • • • • • /api/SessionService /api/SessionService/Sessions /api/SessionService/Sessions(Id) /api/SessionService/CurrentUser /api/SessionService/SessionConfiguration /api/SessionService/Actions/SessionService.SessionConfigurationUpdate /api/SessionService/Actions/SessionService.Logoff /api/SessionService This URI represents the collection of session services. GET method for SessionService This method returns a collection of the sessions services.
Table 133. Attributes (continued) Attribute Name Description Sessions The link to the collection of active sessions. /api/SessionService/Sessions This URI represents a collection of active session services. GET method for Sessions This method returns the collection of active session service. Description Returns a collection of active session services. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(SessionService.Session)", "@odata.
POST method for Sessions This method authenticates the user and establishes a session. Description Authenticates the user and establishes a session. Privilege SECURITY_SETUP HTTP response codes 200 Example request body { } Example response body { } "UserName":"root", "Password":"linux", "SessionType":"API" "Id": "7b723932-a119-4843-a5b7-7a122e4def99", "Description": "root", "Name": "API", "UserName": "root", "Password": null, "Roles": [ "ADMINISTRATOR" ], "IpAddress": "xx.xx.xx.
/api/SessionService/Sessions(Id) This method represents the instance of a session. GET method for Sessions(Id) This method returns the sessions associated with the User ID. Description Returns the session associated with the user ID.
HTTP response codes 204 /api/SessionService/CurrentUser This URI represents the session details of the current user. GET method for session details of current user This method fetches the roles and privileges details of the current user. Description Fetches roles and privileges details of the current user. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#SessionService.SessionUser", "@odata.type": "#SessionService.SessionUser", "@odata.
$metadata#Collection(SessionService.SessionConfiguration)", "@odata.count": 5, "value": [ { "@odata.type": "#SessionService.SessionConfiguration", "SessionType": "GUI", "MaxSessions": 6, "SessionTimeout": 1800000, "MinSessionTimeout": 60000, "MaxSessionTimeout": 7200000, "MinSessionsAllowed": 1, "MaxSessionsAllowed": 6, "MaxSessionsConfigurable": true, "SessionTimeoutConfigurable": true }, { "@odata.type": "#SessionService.
/api/SessionService/Actions/ SessionService.SessionConfigurationUpdate POST method for SessionService.SessionConfigurationUpdate Description This method adds the ability to configure the inactivity (not active sessions) timeout interval and the maximum number of sessions that are enabled per session type. When these properties are changed, the properties of the current active sessions are not terminated or modified.
HTTP response codes 200 Example response body None Session 457
16 APIs specific to OpenManage Enterprise – Modular Edition Topics: • • • • • • • • • • • • • • /api/ApplicationService/Settings /api/ApplicationService/Network/CurrentAddressConfiguration /api/ApplicationService/Network/AddressConfiguration /api/ApplicationService/Actions/ApplicationService.GetConfiguration /api/ApplicationService/Actions/ApplicationService.
● SLOT_NAME ● DNS_NAME POST method for /api/ApplicationService/Settings This method returns the application service settings. Description Returns one or more application settings. You can get the name of the setting and the group, using this API. Privilege APPLIANCE_SETUP HTTP response codes 201 Example Response Body 1 { "ConsoleSetting": [{ "Name": "WARRANTY_EXPIRY_SETTING", "DefaultValue": "90", "Value": "1", "DataType": "java.lang.
HTTP response codes Example response body 200 { "@odata.context": "/api/$metadata#Network.CurrentAddressConfiguration/ $entity", "@odata.type": "#Network.CurrentAddressConfiguration", "@odata.id": "/api/ApplicationService/Network/ CurrentAddressConfiguration", "Ipv4Setting": { "Enable": true, "EnableDHCP": true, "CurrentIPAddress": "xx.xx.xx.xx", "CurrentSubnetMask": "255.255.255.0", "CurrentGateway": "192.168.1.1", "UseDHCPForDNSServerNames": true, "CurrentPreferredDNSServer": "192.168.1.
Table 137. Attributes (continued) Attribute name Description Ipv6Setting.CurrentPreferredDNSServer Current IPv6 DNS preferred server. Ipv6Setting.CurrentAlternateDNSServer Current IPv6 DNS alternate server. DnsSetting.DnsFQDName Current FQDN registered. DnsSetting.DnsDomainName Current Domain Name. /api/ApplicationService/Network/ AddressConfiguration This URI represents the network configuration. NOTE: This API is not available in OpenManage Enterprise from version 3.3.1.
"RegisterWithDNS": false, "DnsName": "MX7000", "UseDHCPForDNSDomainName": false, "DnsDomainName": "" } }, "Delay": 0 PUT method for AddressConfiguration This method updates the network configuration. Description Updates the network configuration. Privilege APPLIANCE_SETUP HTTP response codes 200 Example request body { "@odata.context": "/api/$metadata#Network.AddressConfiguration/ $entity", "@odata.type": "#Network.AddressConfiguration", "@odata.
"Enable": true, "EnableDHCP": true, "StaticIPAddress": "", "StaticSubnetMask": "", "StaticGateway": "", "UseDHCPForDNSServerNames": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" } }, "Ipv6Configuration": { "Enable": false, "EnableAutoConfiguration": true, "StaticIPAddress": "", "StaticPrefixLength": 0, "StaticGateway": "", "UseDHCPForDNSServerNames": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "ManagementVLAN": { "EnableVLAN": false, "Id": 1 }, "DnsConfig
Table 138. Attributes (continued) Attribute name Description Ipv6Configuration.UseDHCPForDNSServerNames Obtain IPv6 DNS servers via DHCP server options. Ipv6Configuration.StaticPreferredDNSServer Set Static IPv6 DNS preferred server. Ipv6Configuration.StaticAlternateDNSServer Set Static IPv6 DNS alternate server. ManagementVLAN.EnableVLAN Enable Tagged VLAN. ManagementVLAN.Id Set VLAN ID. DnsConfiguration.RegisterWithDNS Register/Unregister with DNS server. DnsConfiguration.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Name": "Preference.1#DeviceName", "Value": "SLOT_NAME" "Name": "LoginSecurity.1#Id", "Value": "10" "Name": "LoginSecurity.1#LockoutFailCount", "Value": 3 "Name": "LoginSecurity.1#LockoutFailCountTime", "Value": 30 "Name": "LoginSecurity.1#LockoutPenaltyTime", "Value": 900 "Name": "LoginSecurity.1#IPRangeAddr", "Value": null "Name": "LoginSecurity.1#LockoutByUsernameEnable", "Value": false "Name": "LoginSecurity.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 466 "Name": "RemoteSystemLog.4#RemoteSyslogEnable", "Value": false "Name": "RemoteSystemLog.4#destinationAddress", "Value": null "Name": "RemoteSystemLog.4#Port", "Value": 0 "Name": "ChassisPower.1#SystemInputPowerCap", "Value": "6763" "Name": "ChassisPower.1#RedundancyPolicy", "Value": "NO_REDUNDANCY" "Name": "ChassisPower.1#EnablePowerCap", "Value": true "Name": "SNMPAlerts.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Name": "SNMPAlerts.3#port", "Value": 0 "Name": "SNMPAlerts.3#version", "Value": null "Name": "SNMPAlerts.3#CommunityString", "Value": null "Name": "SNMPAlerts.4#Enable", "Value": false "Name": "SNMPAlerts.4#DestinationIP", "Value": null "Name": "SNMPAlerts.4#port", "Value": 0 "Name": "SNMPAlerts.4#version", "Value": null "Name": "SNMPAlerts.4#CommunityString", "Value": null "Name": "TimeConfig.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 468 "Value": "READ_WRITE" "Name": "QuickSync.1#InactivityTimerEnable", "Value": true "Name": "QuickSync.1#InactivityTimeout", "Value": 120 "Name": "QuickSync.1#ReadAuthentication", "Value": true "Name": "QuickSync.1#WifiEnable", "Value": true "Name": "EmailAlertsConf.1#DestinationEmailAddress", "Value": "10.36.0.167" "Name": "EmailAlertsConf.1#portNumber", "Value": 25 "Name": "EmailAlertsConf.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Value": true "Name": "Proxy.1#ipAddress", "Value": null "Name": "Proxy.1#Port", "Value": 0 "Name": "Proxy.1#user", "Value": null "Name": "Proxy.1#password", "Value": null "Name": "Proxy.1#enableAuthentication", "Value": false "Name": "Proxy.
}, { }, { }, { }, { }, { "Name": "Network#Ipv6Settings#EnableIPv6", "Value": false "Name": "Network#Ipv6Settings#EnableAutoconfiguration", "Value": true "Name": "Network#Ipv6Settings#StaticIPv6Address", "Value": "" "Name": "Network#Ipv6Settings#StaticPrefixLength", "Value": "0" "Name": "Network#Ipv6Settings#StaticGateway", "Value": "" "Name": "Network#Ipv6Settings#UseDHCPv6ObtainDNSServerAddresses", "Value": true }, { "Name": "Network#Ipv6Settings#StaticPreferredDNSServer", "Value": "" }, { "Name": "Netwo
}, { }, { }, { }, { }, { }, { "Name": "Users.1#Name", "Value": "root" "Name": "Users.1#Privilege", "Value": "10" "Name": "Users.1#Enable", "Value": true "Name": "Users.1#Password", "Value": null "Name": "Users.2#userType", "Value": 1 "Name": "Users.2#SHA256Password", "Value": "$2a$10$zpVUzQIfE3nCOpodYXiz9.A.rr6SAkYcovyTEd49hxL7N83ZeqkqK" }, { "Name": "Users.2#Name", "Value": "ravi2" }, { "Name": "Users.2#Privilege", "Value": "10" }, { "Name": "Users.2#Enable", "Value": true }, { "Name": "Users.
"Name": "Users.4#SHA256Password", "Value": "$2a$10$ntDJPWAkaB5oemKyzLQPG.M5HliotxOby.q9cHPg2XIiYgPZjannC" }, { "Name": "Users.4#Name", "Value": "MK" }, { "Name": "Users.4#Privilege", "Value": "10" }, { "Name": "Users.4#Enable", "Value": true }, { "Name": "Users.4#Password", "Value": null }, { "Name": "Users.5#userType", "Value": 2 }, { "Name": "Users.5#SHA256Password", "Value": "$2a$10$H0cK06cAnceieSNuaI3JT.TI8DfX49XkdVcNbHC4G2X92lAhCAstS" }, { "Name": "Users.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { } } ] } ] } "Name": "ActiveDirectory.1#Port", "Value": 3269 "Name": "ActiveDirectory.1#NetworkTimeout", "Value": 120 "Name": "ActiveDirectory.1#SearchTimeout", "Value": 120 "Name": "ActiveDirectory.1#CertValidationEnable", "Value": false "Name": "ActiveDirectory.1#certificateFile", "Value": "" "Name": "LDAP.1#name", "Value": "LDAP Dell" "Name": "LDAP.1#serverType", "Value": "MANUAL" "Name": "LDAP.1#DomainController1", "Value": "10.
Table 139. Attributes (continued) Attribute Description ServiceTag Chassis Service Tag. TimeStamp Time stamp when the configuration is retrieved. Components Components for which the configuration is retrieved. FQDD A key for each setting. Attributes Key-value pairs of attributes. Name Attribute name. Value Attribute value. /api/ApplicationService/Actions/ ApplicationService.ApplyConfiguration POST method for ApplicationService.ApplyConfiguration This method updates the system settings.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Value": 3 "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.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 476 "Value": 0 "Name": "ChassisPower.1#SystemInputPowerCap", "Value": "6763" "Name": "ChassisPower.1#RedundancyPolicy", "Value": "NO_REDUNDANCY" "Name": "ChassisPower.1#EnablePowerCap", "Value": true "Name": "SNMPAlerts.1#Enable", "Value": true "Name": "SNMPAlerts.1#DestinationIP", "Value": "10.36.0.167" "Name": "SNMPAlerts.1#port", "Value": 162 "Name": "SNMPAlerts.1#version", "Value": "SNMPV1" "Name": "SNMPAlerts.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Value": null "Name": "SNMPAlerts.4#Enable", "Value": false "Name": "SNMPAlerts.4#DestinationIP", "Value": null "Name": "SNMPAlerts.4#port", "Value": 0 "Name": "SNMPAlerts.4#version", "Value": null "Name": "SNMPAlerts.4#CommunityString", "Value": null "Name": "TimeConfig.1#TimeZone", "Value": "TZ_ID_11" "Name": "TimeConfig.1#NTPEnable", "Value": false "Name": "TimeConfig.1#NTPServer1", "Value": null "Name": "TimeConfig.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 478 "Name": "QuickSync.1#ReadAuthentication", "Value": true "Name": "QuickSync.1#WifiEnable", "Value": true "Name": "EmailAlertsConf.1#DestinationEmailAddress", "Value": "10.36.0.167" "Name": "EmailAlertsConf.1#portNumber", "Value": 25 "Name": "EmailAlertsConf.1#useCredentials", "Value": false "Name": "EmailAlertsConf.1#useSSL", "Value": false "Name": "EmailAlertsConf.1#user", "Value": null "Name": "EmailAlertsConf.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Name": "Proxy.1#user", "Value": null "Name": "Proxy.1#password", "Value": null "Name": "Proxy.1#enableAuthentication", "Value": false "Name": "Proxy.
{ }, { }, { "Name": "Network#Ipv6Settings#StaticPrefixLength", "Value": "0" "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": "Netw
}, { }, { }, { "Value": true "Name": "Users.1#Password", "Value": null "Name": "Users.2#userType", "Value": 1 "Name": "Users.2#SHA256Password", "Value": "$2a$10$zpVUzQIfE3nCOpodYXiz9.A.rr6SAkYcovyTEd49hxL7N83ZeqkqK" }, { "Name": "Users.2#Name", "Value": "ravi2" }, { "Name": "Users.2#Privilege", "Value": "10" }, { "Name": "Users.2#Enable", "Value": true }, { "Name": "Users.2#Password", "Value": null }, { "Name": "Users.3#userType", "Value": 1 }, { "Name": "Users.
}, { }, { }, { }, { "Name": "Users.4#Enable", "Value": true "Name": "Users.4#Password", "Value": null "Name": "Users.5#userType", "Value": 2 "Name": "Users.5#SHA256Password", "Value": "$2a$10$H0cK06cAnceieSNuaI3JT.TI8DfX49XkdVcNbHC4G2X92lAhCAstS" }, { "Name": "Users.5#Name", "Value": "OME-ModularMegatronTeam" }, { "Name": "Users.5#Privilege", "Value": "10" }, { "Name": "Users.5#Enable", "Value": true }, { "Name": "Users.5#objectGuid", "Value": "d22005b6-0ce5-40ed-88d0-7f7759b52f25" }, { "Name": "Users.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { } Example response body { } } ] } ] } "Value": 120 "Name": "ActiveDirectory.1#CertValidationEnable", "Value": false "Name": "ActiveDirectory.1#certificateFile", "Value": "" "Name": "LDAP.1#name", "Value": "LDAP Dell" "Name": "LDAP.1#serverType", "Value": "MANUAL" "Name": "LDAP.1#DomainController1", "Value": "10.36.0.167" "Name": "LDAP.1#Port", "Value": 636 "Name": "LDAP.1#BaseDN", "Value": "dc=dell,dc=com" "Name": "LDAP.
Table 140. Attributes (continued) Attribute Description Components Components for which the configuration is retrieved. FQDD A key for each setting. Attributes Key-value pairs of attributes. Name Attribute name. Value Attribute value. 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.
/api/ApplicationService/Actions/ApplicationService.ActivateBrand This URI allows you to change the branding between the default brand or de-branded. POST method for ActivateBrand This method activates the default brand or keeps the environment de-branded. Description Activate the default brand or keep it de-branded, based on the provided brand type.
"Actions": null, "Domains@odata.navigationLink": "/api/ManagementDomainService/Domains", "PendingDomains@odata.navigationLink": "/api/ManagementDomainService/ PendingDomains", "DiscoveredDomains@odata.navigationLink": "/api/ ManagementDomainService/DiscoveredDomains", "ConfigurationTypes@odata.navigationLink": "/api/ ManagementDomainService/ConfigurationTypes" } Output — Member chassis: { "@odata.context": "/api/ $metadata#ManagementDomainService.ManagementDomainService", "@odata.
}, { }, { "ConfigType": "TimeSettings", "Enabled": true "ConfigType": "SecuritySettings", "Enabled": true "ConfigType": "SessionConfiguration", "Enabled": true } ], "VirtualIPConfiguration": null, "LeadRedundancyStatus": 5000, "OpaquePLId": 10, "SyncFailureAlertTimeout": 30 }, "Actions": null, "Domains@odata.navigationLink": "/api/ManagementDomainService/ Domains", "PendingDomains@odata.navigationLink": "/api/ManagementDomainService/ PendingDomains", "DiscoveredDomains@odata.
Privilege APPLIANCE_SETUP HTTP response codes 200 Example request body Request for creating a group { } Example response body Request for creating a group { } Example request body "JobId": 36183, "Status": "Success" Request for editing a group { 488 "GroupName": "group name", "GroupDescription": "group description", "JoinApproval": "Manual/Automatic", "ConfigReplication": [ { "ConfigType": "UserAuthentication", "Enabled": true }, { "ConfigType": "NetworkServices", "Enabled": true }, { "ConfigTyp
}, { }, { }, { }, { }, { }, { }, { } Example response body } "ConfigType": "UserAuthentication", "Enabled": true "ConfigType": "AlertDestinations", "Enabled": false "ConfigType": "TimeSettings", "Enabled": false "ConfigType": "ProxySettings", "Enabled": false "ConfigType": "SecuritySettings", "Enabled": false "ConfigType": "NetworkServices", "Enabled": false "ConfigType": "LocalAccessConfiguration", "Enabled": false Request for editing a group { } Example request body ] "ConfigType": "Power", "Enable
}, { }, { } Example response body "Enabled": false "ConfigType": "TimeSettings", "Enabled": false "ConfigType": "SecuritySettings", "Enabled": false } ], "VirtualIPConfiguration": { "IPv4": { "StaticIPv4Address":"10.35.155.155", "SubnetMask":"255.255.255.32", "Gateway":"10.35.2.1" } } Request for configuring static IPv4 on the lead chassis { } "GroupId": "4964", "Status": "Success" NOTE: You can use the API, /api/JobService/Jobs(JobId) for polling the job status. Table 142.
/api/ManagementDomainService/DiscoveredDomains This URI represents the chassis domains available on the wired chassis network. GET method for DiscoveredDomains This method returns a list of chassis domains available on the wired chassis network. Description Returns the list of available chassis domains. Each chassis domain returned identifies its role in a MCM domain group, if applicable. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
} ] } "Name": "MX-01UTCOME-Modular", "Description": "POWEREDGE MX7000", "Identifier": "01UTCOME-Modular", "DomainTypeId": 4000, "DomainTypeValue": "OME-M", "DomainRoleTypeId": 3000, "DomainRoleTypeValue": "LEAD", "Version": "1" Table 143. Attributes Attribute Description GroupId Unique identifier of the group across different domains. GroupName Group name for the MCM domain group. GroupDescription Description of the group. Address IP address of the domain. Name Name of the chassis.
"value":[ { "@odata.type": "#ManagementDomainService.ConfigurationType", "@odata.id": "/api/ManagementDomainService/ConfigurationTypes(1)", "Id": 1, "Name": "UserAuthentication", "Description": "User Authentication" }, { "@odata.type": "#ManagementDomainService.ConfigurationType", "@odata.id": "/api/ManagementDomainService/ConfigurationTypes(2)", "Id": 2, "Name": "NetworkServices", "Description": "Network Services" }, { "@odata.type": "#ManagementDomainService.ConfigurationType", "@odata.
Table 144. Attributes Attribute Description Id ID of the configuration. Name Name of the configuration. Description Description of the configuration. /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.
If you run this API on a BACKUP, one domain representing the BACKUP (itself) and one domain representing LEAD is returned. Description Returns the role of this chassis domain. ● Part of MCM—LEAD or MEMBER ● Not part of MCM—STANDALONE Privilege VIEW HTTP response codes 200 Example request body Example response body N/A Output — Lead chassis: { "@odata.context": "/api/ $metadata#Collection(ManagementDomainService.Domain)", "@odata.count": 3, "value": [ { "@odata.type": "#ManagementDomainService.
} ] } "@odata.id": "/api/ManagementDomainService/Domains(10236)", "Id": 10236, "DeviceId": 10195, "PublicAddress": [ "100.69.115.193" ], "Name": "MX-75HK1S2", "Description": "PowerEdge MX7000", "Identifier": "75HK1S2", "DomainTypeId": 4000, "DomainTypeValue": "OME-M", "DomainRoleTypeId": 3001, "DomainRoleTypeValue": "MEMBER", "Version": "1.20.
} ] } "DomainRoleTypeId": 3000, "DomainRoleTypeValue": "LEAD", "Version": "1.20.00", "Local": false, "GroupId": "28bf881c-f736-440d-b327-2fb0b2d7fd55", "GroupName": "test", "BackupLead": false, "Capabilities": [], "BackupLeadHealth": 2000 Table 146. Attributes Attribute Description Id Record ID. DeviceId Device ID. Address IP address. Name Name of the chassis. Description Description of the chassis. Identifier Service Tag of the chassis.
/api/ManagementDomainService/Domains(Id) This URI represents the role of a specific chassis domain. GET method for Domains(Id) This method returns the role of a specific chassis domain. The chassis domain role is as follows: ● Chassis domain part of MCM group — LEAD or MEMBER ● Chassis domain not part of a MCM group — STANDALONE Description Returns the role of a specific chassis domain.
Table 147. Attributes (continued) Attribute Description ● LEAD ● MEMBER ● STANDALONE Version Version of OME–Modular. Local ● TRUE — Indicates that this domain is the local domain where the API is executed. ● FALSE — Indicates that this domain is the remote domain where the API is executed. GroupId Unique identifier of the group across different domains. GroupName Group name for the MCM domain group.
Table 148. Attributes (continued) Attribute Description State Internal state of the request. Possible values: ● 1001 - Join approval is pending with the lead domain. ● 1002 - Join request is approved by the lead. ● 1004 - Onboarding is in progress. ● 1006 - Request is initiated to delete the member domain. ● 1007 - Request is in progress to delete the member domain. ● 1012 - Request to join group is initiated from the standalone chassis.
Table 149. Attributes Attribute Description Id Record ID. JobId Job ID created for the operation. State Internal state of the request. Possible values: ● 1001 - Join approval is pending with the lead domain. ● 1002 - Join request is approved by the lead. ● 1004 - Onboarding is in progress. ● 1006 - Request is initiated to delete the member domain. ● 1007 - Request is in progress to delete the member domain. ● 1012 - Request to join group is initiated from the standalone chassis.
} Example request body Example response body "Status": "APPROVED" Adding multiple domains to an MCM group [ { "GroupId": "be062037-30a5-4a8e-ae39-ee3bff4a8a29" } ] [ { "GroupId": "91e0b654-9de4-4a62-b5b1-c0da11d81b70" } ] Adding multiple domains to an MCM group { "JobId": 36128, "Status": "APPROVED" } Table 150. Attributes Attribute Description JobId Job ID created for the operation. Status Status of the operation. NOTE: The Status is always displayed as APPROVED.
Table 151. Attributes Attribute Description GroupId Group ID of the lead domain. JobId Job ID for tracking the status of the join operation. Status Status of the join request. /api/ManagementDomainService/Actions/ ManagementDomainService.Leave POST method for ManagementDomainService.Leave This method enables a member chassis domain to leave an MCM domain group. This API is applicable only to member chassis domains. Description Enables a member chassis domain to leave an MCM domain group.
{ ] Example response body { } } “Id”: 123, //Id from /api/ManagementDomainService/Domains "JobId": 36126, "Status": "SUCCESS" Table 153. Attributes Attribute Description JobId Job ID created for the operation. Status Status of the operation. NOTE: The Status is always displayed as SUCCESS. To track the status, use the JobId. /api/ManagementDomainService/Actions/ ManagementDomainService.DeleteGroup POST method for ManagementDomainService.DeleteGroup This method deletes an MCM domain group.
Table 154. Attributes (continued) Attribute Description After the job is successful, use the JobId to poll the delete group status. If the job fails, retry the job. /api/ManagementDomainService/ GetSyncFailureAlertTimeoutValues This URI represents the possible failure alert timeout values, in minutes, to configure threshold on lead for backup sync.
] Example response body Example request body Example response body } "Approval":true Approving or rejecting one pending request { "Status": "SUCCESS" } Approving or rejecting multiple pending requests [ { "Id": 36197, "Approval": true }, { "Id": 36198, "Approval": false } ] Approving or rejecting multiple pending requests { "Status": "SUCCESS" } Table 155. Attributes Attribute name Description Id ID of the pending domain that requested to join the group.
Example response body { } "JobId": 25857 Table 156. Attributes Attribute Description Id Member chassis identifier on the lead. JobId Job ID for tracking the status of unassigning the backup lead. NOTE: Use the API, /api/JobService/ Jobs(JobId) to poll the status of the assign JobId. /api/ManagementDomainService/Actions/ ManagementDomainService.ReassignBackupLead This URI unassigns the existing backup lead in the chassis group and assigns a member in the group as the new backup lead.
/api/ManagementDomainService/Actions/ ManagementDomainService.UnassignBackupLead This URI unassigns the backup lead. POST method for unassigning backup lead This method unassigns the backup lead in the chassis group. Description Unassigns the backup lead. Privilege APPLIANCE_SETUP HTTP Response Code 200 Example request body [{ }] Example response body { } "Id":25706 "JobId": 25857 Table 158. Attributes Attribute Description Id Member chassis identifier on the lead.
Example response body { } "JobId": 25857 Table 159. Attributes Attribute Description RollbackOnRecoverableError If this flag is passed as true, rollback is performed during promote failure and in a recoverable situation. PurgeLeadReferences If this flag is passed as true, all old lead references are purged on new lead during the promote process. JobId Job ID for tracking the status of the unassign backup lead operation.
FIPS mode settings /api/ApplicationService/Security/SecurityConfiguration This URI represents the security configuration. GET method for SecurityConfiguration This method returns the security configuration. Description Returns the security configuration. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#ApplicationService.FIPSModeConfiguration/$entity", "@odata.type": "#ApplicationService.FIPSModeConfiguration", "@odata.
} Example response body { } ], "FabricDesign": { "Name": "2xMX9116n_Fabric_Switching_Engines_in_same_chassis" } "JobId": 10357 /api/NetworkService/Actions/NetworkService.UpdateFabric This URI updates fabrics. POST method for updating fabrics This method updates fabrics. Description Updates fabrics.
HTTP response codes Example request body 200 { } "FabricIds": [ "fd20807f-de87-4317-950d-a77c773ad0ea", "dd20807f-de87-4317-123-a77c773ad45a" ] /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 response body { "@odata.context": "/api/$metadata#NetworkService.NetworkService", "@odata.
/api/NetworkService/Fabrics This URI represents the fabrics. GET method for Fabrics This method returns a list of the fabrics. Description Returns a list of fabrics. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Collection(NetworkService.Fabric)", "@odata.count": 1, "value": [ { "@odata.type": "#NetworkService.Fabric", "@odata.
"Category": "Audit", "DetailedDescription": "The SmartFabric is not healthy because at least one uplink must be configured.", "TimeStamp": "2020-04-20T07:30:12Z" } ] }, "FabricDesignMapping": [ { "DesignNode": "Switch-A", "PhysicalNode": "8178PK2" }, { "DesignNode": "Switch-B", "PhysicalNode": "4178PK2" } ], "Actions": null, "Switches@odata.navigationLink": "/api/NetworkService/ Fabrics('9c7b2839-abe4-40bc-adf9-c53e747516a5')/Switches", "Servers@odata.
} } Example for creating fabric Example response body { { } "Name": "Fabric11", "Description": "Fabric11", "OverrideLLDPConfiguration": "Enabled", "ScaleVLANProfile": "Enabled/Disabled", "FabricDesignMapping": [ { "DesignNode": "Switch-A", "PhysicalNode": "CJ2J4Z2" }, { "DesignNode": "Switch-B", "PhysicalNode": "CJ2J8Z2" } ], "FabricDesign": { "Name": "2xMX9116n_Fabric_Switching_Engines_in_same_chassis" } To get the value of FabricDesign.Name, use the /api/NetworkService/FabricDesigns API.
/api/NetworkService/FabricDesigns This URI represents the fabric designs. GET method for FabricDesigns This method returns a list of the fabric designs. Description Returns a list of fabric designs. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.FabricDesign)", "@odata.count": 3, "value": [ { "@odata.type": "#NetworkService.FabricDesign", "@odata.
}, { }, { }, { }, { "DestinationInterface": "ethernet1/1/37" "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/38", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/38" "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/40", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/40" "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/39", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/39" } ], "FabricDesignNode": [ { "NodeName":
{ }, { } ] } ] } "NodeName": "Switch-A", "ChassisName": "Chassis-X", "Slot": "Slot-A1", "Type": "MX9116n" "NodeName": "Switch-B", "ChassisName": "Chassis-Y", "Slot": "Slot-A2", "Type": "MX9116n" /api/NetworkService/Fabrics(Id) This URI represents a specific fabric in the fabric collection. GET method for Fabrics(Id) This method returns a specific fabric from the collection of fabrics. Description Returns a specific fabric.
"MessageId": "NFAB0017", "Message": "The network fabric is not healthy because all ISLs are not connected.", "MessageArgs": [], "Severity": "Warning", "Resolution": "Make sure that all the ISLs are connected as per the specification.", "Category": "Audit", "DetailedDescription": "", "TimeStamp": "2018-07-12T18:47:56Z" } ] }, "FabricDesignMapping": [ { "DesignNode": "Switch-A", "PhysicalNode": "41F2MN2" }, { "DesignNode": "Switch-B", "PhysicalNode": "41F4MN2" } ], "Switches@odata.
} } NOTE: You cannot modify the FabricDesign attribute. Example response body TRUE Table 162. Attributes Attribute name Description ID The identifier of the fabric. Name Name of the fabric. Description Description of the fabric. 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 Type of the fabric design.
}, { }, { }, { } "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/37", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/37" "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/38", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/38" "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/40", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/40" "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/39", "DestinationNode": "Swi
}, { }, { }, { "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/37" "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/38", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/38" "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/40", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/40" "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/39", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/39" } ], "Actions":
"value": [ { "@odata.type": "#NetworkService.ValidationError", "@odata.
"Id": "0bebadec-b61b-4b16-b354-5196396a4a18ISL-[ICL-1_REVERSE]-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.
"ChassisName": "MX-SKY00201234567890123456789012345", "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 code 201 Example request body { } Example response body "Name":"Uplink_Ethernet_Fabric-B", "Description":"Ethernet Uplink created from REST.", "MediaType":"Ethernet", "Ports":[ { "Id": "6ZB1XC2:ethernet1/1/41" }, { "Id": "5ZB1XC2:ethernet1/1/41" } ], "Networks":[ { "Id":95614 } ] Uplink Id Table 163.
Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#NetworkService.Uplink/$entity", "@odata.type": "#NetworkService.Uplink", "@odata.id": "/api/NetworkService/Fabrics('43be623e-0d74-4f6d-87b3-3ea40bf6372d')/ Uplinks('bda43da9-d6d8-4fc5-98b7-cb9030e8008e')", "Id": "bda43da9-d6d8-4fc5-98b7-cb9030e8008e", "Name": "test", "Description": "test", "MediaType": "Ethernet", "NativeVLAN": 0, "Summary": { "PortCount": 4, "NetworkCount": 2 }, "Ports@odata.
PUT method for Uplinks(Id) This method updates a specific uplink. Description Updates a specific uplink.
} "FcSettings": { "Wwnn": { "IdentityCount":85, "StartingAddress": "IACAgICAgAA=" }, "Wwpn": { "IdentityCount":85, "StartingAddress": "IAGAgICAgAA=" } } Table 164. Attributes Attribute name Description ID The identifier of the target uplink. Name The target uplink name Description The target uplink description MediaType Indicates, type of uplink. For more information, see /api/ NetworkService/UplinkTypes. NativeVLAN VLAN number, user intends to configure uplink with, as untagged network.
Example response body { "@odata.context": "/api/$metadata#Collection(NetworkService.Port)", "@odata.count": 4, "value": [ { "@odata.type": "#NetworkService.Port", "@odata.
"@odata.
}, { }, { }, { } ] } "@odata.type": "#NetworkService.EnumerationEntry", "Id": "CL91-RS", "Name": "CL91-RS" "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Not Supported", "Name": "Not Supported" "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Unknown", "Name": "Unknown" /api/NetworkService/Fabrics(Id)/Uplinks(Id)/Networks This URI represents the network details of a specific uplink in a fabric.
} ] } "VlanMaximum": 17, "VlanMinimum": 14, "Type": 1, "CreatedBy": "root", "CreationTime": "2018-07-11 03:35:20.543", "UpdatedBy": null, "UpdatedTime": "2018-07-11 03:35:20.543", "InternalRefNWUUId": "4c55cc1e-d3ad-48a4-a836-5050437dbe20" /api/NetworkService/Fabrics('Id')/ NetworkService.GetApplicableUplinkNetworks This API represents uplink network information. POST method for /api/NetworkService/Fabrics('Id')/ NetworkService.
api/NetworkService/Fabrics(arg1)/Servers This API gets details of the fabrics that are associated with servers. GET method for fabric details This method gets details of the fabrics that are associated with servers. Description Returns details of the fabrics associated with servers. Privilege VIEW HTTP response codes 200 Example response body 534 { "@odata.context": "/api/$metadata#Collection(DeviceService.Device)", "@odata.count": 2, "value": [ { "@odata.type": "#DeviceService.Device", "@odata.
}, "DeviceManagement": [ { "ManagementId": 8608, "NetworkAddress": "100.69.115.234", "MacAddress": "4c:d9:8f:92:25:84", "ManagementType": 2, "InstrumentationName": "", "DnsName": "iDRAC-8YQ1B03", "ManagementProfile": [ { "ManagementProfileId": 8608, "ProfileId": "WSMAN_OOB", "ManagementId": 8608, "AgentName": "iDRAC", "Version": "4.00.00.00", "ManagementURL": "https:// 100.69.115.234:443", "HasCreds": 0, "Status": 1000, "StatusDateTime": "2020-04-25 13:00:51.
"SystemUpTime": { "@odata.id": "/api/DeviceService/Devices(10056)/ SystemUpTime" }, "BlinkStatus": { "@odata.id": "/api/DeviceService/Devices(10056)/ BlinkStatus" }, "PowerUsageByDevice@odata.navigationLink": "/api/ DeviceService/Devices(10056)/PowerUsageByDevice", "DeviceBladeSlots@odata.navigationLink": "/api/DeviceService/ Devices(10056)/DeviceBladeSlots", "GraphicInfo": { "@odata.id": "/api/DeviceService/Devices(10056)/ GraphicInfo" }, "DeployRequired": { "@odata.
"DeviceManagement": [ { "ManagementId": 8610, "NetworkAddress": "100.69.115.144", "MacAddress": "d0:94:66:87:87:b5", "ManagementType": 2, "InstrumentationName": "", "DnsName": "iDRAC-77BK1S2", "ManagementProfile": [ { "ManagementProfileId": 8610, "ProfileId": "WSMAN_OOB", "ManagementId": 8610, "AgentName": "iDRAC", "Version": "4.20.20.20", "ManagementURL": "https:// 100.69.115.144:443", "HasCreds": 0, "Status": 1000, "StatusDateTime": "2020-04-25 13:00:54.
"@odata.id": "/api/DeviceService/Devices(10055)/ SystemUpTime" }, "BlinkStatus": { "@odata.id": "/api/DeviceService/Devices(10055)/ BlinkStatus" }, "PowerUsageByDevice@odata.navigationLink": "/api/ DeviceService/Devices(10055)/PowerUsageByDevice", "DeviceBladeSlots@odata.navigationLink": "/api/DeviceService/ Devices(10055)/DeviceBladeSlots", "GraphicInfo": { "@odata.id": "/api/DeviceService/Devices(10055)/ GraphicInfo" }, "DeployRequired": { "@odata.
}, { }, { }, { }, { ] } "Id": "1ZB1XC2:ethernet1/1/43", "Name": "", "Description": "", "PortNumber": "1ZB1XC2:ethernet1/1/43" "Id": "1ZB1XC2:ethernet1/1/37", "Name": "", "Description": "", "PortNumber": "1ZB1XC2:ethernet1/1/37" "Id": "1ZB1XC2:ethernet1/1/36", "Name": "", "Description": "", "PortNumber": "1ZB1XC2:ethernet1/1/36" "Id": "1ZB1XC2:ethernet1/1/35", "Name": "", "Description": "", "PortNumber": "1ZB1XC2:ethernet1/1/35" "NodeServiceTag": "DPM4XC1", "Ports": [ { "Id": "DPM4XC1:ethernet1/1/37",
}, { }, { } ] } ] } "Id": "DPM4XC1:ethernet1/1/38", "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/38" "Id": "DPM4XC1:ethernet1/1/36", "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/36" "Id": "DPM4XC1:ethernet1/1/42", "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/42" Table 165. Attributes Attribute name Description UplinkType ID of the uplink type. For more information, see /api/ NetworkService/UplinkTypes).
Table 166. Attributes Attribute name Description ServersServiceTag This takes list of service tags of servers as input for targeted servers in the system. ServerProfile Container object that carries one or more server interface profiles as list. ServerInterfaceProfiles Details of the server profile. NativeVLAN A VLAN number that you can configure as an untagged network on the targeted server NIC interface.
{ "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/HardwareLogs" } ], "SubSystemHealth": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/SubSystemHealth" } ], "RecentActivity": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/RecentActivity" } ], "InventoryTypes": { "@odata.
Example response body - If the SmartFabric Service returns applicable nodes and filter criteria match { } Example response body - If the SmartFabric Service returns applicable nodes and filter criteria do not match "ApplicableNodes": [ { "ServiceTag": "1H86XC2", "Slot": "IOM-A1", "ChassisName": "MX-C4XF1S2", "ChassisServiceTag": "PT0005H" } ] { "ApplicableNodes": [] } /api/NetworkService/Fabrics(arg1)/Actions/ NetworkService.ReplaceSwitch This URI replaces the fabric switch.
/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 response body 544 { "@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.
"/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 response body { "@odata.context": "/api/$metadata#NetworkService.Topology/$entity", "@odata.type": "#NetworkService.Topology", "@odata.
}, "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.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/SubSystemHealth" } ], "RecentActivity": [ { "@odata.
Example response body { "@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/Actions/NetworkService.RemoveFabrics POST method for NetworkService.RemoveFabrics This method deletes multiple fabrics. Description Deletes multiple fabrics. Privilege FABRIC_MANAGEMENT HTTP response codes 204 Example request body { } Example response body { } "FabricIds":["Fabric-1","Fabric-2'] "Fabric-1": true, "Fabric-2": true /api/NetworkService/Actions/NetworkService.RemoveUplinks POST method for NetworkService.
/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 response body { "@odata.context": "/api/$metadata#Collection(NetworkService.Node)", "@odata.count": 2, "value": [ { "@odata.type": "#NetworkService.Node", "@odata.
"ChildNodes@odata.navigationLink": "/api/ NetworkService/Fabrics('43be623e-0d74-4f6d-87b3-3ea40bf6372d')/Topology/ Nodes('Switch%3ADPM4XC1')/ChildNodes" } ] } /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/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 response body { "@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 response body { "@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 response body { "@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 response body { "@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 response body { "@odata.context": "/api/$metadata#NetworkService.Node/$entity", "@odata.type": "#NetworkService.Node", "@odata.
{ "@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.
HTTP response codes Example response body 200 { "@odata.context": "/api/ $metadata#Collection(NetworkService.ValidationError)", "@odata.count": 5, "value": [ { "@odata.type": "#NetworkService.ValidationError", "@odata.
"Make sure that the MX9116N IOMs are in different chassis", "Timestamp": "1531280042" }, { "@odata.type": "#NetworkService.ValidationError", "@odata.
ValidationErrors('43be623e-0d74-4f6d-87b3-3ea40bf6372d-ISL%5BICL-1_REVERSE%5D-NotFound-Issue')", "Id": "43be623e-0d74-4f6d-87b3-3ea40bf6372dISL-[ICL-1_REVERSE]-NotFound-Issue", "MessageId": "NFAB0012", "Category": "FabricError", "SubCategory": "ISLError", "Severity": "Severity1", "ChassisName": "MX-SKY00201234567890123456789012345", "ChassisServiceTag": "SKY00201234567890123456789012345", "Description": "Unable to validate the fabric because the design link ICL-1_REVERSE not connected as per design 2NodeHES
} ] } "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Unknown", "Name": "Unknown" /api/NetworkService/PortStatuses This URI represents the possible statuses of the ports. GET method for PortStatuses This method returns the possible statuses of a port. Description Returns the possible statuses of a port. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.count": 3, "value": [ { "@odata.
Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.count": 0, "value":[ ] } /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 response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.
api/NetworkService/ServerProfileBondingTechnologies This URI represents the server bonding technologies. GET method for server bonding technologies This method gets all applicable server bonding technologies. Description Gets all applicable server bonding technologies. Returns and empty list if the IOM containing the Fabric Manager. Privilege VIEW HTTP Response Code Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.
"ServerServiceTag": "8ZJC0T2", "ServerInterfaceProfiles@odata.navigationLink": "/api/NetworkService/ ServerProfiles('8ZJC0T2')/ServerInterfaceProfiles" }, { "@odata.type": "#NetworkService.ServerProfile", "@odata.id": "/api/NetworkService/ServerProfiles('FFN70T2')", "Id": "FFN70T2", "ServerServiceTag": "FFN70T2", "ServerInterfaceProfiles@odata.navigationLink": "/api/NetworkService/ ServerProfiles('FFN70T2')/ServerInterfaceProfiles" }, { "@odata.type": "#NetworkService.ServerProfile", "@odata.
"Id": "5099PH2", "ServerServiceTag": "5099PH2", "BondingTechnology": "LACP", "ServerInterfaceProfiles@odata.navigationLink": "/api/NetworkService/ ServerProfiles('5099PH2')/ServerInterfaceProfiles" } /api/NetworkService /ServerProfiles(arg1) This URI is used to update the service tag of server profiles in the Fabric Manager. GET method for updating server profile IDs This method returns the service tag of the server profile. Description Returns the service tag of the server profile in the Fabric Manager.
} Example response body "ServerInterfaceProfiles": [{ "Id": "NIC.Mezzanine.1A-1-1", "NicBonded": false, "NativeVLAN": 2 }, { "Id": "NIC.Mezzanine.1A-2-1", "NativeVLAN": 1, "NicBonded": false, "Networks": [{ "Id": 10111 }] }] true Table 168. Attributes Attribute Description Id Server profile identifier. ServerServiceTag Service tag of the server. ServerInterfaceProfiles Sub payload that takes information that is associated with a server NIC.
Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.ServerInterfaceProfile)", "@odata.count": 2, "value": [ { "@odata.type": "#NetworkService.ServerInterfaceProfile", "@odata.id": "/api/NetworkService/ServerProfiles('PFSTN16')/ ServerInterfaceProfiles('NIC.Mezzanine.1A-1-1')", "Id": "NIC.Mezzanine.1A-1-1", "OnboardedPort": "GQ61XC2:ethernet1/1/4", "NativeVLAN": 18, "Networks@odata.count": 2, "Networks": [ { "@odata.
/api/NetworkService /ServerProfiles(arg1)/ ServerInterfaceProfiles(arg2) This URI returns the server profile ID of a server profile in the Fabric Manager. GET method for server interface profile IDs This method returns server interface profile IDs. Description Returns server interface profile ID of a server profile in the Fabric Manager. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#NetworkService.ServerInterfaceProfile/$entity", "@odata.
} "InternalRefNWUUId": "991f2843-376e-49f3-a407-e5118f1d85ba" /api/NetworkService /ServerProfiles(arg1)/ ServerInterfaceProfiles(arg2)/Networks This URI returns tagged VLANs that are configured for server profiles. GET method for tagged VLANs configured for server interface profiles This method returns all tagged VLANs of a server interface profile. Description Returns all tagged VLANs that were configured for a specific server interface profile in the Fabric Manager.
api/NetworkService/ServerProfiles(Id)/ServerInterfaceProfiles This URI gets a list of server interface profiles by server profile IDs. GET method for server interface profiles This method gets the server interface profiles by server profile IDs. Description Privilege VIEW HTTP Response Code Response /api/NetworkService/Actions/ NetworkService.ApplyServersInterfaceProfiles This URI updates one or more server profile IDs at a time. You can also use this URI to set multiple server profiles at a time.
Table 170. Attributes Attribute Description JobId ID of the job that is created as part of the request. You can track the progress of the request using the Job ID. BondingTechnology Indicates the NIC bonding technology that is configured for the server profile. Enables the NIC teaming type that you want to configure for a profile. The supported options are: ● LACP ● Others ● NoTeaming NicBonded Indicates if the given NIC port participates in the NIC teaming. It is a binary attribute.
Table 171. Attributes Attribute Description JobId ID of the job that is created as part of the request. You can track the progress of the request using the Job ID. BondingTechnology Indicates the NIC bonding technology that is configured for the server profile. Enables the NIC teaming type that you want to configure for a profile. The supported options are: ● LACP ● Others ● NoTeaming NicBonded Indicates if the given NIC port participates in the NIC teaming. It is a binary attribute.
/api/NetworkService/Actions/ NetworkService.DeleteServerNetworks This API enables you to delete network profiles from an existing interface profile for one or many targeted servers. POST method for deleting server networks This method enables you to delete network profiles from an existing interface profile for one or many targeted servers. To run this API, you must have a server profile with NICs that were deployed using the server deployment process, on the system.
{ }, { }, { }, { } ] } "@odata.type": "#NetworkService.FeatureCapability", "Name": "ServerBondingConfiguration" "@odata.type": "#NetworkService.FeatureCapability", "Name": "PortVLANConfiguration" "@odata.type": "#NetworkService.FeatureCapability", "Name": "FabricLLDPConfiguration" "@odata.type": "#NetworkService.FeatureCapability", "Name": "FCoEUplinkUntaggedVlanConfiguration" NetworkService/Fabrics(arg1)/Multicast This URI represents multicast details for specific fabrics.
HTTP Response Code Example request body Code Description 200 Success 400 The fabric manager is not reachable, or the input parameters are invalid. 401 Unauthorized 403 Not authorized to perform the task. 404 The fabric ID is not found.
"CreatedBy": "root", "CreationTime": "2021-02-01 10:10:44.243", "UpdatedBy": null, "UpdatedTime": "2021-02-01 10:10:44.243", "InternalRefNWUUId": "15a4c19b-0a8e-49fa-8463-05ecbc2333e9", "Igmp": true, "Mld": true }, { "@odata.type": "#NetworkService.MulticastNetwork", "@odata.
}, { "Name": "Ravi", "Description": "", "VlanMaximum": 125, "VlanMinimum": 125, "Type": 8, "CreatedBy": "system", "CreationTime": "2020-08-27 08:47:42.902", "UpdatedBy": null, "UpdatedTime": "2020-08-27 08:47:42.902", "InternalRefNWUUId": "573eb526-fb43-4f00-ad11-74e2299b7d6a" "@odata.type": "#NetworkConfigurationService.Network", "@odata.
Privilege DEVICE_CONFIGURATION HTTP response codes 201 Example request body "Params": [ { "Key":"operationName", "Value":"CONFIGURE_MTU" }, { "Key":"interfaceId", "Value":"GF86XC2:1/1/9,GF86XC2:1/1/10" }, { "Key":"mtuSize", "Value":"1532" } ], "Targets": [ { "Id":2664, "Data":"", "TargetType": { "Id":4000, "Name":"DEVICE" } } ] POST method for enabling or disabling auto-negotiation This method enables or disables auto-negotiation. Description Enables or disables auto-negotiation.
}, { } "Key": "disableInterfaceIds", "Value": "D23RPK2:ethernet1/1/43,D23RPK2:ethernet1/1/4 "Key": "operationName", "Value": "TOGGLE_AUTONEG_STATUS" } ], "JobType": { "@odata.type": "#JobService.JobType", "Name": "DeviceAction_Task" } POST method for updating port name and description This method updates the port name and description. Description Updates port name and description.
HTTP response code Example request body 201 { } "JobName": "Rest-Breakout Port", "JobDescription": null, "Schedule": "startnow", "State": "Enabled", "CreatedBy": "root", "Targets": [ { "Id": 11881, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "breakoutType", "Value": "1X40GE" }, { "Key": "interfaceId", "Value": "D23RPK2:port-group1/1/16" }, { "Key": "operationName", "Value": "CONFIGURE_PORT_BREAK_OUT" } ], "JobType": { "@odata.type": "#JobService.
Assign enclosure POST method for enclosure assignment Description Creates a job to assign the entire storage in an enclosure to one or more server slots.
Example request body { } "JobName":"Storage Assignment Task 48", "JobDescription":"Storage Assignment Task", "Schedule":"startnow", "State":"Enabled", "JobType":{ "Id":3, "Name":"DeviceAction_Task" }, "Params":[ { "Key":"operationName", "Value":"CLEAR_STORAGE_ASSIGNMENT" }, { "Key":"assignmentMode", "Value":"1" } ], "Targets":[ { "Id":, "Data":"", "TargetType":{ "Id":1000, "Name":"DEVICE" } } ] Assign drives POST method for drive assignment Description Creates a job to a
}, { } "Key":"serverSlots", "Value": } ], "Targets":[ { "Id":, "Data":"", "TargetType":{ "Id":1000, "Name":"DEVICE" } } ] Clear drive assignment POST method for clearing drive assignment Description Creates a job to clear drive assignments to server slots.
Force-activate a SAS IOM POST method for force-activating a SAS IOM Description Creates a job to force-activate a SAS IOM.
} "Name": "DeviceAction_Task" }, "Params": [ { "Key": "operationName", "Value": "CLEAR_CONFIG" } ], "Targets": [ { "Id":, "Data":"", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ] 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.
{ }, { } ] } "Key": "shareName", "Value": e.g: "/var/nfsshare" "Key": "shareType", "Value": "NFS" 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.
}, { } ] } "Key": "password", "Value": "" "Key": "domainName", "Value": "" 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":"gatewayV4", "Value":"255.255.255.0" "Key":"networkTypeV6", "Value":"Static" "Key":"protocolTypeV6", "Value":"true" "Key":"prefixLength", "Value":"0" "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.
}, { }, { }, { }, { }, { "Key": "gatewayV4", "Value": "255.255.255.0" "Key": "networkTypeV6", "Value": "Static" "Key": "protocolTypeV6", "Value": "true" "Key": "prefixLength", "Value": "0" "Key": "gatewayV6", "Value": "255.255.255.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 173. Attributes Attribute name Description Id ID of job.
Table 173. Attributes (continued) Attribute name Description prefixLength Used for IPv6 subnet mask. Applicable when static IPv6 is selected. gatewayV6 IPv6 gateway IP associated with the configuration. Applicable when static IPv6 is selected. SlotId= Indicates the slot where the settings are applied if slot selected is True. Example: SlotSelected=true;SlotType=3000;IPV4Addres s=10.27.0.1;IPV6Address=ax0 ● SlotSelected=true or false.
Table 174. Attributes Attribute Description Id Identifier of the server profile. ServerServiceTag Service tag of the server. NOTE: When the server profile is created using the server deployment process, the server profile id gets set as the service tag of the server. PUT method for server profiles This method updates the server profile by ID. To run /api/NetworkService /ServerProfiles(arg1), you must have an existing server profile that is deployed on the system using the server deployment process.
Table 175. Attributes (continued) Attribute Description ServerInterfaceProfiles/Networks/Id The tagged VLANs configured for a NIC. The input that is required here is the identifier of the network profile, with which you want to associate the NIC. /api/NetworkService /ServerProfiles(arg1)/ ServerInterfaceProfiles This URI represents the server interface profiles information.
} ] } "NativeVLAN": 0, "Networks@odata.count": 0, "Networks": [] Table 176. Attributes Attribute Description Id NIC profile identifier. OnboardedPort IOM port that connected to the onboarded NIC. NativeVLAN Untagged VLAN configured for the NIC. /api/NetworkService /ServerProfiles(arg1)/ ServerInterfaceProfiles(arg2) This URI represents the server interface profiles information that is configured for a server profile on the Fabric Manager. GET method for NetworkService.
HTTP Response Code Example response body 200 { "@odata.context": "/api/ $metadata#Collection(NetworkConfigurationService.Network)", "@odata.count": 2, "value": [ { "@odata.type": "#NetworkConfigurationService.Network", "@odata.id": "/api/NetworkService/ServerProfiles('PFSTN16')/ ServerInterfaceProfiles('NIC.Mezzanine.1A-1-1')/Networks(25076)", "Id": 25076, "Name": "10", "Description": "10", "VlanMaximum": 10, "VlanMinimum": 10, "Type": 1, "CreatedBy": "system", "CreationTime": "1970-01-31 00:08:21.
"@odata.id": "/api/NetworkService/ServerProfiles('PFSTN16')/ ServerInterfaceProfiles('NIC.Mezzanine.1A-1-1')/Networks(25076)", "Id": 25076, "Name": "10", "Description": "10", "VlanMaximum": 10, "VlanMinimum": 10, "Type": 1, "CreatedBy": "system", "CreationTime": "1970-01-31 00:08:21.946", "UpdatedBy": null, "UpdatedTime": "1970-01-31 00:08:21.946", "InternalRefNWUUId": "991f2843-376e-49f3-a407-e5118f1d85ba" } /api/NetworkService/Actions/ NetworkService.
Table 177. Attributes Attribute Description JobId Identifier of the job that is created as part of the request. You can track the progress of the task using the ID. Template Service /api/TemplateService/Profiles This URI represents the profiles. NOTE: This API is not available from version 3.4 of OpenManage Enterprise and version 1.30.00 of OME-Modular. GET method for Profiles This method returns the list of available profiles. Description Returns list of profiles.
/api/TemplateService/Profiles(Id) This URI represents a specific profile. NOTE: This API is not available from version 3.4 of OpenManage Enterprise and version 1.30.00 of OME-Modular. GET method for Profiles(Id) This method returns the details of a specific profile. Description Returns details of a specific profile. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#TemplateService.Profile/$entity", "@odata.type": "#TemplateService.Profile", "@odata.
}, { }, { }, { }, { }, { }, { } ] } "Id": 2, "Name": "DeploymentTaskCreated" "@odata.type": "#TemplateService.ProfileState", "Id": 3, "Name": "DeploymentInProgress" "@odata.type": "#TemplateService.ProfileState", "Id": 4, "Name": "DeploymentCompletedWithErrors" "@odata.type": "#TemplateService.ProfileState", "Id": 5, "Name": "DeploymentFailedOnNoTargetAvailable" "@odata.type": "#TemplateService.ProfileState", "Id": 10, "Name": "DeployedSuccessfully" "@odata.type": "#TemplateService.
}, { }, { } ] } "Name": "Slot" "@odata.type": "#TemplateService.ProfileUsage", "Id": 3, "Name": "DeviceAndSlot" "@odata.type": "#TemplateService.ProfileUsage", "Id": 4, "Name": "ServiceTag" /api/TemplateService/Actions/TemplateService.AttachProfile This API represents information about server profiles that are created from templates. NOTE: This API is not available in OpenManage Enterprise from version 3.4.
/api/TemplateService/Actions/TemplateService.AssociateProfile This API represents information about associated server profiles. NOTE: This API is not available in OpenManage Enterprise from version 3.4. POST method for /api/TemplateService/Actions/ TemplateService.AssociateProfile This method returns information about associated server profiles. Description Returns information about associated server profiles.
/api/TemplateService/Actions/TemplateService.MigrateProfile This API migrates server profiles from one server to another. The system unassigns the identity from the server before the migration. If the migration to the selected server fails, the system displays a critical error. However, you can override the error and force the migration to another server. NOTE: This API is not available in OpenManage Enterprise from version 3.4.
TemplateService/AttributeRegistryDetail This URI represents the attribute registry details. GET method for attribute registry details This method fetches information about the attribute registry. Description Returns information about the attribute registry.
17 APIs specific to OpenManage Enterprise Topics: • • • • • • • • • • • • • • • • • • Application settings Console update Mobile Console Preferences Alerts Incoming Alerts Warranty Network Configuration Configuration compliance Troubleshoot service Query support service Groups service Profiles Devices Auto deploy Monitor Plugin Manager Power Metrics Application settings Console update /api/JobService/Jobs This URI updates the OpenManage Enterprise appliance.
} "Name":"ConsoleUpdateExecution_Task" }, "Params": [ { "Key":"connectionProfile", "Value":"0" } ], "Targets": [ { "Id":500, "Data":"", "TargetType": { "Id":6000, "Name":"GROUP" } } ] /api/ConsoleUpdateService/Updates?$filter= Auto eq true This URI represents the update job status of the OpenManage Enterprise appliance. GET method for Updates?$filter= Auto eq true This method returns the update job status of OpenManage Enterprise. Description Returns the update job status of OpenManage Enterprise.
GET method for UpdateBundleInfo This method returns the job status of the downloaded console update bundle of the OpenManage Enterprise appliance. Description Returns the update job status of the downloaded console update bundle of the OpenManage Enterprise appliance. Privilege VIEW HTTP response code 200 /api/ConsoleUpdateService/Actions/ ConsoleUpdateService.DeleteUpgradeBundle This URL deletes the downloaded console update bundle. NOTE: This API is available in OpenManage Enterprise 3.3.
/api/ConsoleUpdateService/LastUpdateResult This URI returns the information about the last attempted console upgrade. GET method for LastUpdateResult Description Returns the information about the last attempted console upgrade. Privilege VIEW HTTP response code 200 Example response body { } "@odata.context": "/api/$metadata#ConsoleUpdateService.LastUpdateResult", "@odata.type": "#ConsoleUpdateService.LastUpdateResult", "@odata.
"value": [ { "@odata.
/api/AlertService/Actions/ AlertService.CreateEditMobileSubscription This URI represents creating mobile subscriptions. POST method for CreateEditMobileSubscription This method creates mobile subscriptions. The AlertPolicyId must be configured in the appliance before creating the subscription. Description Creates mobile subscriptions.
Privilege MONITORING_SETUP HTTP response codes 200 Example Request Body { } "Enable":"false" /api/AlertService/Actions/AlertService.FilterAlertsByPolicy This URI filters the alerts by using the policy ID. GET method for AlertService.FilterAlertsByPolicy This method returns alerts based on the policy ID. Description Returns alerts based on the policy ID. Privilege VIEW HTTP response codes 200 Example request body { } Example response body "PolicyId": 14164, "Top": 2, "Skip": 1 { "@odata.
"AlertMessageId": "N/A", "AlertVarBindDetails": "10.210.137.100.1.3.6.1.4.1.674.10892.113041.3.6.1.4.1.674.10892.1.5000.10.1. 0OctetString1.3.6.1.4.1.674.10892.1.5000.10.2.0OID1.31.3.6.1.4.1.674.10892.1.5000.
POST method for SMB settings Description Configures the OpenManage Enterprise SMB settings. Privilege APPLIANCE_SETUP HTTP response codes 200 Example Request Body { } "Name": "SHARED_SETTING", "DefaultValue": "disable_V_1", "Value": "enable_V_1", "DataType": "", "GroupName": "" POST method for DeviceHealth settings Description Configures the OpenManage Enterprise device health settings.
/api/ApplicationService/Settings POST method for ReportSettings Description Configures the maximum limit for the reports. Privilege APPLIANCE_SETUP HTTP response codes 200 Example Request Body { } "ConsoleSetting": [ { "Name": "REPORTS_MAX_RESULTS_LIMIT", "DefaultValue": "1000", "Value": 998, "DataType": "java.lang.Integer" } ] POST method for EmailSender settings Description Configures the email sender settings.
} ] } "Value": "Normalized", "DataType": "", "GroupName": "" /api/Console/UpdateConsoleSettings This URI enables the option to receive all alerts or alerts corresponding to chassis as an MX7000 chassis onboarding preference. POST method for UpdateConsoleSettings Description Enables the option to receive all alerts or alerts corresponding to chassis as an MX7000 chassis onboarding preference.
Alerts https:///api/ApplicationService/Settings POST method for Alert Display settings Description Configures the alerts to be displayed on the alerts log page. Privilege APPLIANCE_SETUP HTTP response codes 200 Example Request Body { } "ConsoleSetting": [ { "Name": "ALERT_ACKNOWLEDGEMENT_VIEW", "DefaultValue": "2000", "Value": 1000, "DataType": "java.lang.
https:///api/AlertService/AlertDestinations/Actions/ AlertDestinations.ApplySNMPConfig POST method for AlertDestinations.ApplySNMPConfig Description Configures the SNMP server for alerts. Privilege MONITORING_SETUP HTTP response codes 200 Example Request Body [ { }, { }, { }, { ] } "Id": 1, "Enabled": true, "DestinationAddress": "10.32.19.
HTTP response codes Example Request Body 200 [ { }, { }, { }, { ] } "Id": 1, "Enabled": true, "DestinationAddress": "100.69.123.
}, { }, { }, { }, { }, { }, { }, { } ] } } "securityName": "root", "authenticationProtocol": "NONE", "authenticationPassphrase": "", "privacyProtocol": "NONE", "privacyPassphrase": "", "localizationEngineID": null, "community": "OpenManage Enterprise", "port": 162, "enableV3": true, "enableV1V2": false, "retries": 3, "timeout": 3 "JobId": 0, "Key": "protocolType", "Value": "SNMP" "JobId": 0, "Key": "enableV1", "Value": "true" "JobId": 0, "Key": "enableV2", "Value": "true" "JobId": 0, "Key": "ena
Example Request Body { "ConsoleSetting": [ { "Name": "WARRANTY_SCOREBOARD", "DefaultValue": "false", "Value": "true", "DataType": "java.lang.Boolean", "GroupName": "WARRANTY_SCOREBOARD" } ] } Network Configuration /api/ApplicationService/Network/AdapterConfigurations This URL returns all the network adapter information. GET method for AdapterConfigurations Description Returns all the network adapter information. Privilege VIEW HTTP response code 200 Example response body { "@odata.
"StaticAlternateDNSServer": "" }, "ManagementVLAN": { "EnableVLAN": false, "Id": 0 }, "DnsConfiguration": { "RegisterWithDNS": false, "DnsName": "", "UseDHCPForDNSDomainName": false, "DnsDomainName": "", "FqdndomainName": "", "Ipv4CurrentPreferredDNSServer": "", "Ipv4CurrentAlternateDNSServer": "", "Ipv6CurrentPreferredDNSServer": "", "Ipv6CurrentAlternateDNSServer": "" }, "CurrentSettings": { "Ipv4Settings": { "Enable": true, "EnableDhcp": true, "CurrentIPAddress": [ "XX.XXX.X.
"StaticIPAddress": "", "StaticPrefixLength": 0, "StaticGateway": "", "UseDHCPForDNSServerNames": false, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "ManagementVLAN": { "EnableVLAN": false, "Id": 0 }, "DnsConfiguration": { "RegisterWithDNS": false, "DnsName": "", "UseDHCPForDNSDomainName": false, "DnsDomainName": "", "FqdndomainName": "", "Ipv4CurrentPreferredDNSServer": "", "Ipv4CurrentAlternateDNSServer": "", "Ipv6CurrentPreferredDNSServer": "", "Ipv6CurrentAlternateDNSServer": "" },
HTTP response code Example response body 200 { "@odata.context": "/api/$metadata#Network.AdapterConfigurations", "@odata.type": "#Network.AdapterConfigurations", "@odata.
"Ipv6Dns": [] }, "DnsSetting": { "DnsFQDName": "", "DnsDomainName": "" } }, "Delay": 0, "PrimaryInterface": true } /api/ApplicationService/Actions/ Network.ConfigureNetworkAdapter This URL configures the network adapter. POST method for Network.ConfigureNetworkAdapter NOTE: The interface name of the network adapter in an appliance varies based on the hypervisor. Description This method configures the network adapter.
"Ipv4CurrentAlternateDNSServer": "", "Ipv6CurrentPreferredDNSServer": "", "Ipv6CurrentAlternateDNSServer": "" } }, "Delay": 0, "PrimaryInterface": true Example for Example response body primary interface { "Id": 10085, "JobName": "OMERealtime_Task", "JobDescription": "Generic OME runtime task", "NextRun": null, "LastRun": null, "StartTime": null, "EndTime": null, "Schedule": "startnow", "State": "Enabled", "CreatedBy": "system", "UpdatedBy": null, "LastRunStatus": { "Id": 2080, "Name": "New" }, "JobType"
} Example for secondary interface "InterfaceName": "ens36", "ProfileName": "ens36", "EnableNIC": true, "Ipv4Configuration": { "Enable": false, "EnableDHCP": false, "StaticIPAddress": "", "StaticSubnetMask": "", "StaticGateway": "" }, "Ipv6Configuration": { "Enable": true, "EnableAutoConfiguration": true, "StaticIPAddress": "", "StaticPrefixLength": 0, "StaticGateway": "" }, "ManagementVLAN": { "EnableVLAN": false, "Id": 0 }, "Delay": 0, "PrimaryInterface": false Example response body { "Id": 10085, "JobN
\"\",\"ipv6CurrentPreferredDNSServer\":\"\", \"ipv6CurrentAlternateDNSServer\":\"\",\"fqdndomainName\":\"\"}, \"currentSettings\":{\"ipv4Address\":[],\"ipv4Gateway\":\"\",\"ipv4Dns\": [],\"ipv4Domain\":\"\",\"ipv6Address\":[],\"ipv6LinkLocalAddress\": \"\",\"ipv6Gateway\":\"\",\"ipv6Dns\":[],\"ipv6Domain\":\"\"}, \"delay\":0,\"primaryInterface\":false,\"modifiedConfigs\":{}}" } ], "Visible": true, "Editable": true, "Builtin": false } /api/NetworkConfigurationService/Actions/ NetworkConfigurationService.
Example request body { "Name": "Baseline Name 1", "Description"": "Description 1.", "TemplateId": 19, "BaselineTargets": [{ "Id": 10100, "Type": { "Id": 1, "Name": "DEVICE" } }] } /api/TemplateService/Baselines(ID) This URI modifies a configuration baseline by using an ID. Put method for Baselines(ID) Description Modifies a configuration baseline by using an ID.
} ] } "DeviceName": "XX.XXX.X.XXX", "IpAddresses": [ "XX.XXX.X.XXX" ], "Model": "PowerEdge MX840c", "ServiceTag": "XXXXXX", "ComplianceStatus": 1, "DeviceType": 1000, "InventoryTime": "2020-10-05 18:28:09.842072" } Attributes Attribute Description ComplianceStatus 1 - Compliant 2 - Non-compliant 3 - Not Inventoried /api/TemplateService/Baselines(ID)/ DeviceConfigComplianceReports(ID)/DeviceComplianceDetails The URI returns the device reports for a specific report identification number and baseline.
Example to create a TSR job Example request body { } Example to create a diagnostic job "Id":0, "JobName":"TSR", "JobDescription":"TSRTask", "Schedule":"startnow", "State":"Enabled", "JobType": { "Id":125, "Name":"Diagnostic_Task" }, "Params": [ { "Key":"deviceTypes", "Value":"1000" }, { "Key":"operationName", "Value":"SERVER_EXECUTE_TSR" }, { "Key":"fileName", "Value":"TSR" }, { "Key":"OPERATION_NAME", "Value":"SERVER_EXECUTE_TSR" }, { "Key":"ShareType", "Value":"2" }, { "Key":"DataSelectorArrayIn", "Va
} "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", "Value":"2" }, { "Key":"ScheduledStartTime", "Value":"TIME_NOW" } ], "Targets": [ { "Id":3714, "Data":"", "TargetType": { "Id":3714, "Na
● URI for remote diagnostic files—api/TroubleshootService/Files?$filter=DeviceId eq 25085 and DeviceOperation eq 'SERVER_DIAGNOSTIC' Privilege VIEW HTTP response codes 200 Example Response Body "value": [ { "@odata.type": "#TroubleshootService.FileResponseModel", "DeviceId": 25085, "DeviceOperation": "SERVER_EXECUTE_TSR", "JobId": 0, "FileName": "TSR.zip", "FilePath": "/shared/dell/omc/cifs/idrac/F3TPXK2/ SERVER_EXECUTE_TSR/TSR/TSR.zip" } ] Table 178.
/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 Response Body java.io.File /api/TroubleShootService/Actions/ TroubleShootService.
$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.
{ { } "Description": null, "BaseCategoryId": 2 }, "@odata.type": "#QuerySupportService.QueryContextSummary", "@odata.id": "/api/QuerySupportService/QueryContextSummaries(2)", "Id": 2, "Name": "Devices", "Description": null, "BaseCategoryId": 1 }, "@odata.type": "#QuerySupportService.QueryContextSummary", "@odata.
HTTP response codes Example Response Body 200 { "@odata.context": "/api/$metadata#QuerySupportService.QueryContext/ $entity", "@odata.type": "#QuerySupportService.QueryContext", "@odata.
] }, { } "Id": 5000, "Name": "No Status" "Id": 19, "Name": "Device Model", "TableId": 5, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 20, "Name": "Device Service Tag", "TableId": 5, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 23, "Name": "Device Asset Tag", "TableId": 5, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 15, "Name": "Sub-Category Prefix", "TableId": 4, "Description": null, "FieldT
} ] "TableId": 1, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 2, "Name": "Alert Message", "TableId": 1, "Description": null, "FieldTypeId": 1, "StrMaxLen": 2048, "EnumOpts": [] } /api/QuerySupportService/QueryContexts(Id)/ QuerySupportService.GetFiltersForContext This URI represents summary information for all filters (queries) defined by using a specific Query Context. GET method for QuerySupportService.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Id": 1008, "Name": "Fibre Channel Switches", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1017, "Name": "HCI Appliances", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1014, "Name": "Hypervisor Systems", "UsageId": 1, "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": 100
}, { }, { }, { }, { }, { }, { }, { }, { ] } "Id": 1002, "Name": "PowerEdge FX2", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1003, "Name": "PowerEdge M1000e", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1004, "Name": "PowerEdge VRTX", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1009, "Name": "Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1012, "Name": "Storage Devices", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1015, "Name": "VMware ESXi Serve
Table 179. Attributes (continued) Attribute Description UsageId 1=Query Group, 2=Report FilterText Unused ContextId The Query Context identifier of the filter. It should match the Query Context ID in the request. /api/QuerySupportService/OperatorInfo This URI represents the supported logical operators of a query. 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.
"Name": "is null" }, { "Id": 10, "Name": "is not null" }, { "Id": 11, "Name": "begins with" }, { "Id": 12, "Name": "ends with" }, { "Id": 13, "Name": "before" }, { "Id": 14, "Name": "after" } ], "FieldTypes": [ { "FieldTypeId": 1, "Name": "String", "OperatorIds": [ 1, 2, 3, 4, 5, 6, 11, 12, 7, 8, 9, 10 ] }, { "FieldTypeId": 2, "Name": "Number", "OperatorIds": [ 1, 2, 3, 4, 5, 6, 9, 10 ] }, { "FieldTypeId": 3, "Name": "Date-Time", "OperatorIds": [ 1, 2, 13, 14, 9, 10 ] }, 644 APIs specific to OpenManage En
{ } ] "FieldTypeId": 4, "Name": "Enum", "OperatorIds": [ 1, 2, 9, 10 ] }, { "FieldTypeId": 5, "Name": "Boolean", "OperatorIds": [ 1, 2, 9, 10 ] } /api/QuerySupportService/Filters This URI represents summary information for all filters. GET method for Filters This method returns summary information for all filters. Description Returns summary information for all filters. Privilege VIEW HTTP response codes 200 Example Response Body { "@odata.
{ }, { }, { }, { ] } } "@odata.type": "#QuerySupportService.Filter", "@odata.id": "/api/QuerySupportService/Filters(1007)", "Id": 1007, "Name": "Dell Networking Switches", "UsageId": 1, "FilterText": "", "ContextId": 2, "Conditions": [] "@odata.type": "#QuerySupportService.Filter", "@odata.id": "/api/QuerySupportService/Filters(1008)", "Id": 1008, "Name": "Fibre Channel Switches", "UsageId": 1, "FilterText": "", "ContextId": 2, "Conditions": [] "@odata.type": "#QuerySupportService.Filter", "@odata.
} "FilterText": "", "ContextId": 2, "Conditions": [ { "LogicalOperatorId": "LeftParen": true, "FieldId": 59, "OperatorId": 1, "Value": "101", "RightParen": true }, { "LogicalOperatorId": "LeftParen": true, "FieldId": 59, "OperatorId": 1, "Value": "102", "RightParen": true }, { "LogicalOperatorId": "LeftParen": true, "FieldId": 59, "OperatorId": 1, "Value": "202", "RightParen": true }, { "LogicalOperatorId": "LeftParen": true, "FieldId": 59, "OperatorId": 1, "Value": "203", "RightParen": true } ] 0, 2, 2
} Example Response Body { } "Description": "Test Group1", "GlobalStatus": 0, "ParentId": 0 "Id": 1564, "Name": "Test Group1", "Description": "Test Group1", "TypeId": 3000, "MembershipTypeId": 12, "GlobalStatus": 0, "ParentId": 0, "CreatedBy": "root", "UpdatedBy": "", "CreationTime": "2017-06-08 20:14:37.252", "UpdatedTime": "2017-06-08 20:14:37.
HTTP response codes 200 Example Response Body { } "@odata.context": "$metadata#Collection(GroupService.StatusSummary)", "@odata.count": 3, "value": [ { "StatusType": 4000, "Count": 26 }, { "StatusType": 3000, "Count": 4 }, { "StatusType": 1000, "Count": 15 } ] /api/GroupService/Groups(Id)/EventStatusSummary This URI represents the events status counts. GET method for EventStatusSummary This method returns events status counts per status values.
/api/GroupService/Groups(group id)/EventSeveritySummary? $filter=StatusType eq 2000 This URL returns the count of unacknowledged alerts. GET method for EventSeveritySummary?$filter=StatusType eq 2000 This method returns the count of unacknowledged alerts. Description Returns the count of unacknowledged alerts. /api/GroupService/Groups(group id)/EventSeveritySummary? $filter=StatusType eq 1000 This URL returns the count of acknowledged alerts.
/api/GroupService/Actions/GroupService.CreateGroup This URI represents creation of a group. POST method for GroupService.CreateGroup This method creates a group. Description Creates a group.
} } "ParentId": 1021 /api/GroupService/Actions/GroupService.Clone This URI represents cloning of a group. POST method for GroupService.Clone This method clones a group. Description Clones a group. Privilege GROUP_MANAGEMENT HTTP response codes 200 Example Request Body { } "Id": 3164, "Name": "Test Group-My122-cloned", "Description": "Test Group123-4", "GlobalStatus": 0, "DefinitionId": 0, "ParentId": 12 /api/GroupService/Actions/GroupService.DeleteGroup This URI deletes a group.
/api/GroupService/Actions/GroupService.AddMemberDevices This URI represents adding devices to a group. POST method for GroupService.AddMemberDevices This method adds devices to a group. Description Adds devices to a group. Privilege GROUP_MANAGEMENT HTTP response codes 204 Example Request Body } { "GroupId":2614, "MemberDeviceIds" : [2514] /api/GroupService/Actions/GroupService.RemoveMemberDevices This URI represents removing devices from a group. POST method for GroupService.
Example Request Body { } "UserId" : 3864, "GroupIds" : [1314, 1264] Profiles /api/ProfileService/Profiles This URI is used to create one or more profiles. POST method for Profiles Description This method creates one or more profiles. In the RESTful interface, you can create profiles using sample templates.
/api/ProfileService/Profiles(arg) This URI is used to update the profile information, such as name, description, attributes, and boot ISO. PUT method for Profiles(arg) Description This method updates the profile information, such as name, description, attributes, and boot ISO.
/api/ProfileService/Profiles(arg1)/AttributeDetails This URI retrieves the attribute information for a profile id. GET method for AttributeDetails Description This method retrieves the attribute information for a profile id. Privilege VIEW HTTP response codes 200 Example response body { } "ProfileId": 10079 /api/ProfileService/Actions/ProfileService.Rename This URI renames existing profiles. POST method for ProfileService.Rename Description This method renames existing profiles.
/api/ProfileService/Actions/ProfileService.GetIdentityAttributes This URI retrieves the virtual identities associated with a profile id. POST method for ProfileService.GetIdentityAttributes Description This method retrieves the virtual identities associated with a profile id. Privilege VIEW HTTP response codes 200 Example request body { } "ProfileId": 10079 /api/ProfileService/Actions/ProfileService.AssignProfile This URI assigns a profile to a target device. POST method for ProfileService.
} } /api/ProfileService/Actions/ ProfileService.AssignProfileForAutoDeploy This URI assigns profiles to the auto-deploy identifier. POST method for ProfileService.AssignProfileForAutoDeploy Description This method assigns profiles to the auto-deploy identifier.
} "ProfileIds": [ 10079 ], "Schedule": { "RunNow": true, "RunLater": false, "Cron": "", "StartTime": "" }, "SelectAll": false, "Filters": "*" /api/ProfileService/Actions/ProfileService.MigrateProfile This URI migrates profiles from one device to another. POST method for ProfileService.MigrateProfile Description This method migrates profiles from one device to another.
profils wizard which matches the filter condition { "SelectAll":true, } "Filters":"=contains(ProfileName,'test4')" /api/ProfileService/ProfileStates This URI retrieves the profile state information for all the profiles. GET method for ProfileStates Description This method retrieves the profile state information for all the profiles. Privilege VIEW HTTP response codes 200 /api/ProfileService/Actions/ProfileService.Delete This URI deletes the profiles. POST method for ProfileService.
/api/ProfileService/Profiles(arg1) This URI deletes the given profile id. DELETE method for Profiles(arg1) Description This method deletes the given profile id. Privilege TEMPLATE_MANAGEMENT, AUTO_DEPLOY_MANAGEMENT HTTP response codes 204 /api/ProfileService/Actions/ ProfileService.GetInvalidTargetsForDeployTemplate This URI provides the invalid targets for template deployment. POST method for ProfileService.
Devices /api/DeviceService/HostKeys This URL returns the list of known host keys. GET method for HostKeys Description This method returns the list of known host keys. Privilege DEVICE_CONFIGURATION HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Collection(DeviceService.HostKey)", "@odata.count": 1, "value": [ { "@odata.type": "#DeviceService.HostKey", "@odata.id": "/api/DeviceService/HostKeys(1)", "Id": 1, "Identifier": "1.1.1.
GFmbP7cq4bdys4A49tht239Zo9Dl4MEcPW2qtcMUgg7SknKbTbe7Uc3NtX73qPLa/ BSLMfsd7qGEwkPPtDGReB qTjrZhVB065Ecr2kjldvPp3U/cnHYycXMRxD4dIr3DhWB9V", "Type":"SSH_KNOWN_HOSTS" } } ] /api/DeviceService/Actions/DeviceService.ScanAndAddKeys This URL automatically scans and adds the known keys. POST method for DeviceService.ScanAndAddKeys Description This method automatically scans and adds the known keys. Privilege DEVICE_CONFIGURATION HTTP response codes 200 Example request body { "Host":["1.1.1.
/api/DeviceService/Actions/DeviceService.AddCredentialToDevice When an onboarding operation is initiated on the OpenManage Enterprise console, this URI is used to first add the credentials of the devices. This URI can be used to add credential information pertaining to management operations used for a particular target. POST method for DeviceService.AddCredentialToDevice Description Adds the credential information of devices when an onboarding job is initiated.
{ }, { ] } } "@odata.type": "#AutoDeployService.AutoDeployTarget", "@odata.id": "/api/AutoDeployService/Targets(7)", "AutoDeployDeviceId": 7, "Identifier": "DT3Y6S1", "TemplateId": 9, "TemplateTypeId": 2, "TemplateName": "test-migrate", "GroupName": null, "IsBootToNetworkIso": false, "ShareIp": null, "ShareType": null, "IsoPath": null, "TaskId": 0, "TaskLastRunStatusId": 2200, "CreatedBy": "admin", "CreatedOn": "2019-05-15 17:24:29.411303" "@odata.type": "#AutoDeployService.AutoDeployTarget", "@odata.
}, { }, { } ] } "Identifier": "AAD6AAA", "ResultCode": 0, "BaseEntityId": 10327 "Identifier": "DSF346FAD", "ResultCode": 1, "BaseEntityId": 0 "Identifier": "SR346HCF", "ResultCode": 0, "BaseEntityId": 10328 Table 182.
Case 3: Select All with filters – to delete all the devices in the auto deploy wizard which matches the filter condition { "AutoDeployDeviceId":null, "SelectAll":true, "Filters":"contains(Identifier,'RR')&contains(TemplateName,'sample')" } /api/AutoDeployService/AutoDeploy After the identifiers are validated, this URL is used to complete the AutoDeploy request with the NetworkBootIso details.
} Monitor Discovery service /api/DiscoveryConfigService/Jobs This URI represents the information of discovery tasks. GET method for Jobs This method returns the discovery job information with discovery request details. Description Returns the discovery job information. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(DiscoveryConfigService.DiscoveryJob)", "@odata.count": 5, "value": [ { "@odata.type": "#DiscoveryConfigService.
}, { }, { }, { "LastUpdateTime": "2018-09-13 19:12:24.777", "DiscoveryConfigGroupId": 7, "DiscoveryConfigExpectedDeviceCount": 256, "DiscoveryConfigDiscoveredDeviceCount": 31, "DiscoveryConfigEmailRecipient": null, "DiscoveredDevicesByType": [ { "DeviceType": "SERVER", "Count": 31 } ] "@odata.type": "#DiscoveryConfigService.DiscoveryJob", "@odata.
} ] } "DiscoveryConfigEmailRecipient": null, "DiscoveredDevicesByType": [ { "DeviceType": "SERVER", "Count": 1 } ] Table 183. Attributes Attribute Description JobId ID of the discovery job. JobName Name of the discovery job. JobSchedule Discovery job schedule information. JobStartTime Start time of the discovery job. JobEndTime Completion time of the discovery job. JobProgress Percentage of discovery job completion. JobStatusId Status of the discovery job.
} "Exclude":false ], "ConnectionProfileId":0, "ConnectionProfile":"{\"profileName\":\"\",\"profileDescription\":\"\", \"type\":\"DISCOVERY\",\"credentials\":[{\"id\":0,\"type\":\"WSMAN\", \"authType\":\"Basic\",\"modified\":false,\"credentials\":{\"username\": \"root\",\"password\":\"calvin\",\"caCheck\":false,\"cnCheck\":false, \"port\":443,\"retries\":3,\"timeout\":60,\"isHttp\":false, \"keepAlive\":false}}]}", "DeviceType":[ 1000 ] } ], "Schedule":{ "RunNow":true, "RunLater":false, "Cron":"startnow", "
Example to schedule a discovery job Example request body { "DiscoveryConfigGroupName":"Discovery-2017091613573232", "DiscoveryConfigGroupDescription":"null", "DiscoveryConfigModels":[ { "DiscoveryConfigId":916135732, "DiscoveryConfigDescription":"", "DiscoveryConfigStatus":"", "DiscoveryConfigTargets":[ { "DiscoveryConfigTargetId":0, "NetworkAddressDetail":"xx.xx.xx.xx", "AddressType":30, "Disabled":false, "Exclude":false } ], "ConnectionProfileId":0, "ConnectionProfile":"{\"profileName\":\"\",\"profileD
\"teste\",\"password\":\"test\",\"caCheck\":false,\"cnCheck\":false, \"port\":443,\"retries\":3,\"timeout\":60,\"isHttp\":false, \"keepAlive\":false}},{\"id\":0,\"type\":\"SNMP\",\"authType\": \"Basic\",\"modified\":false,\"credentials\":{\"community\":\"public\", \"enableV1V2\":true,\"port\":161,\"retries\":3,\"timeout\":3}}, {\"id\":0,\"type\":\"IPMI\",\"authType\":\"Basic\",\"modified\":false, \"credentials\":{\"username\":\"test\",\"password\": \"test\",\"privilege\":2,\"retries\":3,\"timeout\":59}}, {\
"RunLater":false, "Cron":"startnow", "StartTime":"", "EndTime":"" } Example for discovery of OME– Modular using OpenManage Enterprise with trap destination }, "CreateGroup":true, "TrapDestination":false Example request body { "DiscoveryConfigGroupName": "Discovery-testesx2", "DiscoveryConfigGroupDescription": "null", "DiscoveryConfigModels": [{ "DiscoveryConfigId": 916135421, "DiscoveryConfigDescription": "", "DiscoveryConfigStatus": "", "DiscoveryConfigTargets": [{ "DiscoveryConfigTargetId": 0, "Networ
Example request body { "DiscoveryGroupIds":[1,2,3] } /api/DiscoveryConfigService/Actions/DiscoveryConfigService.Parse This URI represents discovery ranges parsed from a .CSV file. POST method for DiscoveryConfigService.Parse This method parses the discovery ranges from the .CSV file. Description Parses the discovery ranges from the .CSV file. Privilege DISCOVERY_MANAGEMENT HTTP response codes 201 Example request body abc.
\"port\":443,\"retries\":2,\"timeout\":4,\"isHttp\":false, \"keepAlive\":false}}]}", "DeviceType": [ 1000 ] }], "DiscoveryConfigTaskParam": [], "DiscoveryConfigTasks": [], "Schedule": { "RunNow": true, "RunLater": false, "Cron": "startnow" } Example response body }, "CreateGroup":true, "TrapDestination":false { "DiscoveryConfigGroupId": 11, "DiscoveryConfigGroupName": "Discovery-2018022611572222-updated", "DiscoveryConfigGroupDescription": "Discovery-2018022611572222updated", "DiscoveryStatusEmailRecip
} }, "TrapDestination": false, "ChassisIdentifier": null Table 184. Attributes Attribute name Description GroupId Group Id DiscoveryName Discovery Name Description Definition for discovery Task Schedule Discovery job schedule information TaskId Id of the job ConnectionProfileId Connection profile Id DeviceTypeList List of all device types DiscoveryConfiglist Config details Server-initiated discovery /api/DiscoveryConfigService/Actions/ DiscoveryConfigService.
/api/DiscoveryConfigService/Actions/ DiscoveryConfigService.SignalNodePresence This URI is used by iDRAC to initiate contact with OpenManage Enterprise console. However, this API is accessible from the OpenManage Enterprise console only when the client certificate of the servers is signed by the Dell CA. POST method for DiscoveryConfigService.SignalNodePresence Description This method is used by iDRAC to initiate contact with OpenManage Enterprise console.
Privilege DISCOVERY_MANAGEMENT HTTP response codes 200 Example request body { } "NodeId": [1, 2] /api/DiscoveryConfigService/SignaledNodes This URI is used to view the information, and status of the servers added by using the server-initiated discovery feature. GET method for SignaledNodes Description This method is used to view the information, and status of the servers added by using the server-initiated discovery feature.
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. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#Collection(WarrantyService.Warranty)", "@odata.count": 1, "value": [ { "@odata.type": "#WarrantyService.
Table 185. Attributes (continued) Attribute Description DaysRemaining Filter by remaining days for warranty expiry CustomerNumber Filter by customer number- default 0 OrderNumber Filter by order number - default 0 /api/WarrantyService/Actions/WarrantyService.WarrantyCount This URI represents the warranty counts based on Warranty Setting Criteria for scoreboard POST method for WarrantyService.WarrantyCount This method returns the count of warranty based on Warranty Setting Criteria for scoreboard.
"@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.
} ], "FilterGroupId": 0, "QsmQuery": false, "ReportResults": { "@odata.id": "/api/ReportService/ReportDefs(10042)/ReportResults" } }] Table 186.
}, { "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.
} } "LogicalOperatorId": 1, "LeftParen": false, "FieldId": 65, "OperatorId": 1, "Value": "1000", "RightParen": false }], "ResultFields": [{ "FieldId": 71 }, { "FieldId": 68 }, { "FieldId": 69 }, { "FieldId": 70 }, { "FieldId": 65 }], "SortFields": [{ "FieldId": 65, "SortDir": 0 }] Table 187. Attributes Attribute name Description ID Report ID Name Report Name Description Definition of the report. FilterGroupId Group to filter the report output. ColumnNames Names of the columns for the reports.
"Name": "Device Name", "Width": 20, "Sequence": 0 }, { "Id": 22, "Name": "Device Type", "Width": 20, "Sequence": 1 }, { "Id": 23, "Name": "Device Model", "Width": 20, "Sequence": 2 }, { "Id": 24, "Name": "Identifier", "Width": 20, "Sequence": 3 }, { "Id": 25, "Name": "Device Asset Tag", "Width": 25, "Sequence": 4 }, { "Id": 26, "Name": "Datacenter", "Width": 25, "Sequence": 5 }, { "Id": 27, "Name": "Aisle", "Width": 25, "Sequence": 6 }, { "Id": 28, "Name": "Rack", "Width": 25, "Sequence": 7 } ], "ResultRows
Example response body { "@odata.context": "/api/ $metadata#Collection(ReportService.ReportResultRow)", "@odata.count": 1, "value": [ { "@odata.type": "#ReportService.ReportResultRow", "Values": [ "iDRAC-792B0M2", "SERVER", "PowerEdge R640", "792B0M2", "", "", "", "" ] } ] } /api/ReportService/Actions/ReportService.RunReport This URI is used to run a report. POST method for Running Reports This method is used to run reports. Description Used to run reports.
Example request body { } "ReportDefId":1564, "Format":"pdf" /api/ReportService/Actions/ReportService.DeleteReports This URI represents the reports deletion. POST method for ReportService.DeleteReports This method deletes all the reports. Description Deletes all the reports. Privilege REPORT_MANAGEMENT HTTP response codes 200 Example request body [1564] /api/ReportService/Actions/ReportService.CloneReport This URI represents cloning of a report. POST method for ReportService.
HTTP response codes Example request body 200 { "ReportDefId":10037, "Format":"pdf", "EmailIds":"abcd@xyz.com" } MIB import service /api/MIBImportService/MIBS This URI represents the MIB traps. GET method for MIBS This method returns the traps imported from all the MIBs. All the traps with information are listed and they an be grouped based on the catalog name. Description Returns the traps imported from all the MIBs. Privilege VIEW HTTP response codes 200 Example request body { "@odata.
} "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. Description Saves parsed traps from MIB in the appliance. Privilege TRAP_MANAGEMENT HTTP response codes 200 Example response body 690 [{ "EnterpriseOid": ".1.3.6.1.4.1.674.10892.
/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 request body ["/tmp/parseMib/10892.mib"] /api/MIBImportService/Actions/MIBImportService.
} "Name": "Unknown", "Description": "Unknown" }] /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 response body { "@odata.context": "/api/ $metadata#Collection(MIBImportService.MIBEventCatalog)", "@odata.count": 46, "value": [{ "@odata.type": "#MIBImportService.MIBEventCatalog", "@odata.
} }] Plugin Manager NOTE: The APIs in this section can be used only when the Power Manager plug-in is installed on OpenManage Enterprise. /api/PluginService/Plugins This URL returns the plug-in list. GET method for Plugins Description This method returns all the available plug-in. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Collection(PluginService.Plugin)", "@odata.count": 1, "value": [ { "@odata.type": "#PluginService.Plugin", "@odata.
to gain efficiencies and cut wasteful costs. Features vary by access method and server model - Please contact Sales or refer to: dell.com/support.", "InstalledDate": "2019-06-14 21:13:09.487", "LastUpdatedDate": null, "LastDisabledDate": null, "AvailableVersionDetails@odata.navigationLink": "/api/ PluginService/ Plugins('2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625')/AvailableVersionDetails" } ] } Table 188.
"Publisher": "DELL EMC", "CurrentVersion": "1.0.0.9", "Description": "Dell EMC OpenManage Enterprise Power Manager is a plugin to the Dell EMC OpenManage Enterprise console and uses fine-grained instrumentation to provide increased visibility over power consumption, anomalies, and utilization. In addition, the Power Manager extension alerts and reports on thermal events with servers and groups of servers.
instrumentation to provide increased visibility over power consumption, anomalies, and utilization. In addition, the Power Manager extension alerts and reports on thermal events with servers and groups of servers. This enables increased control, faster response times, greater accuracy, and broader decision-making intelligence than would otherwise be possible.
Example request body { } "OmeVersion": "1.0.0", "Plugins": [ { "Id": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625", "Version": "1.0.0.9" } ] Response: { "Plugins": [ { "Id": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625", "Compatible": false } ] } Table 190. Attributes Attribute Description OmeVersion If empty version is passed, current installed OpenManage Enterprise version is used to check compatibility. Version format 1.0.0.325 (major.minor.revision.BuildNumber). Build number is not required.
} Example response body ] } "Version": "1.1.0", "Action": "Install" 12098 Table 191. Attributes Attribute Description Id ID of the plug-in. Version Version of the plug-in. Action Plug-in Action—Install or Uninstall or Enable or Disable or Update. NOTE: ● The version is not required for uninstall, enable, and disable. ● For install and update, the version that needs to be installed should be mentioned. ● Only one action can occur at a time for multiple plugins.
} Example response body 3 ], "Duration": 0, "SortOrder":0 { "EntityId": 10397, "Value":[ { "Type": "1", "Value": "230.0", "Timestamp": "2019-07-02 13:45:05.147666" }, { "Type": "2", "Value": "177.0", "Timestamp": "2019-07-02 13:45:05.147666" }, { "Type": "3", "Value": "197.0", "Timestamp": "2019-07-02 13:45:05.147666" } ] } Table 192. Attributes Attribute Description PluginId ID of a plug-in. EntityType Type of entity—device or group. EntityId ID of an entity—device or group.
Table 192.
} Example response body "EntityType": 0, "DeviceType": 1000, "Duration": 8 { "PluginId": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625", "Value": [ { "Id": 10398, "Name": "SKCLUSN1.tejd.bdcsv.lab", "Value": "0.060" }, { "Id": 10397, "Name": "SKCLUSN1.tejd.bdcsv.lab", "Value": "0.060" }, { "Id": 10396, "Name": "SKCLUSN1.tejd.bdcsv.lab", "Value": "0.000" }, { "Id": 10395, "Name": "SKCLUSN1.tejd.bdcsv.lab", "Value": "0.000" } ] } Table 193. Attributes Attribute Description PluginId ID of plug-in.
Table 193. Attributes (continued) Attribute Description 10 One year /api/MetricService/EnergyConsumption This URL returns the energy consumption of the device. POST method for EnergyConsumption Description This method returns the energy consumption of the device in KWH. Privilege VIEW HTTP response codes 201 Example request body { } Example response body { } "PluginId": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625", "EntityType": 0, "EntityId": 10395, "Duration": 4 "TotalEnergy": "0.
/api/MetricService/MetricTypes This URL returns all the supported metric types. GET method for MetricTypes Description This method returns all the supported metric types. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(MetricService.MetricType)", "@odata.count": 19, "value": [ { "@odata.type": "#MetricService.MetricType", "Id": 1, "Name": "MAX_POWER", "Description": "Maximum System Power Consumption" }, { "@odata.type": "#MetricService.
{ }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { } 704 ] } "@odata.type": "#MetricService.MetricType", "Id": 9, "Name": "MAX_UTIL_CPU", "Description": "Maximum CPU uitilization" "@odata.type": "#MetricService.MetricType", "Id": 10, "Name": "MIN_UTIL_CPU", "Description": "Minimum CPU uitilization" "@odata.type": "#MetricService.MetricType", "Id": 11, "Name": "AVG_UTIL_CPU", "Description": "Average CPU utilization" "@odata.type": "#MetricService.
/api/MetricService/MetricsConsumption This URL represents the aggregated metrics of the device or group. POST method for MetricsConsumption Description This method returns the aggregated metrics of the device or group. Privilege VIEW HTTP response codes 201 Example request body { } Example response body { } "PluginId": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625", "EntityType": 0, "EntityId": 10397, "Duration": 1, "MetricTypes": [1,2,3] "Value": [ { "Type": "1", "Value": "242.
Table 195. Attributes (continued) Attribute Description 7 Three months 8 Six months 9 One year Metric Types 1 MAX_POWER 2 MIN_POWER 3 AVG_POWER /api/MetricService/Threshold This URL represents the threshold set for an entity. POST method for Threshold Description This method returns the threshold value for power and temperature.
Table 196. Attributes (continued) Attribute Description LowerCritical Lower limit threshold of state critical. /api/MetricService/TopOffenders This URL returns the highest power and temperature information of offenders. GET method for TopOffenders Description This method returns the highest power and temperature information of offenders. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(MetricService.TopOffender)", "@odata.
Table 197. Attributes (continued) Attribute Description LowerWarningViolations Lower warning violations UpperCritical Upper critical threshold value UpperWarning Upper warning threshold value LowerCritical Lower critical threshold value LowerWarning Lower warning threshold value Entity Type 1 Device 2 Group Threshold Type 3 Power 7 Temperature Violation State 1 Unknown 2 Normal 3 Warning 4 Critical /api/MetricService/Actions/MetricService.
} "State": "Normal", "UpperCritical": "40", "UpperWarning": "30", "LowerWarning": "20", "LowerCritical": "10" Table 198. Attributes Attribute Description Supported threshold LowerWarning, LowerCritical, UpperWarning, UpperCritical Supported state Unknown, Normal, Warning, Critical Supported power UpperWarning, UpperCritical Supported temperature LowerCritical, LowerWarning, UpperWarning, UpperCritical Reset threshold Pass empty values in all the threshold fields in the payload.
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.
"SearchService":{"@odata.id": "/api/SearchService"}, "ApplicationService":{"@odata.id": "/api/ApplicationService"}, "AccountService":{"@odata.id": "/api/AccountService"}, "UpdateService":{"@odata.id": "/api/UpdateService"}, "JobService":{"@odata.id": "/api/JobService"}, "GroupService":{"@odata.id": "/api/GroupService"}, "DeviceService":{"@odata.id": "/api/DeviceService"}, "OAuthService":{"@odata.id": "/api/OAuthService"}, "SessionService":{"@odata.id": "/api/SessionService"}, "AlertService":{"@odata.
redfish/v1/odata This API represents chassis details. GET method for odata This method returns chassis details. Description Returns the chassis details. Privilege VIEW HTTP response code 200 Example response body { "@odata.
Redfish—SessionService This resource enables you to access the session service. Using this resource, you can view the sessions, create a session, delete a session, and so on. Use the URI in this resource to access the session service and the associated actions. /redfish/v1/SessionService This URI represents the collection of session services. GET method for SessionService This method returns a collection of session service. Description Returns a collection of session service.
/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. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(SessionService.Session)", "@odata.count": 1, "value": [ { "@odata.
Example request body { } Example response body { } "UserName":"root", "Password":"linux", "SessionType":"API" "Id": "7b723932-a119-4843-a5b7-7a122e4def99", "Description": "root", "Name": "API", "UserName": "root", "Password": null, "Roles": [ "ADMINISTRATOR" ], "IpAddress": "xx.xx.xx.xx", "StartTimeStamp": "2017-04-17 20:07:12.357", "LastAccessedTimeStamp": "2017-04-17 20:07:12.357" Table 201. Attributes Attribute name Description Id ID of the session service.
Example response body { } "Id": "7b723932-a119-4843-a5b7-7a122e4def99", "Description": "root", "Name": "API", "UserName": "root", "Password": null, "Roles": [ "ADMINISTRATOR" ], "IpAddress": "xx.xx.xx.xx", "StartTimeStamp": "2017-04-17 20:07:12.357", "LastAccessedTimeStamp": "2017-04-17 20:07:12.357" DELETE method for Members(Id) This method deletes a session. Description Deletes a session.
"Dell": { "ByUserName": false, "ByIPAddress": false, "EnableIpRangeAddress": false } } }, "Id": "10", "Description": "User Accounts", "Name": "Account Service", "Status": { "State": "Enabled", "HealthRollup": "OK", "Health": "OK", "Oem": null }, "ServiceEnabled": false, "AuthFailureLoggingThreshold": 3, "MinPasswordLength": 8, "MaxPasswordLength": 20, "AccountLockoutThreshold": 3, "AccountLockoutDuration": 30, "AccountLockoutCounterResetAfter": 900, "Accounts": { "@odata.
Table 202. Attributes (continued) Attribute name Description EnableIpRangeAddress Indicates if IP range address is enabled or disabled. IpRangeAddress IP range address to be used. PUT method for AccountService This method updates the account configuration of all the accounts. Description Updates the account configuration.
Table 203. 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.id": "/redfish/v1/AccountService/Accounts/Members('10042')", "Oem":{"Dell":{"UserTypeId": 1, "DirectoryServiceId": 0, "IsBuiltin": true }}, "Id": "10042", "Description": "root", "Name": "root", "Password": null, "UserName": "root", "RoleId": "10", "Locked": false, "Enabled": true }, { "@odata.type": "#ManagerAccount.v1_1_3.ManagerAccount", "@odata.
Example request body { } Example response body { } "Description": "user2 description", "Name": "user2", "Password": "Dell123$", "UserName": "user2", "RoleId": "10", "Locked": false, "Enabled": true "Id": "3064", "UserTypeId": 1, "DirectoryServiceId": 0, "Name": "user2", "Password": null, "UserName": "user2", "Description": "user2 description", "Oem": null, "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true Table 205. Attributes Attribute name Description Id ID of the account.
Example response body { "@odata.context": "$metadata#ManagerAccount.v1_0_2.ManagerAccount/ $entity", "@odata.id": "/redfish/v1/AccountService/Accounts/Members('1814')", "Oem": { "Dell": { "UserTypeId": 1, "DirectoryServiceId": 0, "IsBuiltin": true } }, "Id": "1814", "Description": "root", "Name": "root", "Password": null, "UserName": "root", "RoleId": "10", "Locked": false, "Enabled": true, "Links": null } Table 206. Attributes Attribute name Description Id ID of the account.
} Example response body { } "Locked": false, "Enabled": true "Id": "3064", "UserTypeId": 1, "DirectoryServiceId": 0, "Name": "user2", "Password": null, "UserName": "user2", "Description": "user2 description", "Oem": null, "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true Table 207. Attributes Attribute name Description Id ID of the account. UserTypeId ID of the type of user. DirectoryServiceId ID of the directory service. Description Description of the user.
redfish/v1/AccountService/Roles/Members This API gets a list of all roles of members. GET method for Roles This method returns the role details of members. Description Returns role details of the members. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/redfish/v1/$metadata#Collection(Role.v1_2_2.Role)", "@odata.count": 5, "value":[ { "@odata.type": "#Role.v1_2_2.Role", "@odata.
Example response body { } "@odata.context": "$metadata#Role.Role/$entity", "@odata.id": "/redfish/v1/AccountService/Roles/Members('10')", "Oem": null, "Id": "10", "Description": "Privileges to do all operations", "Name": "CHASSIS_ADMINISTRATOR" Table 209. Attributes Attribute name Description Id Record ID of the role. Description Description of the role. Name Name of the role. Redfish—Message Registry This resource enables you to access the message services.
GET method for Registry instance This API represents the registry information of members. GET method for registry instance This method returns the registry information of members, by ID. Description Returns the registry information of members, by ID. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/ redfish/v1/$metadata#MessageRegistryFile.v1_0_0.MessageRegistryFile", "@odata.type": "#MessageRegistryFile.v1_0_0.MessageRegistryFile", "@odata.
] } redfish/v1/MessageRegistryCollection/Members() This API represents message listings for a location. GET method for messages of location This method returns a list of messages for a specific location. Description Returns a list of messages for a location. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/ redfish/v1/$metadata#MessageRegistry.v1_0_0.MessageRegistry/$entity", "@odata.type": "#MessageRegistry.v1_0_0.MessageRegistry", "@odata.
Example response body { "@odata.context": "/ redfish/v1/$metadata#ChassisCollection.ChassisCollection", "@odata.type": "#ChassisCollection.ChassisCollection", "@odata.id": "/redfish/v1/Chassis", "Name": "Chassis Collection", "Members@odata.count": 6, "Members": [ { "@odata.id": "/redfish/v1/Chassis/Members('10057')" }, { "@odata.id": "/redfish/v1/Chassis/Members('10056')" }, { "@odata.id": "/redfish/v1/Chassis/Members('10055')" }, { "@odata.id": "/redfish/v1/Chassis/Members('10059')" }, { "@odata.
} ], "ManagedBy@odata.count": 1, "Drives":[ ] }, "Actions":{ "Oem":{ "#DellChassis.VirtualReseat":{ "target": "/redfish/v1/Chassis/Members('10057')/Actions/Oem/ DellChassis.VirtualReseat" } }, "#Chassis.Reset":{ "ResetType@Redfish.AllowableValues":["On", "ForceOff", "GracefulShutdown", "PowerCycle"], "target": "/redfish/v1/Chassis/Members('10057')/Actions/Chassis.Reset" } }, "PowerState": "On", "Thermal":{ "@odata.id": "/redfish/v1/Chassis/Members('10057')/Thermal" }, "Power":{ "@odata.
"ManagedBy@odata.count": 1, "Drives":[ ] }, "Actions":{ "Oem":{ "#DellChassis.VirtualReseat":{ "target": "/redfish/v1/Chassis/Members('10057')/Actions/Oem/ DellChassis.VirtualReseat" } }, "#Chassis.Reset":{ "ResetType@Redfish.AllowableValues":["On", "ForceOff", "GracefulShutdown", "PowerCycle"], "target": "/redfish/v1/Chassis/Members('10057')/Actions/Chassis.Reset" } }, "PowerState": "On", "Thermal":{ "@odata.id": "/redfish/v1/Chassis/Members('10057')/Thermal" }, "Power":{ "@odata.
}, "RelatedItem":[ ] } redfish/v1/Chassis/Members(id)/Power/PowerSupplies() This API represents chassis power supply information. GET method for power supply information This method returns chassis power supply information. Description Returns chassis power supply information. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/redfish/v1/$metadata#Power.v1_0_0.PowerSupply", "@odata.type": "#Power.v1_0_0.PowerSupply", "@odata.
"Description": "Chassis Thermal Information", "Name": "Thermal", "Status":{ "State": "Enabled", "HealthRollup": "OK", "Health": "OK" }, "Temperatures@odata.count": 0, "Temperatures":[ ], "Fans@odata.count": 0, "Fans":[ ], "Redundancy":[ ] } redfish/v1/Chassis/Members(id)/Thermal/Temperatures() This API represents chassis temperature information. GET method for temperature information This method returns chassis temperature information. Description Returns chassis temperature information.
HTTP response code Example response body 200 { "@odata.context": "/redfish/v1/$metadata#Thermal.v1_0_0.Fan", "@odata.type": "#Thermal.v1_0_0.Fan", "@odata.id": "/redfish/v1/Chassis/Members('10054')/Thermal/ Fans('Fan.Slot.8')", "MemberId": "Fan.Slot.8", "FanName": "Rear Fan 4", "PhysicalContext": "Fan", "Status":{ "Health": "OK" }, "Reading": 8731 } redfish/v1/Managers/Members() This API represents the chassis manager information.
redfish/v1/Chassis/Members(id)/Actions/Oem/DellChassis.VirtualReseat This API represents virtual reseat information of the chassis. POST method for virtual reseat This method performs virtual reseat of the chassis. Description Performs virtual reseat of the chassis. Privilege DEVICE_CONFIGURATION HTTP response code 202 redfish/v1/Chassis/Members(id)/Actions/Chassis.Reset This API represents chassis reset information. POST method for chassis reset This method resets the chassis.
Example request body { "ResetType": "" } Table 211. Attributes Attribute name Description ResetType The allowed value is—GracefulRestart Redfish—Systems This API represents server information. /redfish/v1/Systems This URI represents the systems. GET method for Systems This method returns the collection of the systems. Description Returns the collection of systems. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
HTTP response codes Example response body 200 { "@odata.context": "/ redfish/v1/$metadata#ComputerSystem.v1_6_0.ComputerSystem", "@odata.type": "#ComputerSystem.v1_6_0.ComputerSystem", "@odata.id": "/redfish/v1/Systems/Members('10055')", "Id": "10055", "Description": "Server Device", "Name": "idrac-7C1000D", "SystemType": "Physical", "Links":{ "ResourceBlocks":[ { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('19')" }, {"@odata.
"MemorySummary":{ "TotalSystemMemoryGiB": 16, "Status":{ "State": "Enabled", "HealthRollup": "OK", "Health": "OK" } }, "Actions":{ "Oem":{ }, "#ComputerSystem.Reset":{ "ResetType@Redfish.AllowableValues":["On", "ForceOff", "GracefulShutdown", "PowerCycle"], "target": "/redfish/v1/Systems/Members('10055')/Actions/ ComputerSystem.Reset" }, "#ComputerSystem.AddResourceBlock":{ "target": "/redfish/v1/Systems/Members('10055')/Actions/ ComputerSystem.AddResourceBlock" }, "#ComputerSystem.
Example response body { "@odata.context": "/ redfish/v1/$metadata#ProcessorCollection.ProcessorCollection", "@odata.type": "#ProcessorCollection.ProcessorCollection", "@odata.id": "/redfish/v1/Systems/Members('10055')/Processors", "Name": "Processor Collection", "Members@odata.count": 2, "Members":[ { "@odata.id": "/redfish/v1/Systems/Members('10055')/Processors/ Members('9776')" }, { "@odata.
redfish/v1/Systems/Members(id)/EthernetInterfaces This API represents Ethernet interface. GET method for EthernetInterfaces This method returns Ethernet interface information, by device ID. Description Returns Ethernet interface information. Privilege VIEW HTTP response code 200 Example response body 746 { "@odata.context": "/redfish/ v1/$metadata#EthernetInterfaceCollection.EthernetInterfaceCollection", "@odata.type": "#EthernetInterfaceCollection.EthernetInterfaceCollection", "@odata.
redfish/v1/Systems/Members(id)/EthernetInterfaces/ Members(id) This API represents server Ethernet interface information, by IDs. GET method for Ethernet Interfaces by ID This method returns the server Ethernet Interface information, by Ethernet interface ID. Description Returns the server Ethernet Interface information, by Ethernet interface ID. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/ redfish/v1/$metadata#EthernetInterface.v1_0_0.
"@odata.id": "/redfish/v1/Systems/Members('10189')/SimpleStorage/ Members('9807')" }, { "@odata.id": "/redfish/v1/Systems/Members('10189')/SimpleStorage/ Members('9808')" }, { "@odata.id": "/redfish/v1/Systems/Members('10189')/SimpleStorage/ Members('9809')" } ] } redfish/v1/Systems/Members(id)/SimpleStorage/Members This API represents the simple server storage. Get method for storage devices This method returns the simple server storage details. Description Returns the simple server storage details.
redfish/v1/Systems/Members(id)/SimpleStorage/Members(id) This API represents the simple server storage details, by storage device ID. GET method for storage devices by ID This method returns the simple server storage details, by storage device ID. Description Returns the simple server storage details, by storage device ID. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/redfish/v1/$metadata#SimpleStorage.SimpleStorage", "@odata.type": "#SimpleStorage.v1_0_0.
Table 212. Attributes Attribute name Description ● PowerCycle Redfish—CompositionService redfish/v1/CompositionService This API represents the composition service information. GET method for CompositionService This method returns the composition service information. Description Returns the composition service information. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/ redfish/v1/$metadata#CompositionService.v1_0_0.CompositionService", "@odata.
Example response body { "@odata.context": "/ redfish/v1/$metadata#ResourceBlockCollection.ResourceBlockCollection", "@odata.type": "#ResourceBlockCollection.ResourceBlockCollection", "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks", "Description": "Resource Blocks in MX Chassis", "Name": "Resource Block Collection", "Members@odata.count": 24, "Members":[ { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Members('1')" }, { "@odata.
}, { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('43')" }, { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('44')" }, { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('45')" }, { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('46')" }, { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('47')" }, { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('48')" }, { "@odata.
}, "CompositionStatus":{ "CompositionState": "Composed", "SharingCapable": false }, "ResourceBlockType":[ "ComputerSystem" ], "Links":{ "ComputerSystems":[ { "@odata.id": "/redfish/v1/Systems/Members('10189')" } ], "Chassis":[ { "@odata.id": "/redfish/v1/Chassis/Members('10189')" } ], "Zones":[ { "@odata.id": "/redfish/v1/CompositionService/ResourceZones/Members('3')" } ] }, "ComputerSystems@odata.count": 1, "ComputerSystems":[ { "@odata.id": "/redfish/v1/Systems/Members('10189')" } ], "Drives@odata.
}, { "@odata.id": }, { "@odata.id": }, { "@odata.id": }, { "@odata.id": }, { "@odata.
/redfish/v1/Systems/Members()/Actions/ ComputerSystem.AddResourceBlock This API represents addition of chassis to a chassis group. POST method for adding ResourceBlocks This method adds chassis to a chassis group. Description Adds chassis to a chassis group. Privilege DEVICE_CONFIGURATION HTTP response codes 202 Example request body { "ResourceBlock": { "@odata.
Redfish—EventService /redfish/v1/EventService This URI contains properties and actions to manage event subscriptions and generates events that are sent to subscribers. This URI has links to the collection of subscriptions that are called event destinations. GET method for EventService This method returns event service resource information for managing event subscriptions. Description Returns event service resource information for managing event subscriptions.
PATCH method for event service This method modifies the event service properties. Description Modifies the event service properties. Privilege APPLIANCE_SETUP HTTP response codes 200 Input { } Example request body { } "ServiceEnabled": "@Message.ExtendedInfo": [ { "Message": "Successfully Completed Request", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "Base.1.5.Success", "RelatedProperties": [], "RelatedProperties@odata.
/redfish/v1/EventService/SSE This URI provides access to Server-Sent Events (SSE). GET method for EventService SSE This method fetches a stream of SSE. Description Fetches a stream of SSE. You can cancel the stream by terminating the session or connection. If a license is installed, you can find the MetricReport events in the stream. However, licenses are not required for alert type events. NOTE: A maximum of eight combined subscribers and SSE sessions is allowed.
/redfish/v1/EventService/Subscriptions This URI represents subscriptions, which are a collection of event destinations. An event destination defines the target of an event subscription including event types and context to provide the target in the event payload. GET method for event subscriptions This method returns a list of event subscriptions. Description Returns a list of event subscriptions. NOTE: The subscriptions collection includes both event subscribers and SSE sessions.
NOTE: A maximum of eight combined subscribers and SSE sessions is allowed. If the maximum number is met, additional subscriber and SSE session are not allowed and an error is displayed. To see the current number of subscribers and SSE sessions, use the GET method for /redfish/v1/ EventService/Subscriptions. NOTE: A subscriber added to the collection must be accessible in the network and running. Upon receiving events, it must send back a response immediately.
/redfish/v1/EventService/Subscriptions/ This URI represents event subscriptions. DELETE method for specific event service subscriptions This method deletes a specific event subscription from the collection of subscriptions. Description Deletes a specific event subscription from the collection of event subscriptions. Privilege APPLIANCE_SETUP HTTP response codes 204 Redfish—OpenManage Enterprise License Manager This URI represents the OpenManage Enterprise license information.
/redfish/v1/Oem/Dell/LicenseManager/LicenseCollection This URI represents the license collection information. GET method for license collection This method lists the installed licenses. Description Lists the installed licenses. Privilege VIEW HTTP response codes 200 Example response body { "@odata.id": "/redfish/v1/Oem/Dell/LicenseManager/LicenseCollection", "@odata.type": "#DellLicenseCollection.DellLicenseCollection", "Members": [ { "@odata.
/redfish/v1/Oem/Dell/LicenseManager/LicenseCollection/ This URI represents the installed licenses information. GET method for License Collection by Entitlement ID This URI returns a list of installed licenses, by entitlement ID. Description Returns a list of installed licenses, by entitlement ID. Privilege VIEW HTTP response codes 200 Example response body { "@odata.id": "/redfish/v1/Oem/Dell/LicenseManager/LicenseCollection/ 9207PA_abc", "@odata.type": "#DellLicense.v1_1_0.
}, { } ] } "Severity": "OK" "Message": "The operation successfully completed.", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "IDRAC.2.1.SYS413", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "No response action is required.", "Severity": "Informational" /redfish/v1/Oem/Dell/LicenseManager/Actions/ DellLicenseManagementService.ExportLicense This URI exports or retrieves license information in XML that is encoded as base64.
Redfish—Telemetry This URI represents chassis telemetry. /redfish/v1/TelemetryService This URI represents telemetry service resource information. The resource has links to various telemetry definitions and the collection of telemetry data. GET method for telemetry service This method gets the telemetry service resource information. Description Returns the telemetry service resource information. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
} ] "" PATCH method for telemetry service This method updates the telemetry service resource. Description Updates the telemetry service resource information. Privilege APPLIANCE_SETUP HTTP response codes 200 Example request body { } Example response body 766 "ServiceEnabled": true { "@Message.ExtendedInfo": [ { "Message": "Successfully Completed Request", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "Base.1.5.Success", "RelatedProperties": [], "RelatedProperties@odata.
"Dell": { "@odata.type": "#DellTelemetryService.v1_0_0.DellTelemetryService", "FQDDList": [ "System.Chassis.1", "Fan.Slot.2", "Fan.Slot.3", "Fan.Slot.4", "Fan.Slot.5", "Fan.Slot.6", "Fan.Slot.7", "Fan.Slot.8", "Fan.Slot.9", "PSU.Slot.1", "PSU.Slot.2", "PSU.Slot.3", "PSU.Slot.4", "PSU.Slot.5", "PSU.Slot.6" ], "SourceList": [ "" ] } } }, "ServiceEnabled": true, "SupportedCollectionFunctions": [ "Average", "Maximum", "Minimum", "Summation" ], "Triggers": { "@odata.
"Name": "MetricDefinitions", "Members": [ { "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/ ActivePSUs" }, { "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/ ActivePSUsPercent" }, { "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/ ChassisReadingCelsius" }, { "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/ EnergyConsumption" }, { "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/ FanSpeedPercent" }, { "@odata.
PSUInputVoltage" }, { "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/ PeakHeadroom" }, { "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/ PowerConsumedWatts" }, { "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/ LastDayAvgPower" }, { "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/ LastDayMaxPower" }, { "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/ LastDayMaxPowerTime" }, { "@odata.
HTTP response codes 200 /redfish/v1/TelemetryService/MetricReports This URI represents metric report lists. GET method for telemetry metric reports This method lists the metric reports. Description Returns a list of metric reports. Privilege VIEW License Required Advanced License HTTP response codes 200 /redfish/v1/TelemetryService/MetricReports/ID This URI represents the generated metric report containing the list of metric values that are defined in the metric report definition.
Privilege VIEW HTTPS response code 200 Example response body { "@odata.context": "/redfish/ v1/$metadata#MetricReportDefinitionCollection.MetricReportDefinitionCollection", "@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions", "@odata.type": "#MetricReportDefinitionCollection.MetricReportDefinitionCollection", "Name": "MetricReportDefinitions", "Members": [ { "@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/ PSUMetrics" }, { "@odata.
} "Name": "ChassisReadingCelsius", "Description": "ChassisReadingCelsius", "MetricReportDefinitionEnabled": true, "MetricReportDefinitionType": "Periodic", "MetricReportHeartbeatInterval": "PT0H10M0S", "SuppressRepeatedMetricValue": true, "ReportTimespan": "PT0H0M0S", "ReportUpdates": "Overwrite", "ReportActions": [ "RedfishEvent", "LogToMetricReportsCollection" ], "Schedule": { "RecurrenceInterval": "PT0H1M0S" }, "Metrics": [ { "MetricId": "ChassisReadingCelsius" } ] Table 217.
/redfish/v1/TelemetryService/MetricReportDefinitions/ This URI represents specific metric report definitions. GET method for specific metric report definitions This method fetches information about a specific metric report definition. Description Returns information about a specific metric report definition. Privilege VIEW HTTP response codes 200 Example response body { "@odata.type": "#MetricReportDefinition.v1_3_0.MetricReportDefinition", "@odata.
"CollectionDuration": null, "CollectionTimeScope": "Point", "Oem": { "Dell": { "@odata.type": "#DellMetricReportDefinition.v1_0_0.DellMetricReportDefinition", "FQDD": null, "Source": null } } }, { "MetricId": "PSUInputCurrent", "MetricProperties": [], "CollectionFunction": null, "CollectionDuration": null, "CollectionTimeScope": "Point", "Oem": { "Dell": { "@odata.type": "#DellMetricReportDefinition.v1_0_0.DellMetricReportDefinition", "FQDD": null, "Source": null } } } ], "Metrics@odata.
While creating a Metric Report Definition (MRD) with MetricReportDefinitionType as "Periodic" and RecurrenceInterval as "0", the report generated serves like an OnRequest report. If you want to generate a metric report for SSE or Subscription, update the recurrence interval with accepted values such as 2min that is PT2M. Such values help generate a metric report with at least one metric value.
"MetricId": "Health", "MetricProperty": "/redfish/v1/Chassis/System.Embedded.1/ Thermal/InletTemp", "MetricValue": "OK", "Timestamp": "2019-05-14T13:18:10.236Z" } ], "MetricReportName": "testThermalStatus" } Table 218. Attributes Attribute name Description MetricReportName Name of the test metric report. GeneratedMetricReportValues A list of metric report values. MetricDefinition Definition of the metric values. /redfish/v1/TelemetryService/Triggers This URI represents triggers.
"Name": "Trigger on when power cord & PSU removal", "Description": "Trigger when an OEM event is raised", "MetricType": "Numeric", "TriggerActions": [ "RedfishMetricReport" ], "EventTriggers": [ "PSU0003" ], "Links": { "MetricReportDefinitions": [ { "@odata.id": "/redfish/v1/TelemetryService/ MetricReportDefinitions/PSUMetrics" } ] } } /redfish/v1/TelemetryService/Triggers/ID This URI represents trigger information for metrics. GET method for Triggers This method returns a list of triggers.
Managers This URI represents hardware certificate information. /redfish/v1/CertificateService This URI represents the certificate service information. GET method for certificate service This method fetches the certificate service information. Description Fetches the certificate service information. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/ redfish/v1/$metadata#CertificateService.v1_0_3.CertificateService", "@odata.type": "#CertificateService.v1_0_3.
} ] } /redfish/v1/Managers/Members('ChassisManager')/Oem/Dell/ HWCertificate This URI represents the hardware certificate information. GET method for hardware certificates This method gets the hardware certificate information. Description Returns the hardware certificate information. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/redfish/v1/$metadata#Manager.HWCertificate", "@odata.type": "#Manager.HWCertificate", "@odata.
/redfish/v1/Managers/Members('ChassisManager')/Actions/ Oem/DellManager.VerifyHWCertificate This URI validates the hardware certificate. POST method for viewing hardware certificate This method displays the hardware certificate details. Description Adds chassis to a chassis group.
Redfish—OpenID Connect Provider This resource enables you to access the OpenID Connect Provider information. You can use the URIs in this resource to view, fetch, and update OpenID Connect Provider-related details. /api/AccountService/ExternalAccountProvider/ OpenIDConnectProvider This URI creates OpenID Connect Providers in OME-Modular or OpenManage Enterprise. POST method for OpenIDConnect Provider This method creates OpenID Connect Providers in OME-Modular and OpenManage Enterprise.
} "CertificateFile":"Content of TrustStore File" /api/AccountService/ExternalAccountProvider / OpenIDConnectProvider(‘ID’) This URI provides information about a specific OpenID Connect Provider from OME-Modular or OpenManage Enterprise. GET method for specific OpenID Connect Provider This method fetches a specific OpenID Connect Provider from OME-Modular or OpenManage Enterprise. Description Fetches a specific OpenID Connect Provider from OME-Modular or OpenManage Enterprise.
NOTE: If the attribute, IncludeAllIds, is set to "true", you need not provide the OidcServerIds. The IncludeAllIds attribute enables all the OpenID Connect IDs in OMEModular or OpenManage Enterprise. /api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.TestOIDCProvider This URI represents the details of the OpenID Connect Provider test connection.
/api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.DeleteOIDCProviders This API deletes OpenID Connect Provider details. POST method for deleting OpenID Connect Providers This method deletes the OpenID Connect Provider from OME-Modular or OpenManage Enterprise. Description Deletes the OpenID Connect Provider from OME-Modular or OpenManage Enterprise.
