OpenManage Enterprise Version 3.2 and OpenManage Enterprise - Modular Edition Version 1.00.10 RESTful API Guide March 2020 Rev.
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. © 2018 - 2019 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents 1 About this document................................................................................................................... 13 2 Overview....................................................................................................................................14 RESTful application programming interface..................................................................................................................... 14 OData...................................................
/api/AccountService/Roles.........................................................................................................................................45 /api/AccountService/Roles(Id).................................................................................................................................. 46 /api/AccountService/ExternalAccountProvider.......................................................................................................
/api/AlertService/AlertPolicies(Id)............................................................................................................................. 93 /api/AlertService/AlertPolicies(Arg1)/PolicyCriteria............................................................................................... 99 /api/AlertService/AlertPolicies(Arg1)/PolicyCriteria(Arg2).................................................................................. 100 /api/AlertService/AlertPolicies(Arg1)/PolicyActions.
/api/TemplateService/Actions/TemplateService.DetachProfile..........................................................................153 /api/TemplateService/Actions/TemplateService.Clone........................................................................................154 /api/TemplateService/Actions/TemplateService.Export...................................................................................... 154 /api/TemplateService/Actions/TemplateService.Import.........................................
GET method for LogSeverities...................................................................................................................................199 /api/DeviceService/Devices(Id)/Settings.................................................................................................................... 200 GET method for Settings...........................................................................................................................................
/api/GroupService/Groups(Id).......................................................................................................................................223 GET method for Groups(Id).......................................................................................................................................223 PUT method for Groups(Id)......................................................................................................................................
11 Reset application......................................................................................................................261 /api/ApplicationService/Actions/ApplicationService.ResetApplication.....................................................................261 POST method for ResetApplication.......................................................................................................................... 261 12 Console version.....................................................
/api/ManagementDomainService/PendingDomains(Id)....................................................................................... 308 /api/ManagementDomainService/Actions/ManagementDomainService.Domains.......................................... 309 /api/ManagementDomainService/Actions/ManagementDomainService.Join...................................................310 /api/ManagementDomainService/Actions/ManagementDomainService.Leave...............................................
Port configuration in Fabrics............................................................................................................................................ 361 /api/JobService/Jobs.................................................................................................................................................361 Storage management.......................................................................................................................................................
/api/GroupService/Actions/GroupService.DeleteGroup......................................................................................406 /api/GroupService/Actions/GroupService.AddMemberDevices.........................................................................407 /api/GroupService/Actions/GroupService.RemoveMemberDevices................................................................. 407 /api/GroupService/Actions/GroupService.AddUserToGroups..........................................................
1 About this document This document contains information about the resource models for OpenManage Enterprise (OME) and OpenManage Enterprise Modular Edition (OME - Modular). Each RESTful API specification includes the URI, method, parameters, request codes, and response codes. Some of the APIs are available only in OME and do not work if used in OME - Modular and the opposite way. Table 1. Supported REST API versions Product Date of release Whats new OpenManage Enterprise 3.
2 Overview RESTful API support in OME and OME - Modular OME - Modular supports RESTful API. Support for APIs has also been improved for OME. Improved support for APIs on these products enhances the systems management capabilities. The RESTful interface is provided over HTTPS in JSON format based on ODATA v4 usable by clients, scripts, and browser-based GUIs. The APIs enable you to build console management tools based on common programming and scripting languages such as Python, Java, and C.
for growing businesses. A unified web and RESTful API interface manages all nodes including compute, storage, and networking. OME Modular helps reduce costs and learning curve, and consolidates multiple tools for ease of access and monitoring. Simplified administration helps deploy and monitor at scale, from one to many chassis, with support for remote management.
3 Key integration concepts This section describes the key integration concepts that are applicable to the use cases and resource model. Topics: • • • • • • • • • • • • • Base URI Security Authentication Authorization Resource addressing Resource operations Security considerations Data filtering Data sorting Data pagination Request headers Response codes Response headers Base URI REST API tree structure The console software provides a web-based hypermedia driven API using a simple folder structure.
Resource tree for OME - Modular OEM scheme Figure 1. Resource tree for OME - Modular OEM scheme Resource tree for OME OEM scheme Figure 2.
Redfish scheme https://[IP or DNS name]/redfish/v1 Resource tree for Redfish scheme Figure 3. Resource tree for Redfish scheme NOTE: Current version of the console supports the DMTF-defined schema for a selected set of resources in the hierarchy that is outlined in this image. Resource model https://[IP or DNS name]/redfish/v1/$metadata Security To improve security, only HTTPS is supported. You can also update the SSL self-signed certificate with a custom certificate.
X-Auth-Token authentication X-Auth-Token Authentication provides a more secure implementation. To establish a session, perform a POST operation on the SessionService REST API. POST https://[ IP Address ]/api/SessionService/Sessions Input { "UserName":"root", "Password":"linux", "SessionType":"API" } The X-Auth-Token is available in the header that is returned. connection →Keep-Alive content-length →268 content-type →application/json; odata.
Table 3. Role descriptions OME - Modular(continued) Role Description MONITORING_SETUP Alerting policies, forwarding, SupportAssist, and so on. POWER_CONTROL Reboot or power-cycle device. DEVICE_CONFIGURATION Device configuration, application of templates, manage or migrate IO identity, storage mapping, and so on. OPERATING_SYSTEM_DEPLOYMENT Deploy operating system, map to LUN, and so on. DEVICE_UPDATE Device firmware update, application of update baselines, and so on.
Table 4. Roles and associated privileges for OME - Modular(continued) Privilege Roles CHASSIS_ADMINI STRATOR COMPUTE_MANA GER Y Y NETWORK_MANA GEMENT STORAGE_MANA GER FABRIC_MANAGE R VIEWER Y OME Table 5.
Following is the format of a resource URI: // Following is an example of a resource URI, where 1234 is the unique identifier for the device: /DeviceService/Devices(1234) Resource operations Standard HTTP methods are used for creating, retrieving, updating, and deleting resources. The mapping of the HTTP methods to operational semantics is described in the following table: Table 6.
Data filtering The console software provides filtering options on certain URIs that return a collection of entities. Using this feature, the clients can extract a selected set of records using comparison operators on attributes of the model entity behind the collection. The relevant URI sections contain the information about the attributes and the operators that support filtering.
The following table lists a few examples of request headers: Table 7. Examples of request headers Request Header Description Example x-auth-token Authentication token taken from the return header of the SessionService/ Sessions POST operation to create a session. x-auth-token: d6399a19-38c8-467ba1ec-75ffa03efb7c Accept-Language Choice of language that the client can request—Optional. Accept-Language: en Response codes For synchronous operations, the server returns HTTP response codes 200 or 204.
Table 9. Examples of response headers Response Header Description Example Connection Control options for the current connection and list of hop-by-hop request fields. Connection: Keep-Alive Content-Type Specifies the format of the content that the Content-Type: application/json; server returns. If there are multiple formats odata.metadata=minimal that can be accepted in the client request (using the Accept header), the server chooses the appropriate supported format.
4 Application settings Network /api/ApplicationService/Network This URI represents the collection of network application services. GET method for Network This method returns the network configuration details. Description Returns the network configuration details. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Network.Network/$entity", "@odata.id": "/api/ApplicationService/Network", "Actions": null, "ProxyConfiguration": { "@odata.
/api/ApplicationService/Network/ CurrentAddressConfiguration This URI represents the current network IP configuration. GET method for CurrentAddressConfiguration This method returns the current network IP configuration. Description Returns the current network IP configuration. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Network.CurrentAddressConfiguration/ $entity", "@odata.type": "#Network.CurrentAddressConfiguration", "@odata.
Table 10. Attributes(continued) Attribute name Description Ipv4Setting.CurrentPreferredDNSServer Current IPv4 DNS preferred server. Ipv4Setting.CurrentAlternateDNSServer Current IPv4 DNS alternate server. Ipv6Setting.Enable IPv6 network settings status. Ipv6Setting.EnableAutoConfiguration IPv6 via DHCP server status. Ipv6Setting.CurrentIPAddress Current IPv6 address. Ipv6Setting.CurrentGateway Current IPv6 prefix length. Ipv6Setting.CurrentLinkLocalAddress Current IPv6 gateway address.
} "StaticAlternateDNSServer": "" }, "ManagementVLAN": { "EnableVLAN": false, "Id": 1 }, "DnsConfiguration": { "RegisterWithDNS": false, "DnsName": "MX7000", "UseDHCPForDNSDomainName": false, "DnsDomainName": "" }, "Delay": 0 PUT method for AddressConfiguration This method updates the network configuration. Description Updates the network configuration. Privilege APPLIANCE_SETUP HTTP response codes 200 Example Input: { "@odata.context": "/api/$metadata#Network.AddressConfiguration/$entity", "@odata.
Output: { "EnableNIC": true, "Ipv4Configuration": { "Enable": true, "EnableDHCP": true, "StaticIPAddress": "", "StaticSubnetMask": "", "StaticGateway": "", "UseDHCPForDNSServerNames": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "Ipv6Configuration": { "Enable": false, "EnableAutoConfiguration": true, "StaticIPAddress": "", "StaticPrefixLength": 0, "StaticGateway": "", "UseDHCPForDNSServerNames": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "ManagementVLA
Table 11. Attributes(continued) Attribute name Description Ipv6Configuration.StaticIPAddress Set Static IPv6 address. Ipv6Configuration.StaticPrefixLength Set Static IPv6 prefix length. Ipv6Configuration.StaticGateway Set Static IPv6 gateway address. Ipv6Configuration.UseDHCPForDNSServerNames Obtain IPv6 DNS servers via DHCP server options. Ipv6Configuration.StaticPreferredDNSServer Set Static IPv6 DNS preferred server. Ipv6Configuration.
HTTP response codes 200 Example Input: { "TimeOut": 4, "PortNumber": 8778, "EnableWebServer": true } Output: { "@odata.context": "$metadata#Network.WebServerConfiguration/$entity", "@odata.id": "/api/ApplicationService/Network/WebServerConfiguration", "TimeOut": 30, "PortNumber": 443, "EnableWebServer": true } Table 12.
HTTP response codes 200 Example Input: { "TimeZone": "TZ_ID_11", "EnableNTP": false, "PrimaryNTPAddress": null, "SecondaryNTPAddress1": null, "SecondaryNTPAddress2": null, "SystemTime": "2017-35-23 21:35:18" } Output: { "TimeZone": "TZ_ID_11", "EnableNTP": false, "PrimaryNTPAddress": null, "SecondaryNTPAddress1": null, "SecondaryNTPAddress2": null, "SystemTime": "2017-35-23 21:35:18" } Table 13. Attributes Attribute name Description TimeZone The timezone to use.
{ } ] } "Utcoffsetminutes": 330, "Id": "TZ_ID_66", "Name": "(GMT+05:30) Sri Jayawardenepura" Table 14. Attributes Attribute Description Utcoffsetminutes The number of minutes this time zone is offset from UTC. Id The ID of the time zone. Name The name or location of the time zone. /api/ApplicationService/Network/ProxyConfiguration This URI represents the proxy configuration. GET method for ProxyConfiguration This method returns the current proxy configuration.
} Output: { "IpAddress": null, "PortNumber": 0, "Username": null, "Password": null, "EnableAuthentication": false, "EnableProxy": false } Table 15. 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.
} "EnableIpRangeAddress": false, "IpRangeAddress": null, "ByUserName": false, "ByIPAddress": false, "Actions": null, "Accounts": [ { "@odata.id": "/api/AccountService/Accounts" } ], "Roles": [ { "@odata.id": "/api/AccountService/Roles" } ], "ExternalAccountProvider": { "@odata.id": "/api/AccountService/ExternalAccountProvider" } Table 16. Attributes Attribute Description Description Description for the Account service. Name Name given for Account service.
HTTP response codes 200 Example Input: { "Id": "10", "Description": "MSM 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": false, "ByIPAddress": false } Output: { "Id"
Table 17. 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.
} ] } ] } "@odata.id": "/api/AccountService/Accounts('1814')/Permissions" Table 18. Attributes Attribute Description Id Uniquely identifies the resource within the collection. UserTypeId Type of user. DirectoryServiceId Directory service ID. Description Description for the user. Name Name of the user. This name is the same as user name. Password Password for the user. When retrieving the details, Password is displayed as blank. UserName User name of the account.
} "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true Table 19. Attributes Attribute Description Id Uniquely identifies the resource within the collection. UserTypeId Type of user. DirectoryServiceId Directory service ID. Description Description for the user. Name Name of the user. This name is the same as user name. Password Password for the user. When retrieving the details, Password is displayed as blank. UserName User name of the account. RoleId Role for the account.
} ] Table 20. Attributes Attribute Description Id Uniquely identifies the resource within the collection. UserTypeId Type of user. DirectoryServiceId Directory service ID. Description Description for the user. Name Name of the user. This name is the same as user name. Password Password for the user. When retrieving the details, Password is displayed as blank. UserName User name of the account. RoleId Role for the account. Locked Indicates if the account is locked or unlocked.
} "Enabled": true Table 21. Attributes Attribute Description Id Uniquely identifies the resource within the collection. UserTypeId Type of user. DirectoryServiceId Directory service ID. Description Description for the user. Name Name of the user. This name is the same as user name. Password Password for the user. When retrieving the details, Password is displayed as blank. UserName User name of the account. RoleId Role for the account.
Example Input: Output: { "@odata.context": "$metadata#Collection(AccountService.Permission)", "@odata.count": 1, "value": [ { "Id": 3214, "UserId": 3164, "RoleId": 10, "Entities": [ 64 ] } ] } Table 23. Attributes Attribute Description Id Permission record ID. UserId Account ID for which permissions are retrieved. RoleId Role ID of the account. Entities List of entities that the account has access to. /api/AccountService/Actions/AccountService.
/api/AccountService/Actions/AccountService.Disable This URI enables you to disable multiple accounts. POST method for AccountService.Disable This method disables multiple accounts. Description Disables multiple accounts. Privilege SECURITY_SETUP HTTP response codes 204 Example Input: { "AccountIds":[3164,3264] } Output: Table 25. Attributes Attribute Description AccountIds Account IDs to be disabled. /api/AccountService/Actions/AccountService.
/api/AccountService/Roles This URI represents the user roles. GET method for Roles This method returns a list of roles and the respective privileges. Description Returns a list of user roles and respective privileges. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AccountService.Role)", "@odata.count": 5, "value": [ { "@odata.
/api/AccountService/Roles(Id) This URI represents the details of a user role. GET method for Roles(Id) This method returns the details of a user role. Description Returns the details of a user role. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AccountService.Role)", "@odata.count": 5, "value": [ { "@odata.
/api/AccountService/ExternalAccountProvider This URI represents the collection of external account providers. GET method for ExternalAccountProvider This method returns the details of the default LDAP and AD ports and network timeouts. Description Returns the LDAP and AP ports and network timeouts. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#ExternalAccountProvider.ExternalAccountProvider/$entity", "@odata.
/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 Input: Output: { "@odata.context": "$metadata#Collection(ExternalAccountProvider.DirectoryServiceType)", "@odata.
"@odata.context": "$metadata#Collection(ExternalAccountProvider.ADAccountProvider)", "@odata.count": 1, "value": [ { "@odata.id": "/api/AccountService/ExternalAccountProvider/ ADAccountProvider(1264)", "Id": 1264, "Name": "Dell Servers", "ServerType": "MANUAL", "ServerName": [ "ausdc12amer29.amer.dell.
} "SearchTimeOut": 300, "CertificateValidation": false, "CertificateFile": null Table 31. Attributes Attribute Description Id Active Directory or LDAP server ID. ServerType Server type of the directory—DNS or Manual. ServerName Server name of the directory service. UserName User name of the directory service. Password Password of the directory service. ServerPort Port of the directory Service. NetworkTimeOut Network timeout value. SearchTimeOut Search timeout value.
"NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": null, "Groups": [ { "@odata.id": "/api/AccountService/ExternalAccountProvider/ ADAccountProvider(1264)/Groups" } ] } ] } PUT method for ADAccountProvider(Id) This method updates the details of a specific Active Directory server in the collection. Description Updates the details of a specific Active Directory server.
Table 32. Attributes(continued) Attribute name Description ServerPort Port of the directory service. NetworkTimeOut Network timeout value. SearchTimeOut Search timeout value. CertificateValidation Enable or disable certificate validation for the directory service. CertificateFile Certificate file for authentication. /api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.TestADConnection This URI enables you to test the Directory Service connection.
} "dell.com" ], "GroupDomain": "dell.com", "UserName": null, "Password": "", "ServerPort": 3269, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": "" Output: { "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.
/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 Input: Output: { "@odata.context": "$metadata#Collection(ExternalAccountProvider.LDAPAccountProvider)", "@odata.count": 1, "value": [ { "@odata.
} "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": "" Output: { "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 Input: Output: { "@odata.context": "$metadata#ExternalAccountProvider.LDAPAccountProvider/ $entity", "@odata.
} "Password": "test@123", "ServerPort": 3268, "BaseDistinguishedName" : "dc=dell,dc=com", "NetworkTimeOut": 300, "SearchTimeOut": 300, "CertificateValidation": false, "CertificateFile": "" Output: { "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.
} "BindPassword": "", "BaseDistinguishedName": "dc=dell,dc=com", "AttributeUserLogin": null, "AttributeGroupMembership": null, "SearchFilter": null, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": "" Output: { "Name": "LDAP", "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.
Table 36. Attributes(continued) Attribute name Description SearchTimeOut Search timeout value. CertificateValidation Enable or disable certificate validation for the directory service. CertificateFile Certificate file for authentication. /api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.SearchGroups POST method for ExternalAccountProvider.SearchGroups This method returns the Group details of an Active Directory service from the collection.
/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.
] "Description": "admin", "Name": "MSMDevelopmentTeam", "Password": "", "UserName": "MSMDevelopmentTeam", "RoleId": "10", "Locked": false, "Enabled": true, "ObjectGuid": "21dd5985-602f-48a2-bde5-dde50eefb422" } Output: [ { "Id": "4664", "UserTypeId": 2, "DirectortyServiceId": 0, "Name": "test456", "Password": null, "UserName": "test456", "Description": "admin", "Oem": null, "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true, "ObjectGuid": null }, { "Id": "4764", "UserTypeId": 2, "Directo
Table 39. Attributes(continued) Attribute name Description ObjectGuid Unique group ID for directory service. 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 Input: Output: { "@odata.context": "/api/$metadata#ApplicationService.Security/$entity", "@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 Input: Output: { "@odata.context": "$metadata#Collection(ApplicationService.CertInfo)", "@odata.
Table 40. Attributes(continued) Attribute name Description 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.Locality Locality to which the certificate is issued. Value.IssuedTo.State State to which the certificate is issued. Value.IssuedTo.
Table 41. Attributes(continued) Attribute name Description BusinessName Business name that issued the certificate. Locality Locality. State State. Country Country. Email Email associated with the issuer. /api/ApplicationService/Actions/ ApplicationService.UploadCertificate This URI allows you to upload certificates. POST method for UploadCertificate This method uploads a certificate. Description Uploads a certificate.
"Id": 1, "Enabled": true, "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } }, { "Id": 2, "Enabled": true, "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } }, { "Id": 3, "Enabled": false, "DestinationAddress": "100.97.1.
api/AlertService/AlertDestinations/Actions/ AlertDestinations.ApplySNMPConfig POST method for AlertDestinations.ApplySNMPConfig This method configures SNMP. Description Configures SNMP. Privilege MONITORING_SETUP HTTP response codes 200 Example Input: [ { "Enabled": true, "DestinationAddress": "100.97.1.185", "PortNumber": "162", "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } }, { "Enabled": true, "DestinationAddress": "100.97.1.
] "Enabled": true, "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" }, "SnmpV3Credential": null }, { "Id": 3, "Enabled": false, "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" }, "SnmpV3Credential": null }, { "Id": 4, "Enabled": true, "DestinationAddress": "100.97.1.
"@odata.context": "$metadata#Collection(AlertDestinations.SyslogConfiguration)", "@odata.count": 4, "value": [ { "Id": 1, "Enabled": true, "DestinationAddress": "100.97.10.17", "PortNumber": 514 }, { "Id": 2, "Enabled": true, "DestinationAddress": "100.97.10.17", "PortNumber": 514 }, { "Id": 3, "Enabled": true, "DestinationAddress": "10.19.12.1", "PortNumber": 514 }, { "Id": 4, "Enabled": true, "DestinationAddress": "100.97.1.23", "PortNumber": 514 } ] } Table 44.
}, { "Enabled": true, "DestinationAddress": "100.97.10.17", "PortNumber": 514 }, { "Enabled": true, "DestinationAddress": "10.19.12.1", "PortNumber": 514 }, { ] } "Enabled": true, "DestinationAddress": "100.97.1.
HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AlertDestinations.SMTPConfiguration)", "@odata.count": 1, "value": [ { "DestinationAddress": "10.35.12.7", "UseCredentials": false, "PortNumber": 25, "UseSSL": false, "Credential": null } ] } Table 46. Attributes Attribute name Description DestinationAddress Destination address of SMTP. PortNumber Port number of SMTP. UseCredentials Indicates if credentials are used. UseSSL Indicates if SSL is used.
Table 47. Attributes(continued) Attribute name Description PortNumber Port number of SMTP. UseCredentials Indicates if credentials are used. UseSSL Indicates if SSL is used. User User name Password Password /api/AlertService/AlertDestinations/Actions/ AlertDestinations.SendTestTrap POST method for AlertDestinations.SendTestTrap This method sends an SNMP trap to the destination address. Description Sends an SNMP trap to the destination address.
5 Alerts Alert logs /api/AlertService/Alerts This URI represents the alerts. Table 49. Filters Filter name Description Top Top records to return. Default value is 100. Skip Max records to skip. Default value is 0. Orderby Order to apply to the output. Id Filter by event ID. Default value is 0. AlertDeviceId Filter by device ID. Default value is 0. AlertDeviceIdentifier Filter by device identifier. AlertDeviceType Filter by device type. Default value is 0.
[ } ] { } "@odata.id": "/api/AlertService/Alerts(2)", "Id": 2, "SeverityType": 16, "SeverityName": "Critical", "AlertDeviceId": 1714, "AlertDeviceName": "localhost.smd.devops.dell.com", "AlertDeviceType": 1000, "AlertDeviceIpAddress": "xx.xx.xx.
Table 50. Attributes(continued) Attribute name Description Message Message describing the issue. EemiMessage Event and Error Message describing the issue, if applicable. RecommendedAction Recommended action for the alert. AlertMessageId Event and Alert Message ID associated with the issue. AlertVarBindDetails List of variable bindings of the alert, if applicable. AlertMessageType Type of message—Internal, SNMP, Redfish, and so on.
/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 Input: Output: { "@odata.context": "$metadata#AlertService.Alert/$entity", "@odata.id": "/api/AlertService/Alerts(3)", "Id": 3, "SeverityType": 16, "SeverityName": "Critical", "AlertDeviceId": 1714, "AlertDeviceName": "localhost.smd.devops.dell.
Table 51. Attributes(continued) Attribute name Description 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. SubCategoryId Sub category ID associated to alert. SubCategoryName Sub category name associated to alert. StatusType ID of status type. StatusName Name of status type. TimeStamp Date and time when the alert was raised.
] } "Id": 7400, "Name": "Health Status of Managed device", "Description": "Health Status of Managed device" }, { } } ] } "Id": 1003, "Name": "Audit", "CatalogName": "Application", "SubCategoryDetails": [ { "Id": 7600, "Name": "Device Compliance", "Description": "Device Compliance" } ] Table 52. Attributes Attribute name Description Name Name of the catalog for the category. CategoriesDetails Id ID of the category associated on the catalog. Name Name of category.
} } "Name": "System Health", "CatalogName": "Application", "SubCategoryDetails": [ { "Id": 7500, "Name": "Online Status of Managed device", "Description": "Online Status of Managed device" }, { "Id": 7400, "Name": "Health Status of Managed device", "Description": "Health Status of Managed device" } ] Table 53. Attributes Attribute name Description Name Name of the catalog for the category. CategoriesDetails Id ID of the category associated on the catalog. Name Name of category.
} ] "Id": 2, "Name": "Info", "Description": "Info" }, { "@odata.id": "/api/AlertService/AlertSeverities(4)", "Id": 4, "Name": "Normal", "Description": "Normal" }, { "@odata.id": "/api/AlertService/AlertSeverities(8)", "Id": 8, "Name": "Warning", "Description": "Warning" }, { "@odata.id": "/api/AlertService/AlertSeverities(16)", "Id": 16, "Name": "Critical", "Description": "Critical" } Table 54. Attributes Attribute name Description Id ID of the severity. Name Name of the severity.
Table 55. Attributes(continued) Attribute name Description Description Description of the severity. /api/AlertService/AlertStatuses This URI represents the statuses for an alert. GET method for AlertStatuses This method returns all possible statues that are applicable to an alert. Description Returns all the possible alert statues. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AlertService.AlertStatus)", "@odata.
Example Input: Output: { "@odata.context": "$metadata#AlertService.AlertStatus/$entity", "@odata.id": "/api/AlertService/AlertStatuses(1000)", "Id": 1000, "Name": "Acknowledged", "Description": "The event was acknowledged" } Table 57. Attributes Attribute name Description Id ID of the alert status. Name Name of the alert status Description Description of the alert status. /api/AlertService/AlertCatalogs This URI represents the catalogs applicable to an event. Table 58.
"ReleaseVersion": "v3.3", "IsBuiltIn": true, "IsVisible": true }, { } } "@odata.id": "/api/AlertService/AlertCatalogs(1002)", "Id": 1002, "CatalogName": "iDRAC", "InternalName": "MIB-Dell-10909", "ReleaseVersion": "9.0.0", "IsBuiltIn": true, "IsVisible": true Table 59. Attributes Attribute name Description Id Catalog ID. CatalogName Name of the catalog. InternalName Internal name associated with the catalog. ReleaseVersion Catalog version.
Table 60. Attributes(continued) Attribute name Description InternalName Internal name associated with the catalog. ReleaseVersion Catalog version. IsBuiltIn Indicates if the catalog in built-in or is manually included. IsVisible Indicates if the catalog is visible or hidden. /api/AlertService/Events This URI represents the events. POST method for Events This method creates an event. Description Creates a Redfish event.
} } "DeviceType": 0, "Severity": 0, "StatusType": 1000, "StartDate": "", "EndDate": "", "SourceName": "", "Category": 0, "SubCategory": 0, "Message": "" Output: Table 61. Attributes Attribute Description AlertIds List of alert IDs. This value is an empty list when AllAlerts is True. AllAlerts True or False. Determines if action should be taken for all alerts. Filters Optional filters to specify when AllAlerts is True. DeviceIds List of IDs of devices. DeviceType Device type ID.
} } "DeviceType": 0, "Severity": 0, "StatusType": 1000, "StartDate": "", "EndDate": "", "SourceName": "", "Category": 0, "SubCategory": 0, "Message": "" Output: Table 62. Attributes Attribute Description AlertIds List of alert IDs. This value is an empty list when AllAlerts is True. AllAlerts True or False. Determines if action should be taken for all alerts. Filters Optional filters to specify when AllAlerts is True. DeviceIds List of IDs of devices. DeviceType Device type ID.
} } "Severity": 0, "StatusType": 1000, "StartDate": "", "EndDate": "", "SourceName": "", "Category": 0, "SubCategory": 0, "Message": "" Output: Table 63. Attributes Attribute Description AlertIds List of alert IDs. This value is an empty list when AllAlerts is True. AllAlerts True or False. Determines if action should be taken for all alerts. Filters Optional filters to specify when AllAlerts is True. DeviceIds List of IDs of devices. DeviceType Device type ID. Severity ID of severity.
Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AlertService.AlertPolicy)", "@odata.count": 1, "value": [ { "@odata.id": "/api/AlertService/AlertPolicies(314)", "Id": 314, "Name": "Default OnDemand Health Policy", "Description": "This policy is applicable to all devices. A health task will be triggered if category is for system health.
} ] Table 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. PolicyData CatalogName Name of the catalogs associated with the policy.
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. POST method for AlertPolicies This method creates a policy. Description Creates a policy.
] } } ] } }, "State": true Output: { "Id": 4114, "Name": "Policy", "Description": "Policy", "Enabled": true, "DefaultPolicy": false, "Editable": true, "Visible": true, "PolicyData": { "Catalogs": [ { "CatalogName": "iDRAC", "Categories": [ 0 ], "SubCategories": [ 0 ] }, { "CatalogName": "Application", "Categories": [ 0 ], "SubCategories": [ 0 ] } ], "Severities": [ 16, 1, 2, 4, 8 ], "Devices": [ 1714 ], "DeviceTypes": [ 1000 ], "Groups": [], "Schedule": { "StartTime": "2016-06-06 15:02:46.
] }, { "Name": "to", "Value": "test@dell.com", "Type": "string", "TypeParams": [ { "Name": "maxLength", "Value": "255" } ] }, { "Name": "from", "Value": "MCSIApplication@Dell.
"Description": "This policy is applicable to all devices. A health task will be triggered if category is for system health.
Table 66. Attributes(continued) Attribute name Description Visible Indicate if the policy is visible or hidden. PolicyData CatalogName Name of the catalogs associated with the policy. This field is checked during policy evaluation. Categories Name of the categories associated with the policy. This field is checked during policy evaluation. SubCategories Name of the subcategories associated with the policy. If defined, this field is checked during policy evaluation.
"Id": 4114, "Name": "Policy Test 1", "Description": "Policy Test 1", "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": [1914], "Groups": [], "DeviceTypes": [1000], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.
{ "CatalogName": "iDRAC", "Categories": [ 0 ], "SubCategories": [ 0 ] }, { "CatalogName": "Application", "Categories": [ 0 ], "SubCategories": [ 0 ] } ], "Severities": [ 16, 1, 2, 4, 8 ], "Devices": [ 1914 ], "DeviceTypes": [ 1000 ], "Groups": [], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.
] } "Name": "maxLength", "Value": "255" }, { "Name": "message", "Value": "Event occurred for Device Name: $name, Device IP Address: $ip, Service Tag: $identifier, Time: $time, Severity: $severity, $message", "Type": "string", "TypeParams": [ { "Name": "maxLength", "Value": "255" } ] } ], "TemplateId": 50 } ] }, "State": true } Table 67. Attributes Attribute name Description ID Event record ID. Name Name associated with the policy. Description Description associated with the policy.
Table 67. Attributes(continued) Attribute name Description EndTime End event-time to verify. This value indicates the end date and time for policy validity. If defined. This field is validated during policy evaluation. CronString CRON string associated to the policy. This field indicates a special CRON that can be applied to the policy to indicate values such as the days for which the policy is valid. Actions Id ID of action. Name Name associated with the action.
"Id": 4, "PolicyId": 314, "Parameter": "", "Value": "(catalogName == 'iDRAC' AND categoryId==3300) AND (severityType==1 OR severityType==2 OR severityType==4 OR severityType==8 OR severityType==16)", "Type": 3, "TypeName": "EXPRESSION", "ComparisonType": 3, "ComparisonTypeName": "Equal" } ] } Table 69. 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.
} "ComparisonTypeName": "Equal" Table 70. 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.
} ] } } "Description": "OnDemandHealth", "Disabled": false, "ParameterDetails": [] Table 72. Attributes Attribute name Description Id ID of the criteria. PolicyId ID of the policy with which the action is associated. Name Name of the action. Parameters Extra parameter that can be added to the action. TemplateId ID of the action template associated with the action. Template Id ID of the template. Name Name of the template. Description Additional description of the template.
} } Table 73. Attributes Attribute name Description Id ID of the criteria. PolicyId ID of the policy with which the action is associated. Name Name of the action. Parameters Extra parameter that can be added to the action. TemplateId ID of the action template associated with the action. Template Id ID of the template. Name Name of the template. Description Extra description of the template. Disabled Indicates if template is enabled or disabled.
"Id": 90, "Name": "Syslog", "Description": "Syslog", "Disabled": true, "ParameterDetails": [] }, { "@odata.id": "/api/AlertService/AlertActionTemplates(80)", "Id": 80, "Name": "OnDemandHealth", "Description": "OnDemandHealth", "Disabled": false, "ParameterDetails": [] }, { } ] } "@odata.id": "/api/AlertService/AlertActionTemplates(100)", "Id": 100, "Name": "Ignore", "Description": "Ignore", "Disabled": false, "ParameterDetails": [] Table 74.
Table 75. Attributes Attribute name Description Id ID of the action template. Name Name of the action template. Description Extra description of the action template. Disabled Indicates if the template is enabled or disabled. ParameterDetails 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.
Input: { "AllPolicies": true } Output: /api/AlertService/Actions/ AlertService.RemoveAlertPolicies POST method for AlertService.RemoveAlertPolicies This method removes the selected set of alert policies or all the alert policies. Description Removes the selected alerts policies.
GET method for AlertMessageDefinitions This method returns the definitions for all alert messages. Description Returns the definitions for all alert messages. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AlertService.AlertMessageDefinition)", "@odata.count": 3, "value": [ { "@odata.
/api/AlertService/AlertMessageDefinitions(Id) This URI represents a specific message definition. GET method for AlertMessageDefinitions(Id) This method returns the details of a specific message definition. Description Returns the definitions of a specific message. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#AlertService.AlertMessageDefinition/$entity", "@odata.
HTTP response codes Example 200 Input: Output: { "@odata.context": "/api/ $metadata#Collection(AlertService.AlertMessageDefinitionCategory)", "@odata.count": 6, "value": [ {"@odata.type": "#AlertService.AlertMessageDefinitionCategory", "@odata.id": "/api/AlertService/AlertMessageDefinitionsCategories('Audit')", …}, {"@odata.type": "#AlertService.AlertMessageDefinitionCategory", "@odata.id": "/api/AlertService/ AlertMessageDefinitionsCategories('Configuration')",…}, {"@odata.type": "#AlertService.
"@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Devices" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Fabric" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Fan Event" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Feature Card" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Group Manager" }, { "@odata.
}, { "SubCategory": "Management Module" "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Memory" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Node" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "PCI Device" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Power Supply" }, { "@odata.type": "#AlertService.
{ "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "UEFI Event" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "User Tracking" }, { "@odata.type": "#AlertService.
6 Configure Firmware /api/UpdateService/Catalogs This URI represents the catalogs in the appliance. GET method for Catalogs This method returns the catalogs created in the appliance. Description Returns the list of catalogs. Privilege VIEW HTTP response codes 200 Example Input: { "@odata.context": "/api/$metadata#Collection(UpdateService.Catalogs)", "@odata.count": 1, "value": [ { "@odata.type": "#UpdateService.Catalogs", "@odata.
"BaselineId": 7, "BaselineName": "Test 100" }, { "BaselineId": 8, "BaselineName": "Test 2500+" } ] } } ], "Repository": { "@odata.type": "#UpdateService.Repository", "Id": 12, "Name": "Dell", "Description": "", "Source": "downloads.dell.com", "DomainName": null, "Username": null, "Password": null, "CheckCertificate": false, "RepositoryType": "DELL_ONLINE" } POST method for Catalogs This method creates a catalog. Description Creates a catalog.
HTTP response codes Example 200 Input: Output: { "@odata.context": "/api/$metadata#UpdateService.Catalogs/$entity", "@odata.type": "#UpdateService.Catalogs", "@odata.id": "/api/UpdateService/Catalogs(28)", "Id": 28, "Filename": "CatalogA00.xml", "SourcePath": "cifs/compute", "Status": "Completed", "TaskId": 26960, "BaseLocation": "", "ManifestIdentifier": "", "ReleaseIdentifier": "8217fadb-ec37-46a4-b7ba-56a353dbf3d2", "ManifestVersion": null, "ReleaseDate": "2018-05-21 05:33:25.
{ "@odata.type": "#UpdateService.Baselines", "@odata.id": "/api/UpdateService/Baselines(8)", "Id": 8, "Name": "Test 2500+", "Description": "", "CatalogId": 22, "RepositoryId": 12, "TaskId": 27734, "RepositoryName": "Dell", "RepositoryType": "DELL_ONLINE", "LastRun": "2018-08-08 21:22:36.
Output: api/UpdateService/Baselines(Id) This URI represents a specific baseline. GET method for Baselines(Id) This method returns the details of a specific baseline. Description Returns details of a specific baseline. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#UpdateService.Baselines/$entity", "@odata.type": "#UpdateService.Baselines", "@odata.
}, { }, { }, { }, { } "Id": 1000, "Name": "DEVICE" "Id": 25033, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25035, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25580, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25585, "Type": { "Id": 1000, "Name": "DEVICE" } } ], "ComplianceSummary": { "ComplianceStatus": "OK", "NumberOfCritical": 0, "NumberOfWarning": 0, "NumberOfNormal": 9, "NumberOfDowngrade": 0 }, "DeviceComplianceReports@odata.
"value": [ { "@odata.type": "#UpdateService.DeviceComplianceReport", "@odata.id": "/api/UpdateService/Baselines(9)/ DeviceComplianceReports(9523)", "Id": 9523, "DeviceId": 25031, "ServiceTag": "JP00002", "DeviceModel": "PowerEdge MX740c", "DeviceTypeName": "SERVER", "DeviceName": "iDRAC-JP00002", "FirmwareStatus": "Compliant", "ComplianceStatus": "OK", "DeviceTypeId": 1000, "RebootRequired": false, "ComponentComplianceReports@odata.
/api/UpdateService/Baselines(Id)/ DeviceComplianceReports(Id)/ ComponentComplianceReports This URI represents the compliance reports for specific devices. GET method for ComponentComplianceReports This method returns the compliance report for a specific device. Description Returns the compliance report for a specific device from a specific baseline. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(UpdateService.
Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#UpdateService.ComponentComplianceReport/ $entity", "@odata.type": "#UpdateService.ComponentComplianceReport", "@odata.id": "/api/UpdateService/Baselines(8)/DeviceComplianceReports(190)/ ComponentComplianceReports(1597)", "Id": 1597, "Version": "10.4.0E.R3S.285", "CurrentVersion": "10.4.0E.R3S.285", "Path": "Network_Firmware_27PY3_WN64_10.4.0E.R3S.285_A00.
HTTP response codes Example 200 Input: { } "FileToken": "1481131455800" Output: /api/UpdateService/Actions/ UpdateService.RemoveCatalogs POST method for RemoveCatalogs This method deletes catalogs. Description Deletes a catalog. Privilege BASELINE_MANAGEMENT HTTP response codes 204 Example Input: { "CatalogIds":["12"] } Output: /api/UpdateService/Actions/ UpdateService.RemoveBaselines POST method for RemoveBaselines This method deletes baselines. Description Deletes baselines.
/api/UpdateService/Actions/ UpdateService.GetSingleDupDetails POST method for GetSingleDupDetails This method returns the details of a specific Dell Update Package (DUP). Description Returns the details of a specific DUP. Privilege DEVICE_UPDATE HTTP response codes 200 Example Input: { "FileToken": "1481131455800" } Output: { "Date": "2016-01-12 02:37:36.000", "VendorVersion": "1.4.3", "SchemaVersion": "1.0", "ReleaseDate": "2016-01-11 00:00:00.000", "ReleaseId": "G1JD51.4.
} }, { ] 124 Configure "ComponentCurrentVersion": "2.10.10.10", "ComponentUriInformation": null, "DeviceTypeName": "SERVER", "ComponentVersion": "2.30.30.30", "ComponentCriticality": "Recommended", "DeviceId": "1674", "DeviceServiceTag": "JS8BDV1", "IsCompliant": "CRITICAL", "ComponentTargetIdentifier": "25227", "ComponentSourceName": "DCIM:INSTALLED#iDRAC.Embedded.
/api/UpdateService/Actions/ UpdateService.GetBaselinesReportByDeviceids POST method for GetBaselinesReportByDeviceids This method returns the baseline report for specific device IDs. Description Returns the baseline report for specific device IDs. Privilege BASELINE_MANAGEMENT HTTP response codes 200 Example Input: { "Ids":["Device ID"] } Response payload: [ { "Id": 6, "Name": "Baseline1", "Description": "", "LastRun": "2021-09-14 20:34:18.
] } /api/UpdateService/Actions/ UpdateService.GetCertDetails POST method for GetCertDetails This method returns the details of a certificate. Description Returns the details of a certificate. Privilege DEVICE_UPDATE HTTP response codes 200 Example Input: { "UriPath": "https://[ IP Address ]" } Output: { "Version": "3", "Subject": "ST=Texas, C=USA, O=Dell Inc., L=Round Rock, CN=OMEDEV-DAHIR", "SignatureAlgorithm": "SHA1withRSA", "SignatureAlgorithmOid": "1.2.840.113549.1.1.5", "PublicKey": "X.
{ } ] "@odata.id": "/api/TemplateService/TemplateTypes(0)", "Name": "None", "ConfigurationSections": [] }, { "@odata.id": "/api/TemplateService/TemplateTypes(2)", "Name": "Server", "ConfigurationSections": [] }, { "@odata.id": "/api/TemplateService/TemplateTypes(4)", "Name": "Chassis", "ConfigurationSections": [] }, { "@odata.
"@odata.id": "/api/TemplateService/TemplateViewTypes(3)", "Id": 3, "Description": "Inventory" }, { } ] } "@odata.id": "/api/TemplateService/TemplateViewTypes(4)", "Id": 4, "Description": "Sample" Table 80. Attributes Attribute Description Id Unique identifier for the template view type. Name Identifies the features that supports template operations. /api/TemplateService/Templates This URI represents the templates.
"CreationTime": "2017-11-30 19:02:11.200378", "LastUpdatedBy": null, "LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(1)/Views" } ] }, { "@odata.
"CreationTime": "2017-11-30 19:02:11.200378", "LastUpdatedBy": null, "LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(4)/Views" } ] }, { "@odata.
"CreatedBy": "system", "CreationTime": "2017-11-30 19:02:11.200378", "LastUpdatedBy": null, "LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(7)/Views" } ] }, { "@odata.
Table 82. Attributes Attribute Description Name Template name Description Definition for the template TypeId Template type. For more information, see /TemplateService/ TemplateTypes. ViewTypeId Template View type. For more information, see / TemplateService/TemplateViewTypes. SourceDeviceId The identifier of the device—the reference device—from which a template is to be created. Fqdds The FQDDs to copy from the reference device, as a commaseparated string.
Table 83. Attributes(continued) Attribute Description • • • • • • • • iDRAC System BIOS NIC LifeCycleController RAID EventFilters All To get the entire device configuration, useAll. /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 Input: Output: { "@odata.
Table 84. Attributes(continued) Attribute Description Description Definition for the template. SourceDeviceId The identifier of the device whose configuration was used as a reference for creating the template. TypeId Template type. For more information, see /TemplateService/ TemplateTypes. ViewTypeId Template View type. For more information, see / TemplateService/TemplateViewTypes. TaskId The identifier of the task that created the template.
} Output: ID of the template Table 85. Attributes Attribute name Description ID Template ID Name Template Name Description Definition for the template 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.
system stack-unit 0 default system: B:\nboot system gateway 100.100.230.1\n! \nhostname Dell\n! \nprotocol lldp \n!\nredundancy auto-synchronize full\n! \nenable password 7 b125455cf679b208fcf9eeeed0cd6d84\n!\nusername root password 7 d7acc8a1dcd4f698 privilege 15\nusername root password 7 d7acc8a1dcd4f698 privilege 15\n! \nstack-unit 0 provision I/O-Aggregator\n! \ninterface TenGigabitEthernet 0/1\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/2\n auto vlan\n! \n protoco
} "TypeId": 3, "ViewTypeId": 2, "TaskId": 10313, "HasIdentityAttributes": false, "Status": 2060, "IdentityPoolId": 0, "IsPersistencePolicyValid": true, "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 86.
HTTP response codes Example 200 Input: Output: { "@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.
Example Input: Output: { "@odata.context": "/api/$metadata#TemplateService.AttributeView/$entity", "@odata.id": "/api/TemplateService/Templates(10)/Views(1)", "Id": 1, "Name": "DefaultModel", "Description": "The default hierarchical model of a template. The hierarchy consists of component classes, groups (from the attribute registry) and attributes.", "AttributeViewDetails": { "@odata.id": "/api/TemplateService/Templates(10)/Views(1)/ AttributeViewDetails" }, "DeviceAttributeViewDetails": [ { "@odata.
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": false }, { "AttributeId": 356
Table 88. 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.
iSCSI storage target.", "IsReadOnly": false, "IsSecure": false, "TextMinLength": 0, "TextMaxLength": 223, "ValueMin": 0, "ValueMax": 0, "DependencyText": null, "OptionSetId": 0, "DefaultOptionId": 0, "GenericNameId": 2258 }, { "Id": 3637, "DataType": 4308, "Description": "Specify the iSCSI Qualified Name (IQN) of the fifth iSCSI storage target.
} ] /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 Input: Output: { "@odata.context": "/api/$metadata#TemplateService.
"CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 0, "CustomId": 43, "AttributeEditInfoId": 0, "DisplayName": "Vlan Tagged", "Description": null, "Value": null, "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 0, "CustomId": 43, "AttributeEditInfoId": 0, "DisplayName": "Vlan UnTagged", "Description": null, "Value": "0", "IsReadOnly": false, "IsIgnored": fal
{ "GroupNameId": 3, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3369, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", "Description": null, "Value": "20", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3370, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false } ] } ], "Attributes": []
"GroupNameId": 1, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3431, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", "Description": null, "Value": "20", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3432, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 0, "CustomI
] }, { } "AttributeId": 3485, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] "GroupNameId": 2, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 3, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3503, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", "Descrip
] } "AttributeId": 3523, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] } ], "Attributes": [] } ], "Attributes": [] } ], "TemplateEditInfoDetails": { "@odata.
} ] } ] } "IsReadOnly": false, "IsIgnored": false /api/TemplateService/Profiles This URI represents the profiles. GET method for Profiles This method returns the list of available profiles. Description Returns list of profiles. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(TemplateService.Profile)", "@odata.count": 12, "value": [ {"@odata.type": "#TemplateService.Profile", "@odata.
/api/TemplateService/Profiles(Id) This URI represents a specific profile. 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 Input: Output: { "@odata.context": "/api/$metadata#TemplateService.Profile/$entity", "@odata.type": "#TemplateService.Profile", "@odata.
/api/TemplateService/Actions/ TemplateService.GetAssignedIdentities POST method for TemplateService.GetAssignedIdentities This method returns a list of virtual identities reserved for a specified target device. The reply also includes boot option attributes. Description Returns a list of virtual identities for a specific target device.
] } "Value": "10:10:10:10:10:0E", "IsReadOnly": true, "IsIgnored": false }, { } ] } ] } ] } ] "GroupNameId": 1, "DisplayName": "Partition", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 0, "CustomId": 0, "AttributeEditInfoId": 0, "DisplayName": "Protocol", "Description": "", "Value": "iSCSI", "IsReadOnly": true, "IsIgnored": false }, { "AttributeId": 0, "CustomId": 0, "AttributeEditInfoId": 0, "DisplayName": "iSCSI IQN", "Description": "iSCSI IQN", "Value": "iqn.pool1.
Privilege TEMPLATE_MANAGEMENT HTTP response codes 200 Example Input: { "SourceEntityId" : 13, "ForceMigrate" : false } Output: /api/TemplateService/Actions/TemplateService.Clone POST method for TemplateService.Clone This method creates a clone of a template. Description Clones a template.
\"LCAttributes.1#PartFirmwareUpdate\">Match firmware of replaced part\nApply always\nOff\nEnabled\nFalse\nDisabled\n
lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/4\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/5\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/6\n auto vlan\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/7\n auto vlan\n! \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 ll
/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 codes 200 Example Input: { "Id": 11, "TargetIds": [5514], "NetworkBootIsoModel": { "BootToNetwork": true, "ShareType": "CIFS", "IsoPath": "bootToIsoPath.iso", "ShareDetail": { "IpAddress": "xx.xx.xx.xx", "ShareName": "xx.xx.xx.
] } "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/ TemplateService.UpdateNetworkConfig POST method for TemplateService.
} ] "Id": 3350, "Value": "30", "IsIgnored": false }, { "Id": 3351, "Value": "100", "IsIgnored": false }, { "Id": 3369, "Value": "20", "IsIgnored": false }, { "Id": 3370, "Value": "100", "IsIgnored": false }, { "Id": 3388, "Value": "30", "IsIgnored": false }, { "Id": 3389, "Value": "100", "IsIgnored": false }, { "Id": 3431, "Value": "20", "IsIgnored": false }, { "Id": 3432, "Value": "100", "IsIgnored": false }, { "Id": 3484, "Value": "30", "IsIgnored": false }, { "Id": 3485, "Value": "100", "IsIgnored": fa
} "VlanAttributes": [ { "ComponentId": 1090, "Untagged": 25455, "Tagged": [25531,25532] } ] /api/TemplateService/Actions/ TemplateService.RemoveBaseline POST method for TemplateService.RemoveBaseline Description This method removes the compliance baseline. Privilege TEMPLATE_MANAGEMENT HTTP response codes 200 Example Input { "BaselineIds": [1,2,5..] } /api/TemplateService/Actions/ TemplateService.Remediate POST method for TemplateService.
HTTP response codes Example 200 Input { "SourceDeviceEntityId":1234, "DestinationDeviceEntityId":5555, "ForceMigrate":false } Identity pools /api/IdentityPoolService/IdentityPools This URI represents the identity pools. GET method for IdentityPools This method returns the details of all identity pools. Description Returns identity pools. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(IdentityPoolService.IdentityPool)", "@odata.
{ "IpRange": "15.15.15.0/24", "SubnetMask": "255.255.255.0", "Gateway": null, "PrimaryDnsServer": null, "SecondaryDnsServer": null } }, "FcoeSettings": { "Mac": { "IdentityCount": 240, "StartingMacAddress": "FBQUFBQB" } }, "FcSettings": { "Wwnn": { "IdentityCount": 260, "StartingAddress": "IAAWFhYWFgE=" }, "Wwpn": { "IdentityCount": 260, "StartingAddress": "IAEWFhYWFgE=" } }, "UsageCounts": { "@odata.id": "/api/IdentityPoolService/IdentityPools(1)/UsageCounts" }, "UsageIdentitySets@odata.
} }, "FcoeSettings": { "Mac": { "IdentityCount": 75, "StartingMacAddress": "cHBwcHAA" } }, "FcSettings": { "Wwnn": { "IdentityCount": 85, "StartingAddress": "IACAgICAgAA=" }, "Wwpn": { "IdentityCount": 85, "StartingAddress": "IAGAgICAgAA=" } }, "UsageCounts": { "@odata.id": "/api/IdentityPoolService/IdentityPools(10)/UsageCounts" }, "UsageIdentitySets@odata.
"IdentityCount":75, "StartingMacAddress": "cHBwcHAA" } } }, "FcSettings": { "Wwnn": { "IdentityCount":85, "StartingAddress": "IACAgICAgAA=" }, "Wwpn": { "IdentityCount":85, "StartingAddress": "IAGAgICAgAA=" } } Output: /api/IdentityPoolService/IdentityPools(Id) This URI represents a specific identity pool. GET method for IdentityPools(Id) This method returns the details of a specific identity pool. Description Returns a specific identity pool.
"IqnPrefix": "Iqn.MyIqnPrefix" }, "InitiatorIpPoolSettings": null }, "FcoeSettings": { "Mac": { "IdentityCount": 75, "StartingMacAddress": "cHBwcHAA" } }, "FcSettings": { "Wwnn": { "IdentityCount": 85, "StartingAddress": "IACAgICAgAA=" }, "Wwpn": { "IdentityCount": 85, "StartingAddress": "IAGAgICAgAA=" } }, "UsageCounts": { "@odata.id": "/api/IdentityPoolService/IdentityPools(4)/UsageCounts" }, "UsageIdentitySets@odata.
"Mac": { { "IdentityCount": 75, "StartingMacAddress": "cHBwcHAA" } }, "FcSettings": "Wwnn": { "IdentityCount": 85, "StartingAddress": "IACAgICAgAA=" }, "Wwpn": { } } } "IdentityCount": 85, "StartingAddress": "IAGAgICAgAA=" Output: Table 89.
/api/IdentityPoolService/IdentityPools(Id)/UsageCounts This URI represents the summary of the usage of identity pools. GET method for UsageCounts This method returns the summary of the usage of identity pools. Description Returns a summary of the usage of identity pools. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#IdentityPoolService.UsageCounts/$entity", "@odata.type": "#IdentityPoolService.UsageCounts", "@odata.
/api/IdentityPoolService/IdentityPools(Id)/ UsageIdentitySets This URI represents the usage identity sets. GET method for UsageIdentitySets This method returns usage identity sets. These sets represent the different protocols for which identity values get reserved. Description Returns the usage identity sets. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(IdentityPoolService.UsageIdentitySet)", "@odata.count": 4, "value": [ { "@odata.
/api/IdentityPoolService/IdentityPoolsI(Id)/ UsageIdentitySets(Id) This URI represents a specific usage identity set. GET method for UsageIdentitySets(Id) This method returns a specific usage identity set. Description Returns a usage identity set. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#IdentityPoolService.UsageIdentitySet/ $entity", "@odata.type": "#IdentityPoolService.UsageIdentitySet", "@odata.
"@odata.type": "#IdentityPoolService.UsageDetail", "TypeofDataSchemaFunction": 3, "IdentitySetId": 1, "Status": 2, "MacAddress": "10:10:10:10:10:22", "IscsiIqn": null, "IscsiInitiatorIp": null, "Wwnn": null, "Wwpn": null, "NicIdentifier": "NIC in Mezzanine 1A Port 2 Partition 1", "DeviceInfo": { "ChassisName": "MX-LCX", "SlotNumber": "7", "ServerName": "idrac-SRVC333", "ManagementIp": "10.215.2.134" } }, { } ] } "@odata.type": "#IdentityPoolService.
"Name": "Reserved", "Description": "Assigned to a profile; deployment pending." }, { } ] } "@odata.type": "#IdentityPoolService.IdentityState", "@odata.id": "/api/IdentityPoolService/IdentityStates(2)", "Id": 2, "Name": "Assigned", "Description": "Assigned to a profile and provisioned on device." /api/IdentityPoolService/IdentityStates(Id) This URI represents a specific identity state. GET method for IdentityStates(Id) This method returns the details of a specific identity state.
Network Configuration Service This resource enables you to access the network service and perform network-related tasks. These tasks include viewing the logical networks and the network types, creating a new logical network, deleting a logical network, and so on. Use the URIs in this resource to access the network service and the associated actions. /api/NetworkConfigurationService/Networks This URI represents the logical networks.
Table 90. Attributes(continued) Attribute name Description Description Description of the network. VlanMaximum VLan can be defined as either a range or a single value. If a single value is defined, the same value is assigned to both VlanMaximum and VlanMinimum. VlanMinimum VLan can be defined as either a range or a single value. If a single value is defined, the same value is assigned to both VlanMaximum and VlanMinimum. Type Network type.
/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 Input: Output: { "@odata.context": "/api/$metadata#NetworkConfigurationService.Network/ $entity", "@odata.
} "InternalRefNWUUId": 0 Table 91. Attributes Attribute name Description ID The identifier of the target network profile. Name The target network profile name. Description The target network profile description. VlanMaximum Maximum VLAN value, when a network profile is defined as a range. VlanMinimum Minimum VLAN value, when a network profile is defined as a range. NOTE: To define a profile which is not in a range, the VlanMaximum and VlanMinimum need to be same.
"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 92.
/api/NetworkConfigurationService/QosTypes This URI represents the types of Quality-of-Service (QoS) that the system supports. GET method for QosTypes This method returns the types of Quality-of-Service (QoS) that the system supports. Description Returns the supported QoS. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(NetworkConfigurationService.QosType)", "@odata.count": 4, "value": [ { "@odata.
} "@odata.id": "/api/NetworkConfigurationService/QosTypes(1)", "Id": 1, "Name": "Platinum" /api/NetworkConfigurationService/Actions/ NetworkConfigurationService.RemoveNetworks POST method for NetworkConfigurationService.RemoveNetworks This method deletes the specified networks from the system. Description Deletes the specified networks.
7 Devices /api/DeviceService This URI represents the device services. GET method for DeviceService This method returns a list of all the device services. Description Returns a list of device services. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#DeviceService.DeviceService", "@odata.id": "/api/DeviceService", "Actions": null, "Devices": [ { "@odata.id": "/api/DeviceService/Devices" } ], "DeviceStatuses": [ { "@odata.
/api/DeviceService/Devices This URI represents the devices. GET method for Devices This method returns a list of all the devices. Description Returns a list of all the devices. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 5, "value": [ { "@odata.
"SlotType": "2000" }, "DeviceManagement": [ { "ManagementId": 5003, "NetworkAddress": "xx.xx.xx.xx", "MacAddress": "18:66:da:a6:c2:1d", "ManagementType": 2, "InstrumentationName": "WIN-02GODDHDJTC", "DnsName": "iDRAC-SVCTG06", "ManagementProfile": [ { "ManagementProfileId": 5003, "ManagementId": 5003, "AgentName": "iDRAC", "Version": "3.20.20.20", "ManagementURL": "https://[ IP Address ]", "Status": 1000, "StatusDateTime": "2017-09-05 04:46:57.807" } ] } ], "InventoryDetails": [ { "@odata.
} ], "Faults": [ { "@odata.id": "/api/DeviceService/Devices(3315)/Faults" } ], "DeviceBladeSlots": [ { "@odata.id": "/api/DeviceService/Devices(3315)/ DeviceBladeSlots" } ], "GraphicInfo": { "@odata.id": "/api/DeviceService/Devices(3315)/GraphicInfo" } }, {…}, {…}, {…}, {…} } /api/DeviceService/Devices(Id) This URI represents a specific device within the collection. GET method for Devices(Id) This method returns the details of a specific device. Description Returns the details of a specific device.
4, 7, 8, 9, 41, 11, 12, 13, 14, 15, 16, 17, 30, 31 ], "Actions": null, "DeviceSubscription": null, "DeviceSpecificData": null, "SlotConfiguration": { "ChassisId": "4165", "SlotNumber": "6", "SledBlockPowerOn": "None blocking", "ChassisName": "GUI PT", "SlotName": "Sled-6", "ChassisServiceTag": "SKY0028", "SlotType": "2000" }, "DeviceManagement": [ { "ManagementId": 5003, "NetworkAddress": "xx.xx.xx.
} } "LogSeverities": { "@odata.id": "/api/DeviceService/Devices(3315)/LogSeverities" }, "Settings": [ { "@odata.id": "/api/DeviceService/Devices(3315)/Settings" } ], "Temperature": { "@odata.id": "/api/DeviceService/Devices(3315)/Temperature" }, "Power": { "@odata.id": "/api/DeviceService/Devices(3315)/Power" }, "BlinkStatus": { "@odata.id": "/api/DeviceService/Devices(3315)/BlinkStatus" }, "PowerUsageByDevice": [ { "@odata.
}, { }, { }, { }, { }, { }, { }, { }, { ] } "SlotType": "Unknown" "Id": 128, "SlotNumber": "P2PBridge.Embedded.1-1", "Manufacturer": "Intel Corporation", "Description": "Lewisburg PCI Express Root Port #1", "DatabusWidth": "Unknown", "SlotLength": "Unknown", "SlotType": "Unknown" "Id": 129, "SlotNumber": "HostBridge.Embedded.
{ }, { ] } "Id": 28, "Family": "Intel(R) Xeon(TM)", "MaxSpeed": 4000, "CurrentSpeed": 1600, "SlotNumber": "CPU.Socket.1", "Status": 2000, "NumberOfCores": 8, "NumberOfEnabledCores": 8, "BrandName": "Intel", "ModelName": "Genuine Intel(R) CPU 0000%@", "InstanceId": "CPU.Socket.1", "Voltage": "1.8" "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('serverNetworkInterfaces')", "InventoryType": "serverNetworkInterfaces", "InventoryInfo": [] }, { "@odata.
}, { "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('serverRaidControllers')", "InventoryType": "serverRaidControllers", "InventoryInfo": [ { "Id": 20, "DeviceId": 0, "Name": "Lewisburg SATA Controller [AHCI mode]", "Fqdd": "AHCI.Embedded.2-1", "Status": 2000, "StatusTypeString": "UNKNOWN", "RollupStatus": 2000, "RollupStatusString": "UNKNOWN", "CacheSizeInMb": 0, "PciSlot": 0 }, { "Id": 19, "DeviceId": 0, "Name": "Lewisburg SSATA Controller [AHCI mode]", "Fqdd": "AHCI.Embedded.
}, { }, { }, { }, { }, { ] } "Id": 110, "PowerState": 5 "Id": 111, "PowerState": 8 "Id": 112, "PowerState": 10 "Id": 113, "PowerState": 11 "Id": 114, "PowerState": 12 "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('deviceLicense')", "InventoryType": "deviceLicense", "InventoryInfo": [ { "SoldDate": "2016-06-12 14:48:13.000", "LicenseBound": 4, "EvalTimeRemaining": 0, "AssignedDevices": "iDRAC.Embedded.
}, { }, { }, { }, { }, { assigned Storage" }, { }, { }, { details" }, "CapabilityType": { "CapabilityId": 14, "Name": "POWER_HISTORY", "Description": "Retrieve historical power data" } "Id": 370, "CapabilityType": { "CapabilityId": 13, "Name": "TSR", "Description": "Tech Support Report" } "Id": 371, "CapabilityType": { "CapabilityId": 12, "Name": "DIAGS", "Description": "Diagnostics" } "Id": 372, "CapabilityType": { "CapabilityId": 11, "Name": "HW_LOGS ", "Description": "System Hardware logs" } "Id
{ }, { }, { }, { }, { }, { }, { ] } "Id": 378, "CapabilityType": { "CapabilityId": 3, "Name": "POWER_CONTROL_RESET", "Description": "Power reset hard/graceful" } "Id": 379, "CapabilityType": { "CapabilityId": 2, "Name": "POWER_CONTROL_OFF", "Description": "Power Down hard/graceful" } "Id": 380, "CapabilityType": { "CapabilityId": 1, "Name": "POWER_CONTROL_ON", "Description": "Power up" } "Id": 381, "CapabilityType": { "CapabilityId": 32, "Name": "REMOTE_SSH", "Description": "14G specific features"
}, { "InventoryType": "deviceLocation", "InventoryInfo": [ { "Id": 19, "Rack": "78", "Aisle": "Lakeln", "Datacenter": "AlladiaAnoop" } ] "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('deviceManagement')", "InventoryType": "deviceManagement", "InventoryInfo": [ { "ManagementId": 5003, "IpAddress": "xx.xx.xx.
Controller", "InstanceId": "DCIM:PREVIOUS#iDRAC.Embedded.1-1#IDRACinfo" }, { "Version": "0.3.0", "InstallationDate": "2017-06-16T01:22:28Z", "Status": "Installed", "SoftwareType": "BIOS", "ComponentId": "159", "DeviceDescription": "BIOS", "InstanceId": "DCIM:INSTALLED#741__BIOS.Setup.
}, { ] } "InstanceId": "DCIM:INSTALLED#803__CPLD.Embedded.1" "@odata.
} ] "Id": 145, "Status": 2000, "SubsystemName": }, { "Id": 146, "Status": 1000, "SubsystemName": }, { "Id": 147, "Status": 1000, "SubsystemName": }, { "Id": 148, "Status": 1000, "SubsystemName": }, { "Id": 149, "Status": 3000, "SubsystemName": }, { "Id": 150, "Status": 1000, "SubsystemName": }, { "Id": 151, "Status": 1000, "SubsystemName": }, { "Id": 152, "Status": 2000, "SubsystemName": } "cpuRollupStatus" "sysMemPrimaryStatus" "voltRollupStatus" "batteryRollupStatus" "licensingRollupStatus" "stora
Example Input: /api/DeviceService/Devices(25004)/InventoryDetails('deviceSoftware') Output: { "@odata.context": "/api/$metadata#DeviceService.InventoryDetail/$entity", "@odata.type": "#DeviceService.InventoryDetail", "@odata.id": "/api/DeviceService/Devices(25009)/ InventoryDetails('deviceSoftware')", "InventoryType": "deviceSoftware", "InventoryInfo": [ {"Version": "0.3.0", "InstallationDate": "2017-07-13T00:00:00Z", "Status": "Installed", "SoftwareType": "BIOS",…}, {"Version": "3.20.20.
} NA Output: Table 94. Attributes Attribute Description SettingType Defines the setting type that must be applied. The setting here is, "ReplicableChassisConfigurations" Configurations Defines the configuration you want to apply. The Configurations attribute requires the Type and Replicate flag. Type The configuration you want to apply. The Type attribute supports "AlertDestination" or "TimeConfigurations". Replicate Boolean flag to determine if you prefer to set the configuration or not.
"LogTimestamp": "20170907053540.000000-300", "LogSequenceNumber": 286412, "LogSeverity": 1000, "LogComment": "[set comment here]", "LogMessageId": "USR0030", "LogMessage": "Successfully logged in using root, from 10.32.19.194 and wsman.", "LogId": "DCIM:LifeCycleLog:286412", "LogCategory": "Audit", "DateFormat": "CIM" }, { "LogTimestamp": "20170907053540.
}, { } ] "SubSystem": "Current", "RollupStatus": "1000" }, { "SubSystem": "Processor", "RollupStatus": "2000" }, { "SubSystem": "Memory", "RollupStatus": "2000" }, { "SubSystem": "Temperature", "RollupStatus": "1000" } /api/DeviceService/Devices(Id)/RecentActivity This URI represents the recent activities for a specific device. GET method for RecentActivity This method returns the recent activities for a specific device. Description Returns the recent activities for a specific device.
} ] } "ExecutionHistoryId": 8, "TaskId": 4015, "TaskType": 24 /api/DeviceService/Devices(Id)/InventoryTypes This URI represents the inventory types for a specific device. GET method for InventoryTypes This method returns the inventory types for a specific device. Description Returns the inventory types for a specific device. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#DeviceService.InventoryTypes/$entity", "@odata.
Example Input: Output: { "@odata.context": "$metadata#DeviceService.LogSeverities/$entity", "@odata.id": "/api/DeviceService/Devices(3265)/LogSeverities", "Warning": 2000, "Critical": 3000, "Fatal": 4000, "Info": 1000 } NOTE: The severity "Unknown": 5000 is not displayed by REST. To view logs in Unknown state, use the web interface. /api/DeviceService/Devices(Id)/Settings This URI represents the settings of a specific device.
• • api/DeviceService/Devices(25031)/Settings('IOMQuickDeploy') api/DeviceService/Devices(25031)/Settings('FIPSMode') GET method for Settings('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 Example for network settings for IOM Input: Output: { "@odata.context": "/api/$metadata#DeviceService.DeviceSetting/$entity", "@odata.
} "StaticAlternateDNSServer": "" }, "Ipv6Settings": { "EnableIPv6": false, "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 Settings
} Output: { "@odata.id": "/api/DeviceService/Devices(25773)/Settings('Network')", "EnableMgmtVLANId": false, "@odata.context": "/api/$metadata#DeviceService.DeviceSetting/$entity", "SettingType": "Network", "IomDNSSettings": { "PrimaryDNS": "", "SecondaryDNS": "", "TertiaryDNS": "" }, "IomIPv4Settings": { "EnableIPv4": true, "EnableDHCP": true, "StaticIPAddress": "xx.xx.xx.xx", "StaticSubnetMask": "255.255.255.0", "StaticGateway": "10.35.176.
} } "DnsDomainName": "", "AutoNegotiation": true, "NetworkSpeed": "1_GB", "Delay": 0 Output : { "SettingType": "Network", "DhcpProvisioning": null, "MgmtVLANId": "1", "EnableVLAN": false, "Ipv4Settings": { "EnableIPv4": true, "EnableDHCP": true, "StaticIPAddress": "", "StaticSubnetMask": "", "StaticGateway": "", "UseDHCPObtainDNSServerAddresses": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "Ipv6Settings": { "EnableIPv6": false, "EnableAutoconfiguration": true, "StaticIPv6Addre
"@odata.context": "$metadata#DeviceService.TemperatureResponseModel/ $entity", "@odata.id": "/api/DeviceService/Devices(3265)/Temperature", "peakTemperatureUnit": "celsius", "avgTemperatureUnit": "celsius", "DateFormat": "CIM", "instantaneousTemperatureUnit": "celsius", "avgTemperatureTimeStamp": "20170907071015.180000-300", "instantaneousTemperature": "21" } /api/DeviceService/Devices(Id)/BlinkStatus This URI represents the LED-blink status of a specific device.
} "powerUnit": "watt", "minimumPowerTimeStamp": "19691231180000.000000-360", "avgPowerUnit": "watt", "minimumPower": "65535", "peakPower": "73", "DateFormat": "CIM", "systemEnergyConsumption": "0.000", "Since": "20170414145039.000000-300", "peakPowerTimeStamp": "20170414145039.000000-300", "power": "0", "peakPowerUnit": "watt", "minimumPowerUnit": "watt" /api/DeviceService/Devices(Id)/DeviceBladeSlots This URI represents the slot details of a specific device.
/api/DeviceService/Devices(Id)/GraphicInfo This URI represents the graphics information of a specific device. GET method for GraphicInfo This method returns the graphics-related information of a specific device. Description Returns the graphics-related information of a specific device. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#DeviceService.GraphicInfo/$entity", "@odata.id": "/api/DeviceService/Devices(3265)/GraphicInfo", "Svg": "
HTTP response codes Example 200 Input: Output: { "@odata.context": "$metadata#Collection(DeviceService.PowerState)", "@odata.count": 3, "value": [ { "PowerState": 1, "Name": "UNKNOWN", "Description": "Unknown" }, { "PowerState": 17, "Name": "ON", "Description": "On" }, { "PowerState": 18, "Name": "OFF", "Description": "Off" } ] } /api/DeviceService/DeviceStatuses This URI represents the statuses that the devices can be in.
"Name": "CRITICAL", "Description": "The device is in critical state." }, { } ] } "GlobalStatus": 5000, "Name": "NOSTATUS", "Description": "The device/group does not have a valid status." /api/DeviceService/DeviceType This URI represents the device types. GET method for DeviceType This method returns a list of devices types. Description Returns a list of devices types. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(DeviceService.
/api/DeviceService/DeviceSummary This URI represents the summary of the devices statuses. In the response, devices of the same type are grouped. GET method for DeviceSummary This method returns the summary of device statuses. Description Returns the summary of device statuses. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(DeviceService.DeviceSummary)", "@odata.count": 6, "value": [ { "@odata.
}, { ] } "StatusType": 5000, "Count": 0 }, { "@odata.id": "/api/DeviceService/DeviceSummary(9000)", "DeviceType": 9000, "TotalCount": 0, "DeviceStatusSummary": [ { "StatusType": 1000, "Count": 0 }, { "StatusType": 2000, "Count": 0 }, { "StatusType": 3000, "Count": 0 }, { "StatusType": 4000, "Count": 0 }, { "StatusType": 5000, "Count": 0 } ] }, { "@odata.
"Count": 1 }, { ] "StatusType": 3000, "Count": 0 }, { "StatusType": 4000, "Count": 0 }, { "StatusType": 5000, "Count": 0 } }, { } ] } "@odata.id": "/api/DeviceService/DeviceSummary(8000)", "DeviceType": 8000, "TotalCount": 1, "DeviceStatusSummary": [ { "StatusType": 1000, "Count": 0 }, { "StatusType": 2000, "Count": 0 }, { "StatusType": 3000, "Count": 1 }, { "StatusType": 4000, "Count": 0 }, { "StatusType": 5000, "Count": 0 } ] /api/DeviceService/DeviceSlotType This URI represents the slot types.
} "value": [ { "SlotType": 1000, "SlotName": "UNKNOWN", "Description": "Slot type is unknown." }, { "SlotType": 2000, "SlotName": "Sled Slot", "Description": "This is Sled Slot type." }, { "SlotType": 3000, "SlotName": "Fan Slot", "Description": "This is Fan Slot type." }, { "SlotType": 4000, "SlotName": "IO Module Slot", "Description": "This is IO Module Slot type." }, { "SlotType": 5000, "SlotName": "Chassis Manager Slot", "Description": "This is Chassis Manager Slot type.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 214 Devices "Key": "GRID_REDUNDANCY", "Value": "GRID Redundancy", "Description": "Redundancy policy type is GRID redundancy" "Id": 3000, "Property": "duplexMode", "Key": "HALF", "Value": "Half", "Description": "Duplex Mode is half." "Id": 4000, "Property": "duplexMode", "Key": "FULL", "Value": "Full", "Description": "Duplex Mode is full.
}, { }, { }, { }, { }, { }, { }, { } ] } "Description": "QuickSyncAccess is read only" "Id": 13000, "Property": "quickSyncAccess", "Key": "READ_WRITE", "Value": "Read-Write", "Description": "QuickSyncAccess is read write" "Id": 14000, "Property": "timeoutLimitUnit", "Key": "SECONDS", "Value": "Seconds", "Description": "Time out limit unit is seconds" "Id": 15000, "Property": "timeoutLimitUnit", "Key": "MINUTES", "Value": "Minutes", "Description": "Time out limit unit is minutes" "Id": 16000, "Prop
Example Output: { "@odata.context": "$metadata#Collection(DeviceService.GlobalExclude)", "@odata.count": 4, "value": [ { "@odata.id": "/api/DeviceService/GlobalExcludes(1)", "Id": 1, "Identifier": "9PKM9Z1", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 1, "NetworkAddress": "xx.xx.xx.xx" } ] }, { "@odata.id": "/api/DeviceService/GlobalExcludes(2)", "Id": 2, "Identifier": null, "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 2, "NetworkAddress": "xx.xx.xx.xx" } ] }, { "@odata.
Example Input: {"DeviceIds": [2464,2614,2514]} Output: True /api/DeviceService/Actions/ DeviceService.AddNetworkRange This URI adds ranges to the globally excluded range. POST method for DeviceService.AddNetworkRange This method adds ranges to global exclusion. Description Adds network ranges to global exclusion. Privilege APPLIANCE_SETUP HTTP response codes 204 Example Input: { } "Id": 0, "Identifier": "IPRange2", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 0, "NetworkAddress": "xx.xx.
} ] } "Id": 0, "NetworkAddress": "xx.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 Input: {"Ids": [1,2,3,4,5,6]} /api/DeviceService/Actions/ DeviceService.ValidateExcludes This URI validates global exclusion.
] } /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 /api/DeviceService/Devices(Id)/Actions/ DeviceService.Diagnostic This URI allows you to execute supported diagnostic commands. POST method for DeviceService.Diagnostic This method executes the supported diagnostics commands. Description Executes supported diagnostic commands.
9 Groups /api/GroupService/Groups This URI represents the groups. GET method for Groups This method returns a list of groups. Description Returns a list of groups. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(GroupService.Group)", "@odata.count": 1, "value": [ { "@odata.id": "/api/GroupService/Groups(64)", "Id": 64, "Name": "All Devices", "Description": "Group associated to all devices.
} ] } ] } "@odata.id": "/api/GroupService/Groups(64)/GroupDevicesSummary" Table 95. Attributes Attribute name Description Id ID of the group. Name Name of the group. Description Description of the group. GlobalStatus Global status of the group. Indicates the health of the group. ParentId Parent ID of the group. If the group is a root group, ParentId is 0. CreationTime Date and time when the group was created. UpdatedTime Date and time when the group was updated.
Table 96. Filters(continued) Attribute name Description Type Filter by group type. MembershipType Filter by group membership type. GlobalStatus Filter by group global status. DefinitionId Filter by group definition ID. DefinitionDescription Filter by group definition description. Visible Filter by group visibility. CreatedBy Filter by the entity that created the group. UpdatedBy Filter by the entity that updated the group.
{ } } "@odata.id": "/api/GroupService/Groups(64)/AllLeafDevices" ], "GroupHierarchy": [ { "@odata.id": "/api/GroupService/Groups(64)/GroupHierarchy" } ], "SubGroups": [ { "@odata.id": "/api/GroupService/Groups(64)/SubGroups" } ], "GroupDevicesSummary": [ { "@odata.id": "/api/GroupService/Groups(64)/GroupDevicesSummary" } ] Table 97. Attributes Attribute name Description Id ID of the group. Name Name of the group. Description Description of the group. GlobalStatus Global status of the group.
Table 97. Attributes(continued) Attribute name Description GroupDevicesSummary Group link to display a summary of all group devices. PUT method for Groups(Id) This method updates the settings of a group within the collection. Description Updates the settings of a group.
Table 98. Attributes Attribute name Description Id ID of the group to be deleted. /api/GroupService/Groups(Id)/Devices This URI represents the devices within a group. GET method for Devices This method returns the list of devices within a specific group. Description Returns the list of devices within a group. NOTE: For more information about the properties for device responses, see DeviceService. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.
"ManagementId": 5003, "NetworkAddress": "fe80::f68e:38ff:fecf:15ba", "MacAddress": "", "ManagementURL": "https://[ IP Address ]", "ManagementType": 2, "InstrumentationName": "WIN-02GODDHDJTC", "DnsName": "idrac-SVCTAG", "Status": 1000 }, { "ManagementId": 5002, "NetworkAddress": "xx.xx.xx.
] } } "@odata.id": "/api/DeviceService/Devices(1614)/DeviceBladeSlots" } ], "GraphicInfo": { "@odata.id": "/api/DeviceService/Devices(1614)/GraphicInfo" } Table 99. Attributes Attribute name Description Id ID of the group. /api/GroupService/Groups(Id)/ GroupDevicesSummary This URI represents the device summary for a group. GET method for GroupDevicesSummary This method returns the device summary of a group. The summary contains the device types and their status.
} ] } Table 100. Attributes Attribute name Description Id ID of the group. GET https://[IP]/api/GroupService/ Groups(500)/AllLeafDeviceSummaries? $filter=Type eq 4000&$top=25&$skip=0& $orderby=Identifier asc This URL represents all the devices recursively for the group. GET method for AllLeafDeviceSummaries Description Returns all the devices recursively for the group. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(DeviceService.
14, 15, 16, 17, 18, 30, 31, 33, 41, 50, 1001, 1009 }, { ], "DeviceManagement": [ { "DeviceId": 10994, "ManagementId": 5710, "NetworkAddress": "xx.xx.xx.xx", "MacAddress": "84:7b:eb:f4:e0:70", "InstrumentationName": "idrac-BBHBS02", "ManagementProfile": [ { "ManagementProfileId": 5710, "ManagementId": 0, "AgentName": "iDRAC", "Version": "3.34.34.34", "ManagementURL": "https://xx.xx.xx.xx:443" } ] } ], "IpAddress": "xx.xx.xx.xx" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
"ManagementId": 5715, "NetworkAddress": "xx.xx.xx.xx", "MacAddress": "34:17:eb:e9:e6:c5", "InstrumentationName": "idrac-", "ManagementProfile": [ { "ManagementProfileId": 5715, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.30.30.30", "ManagementURL": "https://xx.xx.xx.xx:443" } ] }, { } ], "IpAddress": "xx.xx.xx.xx" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
}, { } ] } ] "DeviceId": 11008, "ManagementId": 5717, "NetworkAddress": "xx.xx.xx.xx", "MacAddress": "58:8a:5a:e6:a3:2a", "InstrumentationName": "iDRAC-SM4T326", "ManagementProfile": [ { "ManagementProfileId": 5717, "ManagementId": 0, "AgentName": "iDRAC", "Version": "3.30.30.30", "ManagementURL": "https://xx.xx.xx.xx:443" } ] } ], "IpAddress": "xx.xx.xx.xx" /api/GroupService/Groups(Id)/SubGroups This URI represents the subgroups of a specific group.
} ] } } ], "AllLeafDevices": [ { "@odata.id": "/api/GroupService/Groups(19164)/AllLeafDevices" } ], "GroupHierarchy": [ { "@odata.id": "/api/GroupService/Groups(19164)/GroupHierarchy" } ], "SubGroups": [ { "@odata.id": "/api/GroupService/Groups(19164)/SubGroups" } ], "GroupDevicesSummary": [ { "@odata.id": "/api/GroupService/Groups(19164)/GroupDevicesSummary" } ] Table 101. Attributes Attribute name Description Id ID of the group. Name Name of the group. Description Description of the group.
Table 101. Attributes(continued) Attribute name Description AllLeafDevices Group link to list all group sub groups devices. GroupHierarchy Group link to list the group hierarchy. SubGroup Group link to display the list of sub groups of this group. GroupDevicesSummary Group link to display a summary of all group devices. /api/GroupService/Groups(Id)/GroupHierarchy This URI represents the hierarchy of the subgroup within a group.
Example Input: Output: { "@odata.context": "$metadata#Collection(GroupService.GroupType)", "@odata.count": 5, "value": [ { "@odata.id": "/api/GroupService/GroupTypes(1000)", "Id": 1000, "Name": "Internal Group", "Description": "Internal group. This type is asssocated with a task operation." }, { "@odata.id": "/api/GroupService/GroupTypes(2000)", "Id": 2000, "Name": "Pre-Defined Group", "Description": "Pre-existing group." }, { "@odata.
Example Input: Output: { "@odata.context": "$metadata#GroupService.GroupType/$entity", "@odata.id": "/api/GroupService/GroupTypes(1000)", "Id": 1000, "Name": "Internal Group", "Description": "Internal group. This type is associated with a task operation." } Table 104. Attributes Attribute name Description Id ID of the group type. Name Name of the group type. Description Description of the group type. /api/GroupService/MembershipTypes This URI represents the membership types.
Table 105. Attributes(continued) Attribute name Description 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. Description Returns the details of a specific membership type. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#GroupService.
{ "ParentGroupId": 0, "ChildGroupId": 64 }, { "ParentGroupId": 0, "ChildGroupId": 114 }, { } ] "ParentGroupId": 0, "ChildGroupId": 2614 }, { "ParentGroupId": 64, "ChildGroupId": 19164 } /api/GroupService/Actions/ GroupService.AddMemberDevices POST method for GroupService.AddMemberDevices This method adds a device as a member to a group. Description Adds a device to a group.
} "GroupIds": [] Output: List of privileges for the user { "Privileges": [ "TEMPLATE_MANAGEMENT", "SECURITY_SETUP", "DEVICE_UPDATE", "JOB_MANAGEMENT", "BASELINE_MANAGEMENT", "OPERATING_SYSTEM_DEPLOYMENT", "POWER_CONTROL", "DEVICE_CONFIGURATION", "MONITORING_SETUP", "POWER_MANAGEMENT", "VIEW", "APPLIANCE_SETUP" ] } /api/GroupService/Actions/ GroupService.GroupsByPrivilegesAction POST method for GroupService.
10 Monitor Audit logs /api/ApplicationService/AuditLogs This URI represents a collection of audit logs of the system. GET method for AuditLogs This method returns a collection of audit logs of the system. Description Returns a collection of audit logs. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(ApplicationService.AuditLog)", "@odata.count": 7, "value": [ { "@odata.
/api/ApplicationService/AuditLogs(Id) This URI represents a specific audit log within the collection. GET method for AuditLogs(Id) This method returns the details of a specific event or error message. Description Returns the details of a specific event or error message. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(ApplicationService.AuditLog)", "@odata.count": 7, "value": [ { "@odata.
Jobs /api/JobService/Jobs This URI represents all the jobs. GET method for Jobs This method returns the details of all the jobs. Description Returns details of all the jobs. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(JobService.Job)", "@odata.count": 1, "value": [ { "@odata.type": "#JobService.Job", "@odata.
}, "JobType": { "@odata.type": "#JobService.JobType", "Id": 8, "Name": "Inventory_Task", "Internal": false }, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2020, "Name": "Scheduled" }, "ExecutionHistories@odata.navigationLink": "/api/JobService/ Jobs(10016)/ExecutionHistories" } ] } Table 108. Filters Filter name Description Top Top records to return. Default value is 100. Skip Max records to skip. Default value is 0. JobType/Id Filter by job type. JobStatus/Id Filter by job status.
Table 109. Attributes(continued) Attribute Description UpdatedBy User who updated the job. Visible Indicates whether the job is visible. Editable Indicates whether the job can be edited. BuiltIn Indicates if the job is internal. Targets Job targets. Params Parameters for the job. LastRunStatus Indicates the status of the last instance of the job execution. JobStatus Job completion status.
} ] Output: { "Id": 26097, "JobName": "Inventory Task Device", "JobDescription": "Inventory Task Device", "NextRun": null, "LastRun": null, "StartTime": null, "EndTime": null, "Schedule": "startnow", "State": "Enabled", "CreatedBy": "root", "UpdatedBy": null, "LastRunStatus": { "Id": 2200, "Name": "NotRun" }, "JobType": { "Id": 8, "Name": "Inventory_Task", "Internal": false }, "JobStatus": { "Id": 2080, "Name": "New" }, "Targets": [ { "JobId": 26097, "Id": 25915, "Data": "", "TargetType": { "Id": 1000, "N
Output: { "@odata.context": "/api/$metadata#JobService.Job/$entity", "@odata.type": "#JobService.Job", "@odata.id": "/api/JobService/Jobs(10016)", "Id": 10016, "JobName": "Default Inventory Task", "JobDescription": "Default Inventory Task", "NextRun": "2018-09-14 15:30:00.0", "LastRun": "2018-09-14 15:00:00.
Table 110. Attributes(continued) Attribute Description JobDescription Description of the job. JobType Type of the job. NextRun The next time when the job will be executed. LastRun The last time when the job was executed. StartTime Start time of the job. EndTime End time of the job. Schedule Job schedule (cron string). State Indicates whether the job is enabled or disabled. CreatedBy User who created the job. UpdatedBy User who updated the job.
} "Schedule":"startnow", "State":"Enabled", "JobType": { "Id":8, "Name":"Inventory_Task" }, "Targets": [ { "Id": 25915, "Data": "", "TargetType": { "Id":1000, "Name":"DEVICE" } } ] Output: { "Id": 26097, "JobName": "Inventory Task", "JobDescription": "Inventory Task", "NextRun": null, "LastRun": "2018-09-14 15:31:13.
Table 111. Attributes Attribute Description Id ID of the job. JobName Name for the job. JobDescription Description for the job. Schedule The schedule to start the job. State Enabled state for the job. It should be enabled. JobType Id of job type. JobName Name of the job type. DELETE method for Jobs(Id) This method deletes a specific job. Description Deletes a job. Privilege JOB_MANAGEMENT HTTP response codes 204 Example Input: Output: Table 112.
{ }, { "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2030)", "Id": 2030, "Name": "Queued" } 250 Monitor ] "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2040)", "Id": 2040, "Name": "Starting" }, { "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2050)", "Id": 2050, "Name": "Running" }, { "@odata.type": "#JobService.JobStatus", "@odata.
Table 113. Attributes Attribute Description Id ID of the job status. Name Name of the job status. /api/JobService/JobStatuses(Id) This URI represents the status of a job. GET method for JobStatuses(Id) This method returns the details of a specific job status. Description Returns details of a specific job status. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#JobService.JobStatus/$entity", "@odata.type": "#JobService.JobStatus", "@odata.
"@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(3)", "Id": 3, "Name": "DeviceAction_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(5)", "Id": 5, "Name": "Update_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(8)", "Id": 8, "Name": "Inventory_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.
"Id": 37, "Name": "MCMOnBoarding_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(38)", "Id": 38, "Name": "MCMOffBoarding_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(39)", "Id": 39, "Name": "MCMGroupCreation_Task", "Internal": false }, { "@odata.type": "#JobService.JobType", "@odata.
} "Name": "Update_Task", "Internal": false Table 116. Attributes Attribute Description Id ID of the job type. Name Name of the job type. Internal Indicates whether the job is internal. /api/JobService/Jobs(Id)/ExecutionHistories This URI represents all the execution histories for a job. GET method for ExecutionHistories This method returns the details of all the execution histories for a job. Description Returns details of all executions histories for a job.
"JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" }, "ExecutionHistoryDetails@odata.navigationLink": "/api/JobService/ Jobs(10016)/ExecutionHistories(18811)/ExecutionHistoryDetails" }, { "@odata.type": "#JobService.ExecutionHistory", "@odata.id": "/api/JobService/Jobs(10016)/ExecutionHistories(18774)", "Id": 18774, "JobName": "Default Inventory Task", "Progress": "100", "StartTime": "2018-09-14 14:00:00.526", "EndTime": "2018-09-14 14:00:29.
Table 117. Attributes Attribute Description Id Job execution history detail ID. JobName Name of the job. Progress Percentage of completion. StartTime The start time of job execution. EndTime The end time of job execution. Schedule Job schedule (cron string). State Indicates whether the job is enabled or disabled. LastUpdatedTime Timestamp when the job-execution history was last updated. ExecutedBy Details of who executed the job. JobId Job associated with the execution history.
"@odata.type": "#JobService.ExecutionHistoryDetail", "@odata.id": "/api/JobService/Jobs(10016)/ExecutionHistories(18683)/ ExecutionHistoryDetails(7137)", "Id": 7137, "Progress": "100", "StartTime": "2018-09-14 13:00:00.324", "EndTime": "2018-09-14 13:00:11.948", "Key": "MX-MSMDNH1", "Value": "Running\nCompleted", "ExecutionHistoryId": 18683, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" } } ] } Table 118.
} } "Status": 2020, "State": "", "JobType": "AlertSubscription_Task", "StartTime": "2017-06-06 10:00:00.00", "EndTime": "2017-06-07 10:00:00.00" Or Input: { "AllJobs": true, } Output: /api/JobService/Actions/JobService.DisableJobs POST method for JobService.DisableJobs This method disables the selected jobs. Description Disables the selected jobs.
/api/JobService/Actions/JobService.RemoveJobs POST method for JobService.RemoveJobs This method deletes the selected jobs. Description Deletes the selected jobs.
Or Input: { "Filters": { "Status": 2020, "State": "", "JobType": "AlertSubscription_Task", "StartTime": "2017-06-06 10:00:00.00", "EndTime": "2017-06-07 10:00:00.00" } } Or Input: { "AllJobs": true, } Output: /api/JobService/Actions/JobService.StopJobs POST method for JobService.StopJobs This method stops the selected jobs. Description Stops the selected jobs.
11 Reset application /api/ApplicationService/Actions/ ApplicationService.ResetApplication This URI resets the application and select between resetting all data or only resetting the configuraiton. POST method for ResetApplication This method resets the application. You can either reset only the configuration or also clear all the data. Description Resets the application by clearing only the configuration, or by clearing the configuration and the data.
12 Console version /api/ApplicationService/Info This URI represents the product information. GET method for Info This method returns the product information. Description Returns the product information. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#ApplicationService.Info/$entity", "@odata.type": "#ApplicationService.Info", "@odata.
13 Console capabilities /api/ApplicationService/Capabilities This URI represents the capabilities of the management console—OME or OME - Modular. GET method for Capabilities This method returns the capabilities of the management console—OME or OME - Modular. These two management consoles have different capabilities. Description Returns the capabilities of the management console. Privilege VIEW HTTP response codes 200 Example Input: Output: Example of application capabilities of OME - Modular.
$metadata#Collection(ApplicationService.Capability)", "@odata.count": 7, "value": [ { "@odata.type": "#ApplicationService.Capability", "Name": "DEVICE_MANAGEMENT", "Description": "This capability tells whether the console is capable of restricting execution of tasks based on onboarded and not-onboarded devices" }, { "@odata.type": "#ApplicationService.Capability", "Name": "BOOT_TO_NETWORK_ISO", "Description": "This capability is for booting devices from network iso." }, { "@odata.
14 Search This resource enables you to search for navigation links and documents using query strings. Use the URIs in this resource to search for navigation links and documents by providing search query strings. Topics: • • /api/SearchService/Actions/SearchService.Search /api/SearchService/Actions/SearchService.GetDocument /api/SearchService/Actions/ SearchService.Search POST method for SearchService.
"_type": "tasks", "_id": "3864", "_score": 1, "_source": { "tskNm": "Device_Config_Task (1493523261197) - for Device with Id: 1864", "tskTyp": "Device Config Task", "tskStatus": "Task status is Failed", "tskDesc": "Device_Config_Task (1493523261197) - for Device with Id: 1864", } } ] } } "tskCreatedBy": "system", "tskId": "3864" Table 119. Attributes Attribute name Description QueryString String to search. FilterType Indexes to be searched for the query string.
/api/SearchService/Actions/ SearchService.GetDocument POST method for SearchService.GetDocument This method searches for the document name you provide and returns the document that you can save. Description Returns the document corresponding to the search string. Privilege VIEW HTTP response codes 200 Example Input: { "FileName":"Whitepaper-PCSV-1.0.pdf" } Output: A window appears prompting you to select the location for saving the file. Table 120.
15 Session /api/SessionService This URI represents the collection of session services. GET method for SessionService This method returns a collection of the sessions services. Description Returns a collection of session services. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#SessionService.SessionService", "@odata.
/api/SessionService/Sessions This URI represents a collection of active session services. GET method for Sessions This method returns the collection of active session service. Description Returns a collection of active session services. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(SessionService.Session)", "@odata.count": 1, "value": [ { "@odata.
HTTP response codes Example 200 Input: { "UserName":"root", "Password":"linux", "SessionType":"API" } Output: { "Id": "7b723932-a119-4843-a5b7-7a122e4def99", "Description": "root", "Name": "API", "UserName": "root", "Password": null, "Roles": [ "ADMINISTRATOR" ], "IpAddress": "xx.xx.xx.xx", "StartTimeStamp": "2017-04-17 20:07:12.357", "LastAccessedTimeStamp": "2017-04-17 20:07:12.357" } Table 123. Attributes Attribute Name Description UserName The Session user name.
} "UserName":"root", "Password":"linux", "SessionType":"API" Output: { "Id": "7b723932-a119-4843-a5b7-7a122e4def99", "Description": "root", "Name": "API", "UserName": "root", "Password": null, "Roles": [ "ADMINISTRATOR" ], "IpAddress": "xx.xx.xx.xx", "StartTimeStamp": "2017-04-17 20:07:12.357", "LastAccessedTimeStamp": "2017-04-17 20:07:12.357" } Table 124. Attributes Attribute Name Description Id The unique identifier of the SessionService. UserName The session user name.
Example Output: { "@odata.context": "/api/ $metadata#Collection(SessionService.SessionConfiguration)", "@odata.count": 6, "value": [ { "@odata.type": "#SessionService.SessionConfiguration", "SessionType": "GUI", "MaxSessions": 6, "SessionTimeout": 1320000, "MinSessionTimeout": 60000, "MaxSessionTimeout": 86400000, "MinSessionsAllowed": 1, "MaxSessionsAllowed": 6 }, { "@odata.type": "#SessionService.
/api/SessionService/Actions/ SessionService.SessionConfigurationUpdate POST method for SessionService.SessionConfigurationUpdate Description This method adds the ability to configure the inactivity (not active sessions) timeout interval and the maximum number of sessions that are enabled per session type. When these properties are changed, the properties of the current active sessions are not terminated or modified.
16 APIs specific to OpenManage Enterprise Modular Edition /api/ApplicationService/Actions/ ApplicationService.GetConfiguration POST method for ApplicationService.GetConfiguration This method returns a collection of all the settings of the system or a group of settings. Description Returns a collection of settings.
{ "Name": "LoginSecurity.1#LockoutFailCountTime", "Value": 30 }, { "Name": "LoginSecurity.1#LockoutPenaltyTime", "Value": 900 }, { "Name": "LoginSecurity.1#IPRangeAddr", "Value": null }, { "Name": "LoginSecurity.1#LockoutByUsernameEnable", "Value": false }, { "Name": "LoginSecurity.1#LockoutByIPEnable", "Value": true }, { "Name": "LoginSecurity.1#IPRangeEnable", "Value": false }, { "Name": "RemoteSystemLog.1#RemoteSyslogEnable", "Value": true }, { "Name": "RemoteSystemLog.
{ "Name": "ChassisPower.1#SystemInputPowerCap", "Value": "6763" }, { "Name": "ChassisPower.1#RedundancyPolicy", "Value": "NO_REDUNDANCY" }, { "Name": "ChassisPower.1#EnablePowerCap", "Value": true }, { "Name": "SNMPAlerts.1#Enable", "Value": true }, { "Name": "SNMPAlerts.1#DestinationIP", "Value": "10.36.0.167" }, { "Name": "SNMPAlerts.1#port", "Value": 162 }, { "Name": "SNMPAlerts.1#version", "Value": "SNMPV1" }, { "Name": "SNMPAlerts.1#CommunityString", "Value": "public" }, { "Name": "SNMPAlerts.
{ "Name": "SNMPAlerts.4#Enable", "Value": false }, { "Name": "SNMPAlerts.4#DestinationIP", "Value": null }, { "Name": "SNMPAlerts.4#port", "Value": 0 }, { "Name": "SNMPAlerts.4#version", "Value": null }, { "Name": "SNMPAlerts.4#CommunityString", "Value": null }, { "Name": "TimeConfig.1#TimeZone", "Value": "TZ_ID_11" }, { "Name": "TimeConfig.1#NTPEnable", "Value": false }, { "Name": "TimeConfig.1#NTPServer1", "Value": null }, { "Name": "TimeConfig.1#NTPServer2", "Value": null }, { "Name": "TimeConfig.
{ "Name": "QuickSync.1#WifiEnable", "Value": true }, { "Name": "EmailAlertsConf.1#DestinationEmailAddress", "Value": "10.36.0.167" }, { "Name": "EmailAlertsConf.1#portNumber", "Value": 25 }, { "Name": "EmailAlertsConf.1#useCredentials", "Value": false }, { "Name": "EmailAlertsConf.1#useSSL", "Value": false }, { "Name": "EmailAlertsConf.1#user", "Value": null }, { "Name": "EmailAlertsConf.1#Password", "Value": null }, { "Name": "SNMPService.1#Enable", "Value": true }, { "Name": "SNMPService.
{ "Name": "Proxy.1#password", "Value": null }, { "Name": "Proxy.1#enableAuthentication", "Value": false }, { "Name": "Proxy.
{ "Name": "Network#Ipv6Settings#StaticGateway", "Value": "" }, { "Name": "Network#Ipv6Settings#UseDHCPv6ObtainDNSServerAddresses", "Value": true }, { "Name": "Network#Ipv6Settings#StaticPreferredDNSServer", "Value": "" }, { "Name": "Network#Ipv6Settings#StaticAlternateDNSServer", "Value": "" }, { "Name": "Network#GeneralSettings#EnableNIC", "Value": true }, { "Name": "Network#GeneralSettings#RegisterDNS", "Value": true }, { "Name": "Network#GeneralSettings#DnsName", "Value": "MX-01PTCMSM1234" }, { "Nam
}, { "Name": "Users.2#userType", "Value": 1 }, { "Name": "Users.2#SHA256Password", "Value": "$2a $10$zpVUzQIfE3nCOpodYXiz9.A.rr6SAkYcovyTEd49hxL7N83ZeqkqK" }, { "Name": "Users.2#Name", "Value": "ravi2" }, { "Name": "Users.2#Privilege", "Value": "10" }, { "Name": "Users.2#Enable", "Value": true }, { "Name": "Users.2#Password", "Value": null }, { "Name": "Users.3#userType", "Value": 1 }, { "Name": "Users.3#SHA256Password", "Value": "$2a $10$dTg7igLe1neXnZthG9vzP.8ML.tcUOxyeP.
{ "Name": "Users.4#Password", "Value": null }, { "Name": "Users.5#userType", "Value": 2 }, { "Name": "Users.5#SHA256Password", "Value": "$2a $10$H0cK06cAnceieSNuaI3JT.TI8DfX49XkdVcNbHC4G2X92lAhCAstS" }, { "Name": "Users.5#Name", "Value": "MSMMegatronTeam" }, { "Name": "Users.5#Privilege", "Value": "10" }, { "Name": "Users.5#Enable", "Value": true }, { "Name": "Users.5#objectGuid", "Value": "d22005b6-0ce5-40ed-88d0-7f7759b52f25" }, { "Name": "Users.5#Password", "Value": null }, { "Name": "Users.
}, { "Name": "ActiveDirectory.1#certificateFile", "Value": "" }, { } } ] } ] "Name": "LDAP.1#name", "Value": "LDAP Dell" }, { "Name": "LDAP.1#serverType", "Value": "MANUAL" }, { "Name": "LDAP.1#DomainController1", "Value": "10.36.0.167" }, { "Name": "LDAP.1#Port", "Value": 636 }, { "Name": "LDAP.1#BaseDN", "Value": "dc=dell,dc=com" }, { "Name": "LDAP.1#NetworkTimeout", "Value": 120 }, { "Name": "LDAP.1#SearchTimeout", "Value": 120 }, { "Name": "LDAP.
/api/ApplicationService/Actions/ ApplicationService.ApplyConfiguration POST method for ApplicationService.ApplyConfiguration This method updates the system settings. Description Updates the system settings. Privilege APPLIANCE_SETUP HTTP response codes 200 Example 284 Input: { "SystemConfiguration": { "Comments": [ "Export type is Normal,JSON" ], "Model": "POWEREDGE MX7000", "ServiceTag": "01PTCMSM", "TimeStamp": "2018-09-25T13:39:10.933Z", "Components": [ { "FQDD": "MM.Embedded.
{ "Name": "LoginSecurity.1#LockoutByIPEnable", "Value": true }, { "Name": "LoginSecurity.1#IPRangeEnable", "Value": false }, { "Name": "RemoteSystemLog.1#RemoteSyslogEnable", "Value": true }, { "Name": "RemoteSystemLog.1#destinationAddress", "Value": "10.36.0.167" }, { "Name": "RemoteSystemLog.1#Port", "Value": 514 }, { "Name": "RemoteSystemLog.2#RemoteSyslogEnable", "Value": false }, { "Name": "RemoteSystemLog.2#destinationAddress", "Value": null }, { "Name": "RemoteSystemLog.
{ "Name": "SNMPAlerts.1#DestinationIP", "Value": "10.36.0.167" }, { "Name": "SNMPAlerts.1#port", "Value": 162 }, { "Name": "SNMPAlerts.1#version", "Value": "SNMPV1" }, { "Name": "SNMPAlerts.1#CommunityString", "Value": "public" }, { "Name": "SNMPAlerts.2#Enable", "Value": false }, { "Name": "SNMPAlerts.2#DestinationIP", "Value": null }, { "Name": "SNMPAlerts.2#port", "Value": 0 }, { "Name": "SNMPAlerts.2#version", "Value": null }, { "Name": "SNMPAlerts.
{ "Name": "SNMPAlerts.4#CommunityString", "Value": null }, { "Name": "TimeConfig.1#TimeZone", "Value": "TZ_ID_11" }, { "Name": "TimeConfig.1#NTPEnable", "Value": false }, { "Name": "TimeConfig.1#NTPServer1", "Value": null }, { "Name": "TimeConfig.1#NTPServer2", "Value": null }, { "Name": "TimeConfig.1#NTPServer3", "Value": null }, { "Name": "TimeConfig.1#systemTime", "Value": "2018-09-25 08:39:07" }, { "Name": "LocalAccessConfiguration.
{ "Name": "EmailAlertsConf.1#useSSL", "Value": false }, { "Name": "EmailAlertsConf.1#user", "Value": null }, { "Name": "EmailAlertsConf.1#Password", "Value": null }, { "Name": "SNMPService.1#Enable", "Value": true }, { "Name": "SNMPService.1#Port", "Value": 161 }, { "Name": "SNMPService.1#CommunityName", "Value": "public" }, { "Name": "SSH.1#Enable", "Value": true }, { "Name": "SSH.1#Port", "Value": 22 }, { "Name": "SSH.1#MaxSessions", "Value": 4 }, { "Name": "SSH.
{ "Name": "Network#MgmtVLANId", "Value": "1" }, { "Name": "Network#EnableVLAN", "Value": false }, { "Name": "Network#Ipv4Settings#EnableIPv4", "Value": true }, { "Name": "Network#Ipv4Settings#EnableDHCP", "Value": true }, { "Name": "Network#Ipv4Settings#StaticIPAddress", "Value": "" }, { "Name": "Network#Ipv4Settings#StaticSubnetMask", "Value": "" }, { "Name": "Network#Ipv4Settings#StaticGateway", "Value": "" }, { "Name": "Network#Ipv4Settings#UseDHCPObtainDNSServerAddresses", "Value": true }, { "Name"
{ }, { "Name": "Network#GeneralSettings#EnableNIC", "Value": true "Name": "Network#GeneralSettings#RegisterDNS", "Value": true }, { "Name": "Network#GeneralSettings#DnsName", "Value": "MX-01PTCMSM1234" }, { "Name": "Network#GeneralSettings#UseDHCPForDomainName", "Value": true }, { "Name": "Network#GeneralSettings#DnsDomainName", "Value": "" }, { "Name": "Network#GeneralSettings#AutoNegotiation", "Value": true }, { "Name": "Network#GeneralSettings#NetworkSpeed", "Value": "100_MB" }, { "Name": "Network#Gene
"Value": "10" }, { "Name": "Users.2#Enable", "Value": true }, { "Name": "Users.2#Password", "Value": null }, { "Name": "Users.3#userType", "Value": 1 }, { "Name": "Users.3#SHA256Password", "Value": "$2a $10$dTg7igLe1neXnZthG9vzP.8ML.tcUOxyeP.i3XRD7eYfKMlJOqMDe" }, { "Name": "Users.3#Name", "Value": "ravi" }, { "Name": "Users.3#Privilege", "Value": "10" }, { "Name": "Users.3#Enable", "Value": true }, { "Name": "Users.3#Password", "Value": null }, { "Name": "Users.
}, { "Name": "Users.5#Privilege", "Value": "10" }, { "Name": "Users.5#Enable", "Value": true }, { "Name": "Users.5#objectGuid", "Value": "d22005b6-0ce5-40ed-88d0-7f7759b52f25" }, { "Name": "Users.5#Password", "Value": null }, { "Name": "Users.5#directoryType", "Value": "AD" }, { "Name": "Users.5#directoryName", "Value": "dell.com" }, { "Name": "ActiveDirectory.1#name", "Value": "dell.com" }, { "Name": "ActiveDirectory.1#serverType", "Value": "MANUAL" }, { "Name": "ActiveDirectory.
}, { } } ] } ] "Name": "LDAP.1#Port", "Value": 636 }, { "Name": "LDAP.1#BaseDN", "Value": "dc=dell,dc=com" }, { "Name": "LDAP.1#NetworkTimeout", "Value": 120 }, { "Name": "LDAP.1#SearchTimeout", "Value": 120 }, { "Name": "LDAP.1#CertValidationEnable", "Value": false }, { "Name": "LDAP.1#certificateFile", "Value": "" } Output: { "JobId": 38758 } Table 126. Attributes Attribute Description SystemConfiguration Parent tag that represents system configuration. Comments User-defined comments.
Brand /api/ApplicationService/Actions/ ApplicationService.BrandInfo This URI represents the brand information. POST method for BrandInfo This method returns the brand information. Description Returns the brand information. Privilege VIEW HTTP response codes 200 Example Input: Output: { "BrowserTitle": "globalNavigation.consoleBrowserTitle", "ConsoleTitle": "globalNavigation.
Example Imput: { "BrandType":"DEBRANDED" } OR { "BrandType":"DEFAULT" } Output: { 200 OK } Multichassis management /api/ManagementDomainService This method represents the role of the chassis in a Multi-Chassis Management (MCM)domain. GET method for ManagementDomainService This method returns the role of the chassis in a MCM domain. Description Returns the role of the chassis in a MCM domain. Privilege VIEW HTTP response codes 200 Example Input: Output — Standalone chassis: { "@odata.
ConfigurationTypes" } Output — Lead chassis: { "@odata.context": "/api/ $metadata#ManagementDomainService.ManagementDomainService", "@odata.type": "#ManagementDomainService.ManagementDomainService", "@odata.
Table 127. Attributes(continued) Attribute Description GroupName Name of the group. GroupDescription Description of the group. JoinApproval Join approval • • Automatic: Join requests from a standalone chassis are automatically approved. Manual: Join requests from a standalone chassis are queued on the lead for administrator's approval. Onboarding of the remote chassis does not get initiated until approved. ConfigReplication Configuration that is replicated when a new domain joins this group.
{ } ] } "ConfigType": "LocalAccessConfiguration", "Enabled": false Output: { "JobId": 36183, "Status": "Success" } Example for editing a group Input: { "GroupId": "91e0b654-9de4-4a62-b5b1-c0da11d81b70", "DeviceGroupId": 31436, --Optional "GroupName": "Example-Group", -Mandatory "GroupDescription": "Example-Group", Optional "JoinApproval": "Automatic", -Mandatory "ConfigReplication": [ { "ConfigType": "Power", "Enabled": false }, { "ConfigType": "UserAuthentication", "Enabled": true }, { "ConfigType": "
Table 128. Attributes(continued) Attribute Description GroupName Name of the group. GroupDescription Description of the group. JoinApproval Join approval • • Automatic: Join requests from a standalone chassis are automatically approved. Manual: Join requests from a standalone chassis are queued on the lead for administrator's approval. Onboarding of the remote chassis does not get initiated until approved. ConfigReplication Configuration that is replicated when a new domain joins this group.
"Version": "1" }, { } ] "@odata.type": "#ManagementDomainService.DiscoveredDomain", "GroupId": "8e5c5534-8435-47f9-bf79-65498caf7b54", "GroupName": "Example-GroupName", "GroupDescription": "Example-GroupDescription", "PublicAddress": [ "10.35.155.91" ], "Name": "MX-UTSKY88", "Description": "POWEREDGE MX7000", "Identifier": "UTSKY88", "DomainTypeId": 4000, "DomainTypeValue": "MSM", "DomainRoleTypeId": 3001, "DomainRoleTypeValue": "MEMBER", "Version": "1" }, { "@odata.type": "#ManagementDomainService.
Table 129. Attributes(continued) Attribute Description • • • Version LEAD MEMBER STANDALONE Version of OME - Modular. /api/ManagementDomainService/ConfigurationTypes This URI represents the configuration types supported on the management domain service. GET method for ConfigurationTypes This method returns the collection of configuration types supported on the management domain service. When creating a group, select from these configuration types.
/api/ManagementDomainService/ConfigurationTypes(Id) This URI represents a specific configuration type supported on the management domain service. GET method for ConfigurationTypes(Id) This method returns the details of a specific configuration type supported on the domain service. Description Returns the details of a specific configuration type. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#ManagementDomainService.ConfigurationType/ $entity", "@odata.
Output — Standalone chassis: { "@odata.context": "/api/ $metadata#Collection(ManagementDomainService.Domain)", "@odata.count": 1, "value": [ { "@odata.type": "#ManagementDomainService.Domain", "@odata.id": "/api/ManagementDomainService/Domains(25025)", "Id": 25025, "DeviceId": 25007, "PublicAddress": [ "10.35.0.
} ] } "Identifier": "01PTCMSM", "DomainTypeId": 4000, "DomainTypeValue": "MSM", "DomainRoleTypeId": 3000, "DomainRoleTypeValue": "LEAD", "Version": "1", "Local": false, "GroupId": "8e5c5534-8435-47f9-bf79-65498caf7b54", "GroupName": "Example-GroupName" Output — Lead chassis: { "@odata.context": "/api/ $metadata#Collection(ManagementDomainService.Domain)", "@odata.count": 2, "value": [ { "@odata.type": "#ManagementDomainService.Domain", "@odata.
Table 132. Attributes(continued) Attribute Description DeviceId Device ID. Address IP address. Name Name of the chassis. Description Description of the chassis. Identifier Service Tag of the chassis. DomainTypeId Information for internal programmatic use. DomainTypeValue Information for internal programmatic use. DomainRoleTypeId ID of the domain role. Possible value: • • • DomainRoleTypeValue 3000 — LEAD 3001 — MEMBER 3002 — STANDALONE Type of domain role.
} "@odata.id": "/api/ManagementDomainService/Domains(2714)", "Id": 2714, "DeviceId": 2664, "Address": "fde1:53ba:e9a0:de14:1a66:daff:fe76:4ebc", "Name": "cmc-LEAD123", "Description": "Chassis-LEAD123", "Identifier": "LEAD123", "DomainTypeId": 4000, "DomainTypeValue": "MSM", "DomainRoleTypeId": 3000, "DomainRoleTypeValue": "LEAD", "Version": "VERSION", "Port": "443", "Local": true, "GroupId": "4e361023-07cc-4b98-af3f-ba7c2ef2f5b9", "GroupName": "DDD" Table 133.
/api/ManagementDomainService/PendingDomains This URI represents the pending domain-related requests. GET method for PendingDomains This method returns a list of pending requests that are made for joining an MCM domain group. Description Returns a list of pending requests that are made for joining an MCM domain group. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(ManagementDomainService.PendingDomain)", "@odata.
Table 134. Attributes(continued) Attribute Description Description Description of the onboarding chassis. Identifier Service tag of the onboarding chassis. Domain type Information for internal programmatic use. Version Version of OME - Modular of the onboarding chassis. /api/ManagementDomainService/PendingDomains(Id) This URI represents a specific pending domain-related requests in the collection of pending requests.
Table 135. Attributes(continued) Attribute Description Name Name of the onboarding chassis. Description Description of the onboarding chassis. Identifier Service tag of the onboarding chassis. Domain type Information for internal programmatic use. Version Version of OME - Modular of the onboarding chassis. /api/ManagementDomainService/Actions/ ManagementDomainService.Domains POST method for ManagementDomainService.Domains This method adds a chassis domain to the MCM domain group.
Table 136. Attributes Attribute Description JobId Job ID created for the operation. Status Status of the operation. NOTE: The Status is always displayed as APPROVED. To track the status of the job, use the JobID. /api/ManagementDomainService/Actions/ ManagementDomainService.Join POST method for ManagementDomainService.Join This method allows a standalone chassis (OME - Modular) to join an MCM domain group. Description Allows a standalone chassis (OME - Modular) to join an MCM domain group.
Example Input: Output: { "JobId": 13664, "Status": "SUCCESS" } Table 138. Attributes Attribute Description JobId Job ID created for the operation. Status Status of the operation. NOTE: The Status is always displayed as SUCCESS. To track the status, use the JobId. /api/ManagementDomainService/Actions/ ManagementDomainService.Delete POST method for ManagementDomainService.Delete This method removes a specific member chassis domain from an MCM domain group. This API is applicable only to LEAD domains.
/api/ManagementDomainService/Actions/ ManagementDomainService.DeleteGroup POST method for ManagementDomainService.DeleteGroup This method deletes an MCM domain group. Description Deletes an MCM domain group. Privilege APPLIANCE_SETUP HTTP response codes 200 Example Input: { "GroupId": "671497bc-9d61-4067-afcd-48f9df5e8dd2" } Output: { "JobId": 13514, "Status": "SUCCESS" } Table 140. Attributes Attribute Description GroupId Group ID of the lead domain. JobId Job ID for the delete operation.
{ ] } "Id": 15964, "Approval":true Output: { "Status": "SUCCESS" } Approving or rejecting multiple pending requests Input: [ { "Id": 36197, "Approval": true }, { "Id": 36198, "Approval": false } ] Output: { "Status": "SUCCESS" } Table 141. Attributes Attribute name Description Id ID of the pending domain that requested to join the group. Approval Indicates if the request is approved or rejected. Possible values: • • Status true: Approved false: Rejected Status of the operation.
$entity", "@odata.type": "#ApplicationService.FIPSModeConfiguration", "@odata.id": "/api/ApplicationService/Security/SecurityConfiguration", "FipsMode": "OFF" } Fabric management /api/NetworkService This URI represents the network services. GET method for NetworkService This method returns the details of the network services. Description Returns the details of the network services. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#NetworkService.
Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(NetworkService.Fabric)", "@odata.count": 1, "value": [ { "@odata.type": "#NetworkService.Fabric", "@odata.id": "/api/NetworkService/Fabrics('0bebadec-b61b-4b16b354-5196396a4a18')", "Id": "0bebadec-b61b-4b16-b354-5196396a4a18", "Name": "Fabric-1", "Description": "This is a fabric.
"DesignNode": "Switch-B", "PhysicalNode": "DPM4XC2" } ], "Switches@odata.navigationLink": "/api/NetworkService/ Fabrics('0bebadec-b61b-4b16-b354-5196396a4a18')/Switches", "Servers@odata.navigationLink": "/api/NetworkService/Fabrics('0bebadecb61b-4b16-b354-5196396a4a18')/Servers", "FabricDesign": { "@odata.id": "/api/NetworkService/Fabrics('0bebadec-b61b-4b16b354-5196396a4a18')/FabricDesign" }, "ValidationErrors@odata.
/api/NetworkService/FabricDesign This URI represents the fabric designs. GET method for FabricDesign This method returns a list of the fabric designs. Description Returns a list of fabric designs. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(NetworkService.FabricDesign)", "@odata.count": 3, "value": [ { "@odata.type": "#NetworkService.FabricDesign", "@odata.
}, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/38", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/38" }, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/40", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/40" }, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/39", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/39" } ], "FabricDesignNode": [ { "NodeName": "Switch-A", "ChassisName": "Chassis-X", "Slot
"ChassisName": "Chassis-X", "Slot": "Slot-A1", "Type": "WeaverSwitch" }, { "NodeName": "Switch-B", "ChassisName": "Chassis-Y", "Slot": "Slot-A2", "Type": "WeaverSwitch" } ] } ] } /api/NetworkService/Fabrics(Id) This URI represents a specific fabric in the fabric collection. GET method for Fabrics(Id) This method returns a specific fabric from the collection of fabrics. Description Returns a specific fabric. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.
"Severity": "Warning", "Resolution": "Make sure that all the ISLs are connected as per the specification.", "Category": "Audit", "DetailedDescription": "", "TimeStamp": "2018-07-12T18:47:56Z" } ] }, "FabricDesignMapping": [ { "DesignNode": "Switch-A", "PhysicalNode": "41F2MN2" }, { "DesignNode": "Switch-B", "PhysicalNode": "41F4MN2" } ], "Switches@odata.navigationLink": "/api/NetworkService/ Fabrics('31db245a-9865-4a23-9697-4902cd2d5421')/Switches", "Servers@odata.
{ } "Name":"2xMX9116n_Fabric_Switching_Engines_in_same_chassis " } Output: TRUE Table 142. Attributes Attribute name Description ID The identifier of the fabric. Name The fabric name. Description The fabric name description. DesignNode DesignNode must be identical to the name provided in the selected fabric design. PhysicalNode Service Tag of the switch that you want to configure for the given fabric. FabricDesign Name (FabricDesign) The fabric design name.
} "Name": "2NodeHERedundant", "NetworkLink": [ { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/37", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/37" }, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/38", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/38" }, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/40", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/40" }, { "SourceNode": "Switch-A", "SourceInterface
[ { "@odata.type": "#NetworkService.ValidationError", "@odata.
NotFound-Issue", "MessageId": "NFAB0012", "Category": "FabricError", "SubCategory": "ISLError", "Severity": "Severity1", "ChassisName": "MX-SKY002P1234567890123456789012345", "ChassisServiceTag": "SKY002P1234567890123456789012345", "Description": "Unable to validate the fabric because the design link ICL-1_REVERSE not connected as per design 2NodeHESameChassis.
"ChassisServiceTag": "SKY00201234567890123456789012345", "Description": "Unable to validate the fabric because the design link ICL-1_FORWARD not connected as per design 2NodeHESameChassis.
} ] POST method for Uplinks for a specific fabric This method creates an uplink. Description Creates an uplink. Privilege FABRIC_MANAGEMENT HTTP response codes 201 Example Input: { "Name":"Fabric-1", "Description":"This is a fabric.", "MediaType":"Ethernet", "Ports": [ { "Id":"8KWYERN1:e102-009-0" } ], "Networks": [ { "Id":8756 } ] } Output: Uplink Id Table 143. Attributes Attribute name Description ID The identifier of the fabric. Name The fabric name.
Example Input: Output: { "@odata.context": "/api/$metadata#NetworkService.Uplink/$entity", "@odata.type": "#NetworkService.Uplink", "@odata.id": "/api/NetworkService/ Fabrics('43be623e-0d74-4f6d-87b3-3ea40bf6372d')/Uplinks('bda43da9d6d8-4fc5-98b7-cb9030e8008e')", "Id": "bda43da9-d6d8-4fc5-98b7-cb9030e8008e", "Name": "test", "Description": "test", "MediaType": "Ethernet", "NativeVLAN": 0, "Summary": { "PortCount": 4, "NetworkCount": 2 }, "Ports@odata.
Table 144. Attributes(continued) Attribute name Description Description The target uplink description MediaType Indicates, type of uplink. For more information, see /api/ NetworkService/UplinkTypes. NativeVLAN VLAN number, user intends to configure uplink with, as untagged network. Ports/Id The identifier associated to switch port (interface) that the user intends to associate with the given uplink.
"Type": "PhysicalEthernet", "MediaType": "Ethernet", "NodeServiceTag": "1ZB1XC2", "PortNumber": "ethernet1/1/41", "Status": "Down", "AdminStatus": "Enabled", "CurrentSpeed": "0", "MaxSpeed": "0", "ConfiguredSpeed": "0", "OpticsType": "NotPresent", "BlinkStatus": "OFF", "Role": "Uplink" }, { "@odata.type": "#NetworkService.Port", "@odata.
} ] } "OpticsType": "NotPresent", "BlinkStatus": "OFF", "Role": "Uplink" /api/NetworkService/Fabrics(Id)/Uplinks(Id)/Networks This URI represents the network details of a specific uplink in a fabric. GET method for Networks for a specific uplink This method returns the network details of a specific uplink in a fabric. Description Returns the network details of a specific uplink. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.
/api/NetworkService/Fabrics(Id)/Switches This URI represents the switches of a specific fabric. GET method for Switches for a specific fabric This method returns the switches of a specific fabric. Description Returns the uplinks of a specific fabric. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 1, "value": [ { "@odata.
"@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/RecentActivity" } ], "InventoryTypes": { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/InventoryTypes" }, "Settings": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/Settings" } ] } ] } /api/NetworkService/Fabrics(Id)/Servers This URI represents the servers of a specific fabric.
[ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/InventoryDetails" } ], "HardwareLogs": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/HardwareLogs" } ], "SubSystemHealth": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/SubSystemHealth" } ], "RecentActivity": [ { "@odata.
"@odata.id": "/api/NetworkService/ Fabrics('31db245a-9865-4a23-9697-4902cd2d5421')/ ISLLinks('41F2MN2%3Aethernet1%2F1%2F10%3A1')", "Id": "41F2MN2:ethernet1/1/10:1", "Source": { "ChassisName": "Chassis-19", "ChassisServiceTag": "GYFJ9N2", "Slot": "IOM-B1", "PortNumber": "41F2MN2:ethernet1/1/10:1", "PortName": null }, "Destination": { "ChassisName": "Chassis-19", "ChassisServiceTag": "GYFJ9N2", "Slot": "IOM-B2", "PortNumber": "41F4MN2:ethernet1/1/10:1", "PortName": null } }, { "@odata.type": "#NetworkService.
} ] } "Id": "41F4MN2:ethernet1/1/9", "Source": { "ChassisName": "Chassis-19", "ChassisServiceTag": "GYFJ9N2", "Slot": "IOM-B2", "PortNumber": "41F4MN2:ethernet1/1/9", "PortName": null }, "Destination": { "ChassisName": "Chassis-19", "ChassisServiceTag": "GYFJ9N2", "Slot": "IOM-B1", "PortNumber": "41F2MN2:ethernet1/1/9", "PortName": null } /api/NetworkService/Fabrics(Id)/Topology This URI represents the topology of the nodes and switches.
Output: { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 1, "value": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)", "Id": 0, "Type": 4000, "Identifier": "8KWYERN1", "ChassisServiceTag": "9FHJSUIK1", "Model": null, "PowerState": 2, "Status": 1000, "AssetTag": "8KWYERN1", "SystemId": 0, "DeviceName": "Weaver1Node", "LastInventoryTime": null, "DeviceCapabilities": [], "DeviceSubscription": { "@odata.
} ] /api/NetworkService/Fabrics(Id)/Topology/Nodes(Id) This URI represents a specific node of a fabric topology. GET method for Nodes(Id) This method returns the details of a specific node of a fabric topology. Description Returns the details of a specific node. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 1, "value": [ { "@odata.
a456-426655440000')/Servers(0)/SubSystemHealth" } ], "RecentActivity": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/RecentActivity" } ], "InventoryTypes": { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/InventoryTypes" }, "Settings": [ { "@odata.
"Slot": "IOM-B1", "SwitchMode": "Fabric", "PowerState": 17, "Name": "IOM-B1" }, "ChildNodes@odata.navigationLink": "/api/NetworkService/ Fabrics('43be623e-0d74-4f6d-87b3-3ea40bf6372d')/Topology/Nodes('Switch %3A1ZB1XC2')/ChildNodes" }, { "@odata.type": "#NetworkService.Node", "@odata.
/api/NetworkService/Actions/ NetworkService.RemoveUplinks POST method for NetworkService.RemoveUplinks This method deletes multiple fabric uplinks. Description Deletes multiple fabric uplinks. Privilege FABRIC_MANAGEMENT HTTP response codes 200 Example Input: { "FabricId":"FabricId", "UplinkIds":["id1","id2"] } Output: { "id1": true, "id2": true } /api/NetworkService/FabricDesigns(Id)/ NetworkService.
"NodeName":"Switch-B","ChassisName":"Chassis-Y","Slot":"SlotA2","Type":"WeaverSwitch" }, "ApplicableNodes": [ { "ServiceTag":"DPM4XC2","Slot":"IOM-B2","ChassisName":"MXSKY002P1234567890123456789012345","ChassisServiceTag":"SKY002P123456789012345678901234 } ] } ] } /api/NetworkService/Fabrics(Id)/ NetworkService.GetApplicableUplinkPorts POST method for GetApplicableUplinkPorts This method returns the available uplink ports applicable to a fabric design. Description Returns applicable uplink ports.
] "Id": "1ZB1XC2:ethernet1/1/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", "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/37" }, { "Id": "DPM4XC1:ethernet1/1/40", "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/40" }, { "Id": "DPM4XC1:ethernet1/1/41", "Na
} ] } ] } "Id": "DPM4XC1:ethernet1/1/42", "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/42" Table 145. Attributes Attribute name Description UplinkType ID of the uplink type. For more information, see /api/ NetworkService/UplinkTypes). /api/NetworkService/UplinkTypes This URI represents the uplink types. GET method for UplinkTypes This method returns the uplink types. Description Returns the uplink types.
/api/NetworkService/NodeTypes This URI represents the node types. GET method for NodeTypes This method returns the node types. Description Returns the node types. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(NetworkService.NodeType)", "@odata.count": 3, "value": [ { "@odata.type": "#NetworkService.NodeType", "Id": 1, "Name": "CHASSIS" }, { "@odata.type": "#NetworkService.NodeType", "Id": 2, "Name": "NWIOM" }, { "@odata.
"Id": "Create", "Name": "Create" }, { } ] "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Upgrade", "Name": "Upgrade" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Delete", "Name": "Delete" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "ReplaceNode", "Name": "ReplaceNode" }, { "@odata.type": "#NetworkService.
"Name": "Running" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2060", "Name": "Completed" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2070", "Name": "Failed" }, { } ] "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2080", "Name": "New" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2090", "Name": "Warning" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2100", "Name": "Aborted" }, { "@odata.type": "#NetworkService.
[ { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "1000", "Name": "NORMAL" }, { } ] "@odata.type": "#NetworkService.EnumerationEntry", "Id": "3000", "Name": "WARNING" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "4000", "Name": "CRITICAL" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2000", "Name": "UNKNOWN" }, { "@odata.type": "#NetworkService.
Privilege VIEW HTTP response codes 200 Example Input: Output: { /api/$metadata#NetworkService.Topology/$entity", "@odata.type": "#NetworkService.Topology", "@odata.id": "/api/NetworkService/MultiChassisDomain/Topology", "Nodes@odata.navigationLink": "/api/NetworkService/MultiChassisDomain/ Topology/Nodes" } /api/NetworkService/MultiChassisDomain/Topology/ Nodes This URI represents all the nodes in an MCM group.
Nodes('Chassis%3ASKY00201234567890123456789012345')", "Id": "Chassis:SKY00201234567890123456789012345", "Type": "CHASSIS", "ParentNodeId": null, "Location": null, "NodeInformation": { "@odata.type": "#NetworkService.NodeInformation", "Status": 4000, "MCMRole": "LEAD", "ServiceTag": "SKY00201234567890123456789012345", "DeviceId": 25003, "Model": "POWEREDGE MX7000", "PowerState": 17, "Name": "MX-SKY00201234567890123456789012345" }, "ChildNodes@odata.
/api/NetworkService/MultiChassisDomain/Topology/ Nodes(Id)/ChildNodes This URI represents the switch nodes for a specific chassis node in an MCM group. GET method for ChildNodes in an MCM group This method returns the list of switch nodes for a specific chassis node. Description Returns the switch nodes for a specific chassis node. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(NetworkService.Node)", "@odata.
"ChildNodes@odata.navigationLink": "/api/NetworkService/ MultiChassisDomain/Topology/Nodes('Switch%3ADPM4XC1')/ChildNodes" } ] } /api/NetworkService/MultiChassisDomain/ ValidationErrors This URI represents the fabric validation errors in an MCM group. GET method for ValidationErrors This method returns the fabric validation errors in an MCM group. Description Returns the list of fabric validation errors. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.
ValidationErrors('43be623e-0d74-4f6d-87b3-3ea40bf6372d-Chassis-Issue')", "Id": "43be623e-0d74-4f6d-87b3-3ea40bf6372d-Chassis-Issue", "MessageId": "NFAB0009", "Category": "FabricError", "SubCategory": "PlacementError", "Severity": "Severity2", "ChassisName": "MX-SKY002P1234567890123456789012345", "ChassisServiceTag": "SKY002P1234567890123456789012345", "Description": "Unable to validate the network fabric because the HE IOMs are in the same chassis.
"ChassisName": "MX-SKY00201234567890123456789012345", "ChassisServiceTag": "SKY00201234567890123456789012345", "Description": "Unable to validate the fabric because the design link ICL-2_REVERSE not connected as per design 2NodeHESameChassis.
HTTP response codes Example 200 Input: Output: { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.count": 3, "value": [ { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Disabled", "Name": "Disabled" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Enabled", "Name": "Enabled" }, { "@odata.type": "#NetworkService.
} ] } /api/NetworkService/PortRoles This URI represents the possible roles of the ports. GET method for PortRoles This method returns the possible roles of a port. Description Returns the possible statuses of a port. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.count": 5, "value": [ { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Spinner", "Name": "Spinner" }, { "@odata.
Privilege VIEW Http response code 200 Example Input: Output: { "@odata.context": /api/$metadata#NetworkService.ServerProfile/$entity", "@odata.type": "#NetworkService.ServerProfile", "@odata.id": "/api/NetworkService/ServerProfiles('PFSTN16')", "Id": "PFSTN16", "ServerServiceTag": "PFSTN16", "ServerInterfaceProfiles@odata.navigationLink": "/api/NetworkService/ ServerProfiles('PFSTN16')/ServerInterfaceProfiles" } Table 146. Attributes Attribute Description Id Server profile identifier.
Table 147. Attributes(continued) Attribute Description ServerInterfaceProfiles Sub payload that takes information associated with a server NIC. The request can take one or more server interface profiles, as part of the payload. ServerInterfaceProfiles/Id Server NIC identifier. ServerInterfaceProfiles/NativeVLAN Untagged VLAN configured for the given NIC. ServerInterfaceProfiles/Networks/Id Tagged VLANs configured for the given NIC.
}, … }, { ] "@odata.type": "#NetworkService.ServerInterfaceProfile", "@odata.id": "/api/NetworkService/ServerProfiles('PFSTN16')/ ServerInterfaceProfiles('NIC.Mezzanine.1A-2-1')", "Id": "NIC.Mezzanine.1A-2-1", "OnboardedPort": "8T61XC2:ethernet1/1/4", "NativeVLAN": 0, "Networks@odata.count": 0, "Networks": [] } ] } Table 148. Attributes Attribute Description Id Server interface profile identifier. OnboardedPort IOM port that is connected to the NIC that is onboarded.
/api/NetworkService/ServerProfiles(arg1)/ ServerInterfaceProfiles(arg2)/Networks(arg3) This URI returns the configured tagged VLANs for a server profile in the Fabric Manager. GET method for tagged VLANs of a specific server interface profile This method returns configured tagged VLANs. Description Returns the tagged VLANs that are configured for a server interface profile. Privilege VIEW HTTP response code 200 Example Input: Output: { "@odata.context": "/api/$metadata#NetworkConfigurationService.
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" }, { "@odata.type": "#NetworkConfigurationService.Network", "@odata.id": "/api/NetworkService/ServerProfiles('PFSTN16')/ ServerInterfaceProfiles('NIC.Mezzanine.
}] }, { "Id": 25114 "Id": "NIC.Mezzanine.1-1-1" }] }] Output: { } "JobId": 25546 Table 149. 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. Port configuration in Fabrics /api/JobService/Jobs This URI enables you to configure the ports in fabrics. Port configuration operation The APIs in this group use the Job Service and leverage existing inputs.
[ ] { } "Id":2664, "Data":"", "TargetType": { "Id":4000, "Name":"DEVICE" } Output: POST method for enabling or disabling auto-negotiation This method enables or disables auto-negotiation. Description Enables or disables auto-negotiation.
Example Input: "Params": [ { "Key":"operationName", "Value":"CONFIGURE_PORT_NAME_DESCRIPTION" }, { "Key":"interfaceId", "Value":"GF86XC2:1/1/9" }, { "Key":"name", "Value":"Port A" }, { "Key":"description", "Value":"This is Port A." } ], "Targets": [ { "Id":2664, "Data":"", "TargetType": { "Id":4000, "Name":"DEVICE" } } ] Output: POST method for configuration port speed This method configures the port speed. Description Configures the port speed.
] } } "Id":4000, "Name":"DEVICE" Output: Table 150. Attributes Attribute name Description TargetType (Id) Network IOM device ID. InterfaceId Port name. Key Operation name. Depending on the type of configuration you want to perform, select the operation name as provided in the Input snippet. NOTE: Ensure that you refer the right parameters in the provided Input snippet. For example, for configuring MTU speed, use Speed as the key and 1000 as the value.
], "Targets": [ { "Id":, "Data":"", "TargetType": { "Id":1000, "Name":"DEVICE" } } ] } Output: Clear enclosure assignment POST method for clearing enclosure assignment Description Creates a job to clear the storage assignments in Enclosure Assigned mode.
Assign drives POST method for drive assignment Description Creates a job to assign individual storage drives to server slots.
"JobName":"Storage Assignment", "JobDescription":"Storage Assignment Task", "Schedule":"startnow", "State":"Enabled", "JobType":{ "Id":3, "Name":"DeviceAction_Task" }, "Params":[ { "Key":"operationName", "Value":"CLEAR_STORAGE_ASSIGNMENT" }, { "Key":"assignmentMode", "Value":"2" }, { "Key":"driveSlotIds", "Value":
] } "Id":, "Data":"", "TargetType": { "Id": 1000, "Name": "DEVICE" } } Output: Clear configuration on SAS IOM POST method for clearing SAS IOM configuration Description Creates a job to clear the configuration on SAS IOM.
HTTP response codes Example 201 Input: { "Id": 0, "JobName": "Extract Log", "JobDescription": "Extract device log to NFS location", "Schedule": "startnow", "State": "Enabled", "JobType": { "Id": 18, "Name": "DebugLogs_Task" }, "Targets": [ { "Id": e.g: 2614, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" }, { "Key": "shareAddress", "Value": e.g: "100.100.100.
"Targets": [ { "Id": e.g: 2614, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" }, { "Key": "shareAddress", "Value": e.g: "100.100.100.
"State":"Enabled", "JobType":{ "Id":27, "Name":"QuickDeploy_Task" }, "Params":[ { "Key":"operationName", "Value":"SERVER_QUICK_DEPLOY" }, { "Key":"deviceId", "Value":"1016" }, { "Key":"rootCredential", "Value":"calvin" }, { "Key":"networkTypeV4", "Value":"Static" }, { "Key":"protocolTypeV4", "Value":"true" }, { "Key":"subnetMaskV4", "Value":"255.255.255.0" }, { "Key":"gatewayV4", "Value":"255.255.255.
}, "Name": "QuickDeploy_Task" "Params": [ { "Key": "operationName", "Value": "SERVER_QUICK_DEPLOY" }, { "Key": "deviceId", "Value": "1016" }, { "Key": "rootCredential", "Value": "calvin" }, { "Key": "networkTypeV4", "Value": "Static" }, { "Key": "protocolTypeV4", "Value": "true" }, { "Key": "subnetMaskV4", "Value": "255.255.255.0" }, { "Key": "gatewayV4", "Value": "255.255.255.
Table 151. Attributes(continued) Attribute name Description State Indicates if the job is enabled or disabled. JobType Id ID of the job type. Name Name of the job type. Params operationName Name of the Quick-Deploy operation. deviceId Device ID indicates the Chassis ID. rootCredential Root user password. networkTypeV4 Indicates if the IPv4 is static or dynamic. protocolTypeV4 Indicates whether IPv4 protocol is selected. subnetMaskV4 IPv4 Subnetwork mask associated with the configuration.
17 APIs specific to OpenManage Enterprise Application settings Console update /api/JobService/Jobs This URI updates the OpenManage Enterprise appliance. POST method for Jobs This method updates the OpenManage Enterprise appliance. Description Updates the OpenManage Enterprise appliance.
/api/ConsoleUpdateService/Updates?$filter= Auto eq true This URI represents the update job status of the OpenManage Enterprise appliance. GET method for Updates?$filter= Auto eq true This method returns the update job status of OpenManage Enterprise. Description Returns the update job status of OpenManage Enterprise. Privilege VIEW HTTP response code 200 Example Output: { "@odata.context": "/api/$metadata#Collection(ConsoleUpdateService.Update)", "@odata.count": 1, "value": [ { "Version": "3.0.0.
"APA91bF944FuE2F5wIJQFEX6Uz1N29OvOXvASzGPtfCtOg3sZEPuFezjerOYuBaykTtXl0WWnAcItLYKHvE5E Ek9_BvS1TGFEVbIPr37DCGCbNUQBrE3Op8yGNwSZx8JYrI7f", "Description": "Samsung Quasi-Stellar Object", "LastConnection": "2017-09-18 14:24:51.997", "Created": "2017-09-18 14:24:51.997", "LastError": "1970-01-01 00:00:00.0", "LastPush": "1970-01-01 00:00:00.0", "NewAlertCount": 0, "StatusMessage": "OK" } ] } /api/AlertService/SubscriptionNotificationService This URI represents the subscription service details.
"AlertPolicyId": 414, "Token": "APA91bEbGmqbAy7nMxDOI0rAS3RVCUGv3szsCi5uQUlyIApwzTGYbgZ_CRy54McKZKP3MUSbcfxovqlpDx39L "Description": "Samsung Quasi-Stellar Object" } /api/AlertService/Actions/AlertService.DeleteMobileSubscription This URI represents the deletion of mobile subscriptions. POST method for AlertService.DeleteMobileSubscription This method deletes the specified mobile subscriptions. Description Deletes the specified mobile subscriptions.
"Skip": 1 } Output: { "@odata.context": "/api/$metadata#Collection(AlertService.Alert)", "@odata.count": 1, "value": [ { "@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(1)", "Id": 1, "SeverityType": 2, "SeverityName": "Info", "AlertDeviceId": 0, "AlertDeviceName": "10.210.137.100", "AlertDeviceType": 0, "AlertDeviceIpAddress": "xx.xx.xx.
Privilege APPLIANCE_SETUP HTTP response codes 200 Example Input: { "ConsoleSetting": [ { "Name": "DEVICE_PREFERRED_NAME", "DefaultValue": "SYSTEM_NAME", "Value": "PREFER_NETBIOS,PREFER_IDRAC_SYSTEM_HOSTNAME", "DataType": "", "GroupName": "" }, { "Name": "INVALID_DEVICE_HOSTNAME", "Value": "localhost,localhost.
} ] https:///api/JobService/Jobs(10011) PUT method for Jobs(10011) Description Configures the health poll interval for the device health settings. Privilege JOB_MANAGEMENT HTTP response codes 200 Example Input: { "ConsoleSetting": [{ "Name": "REPORTS_MAX_RESULTS_LIMIT", "Value": "0", "DataType": "java.lang.Integer", "GroupName": "" } ] } https://localhost:443/api/ApplicationService/Settings POST method for ReportSettings Description Configures the maximum limit for the reports.
} ] } "Name": "EMAIL_SENDER", "DefaultValue": "admin@dell.com", "Value": "admin@dell.com", "DataType": "java.lang.String", "GroupName": "" POST method for TrapForwarding Description Configures the OpenManage Enterprise trap forwarding settings.
https:///api/AlertService/AlertDestinations/SMTPConfiguration POST method for SMTPConfiguration Description Configures the email and SMTP configuration for alerts. Privilege MONITORING_SETUP HTTP response codes 200 Example Input: { "DestinationAddress": "10.35.2.0", "UseCredentials": true, "PortNumber": 25, "UseSSL": true, "Credential": { "User": "root", "Password": "calvin" } } https:///api/AlertService/AlertDestinations/Actions/ AlertDestinations.
{ ] } "Id": 4, "Enabled": false, "DestinationAddress": null, "PortNumber": 0, "Version": null, "SnmpV1V2Credential": null, "SnmpV3Credential": null https:///api/AlertService/AlertDestinations/Actions/ AlertDestinations.ApplySyslogConfig POST method for AlertDestinations.ApplySyslogConfig Description Configures the server for alerts. Privilege MONITORING_SETUP HTTP response codes 200 Example Input: [ { }, { }, { }, { ] } "Id": 1, "Enabled": true, "DestinationAddress": "100.69.123.
HTTP response codes Example 384 200 Input: { "Id": ,// Refer task api to get the jobId for this Job name.
Warranty https:///api/ApplicationService/Settings POST method for Warranty settings Description Creates the warranty settings. Privilege APPLIANCE_SETUP Example Input: { "ConsoleSetting": [ { "Name": "WARRANTY_SCOREBOARD", "DefaultValue": "false", "Value": "true", "DataType": "java.lang.Boolean", "GroupName": "WARRANTY_SCOREBOARD" } ] } Troubleshoot service The troubleshoot service methods retrieve TechSupport Report (TSR) or diagnostic log files from the managed systems—iDRACs.
}, { "Key":"operationName", "Value":"SERVER_EXECUTE_TSR" }, { "Key":"fileName", "Value":"TSR" }, { "Key":"OPERATION_NAME", "Value":"SERVER_EXECUTE_TSR" }, { "Key":"ShareType", "Value":"2" }, { "Key":"DataSelectorArrayIn", "Value":"[3]" // Collect Logs types }, { "Key":"user_eula_Agreement", "Value":"true" }, { "Key":"ScheduledStartTime", "Value":"TIME_NOW" } ], "Targets": [ { "Id":25085, "Data":"", "TargetType": { "Id":25085, "Name":"SERVER" } } ] } Example to create a diagnostic job 386 Input: { "Id":0,
{ "Key":"OPERATION_NAME", "Value":"SERVER_DIAGNOSTIC" }, { "Key":"ShareType", "Value":"2" }, { "Key":"RunMode", "Value":"0" }, { "Key":"RebootJobType", "Value":"2" }, { "Key":"ScheduledStartTime", "Value":"TIME_NOW" } ], "Targets": [ { "Id":3714, "Data":"", "TargetType": { "Id":3714, "Name":"SERVER" } } ] } /api/TroubleshootService/Files This URI returns TechSupport Report (TSR) or diagnostic log files. GET method for Files This method returns TechSupport Report (TSR) or diagnostic log files.
} ] Table 152. Attributes Attribute Description DeviceId Device ID of the output file. DeviceOperation 'SERVER_DIAGNOSTIC' to retrieve diagnostic files 'SERVER_EXECUTE_TSR' to retrieve TSR files /api/TroubleshootService/Actions/ TroubleshootService.GetTroubleshootDocument This URI represents TSR/Diagnostic job reports. POST method for TroubleshootService.GetTroubleshootDocument This method extracts TSR/Diagnostic job reports. Description Extracts TSR/Diagnostic job reports.
/api/TroubleShootService/Actions/ TroubleShootService.DeleteArchivedConsoleLogs This URI deletes archived console logs on the appliance. POST method for TroubleShootService.DeleteArchivedConsoleLogs This method deletes all available archived console logs on the appliance. This method ensures no archived logs are present on the file system.
{ "@odata.type": "#QuerySupportService.Query", "@odata.id": "/api/QuerySupportService/Queries(10007)", "Id": 10007, "Name": "Warranty Report", "UsageId": 2, "FilterText": "", "ContextId": 2, "Conditions": [], "ResultFields": [], "SortFields": [] } ] } /api/QuerySupportService/Queries(Id) This URI represents detailed information for a specific query. GET method for QuerySupportService/Queries(Id) This method returns summary information for a specific query.
/api/QuerySupportService/QueryContextSummaries This URI represents summary information for all query contexts. GET method for QueryContextSummaries This method returns summary information for all Query Contexts. A Query Context defines a hierarchical set of tables and fields that are used to define queries for dynamic groups (query groups) and reports. Description This method returns summary information for all Query Contexts. Privilege VIEW HTTP response codes 200 Example Output: { "@odata.
/api/QuerySupportService/QueryContextSummary(Id) This URI represents summary information for a single query context. GET method for QueryContextSummary(Id) This method returns summary information for a specific query context. Description Returns summary information for a specific query context.. Privilege VIEW HTTP response codes 200 Example Output: { "@odata.context": "/api/ $metadata#QuerySupportService.QueryContextSummary/$entity", "@odata.type": "#QuerySupportService.
"Name": "Alert", "Description": null, "ParentTableId": -1 } ], "Fields": [ { "Id": 17, "Name": "Device Name", "TableId": 5, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 18, "Name": "Device Global Status", "TableId": 5, "Description": null, "FieldTypeId": 4, "StrMaxLen": 0, "EnumOpts": [ { "Id": 1000, "Name": "Normal" }, { "Id": 2000, "Name": "Unknown" }, { "Id": 3000, "Name": "Warning" }, { "Id": 4000, "Name": "Critical" }, { "Id": 5000, "Name": "No Status" } ] }, { "I
} 394 "EnumOpts": [] }, { "Id": 15, "Name": "Sub-Category Prefix", "TableId": 4, "Description": null, "FieldTypeId": 1, "StrMaxLen": 20, "EnumOpts": [] }, { "Id": 16, "Name": "Sub-Category Description", "TableId": 4, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 3, "Name": "Alert Status", "TableId": 1, "Description": null, "FieldTypeId": 4, "StrMaxLen": 0, "EnumOpts": [ { "Id": 1000, "Name": "Acknowledged" }, { "Id": 2000, "Name": "Not Acknowledged" } ] }, { "Id": 5, "
/api/QuerySupportService/QueryContexts(Id)/ QuerySupportService.GetFiltersForContext This URI represents summary information for all filters (queries) defined by using a specific Query Context. GET method for QuerySupportService.GetFiltersForContext This method returns summary filter information for all queries defined by using a specific Query Context. For the QuerySupportService, the term 'filter' refers to the row selection conditions for a query—WHERE part of a SQL statement.
{ }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 396 "Id": 1016, "Name": "Hyper-V Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1011, "Name": "Linux Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1000, "Name": "Modular Systems", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1006, "Name": "Network Devices", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1025, "Name": "Non-Dell Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1023, "Na
}, { }, { }, { }, { }, { ] } "Name": "Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1012, "Name": "Storage Devices", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1015, "Name": "VMware ESXi Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1018, "Name": "VxRAIL", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1024, "Name": "Windows Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1019, "Name": "XC", "UsageId": 1, "FilterText": "", "ContextId":
HTTP response codes Example 398 200 Output: { "@odata.context": "/api/$metadata#QuerySupportService.OperatorInfo/$entity", "@odata.type": "#QuerySupportService.OperatorInfo", "@odata.
} "Name": "String", "OperatorIds": [ 1, 2, 3, 4, 5, 6, 11, 12, 7, 8, 9, 10 ] }, { "FieldTypeId": 2, "Name": "Number", "OperatorIds": [ 1, 2, 3, 4, 5, 6, 9, 10 ] }, { "FieldTypeId": 3, "Name": "Date-Time", "OperatorIds": [ 1, 2, 13, 14, 9, 10 ] }, { "FieldTypeId": 4, "Name": "Enum", "OperatorIds": [ 1, 2, 9, 10 ] }, { "FieldTypeId": 5, "Name": "Boolean", "OperatorIds": [ 1, 2, 9, 10 ] } ] APIs specific to OpenManage Enterprise 399
/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 400 Output: { "@odata.context": "/api/ $metadata#Collection(QuerySupportService.Filter)", "@odata.count": 23, "value": [ { "@odata.type": "#QuerySupportService.Filter", "@odata.
{ } ] } "@odata.type": "#QuerySupportService.Filter", "@odata.id": "/api/QuerySupportService/Filters(1006)", "Id": 1006, "Name": "Network Devices", "UsageId": 1, "FilterText": "", "ContextId": 2, "Conditions": [] /api/QuerySupportService/Filters(Id) This URI represents detailed information for a query filter. GET method for Filters(Id) This method returns detailed information for a specific query filter. Description Returns detailed information for a specific query filter.
"OperatorId": 1, "Value": "203", "RightParen": true } ] } Groups service /api/GroupService/Groups This URI represents the groups. POST method for Groups This method creates a group. Description Creates a group.
HTTP response codes Example 204 Input: Output: Table 155. Attributes Attribute name Description Id—Groups(Id) ID of the parent group. Id—SubGroups(Id) ID of the subgroup. /api/GroupService/Groups(Id)/DeviceStatusSummary This URI represents the device status counts. GET method for DeviceStatusSummary This method returns the device status counts per status value. Description Returns the device status counts per status value.
Example Input: Output: { "@odata.context": "$metadata#Collection(GroupService.StatusSummary)", "@odata.count": 2, "value": [ { "StatusType": 16, "Count": 21 }, { "StatusType": 8, "Count": 1 } ] } /api/GroupService/Groups(500)/ EventSeveritySummary?$filter=StatusType eq 2000 This URL represents 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.
Privilege VIEW HTTP response codes 200 Example /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.
Example Input: { "GroupModel": { "Id":25003, "Name": "Name update", "MembershipTypeId": 12, "ParentId": 1021 } } /api/GroupService/Actions/GroupService.Clone This URI represents cloning of a group. POST method for GroupService.Clone This method clones a group. Description Clones 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 Input: { "GroupId":2614, "MemberDeviceIds" : [2514] } /api/GroupService/Actions/ GroupService.RemoveMemberDevices This URI represents removing devices from a group. POST method for GroupService.
Example Input: { "UserId" : 3864, "GroupIds" : [1314, 1264] } Auto deploy /api/AutoDeployService/Targets This URL is used to get all the auto deploy targets. GET method for Targets Description This method is used to get all the auto deploy targets. Privilege AUTO_DEPLOY_MANAGEMENT HTTP response codes 200 Example 408 Input: Output: { "@odata.context": "/api/ $metadata#Collection(AutoDeployService.AutoDeployTarget)", "@odata.count": 2, "value": [ { "@odata.type": "#AutoDeployService.
} /api/AutoDeployService/Actions/ AutoDeployService.Verify This URL validates the identifiers. Post method for AutoDeployService.Verify Description This method validates the identifiers.
/api/AutoDeployService/Actions/ AutoDeployService.Delete This URL deletes the list of autoDeployDevice IDs. POST method for AutoDeployService.Delete Description This method deletes the list of autoDeployDevice IDs. Privilege AUTO_DEPLOY_MANAGEMENT HTTP response codes 200 Example Input: Case 1: Send AutoDeployDeviceIds – to delete the selected devices in the auto deploy wizard.
"IpAddress": "xx.xx.xx.xx", "ShareName": "10.22.33.22", "User": "asdf", "Password": "asdf" } } }, "Attributes": [] /api/AutoDeployService/AutoDeploy(AutoDeployId) This URL cancels the autodeploy request before finalizing the request and deletes all the identifiers that are added in the validation API. Delete method for AutoDeploy(AutoDeployId) Description This method cancels the autodeploy request before finalizing the request and deletes all the identifiers that are added in the validation API.
}, { }, { }, { 412 "JobStartTime": "2018-09-14 01:24:25.322", "JobEndTime": null, "JobProgress": "89", "JobStatusId": 2050, "JobNextRun": null, "JobEnabled": true, "UpdatedBy": "admin", "LastUpdateTime": "2018-09-14 01:24:25.338", "DiscoveryConfigGroupId": 8, "DiscoveryConfigExpectedDeviceCount": 256, "DiscoveryConfigDiscoveredDeviceCount": 0, "DiscoveryConfigEmailRecipient": null, "DiscoveredDevicesByType": [] "@odata.type": "#DiscoveryConfigService.DiscoveryJob", "@odata.
}, { } ] } "JobNextRun": null, "JobEnabled": true, "UpdatedBy": "admin", "LastUpdateTime": "2018-09-13 16:02:09.361", "DiscoveryConfigGroupId": 5, "DiscoveryConfigExpectedDeviceCount": 256, "DiscoveryConfigDiscoveredDeviceCount": 0, "DiscoveryConfigEmailRecipient": null, "DiscoveredDevicesByType": [] "@odata.type": "#DiscoveryConfigService.DiscoveryJob", "@odata.
/api/DiscoveryConfigService/DiscoveryConfigGroups This URI creates a discovery job. POST method for DiscoveryConfigGroups This method creates a discovery job. Description Creates a discovery job.
"Disabled":false, "Exclude":false } ], "ConnectionProfileId":0, "ConnectionProfile":"{\"profileName\":\"\",\"profileDescription \":\"\",\"type\":\"DISCOVERY\",\"credentials\":[{\"id\":0,\"type\":\"WSMAN \",\"authType\":\"Basic\",\"modified\":false,\"credentials\":{\"username \":\"root\",\"password\":\"calvin\",\"caCheck\":false,\"cnCheck \":false,\"port\":443,\"retries\":3,\"timeout\":60,\"isHttp \":false,\"keepAlive\":false}}]}", "DeviceType":[ 1000 ] } ], "Schedule":{ "RunNow":false, "RunLater":true, "Cr
"DiscoveryConfigGroupDescription":"null", "DiscoveryConfigModels":[ { "DiscoveryConfigId":916140325, "DiscoveryConfigDescription":"", "DiscoveryConfigStatus":"", "DiscoveryConfigTargets":[ { "DiscoveryConfigTargetId":0, "NetworkAddressDetail":"xx.xx.xx.xx", "AddressType":30, "Disabled":false, "Exclude":false } ], "ConnectionProfileId":0, "ConnectionProfile":"{\"profileName\":\"\",\"profileDescription \":\"\",\"type\":\"DISCOVERY\",\"credentials\":[{\"id\":0,\"type\":\"VMWARE \",\"authType\":\"Basic\",\"modi
HTTP response codes 204 Example Input: { "DiscoveryGroupIds":[1,2,3] } /api/DiscoveryConfigService/Actions/DiscoveryConfigService.Parse This URI represents discovery ranges parsed from a .CSV file. 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 Input: { fileName="abc.
] }], "DiscoveryConfigTaskParam": [], "DiscoveryConfigTasks": [], "Schedule": { "RunNow": true, "RunLater": false, "Cron": "startnow" } }, "CreateGroup":true, "TrapDestination":false Output: { "DiscoveryConfigGroupId": 11, "DiscoveryConfigGroupName": "Discovery-2018022611572222-updated", "DiscoveryConfigGroupDescription": "Discovery-2018022611572222-updated", "DiscoveryStatusEmailRecipient": null, "DiscoveryConfigParentGroupId": 0, "CreateGroup": true, "DiscoveryConfigModels": [ { "DiscoveryConfigId": 33
Table 158. 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 Warranty service /api/WarrantyService/Warranties This URI represents the retrieval of warranty information from OpenManage Enterprise.
Table 159.
"JobDescription":"Warra "Schedule":"startnow", "State":"Enabled", "JobType":{ "Id":130, "Name":"Warranty_Task" }, "Params":[ { "Key":"warrantyCollectionType", "Value":"complete" ], "Targets":[ } { "Id":500, "Data":"", "TargetType": "Id":6000, "Name":"GROUP" } ] } Report service /api/ReportService/ReportDefs This URI represents the OpenManage Enterprise report definitions. GET method for ReportDefs This method returns the definitions of reports. Description Returns the definitions of reports.
"QueryDef": { "FilterId": 10012, "ContextId": 2 }, "ColumnNames": [{ "Id": 1000, "Name": "Device Name", "Width": 30, "Sequence": 1 }, { "Id": 1001, "Name": "Device Service Tag", "Width": 20, "Sequence": 2 }, { "Id": 1002, "Name": "Device Type", "Width": 20, "Sequence": 3 }, { "Id": 1003, "Name": "Device Model", "Width": 30, "Sequence": 4 }, { "Id": 1004, "Name": "Critical", "Width": 20, "Sequence": 5 }, { "Id": 1005, "Name": "Warning", "Width": 20, "Sequence": 6 }, { "Id": 1006, "Name": "Normal", "Width": 2
Table 160. Attributes Attribute Description Id Report identifier Name Name of the report Description Description of the report IsBuiltIn Specifies whether it is a built-in report or a custom report LastEditedBy Time when report was last edited LastRunDate Time when the report was last run LastRunBy User who has run the report LastRunDuration Duration of the report run.
}, { }, { }, { }, { } "FieldId":61 "FieldId":64 "FieldId":63 "FieldId":99 "FieldId":102 ], "SortFields":[ } } ] PUT method for ReportDefs This method updates a report. Description Updates a report.
}, { "FieldId": 70 }, { "FieldId": 65 }], "SortFields": [{ "FieldId": 65, "SortDir": 0 }] } } Table 161. 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. QueryDefRequest Definition of the query for the report. /api/ReportService/ReportDefs(Id)/ReportResults This URI represents the results of a report.
"Id": 24, "Name": "Identifier", "Width": 20, "Sequence": 3 }, { "Id": 25, "Name": "Device Asset Tag", "Width": 25, "Sequence": 4 }, { "Id": 26, "Name": "Datacenter", "Width": 25, "Sequence": 5 }, { "Id": 27, "Name": "Aisle", "Width": 25, "Sequence": 6 }, { "Id": 28, "Name": "Rack", "Width": 25, "Sequence": 7 } ], "ResultRows@odata.
} ] /api/ReportService/Actions/ReportService.RunReport This URI is used to run a report. POST method for Running Reports This method is used to run reports. Description Used to run reports. Privilege REPORT_RUN HTTP response codes 200 Example Input: { "ReportDefId":1564, "FilterGroupId":0 } /api/ReportService/Actions/ReportService.DownloadReport The URI represents the download of reports. POST method for ReportService.DownloadReport This method downloads all the reports.
/api/ReportService/Actions/ReportService.CloneReport This URI represents cloning of a report. POST method for ReportService.CloneReport This method clones a report. Description Clones a group. Privilege REPORT_MANAGEMENT HTTP response codes 200 Example Input: { "ReportDefId":"25074", "ReportDefName":"new clone report" } MIB import service /api/MIBImportService/MIBS This URI represents the MIB traps. GET method for MIBS This method returns the traps imported from all the MIBs.
"Description": "Critical" }, "EventDefinitionId": 1098064858, "Description": "Memory device status is non-recoverable." }, "FormatString": "$3", "GenericTrapId": 6, "SnmpEventId": 1000, "SpecificTrapId": 5405 }] } /api/MIBImportService/Actions/MIBImportService.Save This URI represents the saved traps from MIBs. POST method for MIBImportService.Save This method saves parsed traps from MIB in the appliance. This URI provides functionality to save traps already parsed from the MIB.
/api/MIBImportService/Actions/MIBImportService.Parse This URI represents the trap information by parsing MIBs. POST method for MIBImportService.Parse This method parses MIB files to get trap information. This URI accepts absolute file paths of the MIB file that need to be parsed. Description Parses MIB files to get trap information. Privilege TRAP_MANAGEMENT HTTP response codes 200 Example Input: ["/tmp/parseMib/10892.mib"] /api/MIBImportService/Actions/MIBImportService.
/api/MIBImportService/MIBImportService/EventCatalogs This URI represents the event catalogs. GET method for EventCatalogs This method returns the event catalogs. Description Returns the event catalogs. Privilege VIEW HTTP response codes 200 Example Output: { "@odata.context": "/api/ $metadata#Collection(MIBImportService.MIBEventCatalog)", "@odata.count": 46, "value": [{ "@odata.type": "#MIBImportService.MIBEventCatalog", "@odata.
Plugin Manager /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 Input: None Output: { "@odata.context": "/api/$metadata#Collection(PluginService.Plugin)", "@odata.count": 1, "value": [ { "@odata.type": "#PluginService.Plugin", "@odata.
Table 162. Attributes(continued) Attribute Description Name Plug-in name UpdateAvailable Is update available for the plug-in. Installed Is the plug-in already installed or not? Enabled Is the plug-in enabled or not? Publisher Plug-in publisher CurrentVersion Current installed version. Description Description associated with the plug-in. InstalledDate Last installed date of the plug-in. LastUpdatedDate Last updated date of the plug-in. LastDisabledDate Last disabled date of the plug-in.
"InstalledDate": "2019-06-14 21:13:09.487", "LastUpdatedDate": null, "LastDisabledDate": null, "AvailableVersionDetails@odata.navigationLink": "/api/PluginService/ Plugins('2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625')/AvailableVersionDetails" } /api/PluginService/Plugins('')/ AvailableVersionDetails This URL returns the plug-in version information. GET method for AvailableVersionDetails Description This method returns the plug-in version information.
Table 163. Attributes(continued) Attribute Description PackageSize Package size of the plug-in in bytes. ReleaseNoteURL Release note URL for the plug-in version. MinimumOmeVersionRequired Minimum OpenManage Enterprise version required for the plug-in version. /api/PluginService/Actions/ PluginService.CheckPluginCompatibility This URL validates the plug-in to check if it is compatible with OpenMange Enterprise. POST method for PluginService.
/api/PluginService/Actions/ PluginService.UpdateConsolePlugins This URL is used to install or uninstall, enable or disable, or update the plug-in. POST method for PluginService.UpdateConsolePlugins Description This method is used to install or uninstall, enable or disable, or update the plug-in. Privilege APPLIANCE_SETUP HTTP response codes 200 Example Input: { "Plugins": [ { "Id": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625", "Version": "1.0.
Power Metrics /api/MetricService/Metrics This URL returns all the device or group metrics. POST method for Metrics Description This method returns all the device or group metrics. Privilege VIEW HTTP response codes 201 Example Input: { "PluginId": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625", "EntityType": 0, "EntityId": 10397, "MetricTypes": [ 1, 2, 3 ], "Duration": 0, "SortOrder":0 } Output: { "EntityId": 10397, "Value":[ { "Type": "1", "Value": "230.0", "Timestamp": "2019-07-02 13:45:05.
Table 166. Attributes(continued) Attribute Description Duration Duration of metric data collection. SortOrder Order of metric data collected.
Table 166. Attributes(continued) Attribute Description 8 Six Months 9 One Year Sort Order 0 Descending 1 Ascending /api/MetricService/TopEnergyConsumption This URL represents the most high energy consumption. POST method for TopEnergyConsumption Description This method returns the information of the most high energy consumption.
Table 167. Attributes Attribute Description PluginId ID of plug-in. Top Top values, 1–5. EntityType Type of entity device or group. DeviceType Type of device—server or chassis. Duration Duration Entity Type 0 Device 1 Group Device Type 1000 Server 2000 Chassis Duration 4 One day 5 One week 6 Two weeks 7 One month 8 Three months 9 Six months 10 One year /api/MetricService/EnergyConsumption This URL returns the energy consumption of the device.
Table 168. Attributes Attribute Description PluginId ID of a plug-in. EntityType Type of an entity, only device. EntityId ID of an entity, only device. Duration Duration Total Energy Energy Consumption in KWH. Duration 1 One hour 2 Six hours 3 Twelve hours 4 One day 5 Seven days 6 One month 7 Three months 8 Six months 9 One year /api/MetricService/MetricTypes This URL returns all the supported metric types.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 442 "Name": "AVG_POWER", "Description": "Average System Power Consumption" "@odata.type": "#MetricService.MetricType", "Id": 4, "Name": "INSTANT_POWER", "Description": "Instant System Power" "@odata.type": "#MetricService.MetricType", "Id": 5, "Name": "MAX_INLET_TEMP", "Description": "Maximum Inlet Temperature" "@odata.type": "#MetricService.
}, { }, { }, { }, { } ] } "Name": "MAX_UTIL_IO", "Description": "Maximum IO utilization" "@odata.type": "#MetricService.MetricType", "Id": 16, "Name": "MIN_UTIL_IO", "Description": "Minimum IO utilization" "@odata.type": "#MetricService.MetricType", "Id": 17, "Name": "AVG_UTIL_IO", "Description": "Average IO utilization" "@odata.type": "#MetricService.MetricType", "Id": 18, "Name": "SYS_AIRFLOW", "Description": "System Air Flow" "@odata.type": "#MetricService.
} Table 169. Attributes Attribute Description PluginId ID of a plug-in. EntityType Type of an entity—device or group. EntityId ID of an entity—device or group. Duration Duration MetricTypes Type that is supported by the metric.
} "EntityId": 10079, "Type": "Temperature", "State": "Unknown", "UpperWarning": "100", "UpperCritical": "150", "LowerWarning": "70", "LowerCritical": "80" Table 170. Attributes Attribute Description PluginId ID of a plug-in. EntityId ID of an entity—device or group. Type Type—temperature or power. State State of an entity—unknown, normal, warning, critical. UpperWarning Upper limit threshold of state warning. UpperCritical Upper limit threshold of state critical.
Table 171. Attributes Attribute Description Supported threshold LowerWarning, lowerCritical, upperWarning, upperCritical Supported state Unknown, normal, warning, critical Supported power UpperWarning, upperCritical Supported temperature LowerCritical, lowerWarning, upperWarning, upperCritical Reset threshold Pass empty values in all the threshold fields in the payload. PluginId ID of a plug-in. EntityId ID of an entity—device or group. Type Type—temperature or power.
18 Redfish resource model Dell EMC incrementally improves the support for API and the associated operations during the life cycle of the products. The limited Redfish implementation follows the industry-standard DMTF specifications. For more information, see the documentation available on the DMTF website.
} ] Table 172. Attributes Attribute name Description Id ID of the session service. ServiceEnabled Indicates if the session service is enabled or disabled. SessionTimeout The period of time after which the session is timed out. /redfish/v1/SessionService/Sessions/Members This URI represents the active session services. GET method for Members This method returns a collection of the active session services. Description Returns a collection of the active session services.
Table 173. Attributes(continued) Attribute name Description LastAccessedTimeStamp Date and time when the session was last accessed. POST method for Members This method authenticates a user and establishes a session. Description Establishes a session.
HTTP response codes Example 200 URI: /api/SessionService/Sessions/Sessions(‘7b723932-a119-4843a5b7-7a122e4def99’) Input: { "UserName":"root", "Password":"linux", "SessionType":"API" } Output: { "Id": "7b723932-a119-4843-a5b7-7a122e4def99", "Description": "root", "Name": "API", "UserName": "root", "Password": null, "Roles": [ "ADMINISTRATOR" ], "IpAddress": "xx.xx.xx.xx", "StartTimeStamp": "2017-04-17 20:07:12.357", "LastAccessedTimeStamp": "2017-04-17 20:07:12.
Example Input: Output: { "@odata.context": "$metadata#AccountService.v1_0_2.AccountService", "@odata.
Table 175. Attributes(continued) Attribute name Description AccountLockoutDuration Number of seconds for which an account is locked after the account lockout threshold is met. This value must be equal to or greater than the value for AccountLockoutResetAfter. 0 indicates that the account is never locked. AccountLockoutCounterResetAfter Number of seconds after which the lockout threshold counter is reset to zero. The duration is counted from the last failed login attempt.
} "EnableIpRangeAddress": false Table 176. Attributes Attribute name Description ID ID of the account service. Description Description of the account service. Name Name of the account service. ByUserName Indicates if the service is configured by user name. ByIPAddress Indicates if the service is configured by IP address. State Indicates the known state of the resource. HealthRollup Health roll-up status Health Health of the resource. MinPasswordLength Minimum length of the password.
{ "@odata.context": "$metadata#Collection(ManagerAccount.v1_0_2.ManagerAccount)", "@odata.count": 1, "value": [ { "@odata.id": "/redfish/v1/AccountService/Accounts/Members('1814')", "Oem": { "Dell": { "UserTypeId": 1, "DirectortyServiceId": 0, "IsBuiltin": true } }, "Id": "1814", "Description": "root", "Name": "root", "Password": null, "UserName": "root", "RoleId": "10", "Locked": false, "Enabled": true, "Links": null } ] } Table 177. Attributes Attribute name Description Id ID of the account.
} "UserName": "user2", "RoleId": "10", "Locked": false, "Enabled": true Output: { "Id": "3064", "UserTypeId": 1, "DirectortyServiceId": 0, "Name": "user2", "Password": null, "UserName": "user2", "Description": "user2 description", "Oem": null, "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true } Table 178. Attributes Attribute name Description Id ID of the account. UserTypeId ID of the type of user. DirectortyServiceId ID of the directory service.
} "@odata.id": "/redfish/v1/AccountService/Accounts/Members('1814')", "Oem": { "Dell": { "UserTypeId": 1, "DirectortyServiceId": 0, "IsBuiltin": true } }, "Id": "1814", "Description": "root", "Name": "root", "Password": null, "UserName": "root", "RoleId": "10", "Locked": false, "Enabled": true, "Links": null Table 179. Attributes Attribute name Description Id ID of the account. UserTypeId ID of the type of user. DirectortyServiceId ID of the directory service. Description Description of the user.
Output: { "Id": "3064", "UserTypeId": 1, "DirectortyServiceId": 0, "Name": "user2", "Password": null, "UserName": "user2", "Description": "user2 description", "Oem": null, "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true } Table 180. Attributes Attribute name Description Id ID of the account. UserTypeId ID of the type of user. DirectortyServiceId ID of the directory service. Description Description of the user. Name Name of the user. This value is the same as user name.
/redfish/v1/AccountService/Roles/Members(Id) This URI represents the role details of a specific account. GET method for Members(Id) This method returns the details of the role for a specific account. Description Returns the details of a role. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Role.Role/$entity", "@odata.
} "Name": "Registry File Collection", "Description": "Registry Repository", "Base.1.0.0": [ { "@odata.id": "/redfish/v1/Registries/Base.1.0.0" } ], "Dellv1_0_0": [ { "@odata.id": "/redfish/v1/Registries/Dellv1_0_0" } ] Redfish — Chassis This resource enables you to access the chassis details. Using this resource, you can retrieve details such as chassis health, chassis rollup health, and so on. Use the URIs in this resource to access the chassis details.
}, { "@odata.id": "/redfish/v1/Chassis/Members('25010')" }, { } ] "@odata.id": "/redfish/v1/Chassis/Members('25009')" } Redfish — Systems /redfish/v1/Systems This URI represents the systems. GET method for Systems This method returns the collection of the systems. Description Returns the collection of systems. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/redfish/ v1/$metadata#ComputerSystemCollection.ComputerSystemCollection", "@odata.
