API Guide

ManualsBrandsDell ManualsC SeriesPowerEdge MX7000

OpenManage Enterprise Version 3.4.1 and

OpenManage Enterprise - Modular Edition

Version 1.20.10

RESTful API Guide

August 2020

Rev. A00

Summary of content (682 pages)

PAGE 1
OpenManage Enterprise Version 3.4.1 and OpenManage Enterprise - Modular Edition Version 1.20.10 RESTful API Guide August 2020 Rev.
PAGE 2
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. © 2018 -2020 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
PAGE 3
Contents Chapter 1: About this document................................................................................................... 17 Chapter 2: Overview.................................................................................................................... 19 RESTful application programming interface................................................................................................................19 OData......................................................................
PAGE 4
/api/AccountService/Actions/AccountService.Delete..................................................................................... 47 /api/AccountService/Roles......................................................................................................................................48 /api/AccountService/Roles(Id)...............................................................................................................................49 /api/AccountService/ExternalAccountProvider..........
PAGE 5
/api/AlertService/Actions/AlertService.Unacknowledge............................................................................... 125 /api/AlertService/Actions/AlertService.RemoveAlerts...................................................................................126 Alert policies...................................................................................................................................................................... 127 /api/AlertService/AlertPolicies......................
PAGE 6
api/TemplateService/Templates(26)................................................................................................................... 188 /api/TemplateService/Templates(Id)/Views......................................................................................................191 /api/TemplateService/Templates(Id)/Views(Id).............................................................................................. 192 /api/TemplateService/Templates(Id)/Views(Id)/AttributeViewDetails.....
PAGE 7
GET method for InventoryDetails......................................................................................................................... 244 /api/DeviceService/Devices(Id)/InventoryDetails(InventoryType)..................................................................255 GET method for inventory details by inventory type.......................................................................................255 /api/DeviceService/Devices(Id)/Settings('ReplicableChassisConfigurations')........
PAGE 8
POST method for /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/ DeviceService.GetComputeIPs..........................................................................................................................275 /api/DeviceService/DeviceSummary........................................................................................................................ 275 GET method for DeviceSummary.................................................................................................
PAGE 9
/api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25& $skip=0 ........................................................................................................................................................................ 320 GET method for AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0.......................... 320 /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25& $skip=0&$orderby=Identifier asc...................
PAGE 10
Chapter 11: Reset application.................................................................................................... 385 /api/ApplicationService/Actions/ApplicationService.ResetApplication........................................................... 385 POST method for ResetApplication..................................................................................................................... 385 Chapter 12: Console version..................................................................
PAGE 11
/api/ManagementDomainService......................................................................................................................... 425 /api/ManagementDomainService/DiscoveredDomains.................................................................................. 430 /api/ManagementDomainService/ConfigurationTypes.................................................................................. 432 /api/ManagementDomainService/ConfigurationTypes(Id)........................................
PAGE 12
/api/NetworkService/FabricActivityStatuses...................................................................................................490 /api/NetworkService/FabricHealthStatuses......................................................................................................491 /api/NetworkService/MultiChassisDomain........................................................................................................492 /api/NetworkService/MultiChassisDomain/Topology............................
PAGE 13
/api/TemplateService/Actions/TemplateService.AttachProfile.................................................................. 534 /api/TemplateService/Actions/TemplateService.AssociateProfile............................................................. 534 /api/TemplateService/Actions/TemplateService.UpdateProfile................................................................. 535 /api/TemplateService/Actions/TemplateService.MigrateProfile................................................................
PAGE 14
/api/TroubleShootService/Actions/TroubleShootService.GetArchivedConsoleLogs............................ 563 /api/TroubleShootService/Actions/TroubleShootService.DeleteArchivedConsoleLogs....................... 563 Query support service................................................................................................................................................... 563 /api/QuerySupportService/Queries.............................................................................................
PAGE 15
/api/DeviceService/Actions/DeviceService.RemoveKeys............................................................................ 592 /api/DeviceService/Actions/DeviceService.AddCredentialToDevice.........................................................593 Auto deploy...................................................................................................................................................................... 593 /api/AutoDeployService/Targets.............................................
PAGE 16
Redfish—Systems..........................................................................................................................................................669 /redfish/v1/Systems............................................................................................................................................... 669 redfish/v1/Systems/Members(id)........................................................................................................................
PAGE 17
1 About this document This document contains information about the resource models for OpenManage Enterprise and OpenManage Enterprise – Modular Edition (OME–Modular). Each RESTful API specification includes the URI, method, parameters, request codes, and response codes. Some of the APIs are available only in OME–Modular and do not work if used in OME–Modular and the opposite way. Table 1. Supported REST API versions Product Date of release What's new OpenManage Enterprise – Modular Edition 1.20.
PAGE 18
Table 1. Supported REST API versions (continued) Product Date of release What's new ● API to log off from the current user session. For more information, see /api/ SessionService/Actions/ SessionService.Logoff. ● APIs to update untagged network profiles to an existing interface for one or more servers. For more information, see Fabric management. ● API for getting sync failure alert timeout values.
PAGE 19
2 Overview RESTful API support in OpenManage Enterprise, OpenManage Enterprise and OME–Modular OME–Modular supports RESTful API. Support for APIs has also been improved for OpenManage Enterprise. Improved support for APIs on these products enhances the systems management capabilities. The RESTful interface is provided over HTTPS in JSON format based on ODATA v4 usable by clients, scripts, and browser-based GUIs.
PAGE 20
OpenManage Enterprise – Modular Edition OpenManage Enterprise – Modular Edition (OME–Modular) is the systems management software that runs on the Dell EMC PowerEdge MX-series chassis. OME–Modular shares a common codebase with OpenManage Enterprise and delivers an agile, reliable, and comprehensive platform to manage PowerEdge MX-series servers, storage, and networking products. OME– Modular boosts services delivery and restores IT agility for growing businesses.
PAGE 21
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.
PAGE 22
Resource tree for OME–Modular OEM scheme Figure 1. Resource tree for OME–Modular OEM scheme Resource tree for OpenManage Enterprise OEM scheme Figure 2.
PAGE 23
Resource model https://[IP or DNS name]/api/$metadata 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.
PAGE 24
Authentication Several common schemes are available for enabling authentication of REST requests. Basic Authentication and X-Auth-Token Authentication are some of the common schemes. Basic authentication The authorization header in the request has the base-64 encoding of the credentials—username and password. If you do not provide the credentials, a 401—Authorization Failure error is returned. Basic Authentication is supported only when SSL/TLS is used for the transport.
PAGE 25
Table 2. Authentication and authorization requirements (continued) Actions Authentication required Authorization required N/A N/A View JSON schemas URI OME - Modular Table 3. Role descriptions OME-Modular Role Description VIEW View all data, report execution and management, and so on. APPLIANCE_SETUP Global appliance/OME - Modular settings that involve setup of the appliance. SECURITY_SETUP User management, security policies, proxy, and firewall setup.
PAGE 26
Table 4. Roles and associated privileges for OME - Modular (continued) Privilege Roles CHASSIS_ADMIN ISTRATOR COMPUTE_MAN AGER STORAGE_MANA GER FABRIC_MANAG ER DEVICE_UPDATE Y Y Y Y TEMPLATE_MANA GEMENT Y Y BASELINE_MANA GEMENT Y Y Y Y POWER_MANAGE MENT Y Y JOB_MANAGEME NT Y Y Y Y ALERT_MANAGEM ENT Y FABRIC_MANAGE MENT Y NETWORK_MANA GEMENT Y VIEWER Y Y Y OME - Modular Table 5.
PAGE 27
Table 5. Roles and associated privileges for OME - Modular (continued) Privilege Roles ADMINISTRATOR DEVICE_MANAGER VIEWER ALERT_MANAGEMENT Y N N AUTO_DEPLOY_MANAGEME NT Y N N FABRIC_MANAGEMENT Y N N NETWORK_MANAGEMENT Y N N Resource addressing Each managed resource must be uniquely addressable using a distinct URI. The URI syntax must be intuitive and should indicate the relationships with a parent resource.
PAGE 28
Table 6. HTTP methods (continued) HTTP method Description Example DELETE Used for removing a specific resource. If the resource does not exist, a Success response is returned. Delete a specific user account. DELETE / AccountService/ Accounts('1414') When you perform tasks using these methods, they return an HTTP response code. For more information about the response codes, see Status Code Definitions on the W3.org website. If a method fails, you may also see an Error and Event Message code.
PAGE 29
Data pagination The console software provides pagination options on certain URIs that return a collection of entities. The pagination options enable the clients to get paginated results. If a URI supports pagination, the relevant URI sections indicate it.
PAGE 30
Table 8.
PAGE 31
Table 9.
PAGE 32
4 Application settings Topics: • • • • Network Security and user management Security and certificate management Monitoring and alert notifications Network /api/ApplicationService/Network This URI represents the collection of network application services. GET method for Network This method returns the network configuration details. Description Returns the network configuration details. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Network.
PAGE 33
/api/ApplicationService/Network/WebServerConfiguration This URI represents the web-server configuration. GET method for WebServerConfiguration This method returns the web server configuration, including the status, port number, and session timeout duration. Description Returns the web-server configuration, including the status of the web server, port number, and session timeout duration. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Network.
PAGE 34
/api/ApplicationService/Network/TimeConfiguration This URI represents the time-configuration-related application services. GET method for TimeConfiguration This method returns the current time-related configuration. Description Returns the time-related configuration. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#Network.TimeConfiguration", "@odata.type": "#Network.TimeConfiguration", "@odata.
PAGE 35
Table 11. Attributes Attribute name Description TimeZone The timezone to use. EnableNTP Specify whether to enable or disable NTP. PrimaryNTPAddress The primary NTP address. SecondaryNTPAddress1 The first secondary NTP address. SecondaryNTPAddress2 The second secondary NTP address. SystemTime The system time. If EnableNTP is False, SystemTime cannot be null or empty. /api/ApplicationService/Network/TimeZones This URI represents the time-zone application services.
PAGE 36
/api/ApplicationService/Network/ProxyConfiguration This URI represents the proxy configuration. GET method for ProxyConfiguration This method returns the current proxy configuration. Description Returns the current proxy configuration. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Network.ProxyConfiguration/$entity", "@odata.
PAGE 37
Table 13. Attributes (continued) Attribute name Description PortNumber Port number, if HTTP Proxy Settings is enabled. EnableAuthentication Enable or disable Proxy Authentication. EnableProxy Enable or disable HTTP Proxy Settings. Username Username, if Proxy Authentication is enabled. Password Password, if Proxy Authentication is enabled. Security and user management /api/AccountService This URI represents the configuration of the user accounts.
PAGE 38
} } "@odata.id": "/api/AccountService/ExternalAccountProvider" Table 14. Attributes Attribute Description Description Description for the Account service. Name Name given for Account service. State Indicates the known state of the resource. HealthRollup Health rollup status. Health Health of the resource. ServiceEnabled Indicates if the service is enabled or disabled.
PAGE 39
} Example response body { } }, "ServiceEnabled": false, "AuthFailureLoggingThreshold": 3, "MinPasswordLength": 8, "MaxPasswordLength": 20, "AccountLockoutThreshold": 3, "AccountLockoutDuration": 30, "AccountLockoutCounterResetAfter": 900, "EnableIpRangeAddress": false, "IpRangeAddress": null, "ByUserName": false, "ByIPAddress": false "Id": "10", "Description": "OME-Modular User Accounts", "Name": "Account Service", "Status": { "State": "Enabled", "HealthRollup": "OK", "Health": "OK", "Oem": null }, "Oe
PAGE 40
Table 15. Attributes (continued) Attribute Description higher than the AccountLockoutResetAfter value. 0 indicates that the account is never locked. AccountLockoutCounterResetAfter The interval of time in seconds since the last failed login attempt at which point the lockout threshold counter for the account is reset to zero. Must be less than or equal to AccountLockoutDuration. EnableIpRangeAddress Enable or disable IP range address. IpRangeAddress IP rage address to be used.
PAGE 41
Table 16. Attributes (continued) Attribute Description 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. IsBuiltin Indicates if the account is an in-built account.
PAGE 42
Table 17. Attributes Attribute Description Id Uniquely identifies the resource within the collection. UserTypeId Type of user. DirectoryServiceId Directory service ID. Description Description for the user. Name Name of the user. This name is the same as user name. Password Password for the user. When retrieving the details, Password is displayed as blank. UserName User name of the account. RoleId Role for the account. Locked Indicates if the account is locked or unlocked.
PAGE 43
Table 18. Attributes Attribute Description Id Uniquely identifies the resource within the collection. UserTypeId Type of user. DirectoryServiceId Directory service ID. Description Description for the user. Name Name of the user. This name is the same as user name. Password Password for the user. When retrieving the details, Password is displayed as blank. UserName User name of the account. RoleId Role for the account. Locked Indicates if the account is locked or unlocked.
PAGE 44
Table 19. Attributes Attribute Description Id Uniquely identifies the resource within the collection. UserTypeId Type of user. DirectoryServiceId Directory service ID. Description Description for the user. Name Name of the user. This name is the same as user name. Password Password for the user. When retrieving the details, Password is displayed as blank. UserName User name of the account. RoleId Role for the account. Locked Indicates if the account is locked or unlocked.
PAGE 45
} ] } "Id": 3214, "UserId": 3164, "RoleId": 10, "Entities": [ 64 ] Table 21. Attributes Attribute Description Id Permission record ID. UserId Account ID for which permissions are retrieved. RoleId Role ID of the account. Entities List of entities that the account has access to. /api/AccountService/Actions/AccountService.GetPrivileges This URI represents the list of privileges for a user for a device. POST method for /api/AccountService/Actions/ AccountService.
PAGE 46
Example request body { "UserId":"100", "MacAddress":"d0:94:66:34:b7:de" } /api/AccountService/Actions/AccountService.GetUserDetail This API returns details of the user who has logged in. POST method for /api/AccountService/Actions/ AccountService.GetUserDetail This method returns details of the user who has logged in. The details include user name, user ID, and role details. Description Returns details the user who has logged in.
PAGE 47
/api/AccountService/Actions/AccountService.Disable This URI enables you to disable multiple accounts. POST method for AccountService.Disable This method disables multiple accounts. Description Disables multiple accounts. Privilege SECURITY_SETUP HTTP response codes 204 Example request body { } "AccountIds":[3164,3264] Table 23. Attributes Attribute Description AccountIds Account IDs to be disabled. /api/AccountService/Actions/AccountService.
PAGE 48
/api/AccountService/Roles This URI represents the user roles. GET method for Roles This method returns a list of roles and the respective privileges. Description Returns a list of user roles and respective privileges. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(AccountService.Role)", "@odata.count": 5, "value": [ { "@odata.
PAGE 49
/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 response body { "@odata.context": "$metadata#Collection(AccountService.Role)", "@odata.count": 5, "value": [ { "@odata.
PAGE 50
/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 response body { "@odata.context": "$metadata#ExternalAccountProvider.ExternalAccountProvider/$entity", "@odata.
PAGE 51
/api/AccountService/ExternalAccountProvider/ DirectoryServiceType This URI represents the collection of directory types. GET method for DirectoryServiceType This method returns the collection of directory types. Description Returns a collection of directory types. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(ExternalAccountProvider.DirectoryServiceType)", "@odata.
PAGE 52
} "@odata.count": 0, "value": [] POST method for ADAccountProvider This method adds an Active Directory service. Description Adds an Active Directory service. Privilege SECURITY_SETUP HTTP response codes 200 Example request body : { } Example response body { } "Name": "Starship", "Id":2, "ServerType": "DNS", "ServerName": ["10.35.195.
PAGE 53
Table 29. Attributes (continued) Attribute Description CertificateValidation Enable or disable certificate validation for the directory service. CertificateFile Certificate file for authentication. /api/AccountService/ExternalAccountProvider/ ADAccountProvider(Id) This URI represents a specific Active Directory server. GET method for ADAccountProvider(Id) This method returns the details of a specific Active Directory server from the collection.
PAGE 54
Privilege SECURITY_SETUP HTTP response codes 200 Example request body { } Example response body { } "Name": "Starship", "Id": 2714, "ServerType": "MANUAL", "ServerName": ["10.35.195.1"], "UserName": "Admin", "Password": null, "ServerPort": 3268, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": null "Id": 2714, "Name": "Starship", "ServerType": "MANUAL", "ServerName": ["10.35.195.
PAGE 55
/api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.TestADConnection This URI enables you to test the Directory Service connection. POST method for ExternalAccountProvider.TestADConnection This method tests the Active Directory Service connection. Description Tests the Active Directory Service connection.
PAGE 56
} "CertificateFile": "" Example for Example response body ServerType: DNS { "Name": "AD", "ServerType": "DNS", "ServerName": [ "ausdcdell1.dell.com", "rdudc12dell01.dell.com", "pendc12dell01.dell.com", "ausdc12dell02.dell.com", "ausdc12dell01.dell.com", "limdc12dell01.dell.com", "ausdc12dell05.dell.com", "ausdc12dell06.dell.com", "rdudc12dell02.dell.com", "ausdc12dell03.dell.com" ], "DnsServer": [ "dell.com" ], "GroupDomain": "dell.
PAGE 57
/api/AccountService/ExternalAccountProvider/ LDAPAccountProvider This URI represents the collection of LDAP Directory Services. GET method for LDAPAccountProvider This method returns the collection of LDAP Directory Service. Description Returns the collection of LDAP Directory Service. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(ExternalAccountProvider.LDAPAccountProvider)", "@odata.count": 1, "value": [ { "@odata.
PAGE 58
} Example response body { } "Name": "seaquest", "Id":1, "ServerType": "DNS", "ServerName": ["10.35.195.1"], "UserName": "Admin", "Password": "XXXXX", "ServerPort": 0, "BaseDistinguishedName" : "dc=dell,dc=com", "AttributeUserLogin": null, "AttributeGroupMembership": null, "NetworkTimeOut": 300, "SearchTimeOut": 300, "CertificateValidation": false, "CertificateFile": "" "Id": 2914, "Name": "seaquest", "ServerType": "DNS", "ServerName": [ "10.35.195.
PAGE 59
/api/AccountService/ExternalAccountProvider/ LDAPAccountProvider(Id) This URI represents a specific LDAP server within the collection of LDAP Directory Service. GET method for LDAPAccountProvider(Id) This method returns the details of a single server of the LDAP Directory Service. Description Returns the details of a single LDAP server. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#ExternalAccountProvider.LDAPAccountProvider/$entity", "@odata.
PAGE 60
"Password": "test@123", "ServerPort": 3268, "BaseDistinguishedName" : "dc=dell,dc=com", "NetworkTimeOut": 300, "SearchTimeOut": 300, "CertificateValidation": false, "CertificateFile": "" } Example response body { } "Id": 2964, "Name": "seaquest", "ServerType": "DNS", "ServerName": [ "10.35.195.
PAGE 61
/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.
PAGE 62
} ], "UserName": null, "Password": "", "ServerPort": 636, "BindDN": null, "BindPassword": "", "BaseDistinguishedName": "dc=dell,dc=com", "AttributeUserLogin": null, "AttributeGroupMembership": null, "SearchFilter": null, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": "" Example for Example response body ServerType: DNS { "Name": "LDAP", "ServerType": "DNS", "ServerName": [ "ausdcdell1.dell.com", "rdudc12dell01.dell.com", "pendc12dell01.dell.
PAGE 63
Table 34. Attributes (continued) Attribute name Description AttributeUserLogin User login details. AttributeGroupMembership Group member information. SearchFilter Search type. NetworkTimeOut Network timeout value. SearchTimeOut Search timeout value. CertificateValidation Enable or disable certificate validation for the directory service. CertificateFile Certificate file for authentication. /api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.
PAGE 64
/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.
PAGE 65
"Name": "OME-ModularDevelopmentTeam", "Password": "", "UserName": "OME-ModularDevelopmentTeam", "RoleId": "10", "Locked": false, "Enabled": true, "ObjectGuid": "21dd5985-602f-48a2-bde5-dde50eefb422" } ] Example Response Body [ { }, { ] } "Id": "4664", "UserTypeId": 2, "DirectoryServiceId": 0, "Name": "test456", "Password": null, "UserName": "test456", "Description": "admin", "Oem": null, "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true, "ObjectGuid": null "Id": "4764", "UserTypeI
PAGE 66
Table 37. 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 response body { } "@odata.context": "/api/$metadata#ApplicationService.
PAGE 67
/api/ApplicationService/Certificate This URI represents the certificates resource. GET method for Certificate This method returns the details of the certificates. Description Returns the details of the security certificates. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(ApplicationService.CertInfo)", "@odata.
PAGE 68
Table 38. 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.
PAGE 69
Table 39. 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.
PAGE 70
Example response body { } "DirectoryServerId": 10430, "Type": "AD", "SerialNumber": "401413413584593270254610161813845066096050178", "IssuerCN": "Dell Root Certificate Authority 2015", "SubjectCN": "Dell Issuing Certificate Authority 101", "ValidFrom": "Aug 14 2015 22:04:36", "ValidTo": "Aug 14 2022 22:14:36" Monitoring and alert notifications api/AlertService/AlertDestinations/SNMPConfiguration This URI represents the collection of SNMP configuration.
PAGE 71
{ } ] } "Id": 4, "Enabled": true, "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } Table 40. Attributes Attribute name Description Id ID of the SNMP configuration. Enabled Indicates if the SNMP send trap is enabled or disabled. DestinationAddress SNMP destination address. PortNumber SNMP port number. Version SNMP version. Community SNMP community.
PAGE 72
{ }, { ] } "Enabled": false, "DestinationAddress": "100.97.1.185", "PortNumber": "162", "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } "Enabled": true, "DestinationAddress": "100.97.1.185", "PortNumber": "162", "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } Response: Example response body [ { }, { }, { }, { ] 72 } "Id": 1, "Enabled": true, "DestinationAddress": "100.97.1.
PAGE 73
Table 41. Attributes Attribute name Description Id ID of the SNMP configuration. Enabled Indicates if the SNMP send trap is enabled or disabled. DestinationAddress SNMP destination address. PortNumber SNMP port number. Version SNMP version. Community SNMP community. /api/AlertService/AlertDestinations/SyslogConfiguration This URI represents a collection of syslog configuration. GET method for SyslogConfiguration This method returns a list of syslog configuration.
PAGE 74
Table 42. Attributes Attribute name Description Id ID of the syslog configuration. Enabled Indicates if syslog is enabled or disabled. DestinationAddress Destination address of syslog. PortNumber Port number of syslog. NOTE: By default, you can configure up to four destinations for syslog/SNMP and the responses are sent to each destination. If there is no information in the response, PortNumber is displayed as 0. api/AlertService/AlertDestinations/Actions/ AlertDestinations.
PAGE 75
}, { }, { ] } "Id": 3, "Enabled": true, "DestinationAddress": "10.19.12.1", "PortNumber": 514 "Id": 4, "Enabled": true, "DestinationAddress": "100.97.1.23", "PortNumber": 514 Table 43. Attributes Attribute name Description Id ID of the syslog. Enabled Indicates if syslog is enabled or disabled. DestinationAddress Destination address of syslog. PortNumber Port number of syslog. /api/AlertService/AlertDestinations/SMTPConfiguration This URI represents the SMTP configuration.
PAGE 76
Table 44. Attributes (continued) Attribute name Description UseCredentials Indicates if credentials are used. UseSSL Indicates if SSL is used. POST method for SMTPConfiguration This method configures SMTP to send emails. Description Configures SMTP. Privilege MONITORING_SETUP HTTP response codes 200 Example request body { } Example response body { } "DestinationAddress":"10.35.12.
PAGE 77
Privilege MONITORING_SETUP HTTP response codes 200 Example request body { } "Enabled":"true", "DestinationAddress":"10.35.12.7", "PortNumber":162, "Version":"SNMPV1", "SnmpV1V2Credential": { "Community":"public" } Table 46. Attributes Attribute name Description DestinationAddress Destination address of SNMP. PortNumber Trap port number of SNMP. Version Version of SNMP. Community Community of SNMP.
PAGE 78
5 Alerts Topics: • • • Alert logs Alert policies Alert definitions Alert logs /api/AlertService/Alerts This URI represents the alerts. Table 47. Filters Filter name Description Top Top records to return. Default value is 100. Skip Max records to skip. Default value is 0. Orderby Order to apply to the output. Id Filter by event ID. Default value is 0. AlertDeviceId Filter by device ID. Default value is 0. AlertDeviceIdentifier Filter by device identifier.
PAGE 79
Example response body { } "@odata.context": "$metadata#Collection(AlertService.Alert)", "@odata.count": 11, "value": [ { "@odata.id": "/api/AlertService/Alerts(2)", "Id": 2, "SeverityType": 16, "SeverityName": "Critical", "AlertDeviceId": 1714, "AlertDeviceName": "localhost.smd.devops.dell.com", "AlertDeviceType": 1000, "AlertDeviceIpAddress": "xx.xx.xx.
PAGE 80
Table 48. Attributes (continued) Attribute name Description StatusType ID of status type. StatusName Name of status type. TimeStamp Date and time when the alert was raised. Message Message describing the issue. EemiMessage Event and Error Message describing the issue, if applicable. RecommendedAction Recommended action for the alert. AlertMessageId Event and Alert Message ID associated with the issue. AlertVarBindDetails List of variable bindings of the alert, if applicable.
PAGE 81
{ "@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/Alerts(4592)", "Id": 4592, "SeverityType": 2, "SeverityName": "Info", "AlertDeviceId": 10056, "AlertDeviceName": "Sled-5", "AlertDeviceType": 1000, "AlertDeviceIpAddress": "100.97.211.
PAGE 82
{"@odata.type": "#AlertService.Alert", Alerts(4587)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4586)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4585)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4584)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4583)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4582)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4581)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4580)",…}, {"@odata.type": "#AlertService.
PAGE 83
{"@odata.type": "#AlertService.Alert", Alerts(4551)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4550)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4549)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4548)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4547)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4546)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4545)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4544)",…}, {"@odata.type": "#AlertService.
PAGE 84
{"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(4515)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(4514)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(4513)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(4512)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(4511)",…}, {"@odata.type": "#AlertService.Alert", "@odata.
PAGE 85
"value":[ { "@odata.type": "#AlertService.Alert", "@odata.
PAGE 86
Alerts(4299)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4298)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4297)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4296)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4293)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4292)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4291)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4290)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4289)",…}, {"@odata.type": "#AlertService.
PAGE 87
Alerts(4065)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4064)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4063)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4062)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4061)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4060)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4059)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4058)",…}, {"@odata.type": "#AlertService.Alert", Alerts(4057)",…}, {"@odata.type": "#AlertService.
PAGE 88
Alerts(3755)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(3754)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(3753)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(3752)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(3751)",…}, {"@odata.type": "#AlertService.Alert", "@odata.id": "/api/AlertService/ Alerts(3750)",…}, {"@odata.type": "#AlertService.
PAGE 89
"@odata.count": 0, "value":[ ] } /api/AlertService/Alerts(Id) This URI represents a specific alert. GET method for Alerts(Id) This method returns the details of a specific alert. Description Returns the details of a specific alert. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#AlertService.Alert/$entity", "@odata.
PAGE 90
Table 49. Attributes (continued) Attribute name Description AlertDeviceIpAddress IP address of device. AlertDeviceMacAddress MAC address of device. AlertDeviceIdentifier Identifier or Service Tag of device. AlertDeviceAssetTag Asset tag of device. DefinitionId ID of the definition associated to the alert. CatalogName Catalog name associated to alert. CategoryId Category ID associated to alert. CategoryName Category name associated to alert.
PAGE 91
{ "@odata.type": "#AlertService.AlertCategory", "Id": 4, "Name": "Audit", "CatalogName": "Application", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 90, "Name": "Devices", "Description": "Devices" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 10, "Name": "Generic", "Description": "Generic" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 151, "Name": "Power Configuration", "Description": "Power Configuration" }, { "@odata.type": "#AlertService.
PAGE 92
"#AlertService.AlertSubCategory", "Id": 10, "Name": "Generic", "Description": "Generic" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 84, "Name": "Groups", "Description": "Groups" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 47, "Name": "Job", "Description": "Job" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 118, "Name": "Metrics", "Description": "Metrics" }, { "@odata.type": "#AlertService.
PAGE 93
}, { ] } "Name": "Users", "Description": "Users" "@odata.type": "#AlertService.AlertCategory", "Id": 7, "Name": "Miscellaneous", "CatalogName": "Application", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 20, "Name": "Miscellaneous", "Description": "Miscellaneous" } ] }, { "@odata.type": "#AlertService.AlertCategory", "Id": 2, "Name": "Storage", "CatalogName": "Application", "SubCategoryDetails": [ { "@odata.type": "#AlertService.
PAGE 94
{ "@odata.type": "#AlertService.AlertCategory", "Id": 3, "Name": "Updates", "CatalogName": "Application", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 85, "Name": "Application", "Description": "Application" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 112, "Name": "Firmware", "Description": "Firmware" } ] } ] }, { "@odata.type": "#AlertService.AlertCategories", "@odata.
PAGE 95
"@odata.id": "/api/AlertService/AlertCategories('iDRAC')", "Name": "iDRAC", "IsBuiltIn": true, "CategoriesDetails": [ { "@odata.type": "#AlertService.AlertCategory", "Id": 4, "Name": "Audit", "CatalogName": "iDRAC", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 41, "Name": "Auto System Reset", "Description": "Auto System Reset" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 54, "Name": "BIOS Management", "Description": "BIOS Management" }, { "@odata.
PAGE 96
}, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 15, "Name": "Management Module", "Description": "Management Module" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 96, "Name": "OS Event", "Description": "OS Event" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 7700, "Name": "Other", "Description": "Other" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 81, "Name": "PCI Device", "Description": "PCI Device" }, { "@odata.type": "#AlertService.
PAGE 97
{ "@odata.type": "#AlertService.AlertSubCategory", "Id": 52, "Name": "Software Change", "Description": "Software Change" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 39, "Name": "Software Config", "Description": "Software Config" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 92, "Name": "Support Assist", "Description": "Support Assist" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 71, "Name": "System Info", "Description": "System Info" }, { "@odata.
PAGE 98
"@odata.type": "#AlertService.AlertSubCategory", "Id": 59, "Name": "Certificate Management", "Description": "Certificate Management" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 51, "Name": "Firmware Download", "Description": "Firmware Download" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 53, "Name": "Group Manager", "Description": "Group Manager" }, { "@odata.type": "#AlertService.
PAGE 99
}, { "Id": 19, "Name": "Log Event", "Description": "Log Event" "@odata.type": "#AlertService.AlertSubCategory", "Id": 15, "Name": "Management Module", "Description": "Management Module" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 80, "Name": "Memory", "Description": "Memory" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 102, "Name": "NIC Configuration", "Description": "NIC Configuration" }, { "@odata.type": "#AlertService.
PAGE 100
}, { "Name": "Security Event", "Description": "Security Event" "@odata.type": "#AlertService.AlertSubCategory", "Id": 39, "Name": "Software Config", "Description": "Software Config" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 18, "Name": "Storage", "Description": "Storage" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 113, "Name": "Storage Controller", "Description": "Storage Controller" }, { "@odata.type": "#AlertService.
PAGE 101
}, { ] } "@odata.type": "#AlertService.AlertCategory", "Id": 2, "Name": "Storage", "CatalogName": "iDRAC", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 108, "Name": "Battery Event", "Description": "Battery Event" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 106, "Name": "Fan Event", "Description": "Fan Event" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 11, "Name": "Hardware Config", "Description": "Hardware Config" }, { "@odata.
PAGE 102
{ "@odata.type": "#AlertService.AlertSubCategory", "Id": 52, "Name": "Software Change", "Description": "Software Change" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 119, "Name": "Software Defined Storage", "Description": "Software Defined Storage" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 99, "Name": "SSD Devices", "Description": "SSD Devices" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 18, "Name": "Storage", "Description": "Storage" }, { "@odata.
PAGE 103
"@odata.type": "#AlertService.AlertSubCategory", "Id": 41, "Name": "Auto System Reset", "Description": "Auto System Reset" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 108, "Name": "Battery Event", "Description": "Battery Event" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 75, "Name": "BIOS POST", "Description": "BIOS POST" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 89, "Name": "Cable", "Description": "Cable" }, { "@odata.type": "#AlertService.
PAGE 104
}, { "Id": 3, "Name": "Link Status", "Description": "Link Status" "@odata.type": "#AlertService.AlertSubCategory", "Id": 19, "Name": "Log Event", "Description": "Log Event" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 15, "Name": "Management Module", "Description": "Management Module" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 80, "Name": "Memory", "Description": "Memory" }, { "@odata.type": "#AlertService.
PAGE 105
}, { "Description": "Power Usage" "@odata.type": "#AlertService.AlertSubCategory", "Id": 61, "Name": "Processor", "Description": "Processor" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 68, "Name": "Processor Absent", "Description": "Processor Absent" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 103, "Name": "PSU Absent", "Description": "PSU Absent" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 109, "Name": "RAC Event", "Description": "RAC Event" }, { "@odata.
PAGE 106
}, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 29, "Name": "System Event Log", "Description": "System Event Log" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 71, "Name": "System Info", "Description": "System Info" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 13, "Name": "System Performance Event", "Description": "System Performance Event" }, { "@odata.type": "#AlertService.
PAGE 107
"@odata.type": "#AlertService.AlertSubCategory", "Id": 40, "Name": "Voltage", "Description": "Voltage" } ] }, { "@odata.type": "#AlertService.AlertCategory", "Id": 3, "Name": "Updates", "CatalogName": "iDRAC", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 51, "Name": "Firmware Download", "Description": "Firmware Download" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 24, "Name": "Firmware Update Job", "Description": "Firmware Update Job" }, { "@odata.
PAGE 108
"@odata.type": "#AlertService.AlertSubCategory", "Id": 54, "Name": "BIOS Management", "Description": "BIOS Management" } ] } ] }, { "@odata.type": "#AlertService.AlertCategories", "@odata.id": "/api/AlertService/AlertCategories('IF-MIB')", "Name": "IF-MIB", "IsBuiltIn": true, "CategoriesDetails": [ { "@odata.type": "#AlertService.AlertCategory", "Id": 1, "Name": "System Health", "CatalogName": "IF-MIB", "SubCategoryDetails": [ { "@odata.type": "#AlertService.
PAGE 109
}, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 23, "Name": "Power Usage", "Description": "Power Usage" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 29, "Name": "System Event Log", "Description": "System Event Log" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 71, "Name": "System Info", "Description": "System Info" } ] }, { "@odata.type": "#AlertService.AlertCategory", "Id": 5, "Name": "Configuration", "CatalogName": "MM", "SubCategoryDetails": [ { "@odata.
PAGE 110
}, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 89, "Name": "Cable", "Description": "Cable" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 106, "Name": "Fan Event", "Description": "Fan Event" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 11, "Name": "Hardware Config", "Description": "Hardware Config" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 105, "Name": "IO Virtualization", "Description": "IO Virtualization" }, { "@odata.type": "#AlertService.
PAGE 111
"@odata.type": "#AlertService.AlertSubCategory", "Id": 78, "Name": "Power Supply", "Description": "Power Supply" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 23, "Name": "Power Usage", "Description": "Power Usage" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 44, "Name": "Redundancy", "Description": "Redundancy" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 25, "Name": "Security Event", "Description": "Security Event" }, { "@odata.type": "#AlertService.
PAGE 112
}, { ] } ] } "Id": 40, "Name": "Voltage", "Description": "Voltage" "@odata.type": "#AlertService.AlertCategories", "@odata.id": "/api/AlertService/ AlertCategories('Networking')", "Name": "Networking", "IsBuiltIn": true, "CategoriesDetails": [ { "@odata.type": "#AlertService.AlertCategory", "Id": 1, "Name": "System Health", "CatalogName": "Networking", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 7700, "Name": "Other", "Description": "Other" } ] } ] }, { "@odata.
PAGE 113
}, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 25, "Name": "Security Event", "Description": "Security Event" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 71, "Name": "System Info", "Description": "System Info" } ] }, { "@odata.type": "#AlertService.AlertCategory", "Id": 1, "Name": "System Health", "CatalogName": "OMSA", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 67, "Name": "Amperage", "Description": "Amperage" }, { "@odata.
PAGE 114
{ "@odata.type": "#AlertService.AlertSubCategory", "Id": 78, "Name": "Power Supply", "Description": "Power Supply" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 23, "Name": "Power Usage", "Description": "Power Usage" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 61, "Name": "Processor", "Description": "Processor" }, { "@odata.type": "#AlertService.AlertSubCategory", "Id": 44, "Name": "Redundancy", "Description": "Redundancy" }, { "@odata.type": "#AlertService.
PAGE 115
}, { ] "@odata.type": "#AlertService.AlertCategories", "@odata.id": "/api/AlertService/AlertCategories('OpenManage %20Enterprise')", "Name": "OpenManage Enterprise", "IsBuiltIn": true, "CategoriesDetails": [ { "@odata.type": "#AlertService.AlertCategory", "Id": 1, "Name": "System Health", "CatalogName": "OpenManage Enterprise", "SubCategoryDetails": [ { "@odata.type": "#AlertService.
PAGE 116
}, { }, { ] } ] } "Id": 7700, "Name": "Other", "Description": "Other" "@odata.type": "#AlertService.AlertCategory", "Id": 6, "Name": "Work Notes", "CatalogName": "OpenManage Essentials", "SubCategoryDetails": [] "@odata.type": "#AlertService.AlertCategories", "@odata.id": "/api/AlertService/AlertCategories('Power %20Manager')", "Name": "Power Manager", "IsBuiltIn": true, "CategoriesDetails": [ { "@odata.type": "#AlertService.
PAGE 117
"Name": "System Health", "CatalogName": "SNMPv2-MIB", "SubCategoryDetails": [ { "@odata.type": "#AlertService.AlertSubCategory", "Id": 7700, "Name": "Other", "Description": "Other" } ] } ] }, { "@odata.type": "#AlertService.AlertCategories", "@odata.id": "/api/AlertService/AlertCategories('VMWare')", "Name": "VMWare", "IsBuiltIn": true, "CategoriesDetails": [ { "@odata.type": "#AlertService.AlertCategory", "Id": 1, "Name": "System Health", "CatalogName": "VMWare", "SubCategoryDetails": [ { "@odata.
PAGE 118
/api/AlertService/AlertCategories('Name') This URI represents the alert categories for a specific catalog within the collection. GET method for AlertCategories('Name') This method returns the alert categories for a specific catalog. Description Returns the details of a specific alert category. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#AlertService.AlertCategories/$entity", "@odata.
PAGE 119
/api/AlertService/AlertSeverities This URI represents the alert severities. GET method for AlertSeverities This method returns all the severities applicable to an alert. Description Returns all the severities applicable to an alert. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(AlertService.AlertSeverity)", "@odata.count": 5, "value": [ { "@odata.
PAGE 120
/api/AlertService/AlertSeverities(Id) This URI represents a specific alert severity. GET method for AlertSeverities(Id) This method returns the details of a specific alert severity. Description Returns the details of a specific alert severity. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#AlertService.AlertSeverity/$entity", "@odata.id": "/api/AlertService/AlertSeverities(1)", "Id": 1, "Name": "Unknown", "Description": "Unknown" Table 53.
PAGE 121
} ] } "Description": "The event was not acknowledged" Table 54. Attributes Attribute name Description Id ID of the alert status. Name Name of the alert status Description Description of the alert status. /api/AlertService/AlertStatuses(Id) This URI represents a specific alert status within the collection. GET method for AlertStatuses(Id) This method returns the details of alert statuses. Description Returns details of a specific alert status.
PAGE 122
GET method for AlertCatalogs This method returns the catalogs applicable to events. Description Returns the catalogs applicable to events. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(AlertService.AlertCatalog)", "@odata.count": 9, "value": [ { "@odata.id": "/api/AlertService/AlertCatalogs(1000)", "Id": 1000, "CatalogName": "iDRAC", "InternalName": "MIB-Dell-10892", "ReleaseVersion": "7.4.
PAGE 123
/api/AlertService/AlertCatalogs(Id) This URI represents a specific alert catalog. GET method for AlertCatalogs(Id) This method returns the details of a specific alert catalog. Description Returns the details of a specific alert catalog. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#AlertService.AlertCatalog/$entity", "@odata.
PAGE 124
} "MemberId": "bbdbfb20-ae33-11e6-a44b-1866da78fcba", "Message": "The system board battery is low.", "MessageArgs": ["arg1", “arg2”], "MessageId": "BAT0000", "Severity": "Warning" /api/AlertService/Actions/AlertService.Acknowledge POST method for AlertService.Acknowledge This method acknowledges the alerts. Description Acknowledges alerts.
PAGE 125
Table 59. Attributes (continued) Attribute Description EndDate End date and time when the alerts were raised. SourceName Source of the alert. Category Category ID associated to the alert. SubCategory Subcategory ID associated to the alert. Message Description of the issue. /api/AlertService/Actions/AlertService.Unacknowledge POST method for AlertService.Unacknowledge This method removes the acknowledgment from the alerts. Description Removes the acknowledgment from the alerts.
PAGE 126
Table 60. Attributes (continued) Attribute Description StatusType ID of status type. StartDate Start date and time when the alerts were raised. EndDate End date and time when the alerts were raised. SourceName Source of the alert. Category Category ID associated to the alert. SubCategory Subcategory ID associated to the alert. Message Description of the issue. /api/AlertService/Actions/AlertService.RemoveAlerts POST method for AlertService.RemoveAlerts This method removes the alerts.
PAGE 127
Table 61. Attributes (continued) Attribute Description DeviceType Device type ID. Severity ID of severity. StatusType ID of status type. StartDate Start date and time when the alerts were raised. EndDate End date and time when the alerts were raised. SourceName Source of the alert. Category Category ID associated to the alert. SubCategory Subcategory ID associated to the alert. Message Description of the issue.
PAGE 128
"Catalogs": [ { "CatalogName": "iDRAC", "Categories": [ 3300 ], "SubCategories": [ 0 ] } ], "Severities": [ 1, 2, 4, 8, 16 ], "Devices": [], "DeviceTypes": [], "Groups": [ 4 ], "Schedule": { "StartTime": null, "EndTime": null, "CronString": null }, "Actions": [ { "Id": 1, "Name": "OnDemandHealth", "ParameterDetails": [], "TemplateId": 80 } ] }, "State": true, "Visible": true, "PolicyActions": [ { "@odata.id": "/api/AlertService/AlertPolicies(314)/ PolicyActions" } ], "PolicyCriteria": [ { "@odata.
PAGE 129
Table 63. Attributes (continued) Attribute name Description 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. Severities List of severities associated to the policy.
PAGE 130
"Description": "Policy", "Enabled": true, "DefaultPolicy": false, "PolicyData": { "Catalogs": [ { "CatalogName": "iDRAC", "Categories": [0], "SubCategories": [0] }, { "CatalogName": "Application", "Categories": [0], "SubCategories": [0] } ], "Severities": [16, 1, 2, 4, 8], "Devices": [1714], "Groups": [], "DeviceTypes": [1000], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.
PAGE 131
}, { 0 ], "SubCategories": [ 0 ] "CatalogName": "Application", "Categories": [ 0 ], "SubCategories": [ 0 ] } ], "Severities": [ 16, 1, 2, 4, 8 ], "Devices": [ 1714 ], "DeviceTypes": [ 1000 ], "Groups": [], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.
PAGE 132
}, { ] "Name": "message", "Value": "Event occurred for Device Name: $name, Device IP Address: $ip, Service Tag: $identifier, Time: $time, Severity: $severity, $message", "Type": "string", "TypeParams": [ { "Name": "maxLength", "Value": "255" } ] } ], "TemplateId": 50 } ] }, "State": true } /api/AlertService/AlertPolicies(Id) This URI represents a specific policy within the collection. GET method for AlertPolicies(Id) This method returns the details of a specific policy.
PAGE 133
], "Devices": [], "DeviceTypes": [], "Groups": [ 4 ], "Schedule": { "StartTime": null, "EndTime": null, "CronString": null }, "Actions": [ { "Id": 1, "Name": "OnDemandHealth", "ParameterDetails": [], "TemplateId": 80 } ] } }, "State": true, "Visible": true, "PolicyActions": [ { "@odata.id": "/api/AlertService/AlertPolicies(314)/PolicyActions" } ], "PolicyCriteria": [ { "@odata.id": "/api/AlertService/AlertPolicies(314)/PolicyCriteria" } ] Table 64.
PAGE 134
Table 64. Attributes (continued) Attribute name Description Groups List of groups associated to the policy. This field is checked during policy evaluation. Schedule StartTime Start event-time to verify. This value indicates the start date and time for policy validity. If defined. This field is checked during policy evaluation. EndTime End event-time to verify. This value indicates the end date and time for policy validity. If defined. This field is checked during policy evaluation.
PAGE 135
], "Devices": [1914], "Groups": [], "DeviceTypes": [1000], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.000", "CronString": "* * * ? * * *" }, "Actions": [ { "TemplateId": 50, "Name": "Email", "ParameterDetails": [ { "Name": "subject", "Value": "Device Name: $name, Device IP Address: $ip, Severity: $severity" }, { "Name": "to", "Value": "test@dell.com" }, { "Name": "from", "Value": "MCSIApplication@Dell.
PAGE 136
], "Severities": [ 16, 1, 2, 4, 8 ], "Devices": [ 1914 ], "DeviceTypes": [ 1000 ], "Groups": [], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.000", "CronString": "* * * ? * * *" }, "Actions": [ { "Id": 3, "Name": "Email", "ParameterDetails": [ { "Name": "subject", "Value": "Device Name: $name, Device IP Address: $ip, Severity: $severity", "Type": "string", "TypeParams": [ { "Name": "maxLength", "Value": "255" } ] }, { "Name": "to", "Value": "test@dell.
PAGE 137
] } } } ], "TemplateId": 50 }, "State": true Table 65. Attributes Attribute name Description ID Event record ID. Name Name associated with the policy. Description Description associated with the policy. Enabled Indicates if the policy is enabled or disabled. DefaultPolicy Indicates if the policy is the default policy or pre-seeded. State State associated with the policy. Visible Indicate if the policy is visible or hidden.
PAGE 138
Table 65. Attributes (continued) Attribute name Description PolicyCriteria Link to the criteria for the evaluation of the alert contents with the policy contents. This evaluation determines if the policy is valid and if any actions are triggered. /api/AlertService/AlertPolicies(Arg1)/PolicyCriteria This URI represents the criteria used for matching the policy with incoming events. The criteria determine if the policy can trigger any actions. Table 66.
PAGE 139
Table 67. Attributes Attribute name Description Id ID of the criteria. PolicyId ID of policy with which the criteria is associated. Parameter Any extra parameter that can be used in the criteria. Value Expression that is used during policy evaluation with events. Type ID of the criteria type. TypeName Name of the criteria type. ComparisonType ID of comparison type. ComparisonTypeName Name of comparison type.
PAGE 140
Table 68. Attributes (continued) Attribute name Description ComparisonTypeName Name of comparison type. /api/AlertService/AlertPolicies(Arg1)/PolicyActions This URI represents the actions associated with a policy. Table 69. Filters Attribute name Description Top Top records to return. Default value is 100. Skip Maximum records to skip. Default value is 0. Arg1 Filter by list of policies IDs. Default value is 0. Id Filter by list of action IDs. Default value is 0.
PAGE 141
Table 70. Attributes (continued) Attribute name Description Parameters Extra parameter that can be added to the action. TemplateId ID of the action template associated with the action. Template Id ID of the template. Name Name of the template. Description Additional description of the template. Disabled Indicates if template is enabled or disabled. ParameterDetails List of other parameter that the template can carry and apply.
PAGE 142
Table 71. Attributes (continued) Attribute name Description Id ID of the template. Name Name of the template. Description Extra description of the template. Disabled Indicates if template is enabled or disabled. ParameterDetails List of other parameter that the template can carry and apply. /api/AlertService/AlertActionTemplates This URI represents the alert-action templates. GET method for AlertActionTemplates This method returns the alert-action templates.
PAGE 143
} ] } "@odata.id": "/api/AlertService/AlertActionTemplates(100)", "Id": 100, "Name": "Ignore", "Description": "Ignore", "Disabled": false, "ParameterDetails": [] Table 72. Attributes Attribute name Description Id ID of the action template. Name Name of the action template. Description Description of the action template. Disabled Indicates if the template is enabled or disabled. ParameterDetail Extra parameter that the template can carry and apply.
PAGE 144
/api/AlertService/Actions/AlertService.EnableAlertPolicies POST method for AlertService.EnableAlertPolicies This method enables the selected alert policies. Description Enables the selected alert policies. Privilege MONITORING_SETUP HTTP response codes 201 Example request body { } "AlertPolicyIds": [100,200,300] Or { } "AllPolicies": true /api/AlertService/Actions/AlertService.DisableAlertPolicies POST method for AlertService.DisableAlertPolicies This method disables the selected alert policies.
PAGE 145
Privilege MONITORING_SETUP HTTP response codes 201 Example request body { } "AlertPolicyIds": [100,200,300] Or { } "AllPolicies": true Alert definitions /api/AlertService/AlertMessageDefinitions This URI represents the definitions for the alert messages. Table 74. Filters Filter name Description Top Top records to return. Default value is 100. Skip Maximum records to skip. Default value is 0. MessageId Filter by message ID. Category Filter by event ID. SubCategory Filter by subcategory.
PAGE 146
}, { "Prefix": "RAC", "SequenceNo": 9000, "Message": "Device has become non compliant.", "RecommendedAction": "No response action is required.", "Severity": "Critical", "Category": "Configuration", "SubCategory": null, "DetailedDescription": "A device has become non compliant." "@odata.id": "/api/AlertService/ AlertMessageDefinitions('LOG9000')", "MessageId": "LOG9000", "Prefix": "LOG", "SequenceNo": 9000, "Message": "Event definition not found for Event.
PAGE 147
"MessageId": "RAC0600", "Prefix": "RAC", "SequenceNo": 600, "Message": "Unable to retrieve the temperature information.", "RecommendedAction": "Power on the server. If the server is already powered on, wait for a few minutes and refresh the page. If the problem persists, contact service provider.", "Severity": "Warning", "Category": "Configuration", "SubCategory": null, "DetailedDescription": "" } Table 76. Attributes Attribute Description MessageId ID of message definition.
PAGE 148
"@odata.id": "/api/AlertService/AlertMessageDefinitionsCategories('System %20Health')",…}, {"@odata.type": "#AlertService.AlertMessageDefinitionCategory", "@odata.id": "/api/AlertService/ AlertMessageDefinitionsCategories('Updates')",…}, {"@odata.type": "#AlertService.AlertMessageDefinitionCategory", "@odata.id": "/api/AlertService/AlertMessageDefinitionsCategories('Work %20Notes')",…} ] } /api/AlertService/AlertMessageDefinitionsCategories('Name') This URI represents a specific alert definition category.
PAGE 149
"@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Hardware Config" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "iDRAC Service Module" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Interface" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "IP Address" }, { "@odata.type": "#AlertService.
PAGE 150
}, { "SubCategory": "Power Usage" "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Power Usage POW" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "RAC Event" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Redundancy" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Server" }, { "@odata.type": "#AlertService.
PAGE 151
6 Configure Topics: • • • • Firmware Template Service Identity pools Network Configuration Service Firmware /api/UpdateService/Catalogs This URI represents the catalogs in the appliance. GET method for Catalogs This method returns the catalogs that are created in the appliance. Description Returns the list of catalogs. Privilege VIEW HTTP response codes 200 Example request body { "@odata.context": "/api/$metadata#Collection(UpdateService.Catalogs)", "@odata.count": 1, "value": [ { "@odata.
PAGE 152
}, { }, { }, { }, { } Example request body ] } "BaselineName": "Single" "BaselineId": 11, "BaselineName": "500" "BaselineId": 6, "BaselineName": "Test" "BaselineId": 7, "BaselineName": "Test 100" "BaselineId": 8, "BaselineName": "Test 2500+" } ], "Repository": { "@odata.type": "#UpdateService.Repository", "Id": 12, "Name": "Dell", "Description": "", "Source": "downloads.dell.
PAGE 153
Table 77. Attributes (continued) Attribute Description Status Status of creating the catalog. TaskId The identifier of the task or job that is created to download the catalog. BaseLocation The repository location for the catalog (for example for online catalogs, the location is downloads.dell.com) ManifestIdentifier Catalog manifest identifier *. ReleaseIdentifier Catalog release identifier *. ManifestVersion Catalog manifest version *. ReleaseDate Catalog release date *.
PAGE 154
} } "Description":"HTTPS Desc", "RepositoryType":"HTTPS", "Source":"10.255.2.128:2607", "DomainName":"", "Username":"", "Password":"", "CheckCertificate":false /api/UpdateService/Catalogs(Id) This URI represents a specific catalog. GET method for Catalogs(Id) This method returns the details of a specific catalog. Description Returns the details of a specific catalog. Privilege VIEW HTTP response codes 200 Example response body { } 154 Configure "@odata.context": "/api/$metadata#UpdateService.
PAGE 155
PUT method for Catalogs(Id) This method updates the catalog details. Description Updates details of a specific catalog. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#UpdateService.Catalogs/$entity", "@odata.type": "#UpdateService.Catalogs", "@odata.id": "/api/UpdateService/Catalogs(28)", "Id": 28, "Filename": "CatalogA00.
PAGE 156
HTTP response codes Example response body 156 Configure 200 { "@odata.context": "/api/$metadata#Collection(UpdateService.Baselines)", "@odata.count": 2, "value": [ { "@odata.type": "#UpdateService.Baselines", "@odata.id": "/api/UpdateService/Baselines(6)", "Id": 6, "Name": "b1-f", "Description": "", "CatalogId": 22, "RepositoryId": 12, "TaskId": 10203, "TaskStatusId": 2060, "RepositoryName": "ftp", "RepositoryType": "DELL_ONLINE", "LastRun": "2020-07-07 19:31:21.
PAGE 157
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, } "Id": 10084, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 10085, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 10086, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 10087, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 10088, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 10089, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 10090, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 10091, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 10092, "
PAGE 158
{ }, { }, { }, { }, { }, { }, { }, { "Id": 10094, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 10095, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 10097, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 10098, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 10099, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 10100, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 10101, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 10102, "Type": { "Id": 1000, "Name": "DEVICE" } } ], "ComplianceSummary": { "Compl
PAGE 159
"Id": 7, "Name": "b4", "Description": "", "CatalogId": 22, "RepositoryId": 12, "TaskId": 10205, "TaskStatusId": 2060, "RepositoryName": "ftp", "RepositoryType": "DELL_ONLINE", "LastRun": "2020-07-07 19:33:37.
PAGE 160
Table 78. Attributes (continued) Attribute Description NumberOfCritical Number of critical devices. NumberOfWarning Number of warning devices. NumberOfNormal Number of normal devices. NumberOfDowngrade Number of downgrade devices. Link to Device compliance Report Gives the link to the device compliance report. POST method for Baselines This method creates a baseline. Description Creates a baseline.
PAGE 161
{ }, { }, { }, { }, { }, { }, { }, { }, { } ] } ] } "Id": 25017, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25019, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25021, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25022, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25023, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25032, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25033, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25035, "Type": { "Id": 1000, "Name": "DEVICE" } "Id": 25038, "
PAGE 162
Table 79. Attributes Attribute Description Name Name of the Baseline Description Description of the Baseline CatalogId ID of the catalog - The user needs to enumerate all catalogs and match the "Name" of the repository with the input provided at creation time RepositoryId ID of the repository - Derived from the catalog response DowngradeEnabled If the firmware can be downgraded Is64Bit This should always be set to true - The DUP files used are 64 bit DUPs only.
PAGE 163
{ "Id": 10104, "Type": { "Id": 6000, "Name": "GROUP" } } ], "ComplianceSummary": { "ComplianceStatus": "DOWNGRADE", "NumberOfCritical": 0, "NumberOfWarning": 0, "NumberOfNormal": 0, "NumberOfDowngrade": 1, "NumberOfUnknown": 0 }, "DeviceComplianceReports@odata.navigationLink": "/api/UpdateService/ Baselines(6)/DeviceComplianceReports" } Table 80. Attributes Attribute Description Id Identifier for the device in the appliance. TaskId Identifier of the job.
PAGE 164
[ { "Id": 1010, "Type": { "Id": 6000, "Name": "GROUP" } } ], "ComplianceSummary": { "ComplianceStatus": "CRITICAL", "NumberOfCritical": 7761, "NumberOfWarning": 1, "NumberOfNormal": 12, "NumberOfDowngrade": 1 }, "DeviceComplianceReports@odata.navigationLink": "/api/ UpdateService/Baselines(8)/DeviceComplianceReports" } ] } /api/UpdateService/Actions/ UpdateService.GetBaselinesForDevices This API represents the firmware compliance baselines for specific devices.
PAGE 165
Example response body { "@odata.context": "/api/ $metadata#Collection(UpdateService.SummaryCount)", "@odata.count": 1, "value":[ { "@odata.type": "#UpdateService.SummaryCount", "Id": 4, "Count": 1 } ] } /api/UpdateService/Actions/ UpdateService.CheckBaselinesAssociation This API represents baseline association information. Post method for checking baseline association This method returns information about baseline associations. Description Returns information about baseline associations.
PAGE 166
{ }, { }, { }, { } ] } "@odata.type": "#UpdateService.ComplianceStatus", "@odata.id": "/api/UpdateService/ComplianceStatuses(2)", "StatusId": 2, "StatusName": "DOWNGRADE" "@odata.type": "#UpdateService.ComplianceStatus", "@odata.id": "/api/UpdateService/ComplianceStatuses(3)", "StatusId": 3, "StatusName": "WARNING" "@odata.type": "#UpdateService.ComplianceStatus", "@odata.id": "/api/UpdateService/ComplianceStatuses(4)", "StatusId": 4, "StatusName": "CRITICAL" "@odata.type": "#UpdateService.
PAGE 167
"DeviceUserFirmwareUpdateCapable": true, "ComponentComplianceReports": [ { "@odata.type": "#UpdateService.ComponentComplianceReport", "Id": 12, "Version": "Not updatable through catalog", "CurrentVersion": "10.5.0.7.745", "Path": "", "Name": "IOM Firmware", "Criticality": "Unknown", "UniqueIdentifier": "", "TargetIdentifier": "", "UpdateAction": "UNKNOWN", "SourceName": "IOM.Slot.
PAGE 168
Table 81. Attributes Attribute Description DeviceId Identifier for the device in the appliance. ServiceTag Service Tag of the device. DeviceModel Model of the device. DeviceTypename Type of device, such as server or chassis. DeviceName Name of the device. FirmwareStatus Shows if firmware compliance status. The possible options are: ● ● ● ● ● ComplianceStatus Critical Warning Download Ok Unknown Shows the compliance status.
PAGE 169
} "ComplianceStatus": "UNKNOWN", "DeviceTypeId": 4000, "RebootRequired": false, "DeviceFirmwareUpdateCapable": true, "DeviceUserFirmwareUpdateCapable": true, "ComponentComplianceReports": [ { "@odata.type": "#UpdateService.ComponentComplianceReport", "Id": 12, "Version": "Not updatable through catalog", "CurrentVersion": "10.5.0.7.745", "Path": "", "Name": "IOM Firmware", "Criticality": "Unknown", "UniqueIdentifier": "", "TargetIdentifier": "", "UpdateAction": "UNKNOWN", "SourceName": "IOM.Slot.
PAGE 170
/api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)/ ComponentComplianceReports This URI represents the compliance information for device components. GET method for component compliance reports This method returns the compliance report for a specific device component. Description Returns the compliance report for a device component Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(UpdateService.ComponentComplianceReport)", "@odata.
PAGE 171
/api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)/ ComponentComplianceReports(Id) This URI represents the compliance information for a specific device component. GET method for component compliance reports by Id This method returns component compliance reports by IDs. Description Returns the component compliance reports by Id. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#UpdateService.ComponentComplianceReport", "@odata.
PAGE 172
HTTP response codes Example request body 200 Header: Content-Type: application/octet-stream Request: Example response body A numeric token ID is returned. /api/UpdateService/Actions/UpdateService.RemoveFile POST method for RemoveFile This method removes a file from the system. Description Removes a file identified by the numeric token ID. Privilege DEVICE_UPDATE HTTP response codes 200 Example request body { } "FileToken": "1481131455800" /api/UpdateService/Actions/UpdateService.
PAGE 173
/api/UpdateService/Actions/UpdateService.RemoveCatalogs POST method for RemoveCatalogs This method deletes catalogs. Description Deletes a catalog. Privilege BASELINE_MANAGEMENT HTTP response codes 204 Example request body { } "CatalogIds":["12"] /api/UpdateService/Actions/UpdateService.RemoveBaselines POST method for RemoveBaselines This method deletes baselines. Description Deletes baselines.
PAGE 174
} "@odata.count": 1, "value": [ { "@odata.type": "#UpdateService.RollbackSoftwares", "@odata.id": "/api/UpdateService/RollbackSoftwares(1)", "Id": 1, "InstanceId": "DCIM:PREVIOUS#741__BIOS.Setup.1-1", "DeviceId": 10143, "RollbackVersion": "1.0.2", "CurrentVersion": "1.6.
PAGE 175
/api/UpdateService/Actions/UpdateService.GetSingleDupReport POST method for GetSingleDupReport This method returns the report of a Dell Update Package (DUP). Description Returns the report of a DUP.
PAGE 176
}, { } "DeviceId": 1682, "DeviceReport": { "ComponentUpdateAction": "UPGRADE", "DeviceTypeId": "1000", "ComponentCurrentVersion": "1.57.57", "ComponentUriInformation": null, "DeviceTypeName": "SERVER", "ComponentVersion": "2.30.30.30", "ComponentCriticality": "Recommended", "DeviceId": "1682", "DeviceServiceTag": "7T2W1V1", "IsCompliant": "CRITICAL", "ComponentTargetIdentifier": "25227", "ComponentSourceName": "DCIM:INSTALLED#iDRAC.Embedded.
PAGE 177
"NumberOfCritical": 0, "NumberOfWarning": 0, "NumberOfNormal": 1, "NumberOfDowngrade": 0, "NumberOfUnknown": 0 }, "Targets": [ { "Id": 10067, "Type": { "Id": 1000, "Name": "DEVICE" } } ], "DeviceComplianceReports": [ { "Id": 3, "DeviceId": 10067, "ServiceTag": "CJ2J5Z2", "DeviceModel": "MX9116n Fabric Engine", "DeviceTypeId": 4000, "DeviceTypeName": "NETWORK_IOM", "DeviceName": "IOM-A1", "FirmwareStatus": "Compliant", "ComplianceStatus": "OK", "RebootRequired": true, "ComponentComplianceReports": [ { "Id":
PAGE 178
}, { ] 178 Configure } "Id": 8, "Name": "test4", "Description": "", "LastRun": "2020-07-27 10:27:36.
PAGE 179
/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 request body { } Example response body "UriPath": "https://[ IP Address ]" { "Version": "3", "Subject": "ST=Texas, C=USA, O=Dell Inc., L=Round Rock, CN=OMEDEVDAHIR", "SignatureAlgorithm": "SHA1withRSA", "SignatureAlgorithmOid": "1.2.840.113549.1.1.
PAGE 180
}, { }, { }, { } ] } "Name": "None", "ConfigurationSections": [] "@odata.id": "/api/TemplateService/TemplateTypes(2)", "Id": 2, "Name": "Server", "ConfigurationSections": [] "@odata.id": "/api/TemplateService/TemplateTypes(4)", "Id": 4, "Name": "Chassis", "ConfigurationSections": [] "@odata.id": "/api/TemplateService/TemplateTypes(3)", "Id": 3, "Name": "IO Module", "ConfigurationSections": [] NOTE: OME-Modular supports only the Server template type. Table 85.
PAGE 181
{ } ] } "@odata.id": "/api/TemplateService/TemplateViewTypes(4)", "Id": 4, "Description": "Sample" Table 86. Attributes Attribute Description Id Unique identifier for the template view type. Name Identifies the features that support template operations. /api/TemplateService/Templates This URI represents the templates. GET method for Templates This method returns the details of all available templates. Table 87. Filters Filter name Description Top Top records to return. Default value is 100.
PAGE 182
}, { "LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(1)/Views" } ] "@odata.
PAGE 183
}, { }, { }, { "LastUpdatedBy": null, "LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(4)/Views" } ] "@odata.
PAGE 184
}, { "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.
PAGE 185
Table 88. 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.
PAGE 186
Table 89. 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 response body { } "@odata.
PAGE 187
Table 90. Attributes (continued) Attribute Description 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.
PAGE 188
} Example response body ] } ID of the template Table 91. 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.
PAGE 189
stack-unit 0 secondary system: B:\nboot 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 TenGigabit
PAGE 190
\n!\n!\nclock timezone TZ-68 5 30 \n!\nfeature fip-snooping\nline console 0\nline vty 0\nline vty 1\nline vty 2\nline vty 3\nline vty 4\nline vty 5\nline vty 6\nline vty 7\nline vty 8\nline vty 9\n! \nuplink-state-group 1\n! \nreload-type\n boot-type normal-reload\n config-scr-download enable\n", "SourceDeviceId": 10111, "TypeId": 3, "ViewTypeId": 2, "TaskId": 10313, "HasIdentityAttributes": false, "Status": 2060, "IdentityPoolId": 0, "IsPersistencePolicyValid": true, "IsStatelessAvailable": false, "IsBuilt
PAGE 191
/api/TemplateService/Templates(Id)/Views This URI represents the views of a specific template. GET method for Views of a template This method returns the views available for a specific template. Each view displays template data in a specific structure. Description Returns the views available for a specific template. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(TemplateService.AttributeView) HYPERLINK "mailto:\",\"@odata.
PAGE 192
/api/TemplateService/Templates(Id)/Views(Id) This URI represents a specific view of a template. GET method for Views(Id) This method returns the details of a specific view of a template. Description Returns a specific view of a template. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#TemplateService.AttributeView/ $entity", "@odata.
PAGE 193
GET method for AttributeViewDetails This method returns the details for all attributes applicable to a specific template view.. NOTE: This API does not return the information needed for editing attributes. To get that information, use API / TemplateService/Templates(Id)/Views(Id)/AttributeViewDetails/TemplateEditInfoDetails. Description Returns all attribute details of a template view. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#TemplateService.
PAGE 194
}, { }, { }, { } { Restart", }, { Requested", }, { }, { 194 Configure "CustomId": 0, "AttributeEditInfoId": 1644, "DisplayName": "LCAttributes 1 Part Firmware Update", "Description": null, "Value": "Match firmware of replaced part", "IsReadOnly": false, "IsIgnored": false "AttributeId": 3558, "CustomId": 0, "AttributeEditInfoId": 1643, "DisplayName": "LCAttributes 1 Part Configuration Update", "Description": null, "Value": "Apply always", "IsReadOnly": false, "IsIgnored": false "AttributeId": 356
PAGE 195
] } "CustomId": 0, "AttributeEditInfoId": 1861, "DisplayName": "LCAttributes 1 Automatic Backup Feature", "Description": null, "Value": "Disabled", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] } ], "TemplateEditInfoDetails": { "@odata.id": "/api/TemplateService/Templates(11)/Views(1)/ AttributeViewDetails/TemplateEditInfoDetails" } } Table 94. Attributes Attribute Description AttributeId Unique identifier for an attribute.
PAGE 196
{ }, { }, { "Id": 2, "OptionId": [ 579, 580, 581 ] "Id": 3, "OptionId": [ 562, 563 ] "Id": 3636, "DataType": 4308, "Description": "Specify the iSCSI Qualified Name (IQN) of the eighth iSCSI storage target.
PAGE 197
}, { } ] } "ValueMax": 0, "DependencyText": null, "OptionSetId": 0, "DefaultOptionId": 0 "Id": 2694, "DataType": 18, "Description": null, "IsReadOnly": true, "IsSecure": false, "TextMinLength": 0, "TextMaxLength": 32, "ValueMin": 0, "ValueMax": 0, "DependencyText": null, "OptionSetId": 0, "DefaultOptionId": 0 /api/TemplateService/Templates(Id)/Views(Id)/ DeviceAttributeViewDetails(Id) This URI represents the device-specific attributes for a view of a template.
PAGE 198
[ }, { 198 Configure { "GroupNameId": 1, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3297, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", "Description": null, "Value": "20", "IsReadOnly": false, "IsIgnored": false }, { "AttributeId": 3298, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false },
PAGE 199
{ } }, { }, { } "AttributeId": 3351, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false ], "Attributes": [] "GroupNameId": 1, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 3, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3369, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", "D
PAGE 200
} } }, { Bandwidth", "AttributeId": 3389, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false ], "Attributes": [] "GroupNameId": 2, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 1, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3431, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX }, { Band
PAGE 201
"GroupNameId": 2, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 2, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3484, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", }, { Bandwidth", ] }, { Bandwidth", } "Description": null, "Value": "30", "IsReadOnly": false, "IsIgnored": false "AttributeId": 3485, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX "Descriptio
PAGE 202
}, { Bandwidth", ], "Attributes": [] "GroupNameId": 2, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 4, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3522, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX }, { Bandwidth", ] } "Description": null, "Value": "30", "IsReadOnly": false, "IsIgnored": false "AttributeId": 3523, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX "Des
PAGE 203
HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#TemplateService.DeviceAttributeView/$entity", "@odata.type": "#TemplateService.DeviceAttributeView", "@odata.id": "/api/TemplateService/Templates(26)/Views(9)/ DeviceAttributeViewDetails(10176)", "Id": 9, "Name": "SystemIoaDeploySpecific", "Description": "Hierarchy of attributes, with component classes and groups, containing boot settings for IOA.Virtual components.
PAGE 204
/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.
PAGE 205
}, { }, { } ] } ] } ] } ] } ] } "AttributeEditInfoId": 0, "DisplayName": "MAC Address", "Description": "MAC Address", "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"
PAGE 206
/api/TemplateService/Actions/ TemplateService.FreeReservedIdentities This API represents the identities that are reserved for deployment. POST method for /api/TemplateService/Actions/ TemplateService.FreeReservedIdentities This method returns the reserved identities information. Description Returns information about reserved identities. Privilege TEMPLATE_MANAGEMENT HTTP response codes 200 Example response body { "TemplateId" : , "BaseEntityIds" : [ , , ...
PAGE 207
HTTP response codes Example request body 200 { } Example response body "TemplateId": 11 { "TemplateId": 11, "Content": "\n\n\nConsole \n\n
PAGE 208
HTTP response codes Example request body 208 Configure 200 { "Name": "Import Test - IOA", "Type": 3, "Content": "\n!Cloning Header Start\n!ReleasePlatform XL\n! ReleaseVersion 9-14(0-30)\n!ReleaseSize 48140985\n!ReleaseTime Jun 19 2018 01:29:05\n!OPTM0 10GBASE-T\n!OPTM1 -\n!Service-Tag FJM0Y42\n! Serial-Number CN2829865N0013\n!FCPortsPresent FALSE\n!QuadPortsPresent 33 37 49 53\n!IOM-Mode standalone\n!CheckSum 4fd3e503fd1df86f419aecd3cd23bd21\n!Cloning Header End\n\n\n! Version 9-14(0-30)\n!\nboot syste
PAGE 209
\n! \ninterface TenGigabitEthernet 0/44\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/49\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/50\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/51\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/52\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/53\n! \n protocol lldp \n no shutdown\n! \ninterface TenGigabitEthernet 0/54\n! \n protocol lldp \n no sh
PAGE 210
} } "BootToNetwork" : , "ShareType" : "", "IsoPath” : "", "ShareDetail" : { "IpAddress" : "", "ShareName" : "", "WorkGroup" : "", "User" : "", "Password" : "" } The following is a sample payload for a Deploy Template request: { "Id":29, "TargetIds":[8564,5364], "NetworkBootIsoModel":{ "BootToNetwork":false, "ShareType":"CIFS", "ShareDetail":{ } } }, "Attributes":[ { "DeviceId":0, "Attribute
PAGE 211
} } POST method for TemplateService.Deploy of IOA deployment This method creates an IOA template-deployment job. Description Creates a IOA template-deployment job.
PAGE 212
HTTP response codes Example request body 200 { } "TemplateId": 10, "IdentityPoolId": 0, "BondingTechnology": "NoTeaming", "PropagateVlan": true, "StrictCheck": false, "Attributes": [ { "Attributes": [] } ], "VlanAttributes": [ { "ComponentId": 56, "Untagged": 10218, "Tagged": [ 10219 ], "IsNicBonded": false }, { "ComponentId": 57, "Tagged": [], "IsNicBonded": false }, { "ComponentId": 58, "Untagged": 10220, "Tagged": [ 10221 ], "IsNicBonded": false }, { "ComponentId": 55, "Tagged": [], "IsNicBonded": fa
PAGE 213
/api/TemplateService/Actions/TemplateService.RemoveBaseline POST method for TemplateService.RemoveBaseline Description This method removes the compliance baseline. Privilege TEMPLATE_MANAGEMENT HTTP response codes 200 Example request body { "BaselineIds": [1,2,5..] } /api/TemplateService/Actions/TemplateService.Remediate POST method for TemplateService.Remediate Description This method ensures that the device is compliant to a baseline.
PAGE 214
[ { "@odata.type": "#IdentityPoolService.IdentityPool", "@odata.id": "/api/IdentityPoolService/IdentityPools(1)", "Id": 1, "Name": "Pool 1", "Description": "This is Pool 1", "CreatedBy": "admin", "CreationTime": "2018-09-06 16:41:47.612624", "LastUpdatedBy": "admin", "LastUpdateTime": "2018-09-06 16:41:47.
PAGE 215
"Name": "Sample Identity Pool", "Description": "This is a sample Identity Pool", "CreatedBy": "admin", "CreationTime": "2018-09-11 17:12:46.166658", "LastUpdatedBy": "admin", "LastUpdateTime": "2018-09-11 17:12:46.166658", "EthernetSettings": { "Mac": { "IdentityCount": 55, "StartingMacAddress": "UFBQUFAA" } }, "IscsiSettings": { "Mac": { "IdentityCount": 65, "StartingMacAddress": "YGBgYGAA" }, "InitiatorConfig": { "IqnPrefix": "iqn.myprefix." }, "InitiatorIpPoolSettings": { "IpRange": "10.33.0.1-10.33.0.
PAGE 216
POST method for IdentityPools This method creates an identity pool. Description Creates an identity pool. Privilege TEMPLATE_MANAGEMENT HTTP response codes 200 Example request body { } 216 Configure "Name":"New Identity Pool 4", "EthernetSettings": { "Mac": { "IdentityCount":55, "StartingMacAddress": "UFBQUFAA" } }, "IscsiSettings": { "Mac": { "IdentityCount":65, "StartingMacAddress": "YGBgYGAA" }, "InitiatorConfig": { "IqnPrefix":"Iqn.
PAGE 217
/api/IdentityPoolService/IdentityPools(Id) This URI represents a specific identity pool. GET method for IdentityPools(Id) This method returns the details of a specific identity pool. Description Returns a specific identity pool. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#IdentityPoolService.IdentityPool/ $entity", "@odata.type": "#IdentityPoolService.IdentityPool", "@odata.
PAGE 218
}, "UsageCounts": { "@odata.id": "/api/IdentityPoolService/IdentityPools(4)/UsageCounts" }, "UsageIdentitySets@odata.navigationLink": "/api/IdentityPoolService/ IdentityPools(4)/UsageIdentitySets" } PUT method for IdentityPools(Id) This method updates a specific identity pool. Description Updates an identity pool.
PAGE 219
Table 96. Attributes Attribute name Description ID Iopool Id Name Name of the Iopool Description Definition for the Iopool EthernetSettings- MAC IdentityCount Number of Identities Starting MAC address Initial MAC Address FcSettings WWPN worldwide port names IdentityCount IdentityCount Starting WWPN address Initial WWPN Address WWNN worldwide Node names Starting WWNN address Initial WWNN Address DELETE method for IdentityPools(Id) This method deletes an identity pool.
PAGE 220
{ }, { }, { }, { }, { } ] } "IdentityTypeId": 10, "TotalRequested": 65, "TotalReserved": 0, "TotalDeployed": 0 "IdentityTypeId": 8, "TotalRequested": 55, "TotalReserved": 42, "TotalDeployed": 0 "IdentityTypeId": 3, "TotalRequested": 85, "TotalReserved": 3, "TotalDeployed": 0 "IdentityTypeId": 4, "TotalRequested": 85, "TotalReserved": 3, "TotalDeployed": 0 "IdentityTypeId": 7, "TotalRequested": 0, "TotalReserved": 14, "TotalDeployed": 0 /api/IdentityPoolService/IdentityPools(Id)/UsageIdentitySets Th
PAGE 221
"@odata.id": "/api/IdentityPoolService/IdentityPools(4)/ UsageIdentitySets(2)", "IdentitySetId": 2, "Name": "iSCSI", "Details@odata.navigationLink": "/api/IdentityPoolService/ IdentityPools(4)/UsageIdentitySets(2)/Details" }, { "@odata.type": "#IdentityPoolService.UsageIdentitySet", "@odata.id": "/api/IdentityPoolService/IdentityPools(4)/ UsageIdentitySets(3)", "IdentitySetId": 3, "Name": "FCoE", "Details@odata.
PAGE 222
/api/IdentityPoolService/IdentityPools(Id)/ UsageIdentitySets(Id)/Details This URI represents usage details for a specific identity pool and identity set (protocol). GET method for Details of UsageIdentitySets(Id) This method returns the usage details for a specific identity pool and identity set or protocol. NOTE: ● To get the identifier for each available Identity Pool, use the API /IdentityPoolService/IdentityPools.
PAGE 223
} ] /api/IdentityPoolService/IdentityStates This URI represents the identity states for the identities in an identity pool. GET method for IdentityStates This method returns the identity states, such as Reserved and Assigned, for the identities in an identity pool. Description Returns identity states. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(IdentityPoolService.IdentityState)", "@odata.count": 2, "value": [ { "@odata.
PAGE 224
} "@odata.type": "#IdentityPoolService.IdentityState", "@odata.id": "/api/IdentityPoolService/IdentityStates(1)", "Id": 1, "Name": "Reserved", "Description": "Assigned to a profile; deployment pending." /api/IdentityPoolService/Actions/ IdentityPoolService.DeleteIdentityPools POST method for deleting identity pools This method deletes identity pools. Description Deletes identity pools.
PAGE 225
"@odata.id": "/api/NetworkConfigurationService/ Networks(10133)", "Id": 10133, "Name": "asd", "Description": "", "VlanMaximum": 2, "VlanMinimum": 2, "Type": 3, "CreatedBy": "system", "CreationTime": "1970-01-31 00:12:56.376", "UpdatedBy": null, "UpdatedTime": "1970-01-31 00:12:56.376", "InternalRefNWUUId": "00bc07d7-5d3c-429e-96a3-5c6600230851" }, { "@odata.type": "#NetworkConfigurationService.Network", "@odata.
PAGE 226
Table 97. Attributes (continued) Attribute name Description Type Network profile definition type. For more information, see /api/NetworkConfigurationService/ NetworkTypes. CreatedBy The user who created the network. CreationTime Date and time when the network was created. UpdatedBy The user who last updated the network. UpdatedTime Date and time when the network was last updated. Orderby Order to apply to the output InternalRefId Reference ID used for internal purposes.
PAGE 227
/api/NetworkConfigurationService/Networks(Id) This URI represents a specific network within the collection. GET method for Networks(Id) This method returns the details of a specific network from the collection. Description Returns the details of a specific network. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#NetworkConfigurationService.Network/ $entity", "@odata.
PAGE 228
} "UpdatedBy": "root", "UpdatedTime": "1970-01-01 02:02:15.797", "InternalRefNWUUId": 0 Table 98. Attributes Attribute name Description ID The identifier of the target network profile. Name Name of the network. Description Description of the network. VlanMaximum VLan can be defined as either a range or a single value. If a single value is defined, the same value is assigned to both VlanMaximum and VlanMinimum. VlanMinimum VLan can be defined as either a range or a single value.
PAGE 229
"Id": 1, "Name": "General Purpose (Bronze)", "Description": "This is the network for general purpose traffic. QOS Priority : Bronze.", "VendorCode": "GeneralPurpose", "NetworkTrafficType": "Ethernet", "QosType": 4 }, . . { "@odata.id": "/api/NetworkConfigurationService/NetworkTypes(11)", "Id": 11, "Name": "VMWare FT Logging", "Description": "This is the network for VMware-specific Fault tolerance logging.", "VendorCode": "VMFTLog", "NetworkTrafficType": "Ethernet", "QosType": 1 } ] } Table 99.
PAGE 230
} "QosType": 4 /api/NetworkConfigurationService/QosTypes This URI represents the types of Quality-of-Service (QoS) that the system supports. GET method for QosTypes This method returns the types of Quality-of-Service (QoS) that the system supports. Description Returns the supported QoS. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkConfigurationService.QosType)", "@odata.count": 4, "value": [ { "@odata.
PAGE 231
Example response body { "@odata.context": "/api/$metadata#NetworkConfigurationService.QosType/ $entity", "@odata.id": "/api/NetworkConfigurationService/QosTypes(1)", "Id": 1, "Name": "Platinum" } /api/NetworkConfigurationService/Actions/ NetworkConfigurationService.RemoveNetworks POST method for removing networks This method deletes the specified networks from the system. Description Deletes the specified networks.
PAGE 232
] } "Name":"3", "Description": "", "VlanMinimum": 20, "VlanMaximum": 30, "Type": 1 Table 101. Attributes Attribute name Description Id Unique identifier of the network. Name Name of the network. Description Description of the network. VlanMaximum VLan can be defined as either a range or a single value. If a single value is defined, the same value is assigned to both VlanMaximum and VlanMinimum. VlanMinimum VLan can be defined as either a range or a single value.
PAGE 233
api/NetworkConfigurationService/Actions/ NetworkConfigurationService.ValidateNetworkDefinitionFile This URI validates the network profiles, which you want to import. POST method for validating network profiles This method validates the network profiles that you want to import. Description Validates the network profiles that you want to import.
PAGE 234
7 Devices Topics: • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • 234 /api/DeviceService /api/DeviceService/Devices /api/DeviceService/Devices?$filter=Type eq 1000 /api/DeviceService/Devices(Id) /api/DeviceService/Devices(Id)/InventoryDetails /api/DeviceService/Devices(Id)/InventoryDetails(InventoryType) /api/DeviceService/Devices(Id)/Settings('ReplicableChassisConfigurations') /api/DeviceService/Devices(Device_ID)/Settings('LocalAccessConfiguration') /api/DeviceService
PAGE 235
/api/DeviceService This URI represents the device services. GET method for DeviceService This method returns a list of all the device services. Description Returns a list of device services. Privilege VIEW HTTP response codes 200 Example Response Body { "@odata.context": "/api/$metadata#DeviceService.DeviceService", "@odata.type": "#DeviceService.DeviceService", "@odata.id": "/api/DeviceService", "Actions": null, "Devices@odata.navigationLink": "/api/DeviceService/Devices", "DeviceStatuses@odata.
PAGE 236
"PowerState": 17, "ManagedState": 3000, "Status": 1000, "ConnectionState": true, "AssetTag": "12345678910", "SystemId": 2031, "DeviceName": "IOM-C1", "LastInventoryTime": "2019-09-06 06:30:11.936", "LastStatusTime": "2019-09-06 06:30:06.
PAGE 237
DeviceService/Devices(10281)",…} ] } NOTE: The devices order is not guaranteed for multiple device API calls. Use the Order By, based on the identifier to get the list of unique devices. For example: use the API, api/DeviceService/ Devices?$orderby=Identifier&$top=50&$skip=0, to select the first 50 devices. /api/DeviceService/Devices?$filter=Type eq 1000 This URI gets a collection of devices with filter. GET method for device filter This method gets a collection of devices.
PAGE 238
"DeviceCapabilities": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 41, 11, 12, 13, 14, 15, 1009, 17, 50, 18, 30, 31 ], "SlotConfiguration": { "ChassisName": null }, "DeviceManagement": [ { "ManagementId": 5002, "NetworkAddress": "XX.XX.X.XX", "MacAddress": "58:8a:5a:ee:01:6e", "ManagementType": 2, "InstrumentationName": "WIN-02GODDHDJTC", "DnsName": "idrac-gmgr064.smd.devops.dell.com", "ManagementProfile": [ { "ManagementProfileId": 5002, "ManagementId": 5002, "AgentName": "iDRAC", "Version": "3.30.30.
PAGE 239
"@odata.id": "/api/DeviceService/Devices(10074)/ LogSeverities" }, "Settings@odata.navigationLink": "/api/DeviceService/ Devices(10074)/Settings", "Temperature": { "@odata.id": "/api/DeviceService/Devices(10074)/ Temperature" }, "Power": { "@odata.id": "/api/DeviceService/Devices(10074)/Power" }, "SystemUpTime": { "@odata.id": "/api/DeviceService/Devices(10074)/ SystemUpTime" }, "BlinkStatus": { "@odata.id": "/api/DeviceService/Devices(10074)/ BlinkStatus" }, "PowerUsageByDevice@odata.
PAGE 240
30, 31 ], "SlotConfiguration": { "ChassisName": null }, "DeviceManagement": [ { "ManagementId": 5012, "NetworkAddress": "XX.XX.X.XX", "MacAddress": "50:9a:4c:b2:f6:16", "ManagementType": 2, "InstrumentationName": "WIN-02GODDHDJTC", "DnsName": "idrac-gmgr075.smd.devops.dell.com", "ManagementProfile": [ { "ManagementProfileId": 5012, "ManagementId": 5012, "AgentName": "iDRAC", "Version": "3.36.36.36", "ManagementURL": "https://XX.XX.X.
PAGE 241
"PowerUsageByDevice@odata.navigationLink": "/api/ DeviceService/Devices(10079)/PowerUsageByDevice", "DeviceBladeSlots@odata.navigationLink": "/api/DeviceService/ Devices(10079)/DeviceBladeSlots", "GraphicInfo": { "@odata.id": "/api/DeviceService/Devices(10079)/ GraphicInfo" }, "DeployRequired": { "@odata.id": "/api/DeviceService/Devices(10079)/ DeployRequired" } }, { "@odata.type": "#DeviceService.Device", "@odata.
PAGE 242
] } "ManagementURL": "https://XX.XX.X.XX:XXX", "HasCreds": 0, "Status": 1000, "StatusDateTime": "2019-12-02 16:01:47.786" } ], "Actions": null, "SensorHealth@odata.navigationLink": "/api/DeviceService/ Devices(10085)/SensorHealth", "VirtualSession": { "@odata.id": "/api/DeviceService/Devices(10085)/ VirtualSession" }, "Baselines": { "@odata.id": "/api/DeviceService/Devices(10085)/ Baselines" }, "InventoryDetails@odata.
PAGE 243
/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. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#DeviceService.Device", "@odata.type": "#DeviceService.Device", "@odata.
PAGE 244
] } ], "Actions": null, "DeviceSpecificData":{ "powerRedundancy": "No Redundancy", "expressservicecode": "49896352517", "servicetag": "MX70005", "faceplatePower": 11571, "dnsname": "", "location": "", "hardwareVersion": "", "powercapacity": "Disabled" }, "InventoryDetails@odata.navigationLink": "/api/DeviceService/ Devices(10053)/InventoryDetails", "HardwareLogs@odata.navigationLink": "/api/DeviceService/Devices(10053)/ HardwareLogs", "SubSystemHealth@odata.
PAGE 245
Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(DeviceService.InventoryDetail)", "@odata.count": 18, "value": [ { "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('serverDeviceCards')", "InventoryType": "serverDeviceCards", "InventoryInfo": [ { "Id": 127, "SlotNumber": "SMBus.Embedded.
PAGE 246
{ }, { mode]", }, { ] } "Id": 133, "SlotNumber": "P2PBridge.Embedded.2-1", "Manufacturer": "Intel Corporation", "Description": "Lewisburg PCI Express Root Port #5", "DatabusWidth": "Unknown", "SlotLength": "Unknown", "SlotType": "Unknown" "Id": 134, "SlotNumber": "AHCI.Embedded.2-1", "Manufacturer": "Intel Corporation", "Description": "Lewisburg SATA Controller [AHCI "DatabusWidth": "Unknown", "SlotLength": "Unknown", "SlotType": "Unknown" "@odata.
PAGE 247
"@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('serverArrayDisks')", "InventoryType": "serverArrayDisks", "InventoryInfo": [ { "Id": 10, "DeviceId": 0, "DiskNumber": "Disk 0 on Embedded AHCI Controller 2", "VendorName": "SEAGATE", "Status": 2000, "StatusString": "Unknown", "ModelNumber": "ST1000NX0423", "SerialNumber": "S47171Y1", "Revision": "NA03", "EnclosureId": "Disk 0 on Embedded AHCI Controller 2", "Channel": 0, "Size": "931.
PAGE 248
}, { ] } "SerialNumber": "1446F14C", "TypeDetails": "DDR4 DIMM", "ManufacturerDate": "Mon Oct 17 07:00:00 2016 UTC", "Speed": 2666, "CurrentOperatingSpeed": 2133, "Rank": "Single Rank", "InstanceId": "DIMM.Socket.A1", "DeviceDescription": "DIMM A1" "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('serverStorageEnclosures')", "InventoryType": "serverStorageEnclosures", "InventoryInfo": [] }, { "@odata.
PAGE 249
data" "InventoryInfo": [ { "Id": 366, "CapabilityType": { "CapabilityId": 17, "Name": "FEATURES_14G", "Description": "14G specific features" } }, { "Id": 367, "CapabilityType": { "CapabilityId": 16, "Name": "VIRTUAL_CONSOLE", "Description": "Ability to execute RACADM tasks" } }, { "Id": 368, "CapabilityType": { "CapabilityId": 15, "Name": "TEMP_HISTORY", "Description": "Retrieve historical temperature }, { }, { }, { }, { }, { }, { } "Id": 369, "CapabilityType": { "CapabilityId": 14, "Name": "POWER_HI
PAGE 250
assigned Storage" }, { capability.
PAGE 251
}, { ] } } "CapabilityId": 30, "Name": "REMOTE_RACADM", "Description": "14G specific features" "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('deviceFru')", "InventoryType": "deviceFru", "InventoryInfo": [ { "Id": 38, "Manufacturer": "Dell Inc.", "Name": "SystemPlanar" }, { "Id": 37, "Manufacturer": "Micron Technology", "Name": "DDR4 DIMM", "PartNumber": "9ASF1G72PZ-2G6D1", "SerialNumber": "1446F14C" } ] }, { "@odata.
PAGE 252
"InventoryType": "deviceSoftware", "InventoryInfo": [ { "Version": "0", "InstallationDate": "2017-06-16T00:54:12Z", "Status": "Installed", "SoftwareType": "APAC", "ComponentId": "25806", "DeviceDescription": "Diagnostics", "InstanceId": "DCIM:INSTALLED#802__Diagnostics.Embedded.1:LC.Embedded.
PAGE 253
"DCIM:INSTALLED#802__OSCollector.Embedded.1" }, { "Version": "0", "InstallationDate": "2017-06-16T00:54:12Z", "Status": "Installed", "SoftwareType": "APAC", "ComponentId": "104684", "DeviceDescription": "iDRAC Service Module Installer", "InstanceId": "DCIM:INSTALLED#802__ServiceModule.Embedded.1" }, { "Version": "3.20.20.
PAGE 254
}, { } ] } ] } "SubsystemName": "tempRollupStatus" "Id": 152, "Status": 2000, "SubsystemName": "intrusionRollupStatus" Individual filters You can also use individual filters in this URI. Example response body GET for the following URI: /api/DeviceService/Devices(3315)/ InventoryDetails('subsystemRollupStatus') Output: { "@odata.context": "$metadata#DeviceService.InventoryDetail/$entity", "@odata.
PAGE 255
} ] /api/DeviceService/Devices(Id)/ InventoryDetails(InventoryType) This URI represents the details of a specific inventory type for a specific device. GET method for inventory details by inventory type This method returns the details of a specific inventory type. NOTE: If a PSU is absent, this method reports the status as follows: ● Presence: Absent ● Health: Ok ● Power state: Off Description Returns details of a specific inventory type.
PAGE 256
/api/DeviceService/Devices(Id)/ Settings('ReplicableChassisConfigurations') This URI retrieves the chassis time and alert destination settings and applies the settings to the IOM. PUT method to retrieve chassis time and alert destination settings This method retrieves the chassis and alert destinations settings. Description Retrieves the chassis and alert destinations settings and applies the settings to the IOMs.
PAGE 257
/api/DeviceService/Devices(Device_ID)/ Settings('LocalAccessConfiguration') This API represents the local access configuration information. GET method for local access configuration This method returns the local access configuration details. Description Returns the local access configuration details.
PAGE 258
"EnableReadAuthentication": true, "EnableQuickSyncWifi": true } Example response body { } }, "EnableChassisDirect": true, "LcdAccess": "VIEW_AND_MODIFY", "LcdPresence": "Present", "LcdCustomString": "", "LcdLanguage": "en" "SettingType": "LocalAccessConfiguration", "EnableChassisPowerButton": true, "EnableKvmAccess": true, "LedPresence": "Absent", "QuickSync": { "QuickSyncHardware": "Present", "QuickSyncAccess": "READ_WRITE", "EnableInactivityTimeout": true, "TimeoutLimit": 120, "TimeoutLimitUnit": "SE
PAGE 259
"EnableReadAuthentication": true, "EnableQuickSyncWifi": true } }, "EnableChassisDirect": false, "LcdAccess": "VIEW_AND_MODIFY", "LcdPresence": "Present", "LcdCustomString": "", "LcdLanguage": "en" /api/DeviceService/Devices(Id)/HardwareLogs This URI represents the hardware logs of a specific device. GET method for HardwareLogs This method returns the hardware logs of a specific device. Description Returns the hardware logs of a specific device.
PAGE 260
"LogTimestamp": "20170907053540.000000-300", "LogSequenceNumber": 286411, "LogSeverity": 1000, "LogComment": "[set comment here]", "LogMessageId": "USR0030", "LogMessage": "Successfully logged in using root, from 10.32.22.88 and wsman.", "LogId": "DCIM:LifeCycleLog:286411", "LogCategory": "Audit", "DateFormat": "CIM" } ] } /api/DeviceService/Devices(Id)/SubSystemHealth This URI represents the health of a specific device.
PAGE 261
} ] } /api/DeviceService/Devices(Id)/RecentActivity This URI represents the recent activities for a specific device. GET method for RecentActivity This method returns the recent activities for a specific device. Description Returns the recent activities for a specific device. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(DeviceService.ExecutionHistoryDetailModel)", "@odata.
PAGE 262
/api/DeviceService/Devices(Id)/InventoryTypes This URI represents the inventory types for a specific device. GET method for InventoryTypes This method returns the inventory types for a specific device. Description Returns the inventory types for a specific device. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#DeviceService.InventoryTypes/$entity", "@odata.
PAGE 263
} "Info": 1000 NOTE: The severity "Unknown": 5000 is not displayed by REST. To view logs in Unknown state, use the web interface. /api/DeviceService/Devices(Id)/Settings This URI represents the settings of a specific device. GET method for Settings This method returns the details of the settings of a specific device. Description Returns the details of the settings of a specific device. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
PAGE 264
GET method for device settings by type This method returns the available attributes under a specific setting type. Description Returns the available attributes under a specific setting type. Privilege VIEW HTTP response codes 200 Example for network settings for IOM Example response body { } Example for network settings for Chassis 264 Devices "@odata.context": "/api/$metadata#DeviceService.DeviceSetting/$entity", "@odata.type": "#DeviceService.DeviceSetting", "@odata.
PAGE 265
"EnableAutoconfiguration": true, "StaticIPv6Address": "", "StaticPrefixLength": "0", "StaticGateway": "", "UseDHCPv6ObtainDNSServerAddresses": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" } }, "GeneralSettings": { "EnableNIC": true, "RegisterDNS": false, "DnsName": "MX7000", "UseDHCPForDomainName": false, "DnsDomainName": "", "AutoNegotiation": true, "NetworkSpeed": "1_GB", "Delay": 0 } PUT method for device settings by type This method updates the attributes under a specific sett
PAGE 266
Example for network settings for IOM Example response body { } Example for IOM names Example response body { Example for network settings for Chassis 266 Devices "@odata.id": "/api/DeviceService/Devices(25773)/Settings('Network')", "EnableMgmtVLANId": false, "@odata.context": "/api/$metadata#DeviceService.
PAGE 267
{ } Example for network settings for Chassis } "EnableNIC": true, "RegisterDNS": false, "DnsName": "MX7000", "UseDHCPForDomainName": false, "DnsDomainName": "", "AutoNegotiation": true, "NetworkSpeed": "1_GB", "Delay": 0 Example response body { } "SettingType": "Network", "DhcpProvisioning": null, "MgmtVLANId": "1", "EnableVLAN": false, "Ipv4Settings": { "EnableIPv4": true, "EnableDHCP": true, "StaticIPAddress": "", "StaticSubnetMask": "", "StaticGateway": "", "UseDHCPObtainDNSServerAddresses": true,
PAGE 268
HTTP response codes 200 Example response body { "@odata.context": "$metadata#DeviceService.TemperatureResponseModel/ $entity", "@odata.id": "/api/DeviceService/Devices(3265)/Temperature", "peakTemperatureUnit": "celsius", "avgTemperatureUnit": "celsius", "DateFormat": "CIM", "instantaneousTemperatureUnit": "celsius", "avgTemperatureTimeStamp": "20170907071015.
PAGE 269
Example response body { } "@odata.context": "$metadata#DeviceService.PowerResponseModel/$entity", "@odata.id": "/api/DeviceService/Devices(3265)/Power", "avgPower": "0", "systemEnergyConsumptionUnit": "killowatt-hour", "systemEnergyConsumptionTimeStamp": "20170907071147.450000-300", "powerUnit": "watt", "minimumPowerTimeStamp": "19691231180000.000000-360", "avgPowerUnit": "watt", "minimumPower": "65535", "peakPower": "73", "DateFormat": "CIM", "systemEnergyConsumption": "0.000", "Since": "20170414145039.
PAGE 270
} ] } "Id": 4465, "SlotName": "Sled-3", "PowerState": 18, "SlotType": 2000, "DeviceName": "" /api/DeviceService/Devices(Id)/GraphicInfo This URI represents the graphics information of a specific device. GET method for GraphicInfo This method returns the graphics-related information of a specific device. Description Returns the graphics-related information of a specific device. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#DeviceService.
PAGE 271
/api/DeviceService/Devices(Id)/DeployRequired This API represents the device deployment results. GET method for deployment by device IDs This method returns the results for deployment on devices by IDs. Description Returns the results for deployment on devices by IDs. Privilege HTTP response code Example response body 200 { "@odata.context": "/api/$metadata#DeviceService.DeployRequired", "@odata.type": "#DeviceService.DeployRequired", "@odata.
PAGE 272
/api/DeviceService/Actions/DeviceService/ Devices(Id)Actions/ DeviceService.UploadFSDCertificate This API represents Field Service Debug (FSD) certificate information. POST method for uploading FSD certificate This method returns information about the FSD certificate upload process. Description Returns information about the FSD certificate upload process.
PAGE 273
/api/DeviceService/DeviceStatuses This URI represents the statuses that the devices can be in. GET method for DeviceStatuses This method returns a list of statuses for the devices. Description Returns a list of statuses for the devices. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(DeviceService.DeviceStatus)", "@odata.count": 5, "value": [ { "GlobalStatus": 1000, "Name": "NORMAL", "Description": "The device is running normal.
PAGE 274
Example response body { } "@odata.context": "$metadata#Collection(DeviceService.DeviceType)", "@odata.
PAGE 275
/api/DeviceService/Actions/DeviceService/ Devices(Id)Actions/DeviceService.GetTermState This API represents term state information for devices. POST method for getting term state This method returns term state information. Description Returns term state information. Privilege DEVICE_CONFIGURATION HTTP response codes 202 Table 105. Attributes Attribute name Description Id—Devices(Id) ID of the device. /api/DeviceService/Actions/DeviceService/ Devices(Id)Actions/DeviceService.
PAGE 276
Privilege VIEW HTTP response codes 200 Example response body 276 Devices { "@odata.context": "$metadata#Collection(DeviceService.DeviceSummary)", "@odata.count": 6, "value": [ { "@odata.id": "/api/DeviceService/DeviceSummary(1000)", "DeviceType": 1000, "TotalCount": 2, "DeviceStatusSummary": [ { "StatusType": 1000, "Count": 1 }, { "StatusType": 2000, "Count": 0 }, { "StatusType": 3000, "Count": 0 }, { "StatusType": 4000, "Count": 1 }, { "StatusType": 5000, "Count": 0 } ] }, { "@odata.
PAGE 277
}, { }, { }, { }, { }, { }, { ] } "Count": 0 "StatusType": 2000, "Count": 0 "StatusType": 3000, "Count": 0 "StatusType": 4000, "Count": 0 "StatusType": 5000, "Count": 0 "@odata.id": "/api/DeviceService/DeviceSummary(4000)", "DeviceType": 4000, "TotalCount": 0, "DeviceStatusSummary": [ { "StatusType": 1000, "Count": 0 }, { "StatusType": 2000, "Count": 0 }, { "StatusType": 3000, "Count": 0 }, { "StatusType": 4000, "Count": 0 }, { "StatusType": 5000, "Count": 0 } ] "@odata.
PAGE 278
}, { } ] } ] "@odata.id": "/api/DeviceService/DeviceSummary(8000)", "DeviceType": 8000, "TotalCount": 1, "DeviceStatusSummary": [ { "StatusType": 1000, "Count": 0 }, { "StatusType": 2000, "Count": 0 }, { "StatusType": 3000, "Count": 1 }, { "StatusType": 4000, "Count": 0 }, { "StatusType": 5000, "Count": 0 } ] /api/DeviceService/DeviceSummary(Type) This API represents the device summary information by device status type.
PAGE 279
"StatusType": 3000, "Count": 0 }, { "@odata.type": "#DeviceService.DeviceStatusSummary", "StatusType": 4000, "Count": 0 }, { "@odata.type": "#DeviceService.DeviceStatusSummary", "StatusType": 5000, "Count": 0 } ] } api/DeviceService/Actions/ DeviceService.DevicesPrivilegesAction This API represents the device privilege information that users have for devices. POST method for api/DeviceService/Actions/ DeviceService.
PAGE 280
HTTP response code Example request body 201 { "Privileges": [] } Example response body { “Privileges”: [“VIEW”,”CHASSIS_ADMINISTRATOR”] } /api/DeviceService/Actions/ DeviceService.ExecuteAction This API represents the remote console preview information. POST method /api/DeviceService/Actions/ DeviceService.ExecuteAction This method returns the remote console preview information. Description Returns the remote console preview information.
PAGE 281
}, { }, { }, { }, { }, { } ] } "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.
PAGE 282
}, { }, { }, { }, { }, { }, { }, { }, { }, { 282 Devices "Description": "Redundancy policy type is GRID redundancy" "@odata.type": "#DeviceService.DeviceSettingsMetadata", "Id": 5000, "Property": "dhcpProvisioning", "Key": "DISABLED", "Value": "Disabled", "Description": "Dhcp Provisioning is disable" "@odata.type": "#DeviceService.
PAGE 283
}, { }, { }, { }, { }, { }, { }, { }, { }, { "Description": "Time out limit unit is seconds" "@odata.type": "#DeviceService.DeviceSettingsMetadata", "Id": 15000, "Property": "timeoutLimitUnit", "Key": "MINUTES", "Value": "Minutes", "Description": "Time out limit unit is minutes" "@odata.type": "#DeviceService.DeviceSettingsMetadata", "Id": 16000, "Property": "lcdAccess", "Key": "DISABLED", "Value": "Disabled", "Description": "LCD access is disabled" "@odata.type": "#DeviceService.
PAGE 284
}, { }, { }, { }, { ] } } "Description": "French" "@odata.type": "#DeviceService.DeviceSettingsMetadata", "Id": 19005, "Property": "lcdLanguage", "Key": "de", "Value": "German", "Description": "German" "@odata.type": "#DeviceService.DeviceSettingsMetadata", "Id": 19006, "Property": "lcdLanguage", "Key": "es", "Value": "Spanish", "Description": "Spanish" "@odata.type": "#DeviceService.
PAGE 285
}, { }, { }, { } ] } ] } "@odata.id": "/api/DeviceService/GlobalExcludes(2)", "Id": 2, "Identifier": null, "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 2, "NetworkAddress": "xx.xx.xx.xx" } ] "@odata.id": "/api/DeviceService/GlobalExcludes(3)", "Id": 3, "Identifier": "R930PR0", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 3, "NetworkAddress": "xx.xx.xx.xx" } ] "@odata.
PAGE 286
/api/DeviceService/Actions/ DeviceService.AddNetworkRange This URI adds ranges to the globally excluded range. POST method for DeviceService.AddNetworkRange This method adds ranges to global exclusion. Description Adds network ranges to global exclusion. Privilege APPLIANCE_SETUP HTTP response codes 204 Example request body { } "Id": 0, "Identifier": "IPRange2", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 0, "NetworkAddress": "xx.xx.xx.xx-xx.xx.xx.
PAGE 287
/api/DeviceService/Actions/ DeviceService.RemoveFromExclusion This URI removes ranges from Global Exclusion. POST method for DeviceService.RemoveFromExclusion This method removes ranges in global exclusion. Description Removes ranges in global exclusion. Privilege APPLIANCE_SETUP HTTP response codes 204 Example request body {"Ids": [1,2,3,4,5,6]} /api/DeviceService/Actions/ DeviceService.ValidateExcludes This URI validates global exclusion. POST method for DeviceService.
PAGE 288
/api/DeviceService/Actions/ DeviceService.RemoveDevices This URI deletes an array of devices. POST method for DeviceService.RemoveDevices Description Deletes an array of devices.
PAGE 289
8 Diagnostic Topics: • /api/DeviceService/Devices(Id)/Actions/DeviceService.Diagnostic /api/DeviceService/Devices(Id)/Actions/ DeviceService.Diagnostic This URI allows you to execute supported diagnostic commands. POST method for DeviceService.Diagnostic This method executes the supported diagnostics commands. Description Executes supported diagnostic commands.
PAGE 290
9 Groups Topics: • • • • • • • • • • • • • • • • • • /api/GroupService/Groups /api/GroupService/Groups(Id) /api/GroupService/Groups(Id)/Devices /api/GroupService/Groups(Id)/GroupDevicesSummary /api/GroupService/Groups(group id)/AllLeafDeviceSummaries /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000 /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0 /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25
PAGE 291
} ] } "UpdatedBy": "", "Visible": true, "DefinitionId": 500, "DefinitionDescription": "Root group for all Types of Devices.", "TypeId": 2000, "MembershipTypeId": 24, "Devices": [ { "@odata.id": "/api/GroupService/Groups(64)/Devices" } ], "AllLeafDevices": [ { "@odata.id": "/api/GroupService/Groups(64)/AllLeafDevices" } ], "GroupHierarchy": [ { "@odata.id": "/api/GroupService/Groups(64)/GroupHierarchy" } ], "SubGroups": [ { "@odata.
PAGE 292
Table 106. Attributes (continued) Attribute name Description MembershipTypeId Group membership type. ● 12 — Static ● 24 — Dynamic Link Devices Group link to list group devices. AllLeafDevices Group link to list all group sub groups devices. GroupHierarchy Group link to list the group hierarchy. SubGroup Group link to display the list of sub groups of this group. GroupDevicesSummary Group link to display a summary of all group devices. Table 107.
PAGE 293
Example response body { } "@odata.context": "$metadata#GroupService.Group/$entity", "@odata.id": "/api/GroupService/Groups(64)", "Id": 64, "Name": "All Devices", "Description": "Group associated to all devices.", "GlobalStatus": 5000, "ParentId": 0, "CreationTime": "2017-06-08 18:48:27.069", "UpdatedTime": "2017-06-08 21:15:01.746", "CreatedBy": "system", "UpdatedBy": "", "Visible": true, "DefinitionId": 500, "DefinitionDescription": "Root group for all Types of Devices.
PAGE 294
Table 108. Attributes (continued) Attribute name Description DefinitionDescription Definition description of the group. TypeId Group type. ● ● ● ● ● MembershipTypeId 1000 — Internal 2000 — Predefined 3000 — User defined 4000 — Discovery defined 5000 — MCM group Group membership type. ● 12 — Static ● 24 — Dynamic Link Devices Group link to list group devices. AllLeafDevices Group link to list all group sub groups devices. GroupHierarchy Group link to list the group hierarchy.
PAGE 295
} "DefinitionDescription": "" DELETE method for Groups(Id) This method deletes a group from the collection. Description Deletes a group. Privilege DEVICE_CONFIGURATION HTTP response codes 204 Example request body { } "Id": 1564 Table 109. 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.
PAGE 296
"DeviceName": "WIN-02GODDHDJTC", "LastInventoryTime": "2017-06-08 14:10:43.965", "LastStatusTime": "2017-06-08 21:31:41.
PAGE 297
"Settings": [ { "@odata.id": "/api/DeviceService/Devices(1614)/Settings" } ], "Temperature": { "@odata.id": "/api/DeviceService/Devices(1614)/Temperature" }, "Power": { "@odata.id": "/api/DeviceService/Devices(1614)/Power" }, "BlinkStatus": { "@odata.id": "/api/DeviceService/Devices(1614)/BlinkStatus" }, "PowerUsageByDevice": [ { "@odata.id": "/api/DeviceService/Devices(1614)/ PowerUsageByDevice" } ], "Faults": [ { "@odata.id": "/api/DeviceService/Devices(1614)/Faults" } ], "DeviceBladeSlots": [ { "@odata.
PAGE 298
"$metadata#Collection(GroupService.GroupDevicesSummary)", "@odata.count": 1, "value": [ { "DeviceType": 1000, "TotalCount": 55, "GroupDevicesStatusSummary": [ { "StatusType": 1000, "Count": 29 }, { "StatusType": 2000, "Count": 5 }, { "StatusType": 3000, "Count": 4 }, { "StatusType": 4000, "Count": 17 }, { "StatusType": 5000, "Count": 0 } ] } ] } Table 111. Attributes Attribute name Description Id ID of the group.
PAGE 299
}, { "Model": "PowerEdge FM120", "Identifier": "8FWV992d", "DeviceServiceTag": "8FWV992", "Type": 1000, "Status": 1000, "PowerState": 18, "ConnectionState": true, "ManagedState": 3000, "DeviceCapabilities": [ 1, 12, 5, 41, 2, 30, 8, 9, 1009, 10, 14, 4, 6, 3, 18, 15, 7, 31, 13, 50 ], "DeviceManagement": [ { "DeviceId": 14164, "ManagementId": 5000, "NetworkAddress": "XXX.XX.XXX.
PAGE 300
12, 1, 31, 10, 1009, 9, 2, 41, 8, 7, 6, 5, 50 }, { ], "DeviceManagement": [ { "DeviceId": 14214, "ManagementId": 5001, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "74:86:7a:e5:c5:fc", "InstrumentationName": "idrac-2476qm2.fwtestwin.com", "ManagementProfile": [ { "ManagementProfileId": 5001, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.63.60.62", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
PAGE 301
"DeviceId": 14264, "ManagementId": 5002, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "74:86:7a:e5:c5:f8", "InstrumentationName": "idrac-8FWV992a", "ManagementProfile": [ { "ManagementProfileId": 5002, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.63.60.62", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] }, { } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
PAGE 302
}, { "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
PAGE 303
1001, 18, 41 }, { ], "DeviceManagement": [ { "DeviceId": 15112, "ManagementId": 5010, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "64:00:6a:c4:13:a8", "InstrumentationName": "MINWINPC", "ManagementProfile": [ { "ManagementProfileId": 5010, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.61.60.60", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
PAGE 304
"@odata.type": "#DeviceService.DeviceMinModel", "@odata.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(15132)", "Id": 15132, "DeviceName": "100.97.133.
PAGE 305
}, { "ManagedState": 3000, "DeviceCapabilities": [ 16, 4, 5, 30, 50, 6, 41, 7, 2, 8, 33, 1009, 9, 10, 11, 31, 12, 1, 13, 18, 14, 15, 17, 3 ], "DeviceManagement": [ { "DeviceId": 15133, "ManagementId": 5299, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:8c:ec:7a", "InstrumentationName": "idrac-4598BS2", "ManagementProfile": [ { "ManagementProfileId": 5299, "ManagementId": 0, "AgentName": "iDRAC", "Version": "3.36.36.36", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.
PAGE 306
30, 6, 2, 1, 12, 17, 1009, 33, 3, 15, 8, 1006, 14, 18, 31, 50 }, { ], "DeviceManagement": [ { "DeviceId": 15136, "ManagementId": 5073, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:8e:a9:d1", "InstrumentationName": "idrac-GGWD9V2", "ManagementProfile": [ { "ManagementProfileId": 5073, "ManagementId": 0, "AgentName": "iDRAC", "Version": "3.36.36.36", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
PAGE 307
}, { "DeviceServiceTag": "6FP7F2S", "Type": 1000, "Status": 2000, "PowerState": 1, "ConnectionState": false, "ManagedState": 3000, "DeviceCapabilities": [ 9, 3, 2, 7, 10, 31, 41, 1, 12, 6, 13, 30, 5, 14, 4, 15, 18, 1009, 8 ], "DeviceManagement": [ { "DeviceId": 15230, "ManagementId": 5176, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "5c:f9:dd:d6:9d:54", "InstrumentationName": "idrac-6FP7F2S", "ManagementProfile": [ { "ManagementProfileId": 5176, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.
PAGE 308
5, 8, 4, 15, 33, 18, 30, 7, 1, 12, 6, 10 }, { ], "DeviceManagement": [ { "DeviceId": 15231, "ManagementId": 5178, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "10:98:36:9b:03:7f", "InstrumentationName": "localhost", "ManagementProfile": [ { "ManagementProfileId": 5178, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.63.60.61", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
PAGE 309
{ }, { "DeviceId": 15232, "ManagementId": 5180, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "10:98:36:9a:62:c1", "InstrumentationName": "idrac-1LPSG52", "ManagementProfile": [ { "ManagementProfileId": 5180, "ManagementId": 0, "AgentName": "iDRAC", "Version": "2.63.60.61", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
PAGE 310
}, { "Id": 15251, "DeviceName": "100.97.133.57", "Model": "PowerEdge MX740c", "Identifier": "17YFBS2", "DeviceServiceTag": "17YFBS2", "Type": 1000, "Status": 1000, "PowerState": 17, "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 4, 16, 12, 1009, 8, 11, 7, 1, 14, 2, 9, 3, 10, 18, 17, 15, 41, 13, 33 ], "DeviceManagement": [ { "DeviceId": 15251, "ManagementId": 5211, "NetworkAddress": "XXX.XX.XXX.
PAGE 311
6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 30, 31, 33, 41, 50, 1001, 1009 }, { ], "DeviceManagement": [ { "DeviceId": 15252, "ManagementId": 5303, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:8b:4d:b3", "InstrumentationName": "WIN-FP7P1J8GN1B", "ManagementProfile": [ { "ManagementProfileId": 5303, "ManagementId": 0, "AgentName": "iDRAC", "Version": "3.36.36.36", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.
PAGE 312
{ }, { ] } "ManagementProfileId": 5294, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http://XXX.XX.XXX.XX" "DeviceId": 15253, "ManagementId": 5295, "NetworkAddress": "2607:f2b1:f083:133::2b6", "MacAddress": "20:04:0F:13:3C:E2", "InstrumentationName": "MX5108n Ethernet Switch", "ManagementProfile": [ { "ManagementProfileId": 5295, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http:// [2607:f2b1:f083:133::2b6]" } ] } ], "IpAddress": "XXX.XX.XXX.
PAGE 313
3, 7, 2, 18, 8 ], "DeviceManagement": [ { "DeviceId": 15255, "ManagementId": 5292, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "20:04:0F:12:DF:62", "InstrumentationName": "MX5108n Ethernet Switch", "ManagementProfile": [ { "ManagementProfileId": 5292, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http://XXX.XX.XXX.
PAGE 314
}, { "Id": 15382, "DeviceName": "100.97.135.63", "Model": "PowerEdge M620", "Identifier": "4T36G2S", "DeviceServiceTag": "4T36G2S", "Type": 1000, "Status": 3000, "PowerState": 17, "ConnectionState": true, "ManagedState": 3000, "DeviceCapabilities": [ 1009, 7, 1001, 2, 6, 4, 5, 50, 12, 15, 14, 10, 31, 18, 1, 30, 9, 3, 13, 41, 8 ], "DeviceManagement": [ { "DeviceId": 15382, "ManagementId": 5222, "NetworkAddress": "XXX.XX.XXX.
PAGE 315
14, 13, 12, 31, 11, 1, 10, 9, 33, 41, 8, 7, 6, 50, 5, 4, 17, 3, 1009, 2, 18 }, { ], "DeviceManagement": [ { "DeviceId": 15388, "ManagementId": 5306, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:8b:49:4f", "InstrumentationName": "WIN-8U5E5RHPHL0", "ManagementProfile": [ { "ManagementProfileId": 5306, "ManagementId": 0, "AgentName": "iDRAC", "Version": "3.36.36.36", "ManagementURL": "https://XXX.XX.XXX.XX:XXX" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.
PAGE 316
10, 11, 31, 2, 12, 16, 13, 14 }, { ], "DeviceManagement": [ { "DeviceId": 15389, "ManagementId": 5301, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "d0:94:66:87:af:3c", "InstrumentationName": "idrac-4RKG9V2", "ManagementProfile": [ { "ManagementProfileId": 5301, "ManagementId": 0, "AgentName": "iDRAC", "Version": "3.36.36.36", "ManagementURL": "https://XXX.XX.XXX.XX:xxx" } ] } ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
PAGE 317
} ] /api/GroupService/Groups(group id)/ AllLeafDeviceSummaries?$filter=Type eq 4000 This URL returns the device data by specifying the device type. Get method for AllLeafDeviceSummaries?$filter=Type eq 4000 Description Returns the device data specified by device type. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(DeviceService.DeviceMinModel)", "@odata.count": 5, "value": [ { "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
PAGE 318
}, { "DeviceId": 15253, "ManagementId": 5295, "NetworkAddress": "2607:f2b1:f083:133::2b6", "MacAddress": "20:04:0F:13:3C:E2", "InstrumentationName": "MX5108n Ethernet Switch", "ManagementProfile": [ { "ManagementProfileId": 5295, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http:// [2607:f2b1:f083:133::2b6]" } ] } ], "IpAddress": "XXX.XX.XXX.XX" }, { "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
PAGE 319
}, { "DeviceId": 15255, "ManagementId": 5292, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "20:04:0F:12:DF:62", "InstrumentationName": "MX5108n Ethernet Switch", "ManagementProfile": [ { "ManagementProfileId": 5292, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http://XXX.XX.XXX.
PAGE 320
} ] } "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 7, 3, 5, 9, 8, 2, 1 ], "DeviceManagement": [ { "DeviceId": 15390, "ManagementId": 5296, "NetworkAddress": "XXX.XX.XXX.XX", "MacAddress": "88:94:71:DB:E8:98", "InstrumentationName": "MXG610s FC Switch 2SFP", "ManagementProfile": [ { "ManagementProfileId": 5296, "ManagementId": 0, "AgentName": null, "Version": null, "ManagementURL": "http://XXX.XX.XXX.XX" } ] } ], "IpAddress": "XXX.XX.XXX.
PAGE 321
"@odata.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(15253)", "Id": 15253, "DeviceName": "MX5108n Ethernet Switch", "Model": "MX5108n Ethernet Switch", "Identifier": "8Y280T2", "DeviceServiceTag": "8Y280T2", "Type": 4000, "Status": 1000, "PowerState": 17, "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 18, 1, 3, 8, 2, 9, 7, 5 ], "DeviceManagement": [ { "DeviceId": 15253, "ManagementId": 5294, "NetworkAddress": "XXX.XX.XXX.
PAGE 322
}, { "ManagedState": 7000, "DeviceCapabilities": [ 2, 7, 9, 5, 1, 3 ], "DeviceManagement": [], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
PAGE 323
}, { "@odata.type": "#DeviceService.DeviceMinModel", "@odata.id": "/api/GroupService/Groups(500)/ AllLeafDeviceSummaries(15256)", "Id": 15256, "DeviceName": "IOM-B1", "Model": "MX7116n Fabric Expander Module", "Identifier": "902B0T2", "DeviceServiceTag": "902B0T2", "Type": 4000, "Status": 1000, "PowerState": 17, "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 3, 9, 1, 2, 7, 5 ], "DeviceManagement": [], "IpAddress": "XXX.XX.XXX.XX" }, { "@odata.type": "#DeviceService.
PAGE 324
} /api/GroupService/Groups(group id)/ AllLeafDeviceSummaries?$filter=Type eq 4000& $top=25&$skip=0&$orderby=Identifier asc This URL returns the device data by specifying the order—ascending or descending. GET method for AllLeafDeviceSummaries?$filter=Type eq 4000& $top=25&$skip=0&$orderby=Identifier asc Description Returns the device data by specifying the order—ascending or descending. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
PAGE 325
} }, { ] } "ManagementURL": "http://XXX.XX.XXX.XX" ], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
PAGE 326
"Id": 15253, "DeviceName": "MX5108n Ethernet Switch", "Model": "MX5108n Ethernet Switch", "Identifier": "8Y280T2", "DeviceServiceTag": "8Y280T2", "Type": 4000, "Status": 1000, "PowerState": 17, "ConnectionState": true, "ManagedState": 7000, "DeviceCapabilities": [ 18, 1, 3, 8, 2, 9, 7, 5 ], "DeviceManagement": [ { "DeviceId": 15253, "ManagementId": 5294, "NetworkAddress": "XXX.XX.XXX.
PAGE 327
2, 7, 9, 5, 1, 3 }, { ], "DeviceManagement": [], "IpAddress": "XXX.XX.XXX.XX" "@odata.type": "#DeviceService.DeviceMinModel", "@odata.
PAGE 328
"CreationTime": "2017-06-08 21:34:42.681", "UpdatedTime": "2017-06-08 21:34:42.681", "CreatedBy": "root", "UpdatedBy": "", "Visible": true, "DefinitionId": 400, "DefinitionDescription": "UserDefined", "TypeId": 3000, "MembershipTypeId": 12, "Devices": [ { "@odata.id": "/api/GroupService/Groups(19164)/Devices" } ], "AllLeafDevices": [ { "@odata.id": "/api/GroupService/Groups(19164)/AllLeafDevices" } ], "GroupHierarchy": [ { "@odata.
PAGE 329
Table 112. Attributes (continued) Attribute name Description ● 3000 — User defined ● 4000 — Discovery defined ● 5000 — MCM group MembershipTypeId Group membership type. ● 12 — Static ● 24 — Dynamic Link Devices Group link to list group devices. AllLeafDevices Group link to list all group sub groups devices. GroupHierarchy Group link to list the group hierarchy. SubGroup Group link to display the list of sub groups of this group.
PAGE 330
/api/GroupService/GroupTypes This URI represents the group types. GET method for GroupTypes This method returns a list of all the group types. Description Returns all the group types. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(GroupService.GroupType)", "@odata.count": 5, "value": [ { "@odata.id": "/api/GroupService/GroupTypes(1000)", "Id": 1000, "Name": "Internal Group", "Description": "Internal group.
PAGE 331
/api/GroupService/GroupTypes(Id) This URI represents a group type within the collection. GET method for GroupTypes(Id) This method returns the details of a specific group from the collection. Description Returns the details of a specific group. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#GroupService.GroupType/$entity", "@odata.id": "/api/GroupService/GroupTypes(1000)", "Id": 1000, "Name": "Internal Group", "Description": "Internal group.
PAGE 332
} ] } "@odata.id": "/api/GroupService/MembershipTypes(24)", "Id": 24, "Name": "Dynamic", "Description": "Dynamic type" Table 116. Attributes Attribute name Description Id ID of the membership type. Name Name of the membership type. Description Description of the membership type. /api/GroupService/MembershipTypes(Id) This URI represents a specific membership type within the collection. GET method for MembershipTypes(Id) This method returns the details of a specific membership type.
PAGE 333
/api/GroupService/AllGroupsHierarchy This URI represents the hierarchy of all the groups and subgroups. GET method for AllGroupsHierarchy This method returns the hierarchy of all the groups and subgroups. Description Returns the hierarchy of all the groups and subgroups. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#Collection(GroupService.GroupHierarchy)", "@odata.
PAGE 334
/api/GroupService/Actions/ GroupService.GroupsPrivilegesAction POST method for GroupService.GroupsPrivilegesAction This method returns the group privileges for the logged-in user. Description Returns the group privileges for the user. To view the privileges of multiple groups, provide the group IDs separated by a comma.
PAGE 335
“Privileges”: [[] // ex. [“DEVICE_UPDATE”] } Example response body List of groups on which the user the specified privilege.
PAGE 336
10 Monitor Topics: • • Audit logs Jobs Audit logs /api/ApplicationService/AuditLogs This URI represents a collection of audit logs of the system. GET method for AuditLogs This method returns a collection of audit logs of the system. Description Returns a collection of audit logs. Privilege VIEW HTTP response codes 200 Example response body { } 336 Monitor "@odata.context": "$metadata#Collection(ApplicationService.AuditLog)", "@odata.count": 7, "value": [ { "@odata.
PAGE 337
/api/ApplicationService/AuditLogCategories This API represents information about audit log categories. GET method for /api/ApplicationService/AuditLogCategories This method returns the audit log categories. Description Returns the audit log categories. Privilege HTTP response code Example response body 200 { "@odata.context": "/api/ $metadata#Collection(ApplicationService.AuditLogCategories)", "@odata.count": 1, "value":[ { "@odata.type": "#ApplicationService.
PAGE 338
"Severity": "1000", "Message": "Successfully logged in.", "Category": "Audit", "UserName": "root", "IpAddress": "xx.xx.xx.xx", "MessageArgs": "root || xx.xx.xx.xx", "MessageID": "CUSR0001", "CreatedDate": "2017-04-26 16:13:57.880" } Table 118. Attributes Attribute Description Id Identifier of the SessionService. Severity Severity of the event or error message. Possible values are Critical, Warning, and Informational. Message Message text. Category Category of the message.
PAGE 339
"StartTime": null, "EndTime": null, "Schedule": "0 0/30 * 1/1 * ? *", "State": "Enabled", "CreatedBy": "admin", "UpdatedBy": null, "Visible": false, "Editable": false, "Builtin": true, "Targets": [ { "JobId": 10016, "Id": 500, "Data": "All-Devices", "TargetType": { "Id": 6000, "Name": "GROUP" } } ], "Params": [ { "JobId": 10016, "Key": "defaultInventoryTask", "Value": "TRUE" } ], "LastRunStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" }, "JobType": { "@odata.
PAGE 340
Table 119. Filters (continued) Filter name Description Visible Filter by group visibility NextRunBegin Filter by job next run time start. NextRunEnd Filter by next run time end. LastRunBegin Filter by last run time start. LastRunEnd Filter by last run time end. Table 120. Attributes Attribute Description Id ID of the job. JobName Name of the job. JobDescription Description of the job. JobType Type of the job. NextRun The next time when the job will be executed.
PAGE 341
POST method for Jobs This method creates a job. Description Creates a job.
PAGE 342
"JobId": 26097, "Id": 25915, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } } ], "Params": [], "Visible": true, "Editable": true, "Builtin": false Updating firmware using Compliance method Example response body Updating firmware using Individual Package method Example response body 342 Monitor { "JobName": "", "JobDescription": "", "Schedule": "", "State": "Enabled", "JobType": { "Id": 5, Name": "Update_Task" }, "Targets": [ { "Id":
PAGE 343
{"Id":, "Data":";", "TargetType":{"Id":1000, "Name":"Device"}}, ........
PAGE 344
"Key": "operationName", "Value": "UPDATE_SLOT_DATA" } Quick Deploy of IOM Example response body { 344 Monitor } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task" } "JobName": "Quick Deploy Task", "JobDescription": "Quick Deploy Task", "Schedule": "startnow", "State": "Enabled", "JobType": { "Id": 42, "Name": "QuickDeploy_Task" }, "Params": [ { "Key": "operationName", "Value": "IOM_QUICK_DEPLOY" }, { "Key": "deviceId", "Value": "25041" }, { "Key": "rootCredential", "Value": "password" }, { "Key": "n
PAGE 345
}, { }, { }, { }, { } Quick Deploy of sleds ] } "Key": "slotId=2", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" "Key": "slotId=3", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" "Key": "slotId=4", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" "Key": "slotId=5", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" "Key": "slotId=6", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" Example response body { "JobName": "Qu
PAGE 346
}, { "Key": "slotId=2", "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1" }, { "Key": "slotId=4", "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1" }, { "Key": "slotId=1", "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.
PAGE 347
Rolling back firmware update —Catalog method Example response body { } Rolling back firmware update —Browse method "JobName":"Rollback Firmware", "Schedule":"", "State":"Enabled", "JobType":{ "Id": 15, "Name":"RollbackSoftware_Task" }, "Params":[ { "Key":"operationName", "Value":"INSTALL_FIRMWARE" }, { "Key":"stagingValue", "Value":"false" }, { "Key":"signVerify", "Value":"true" } ], "Targets":[ { "Id":, "Data": "=
PAGE 348
Failover of management module Example response body { } Chassis backup "JobName": "Failover Operation", "JobDescription": "Failover Operation", "Schedule": "", "State": "Enabled", "Targets": [ { "Id": 25039, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "operationName", "Value": "FAILOVER" } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task" } Example response body { "Id": 0, "JobName": "Backup Task", "JobDescription": "Create a Backup of the chassis", "Schedule
PAGE 349
} Chassis restore } ], "JobType": { "Id": 21, "Name": "Backup_Task", "Internal": false } Example response body { "Id": 0, "JobName": "Restore Task", "JobDescription": "Restore an existing device backup" "Schedule": "startnow", "State": "Enabled", "Targets": [], "Params": [ { }, { }, { }, { }, { }, { }, { }, { ], } "Key": "shareType", "Value": "" "Key": "backup_filename", "Value": "
PAGE 350
Exporting chassis Example response body profiles { "@odata.context": "/api/$metadata#JobService.Job", "@odata.type": "#JobService.Job", "@odata.id": "/api/JobService/Jobs(13286)", "Id": 13286, "JobName": "Export Profile", "JobDescription": "Create and export profile of the chassis", "NextRun": null, "LastRun": "2020-06-10 12:33:19.
PAGE 351
ExecutionHistories" } Importing chassis profiles Example response body { "@odata.context": "/api/$metadata#JobService.Job", "@odata.type": "#JobService.Job", "@odata.id": "/api/JobService/Jobs(13288)", "Id": 13288, "JobName": "Import Profile", "JobDescription": "Import of backed up chassis profile", "NextRun": null, "LastRun": "2020-06-10 12:35:09.
PAGE 352
"Internal": false }, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2080, "Name": "New" }, "ExecutionHistories@odata.
PAGE 353
{ }, { }, { }, { } "Key": "shareName", "Value": "/var/nfsshare" "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" "Key": "shareType", "Value": "HTTPS" "Key": "maskSensitiveInfo", "Value": "FALSE" } ], "JobType": { "Id": 18, "Name": "DebugLogs_Task" } Chassis Extract Example response body Logs—NFS Share { "JobName": "Extract Log", "JobDescription": "Extract device log to NFS location", "Schedule": "startnow", "State": "Enabled", "Targets": [ { "Id": 25016, "Data": "", "TargetType": { "Id": 1000, "Name": "
PAGE 354
Chassis Extract Logs—CIFS Share Example response body { } Device-based reseat for compute, storage, or IOM 354 Monitor "JobName": "Extract Log", "JobDescription": "Extract device log to CIFS location", "Schedule": "startnow", "State": "Enabled", "Targets": [ { "Id": 25016, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" }, { "Key": "password", "Value": "sharepass" }, { "Key": "userName", "Value": "administrator" }, { "Key":
PAGE 355
{ "Key": "override", "Value": "true" }, { "Key": "operationName", "Value": "VIRTUAL_RESEAT" }, { "Key": "deviceTypes", "Value": "1000" } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task", "Internal": false }} Slot-based reseat for compute, storage, or IOM Example response body Chassis power off operation Example response body { "JobName": "Slot Based Virtual Reseat", "JobDescription": "Virtual_Reseat_Slot_based", "Schedule": "startnow", "State":"Enabled", "Targets": [ { "Id": 25045, "Data": "", "Targ
PAGE 356
} }], "Params": [ { "Key": "override", "Value": "true" }, { "Key": "powerState", "Value": "8" }, { "Key": "operationName", "Value": "POWER_CONTROL" }, { "Key": "deviceTypes", "Value": "1000" } ], "JobType": { "Id": 3, "Name": "DeviceAction_Task", "Internal": false } } Blade server (sled) power off operation 356 Monitor Example response body { "JobName": "Power Off (Non-graceful)", "JobDescription": "Power Control Task: Power Off (Non-graceful)", "Schedule": "startnow", "State": "Enabled", "Targets": [ {
PAGE 357
IOM power off operation Example response body { "JobName": "Power Off (Non-graceful)", "JobDescription": "Power Control Task: Power Off (Non-graceful)", "Schedule": "startnow", "State": "Enabled", "Targets": [ { "Id": 10660, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } }], "Params": [ { "Key": "override", "Value": "true" }, { "Key": "powerState", "Value": "8" }, { "Key": "operationName", "Value": "POWER_CONTROL" }, { "Key": "deviceTypes", "Value": "1000" } ], "JobType": { "Id": 3, "Name": "De
PAGE 358
], "JobType": { "Id": 3, "Name": "DeviceAction_Task", "Internal": false } } Where Slot type is always 2000 for compute SLED and ID "10099" is for chassis ID.
PAGE 359
} Blink LED ] } } "Id":1000, "Name":"Device" Example response body { "Id": 0, "JobName": "Blink LED", "JobDescription": "Blink LED: N Minute(s) or Indefinitely", "Schedule": "startnow", "State": "Enabled", "JobType": { "Name": "DeviceAction_Task" }, "Targets": [ { "Id": 10043, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "identifyState", "Value": "2" // 2 = duration in minutes, -1= indefinitely }, { "Key": "durationLimit", "Value": "60" // 60= 1 minute, 600=10 m
PAGE 360
{ }, { }, { }, { } System reseat } Monitor "Key": "operationName", "Value": "POWER_CONTROL" "Key": "deviceTypes", "Value": "1000" "Id": 0, "JobName": "System Reseat", "JobDescription": "Power Control Task: System Reseat", "State": "Enabled", "Schedule": "startnow", "JobType": { "Name": "DeviceAction_Task" }, "Targets": [ { "Id": 10043, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "operationName", "Value": "VIRTUAL_RESEAT" } ] Example response body { 360 } "Ke
PAGE 361
} Configure Port Break Out ] } "TargetType": { "Id": 1000, "Name": "DEVICE" } Example response body { "JobName": "Breakout Port", "JobDescription": null, "Schedule": "startnow", "State": "Enabled", "JobType": { "Id": 3, "Name": "DeviceAction_Task", "Internal": false }, "Targets": [ { "Id": 10045, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ {"Key": "breakoutType", "Value": “FabricExpander"}, {"Key": "interfaceId", "Value": "DPM4XC1:portgroup1/1/1,DPM4XC1:port-group1/1/2"
PAGE 362
Configure MTU Example response body { } Group Inventory Example response body { } Device Inventory Monitor "Id": 0, "JobName": "Default Inventory Task - All Devices ", "JobDescription": "Default Inventory Task - All Devices", "Schedule": "startnow", "State": "Enabled", "JobType": { "Name": "Inventory_Task" }, "Targets": [ { "Id": 500, "Data": "", "TargetType": { "Id": 6000, "Name": "GROUP" } } ] Example response body { 362 "JobName": "Update Maximum Transmission Unit", "JobDescription": null, "Sche
PAGE 363
} ] } } Extracting device Example response body logs { "Id": 0, "JobName": "Extract Log", "JobDescription": "Extract device log to CIFS location", "Schedule": "startnow", "State": "Enabled", "JobType": { "Id": 18, "Name": "DebugLogs_Task" }, "Targets": [ { "Id": 10036, "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" }, { "Key": "shareAddress", "Value": "100.69.127.105" }, { "Key": "shareName", "Value": "\\cifs\\share" }, { "Key": "shareT
PAGE 364
} "JobType":{ "Id":18, "Name":"DebugLogs_Task" }, "Targets":[ { "Id":10038, "TargetType":{ "Id":1000, "Name":"DEVICE" } } ], "Params":[ { "Key":"OPERATION_NAME", "Value":"EXTRACT_LOGS" }, { "Key":"shareType", "Value":"NFS" }, { "Key":"shareAddress", "Value":"1.2.3.4" }, { "Key":"shareName", "Value":"filepath" }, { "Key":"logSelector", "Value":"0,1,2" } ] Table 121. Attributes Attribute Description Target Id ID of the device.
PAGE 365
Table 121. Attributes (continued) Attribute Description ● 12 (Power Off - Soft Graceful)—Performs an orderly transition to "power off" state. The corresponding ACPI state is G2/S5, in which the system consumes a minimal amount of power. Override Ignores device state and performs the operation upInterfaceIds Id of the port that must be configured or toggled. If there are multiple ports these are separated by a "," in the parameter.
PAGE 366
"Schedule": "0 0/30 * 1/1 * ? *", "State": "Enabled", "CreatedBy": "admin", "UpdatedBy": null, "Visible": false, "Editable": false, "Builtin": true, "Targets": [ { "JobId": 10016, "Id": 500, "Data": "All-Devices", "TargetType": { "Id": 6000, "Name": "GROUP" } } ], "Params": [ { "JobId": 10016, "Key": "defaultInventoryTask", "Value": "TRUE" } ], "LastRunStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" }, "JobType": { "@odata.type": "#JobService.
PAGE 367
Table 122. Attributes (continued) Attribute Description State Indicates whether the job is enabled or disabled. CreatedBy User who created the job. UpdatedBy User who updated the job. Visible Indicates whether the job is visible. 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.
PAGE 368
{ } Example response body { } ] } } "Id":1000, "Name":"DEVICE" "Id": 26097, "JobName": "Inventory Task", "JobDescription": "Inventory Task", "NextRun": null, "LastRun": "2018-09-14 15:31:13.
PAGE 369
Table 123. Attributes (continued) Attribute Description 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 Table 124. Attributes Attribute Description Id ID of the job to be deleted. /api/JobService/JobStatuses This URI represents the status of all the jobs. GET method for JobStatuses This method returns the status of all the jobs.
PAGE 370
}, { }, { }, { }, { }, { }, { }, { }, { } ] } "@odata.id": "/api/JobService/JobStatuses(2050)", "Id": 2050, "Name": "Running" "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2060)", "Id": 2060, "Name": "Completed" "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2070)", "Id": 2070, "Name": "Failed" "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2080)", "Id": 2080, "Name": "New" "@odata.
PAGE 371
/api/JobService/JobStatuses(Id) This URI represents the status of a job. GET method for JobStatuses(Id) This method returns the details of a specific job status. Description Returns details of a specific job status. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#JobService.JobStatus/$entity", "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2030)", "Id": 2030, "Name": "Queued" Table 126.
PAGE 372
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 372 Monitor "Name": "Update_Task", "Internal": false "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(8)", "Id": 8, "Name": "Inventory_Task", "Internal": false "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(15)", "Id": 15, "Name": "RollbackSoftware_Task", "Internal": false "@odata.type": "#JobService.JobType", "@odata.
PAGE 373
}, { }, { }, { } ] } "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(39)", "Id": 39, "Name": "MCMGroupCreation_Task", "Internal": false "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(41)", "Id": 41, "Name": "ProfileUpdate_Task", "Internal": false "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(42)", "Id": 42, "Name": "QuickDeploy_Task", "Internal": false Table 127.
PAGE 374
Table 128. Attributes (continued) Attribute Description Name Name of the job type. Internal Indicates whether the job is internal. /api/JobService/Jobs(Id)/ExecutionHistories This URI represents all the execution histories for a job. GET method for ExecutionHistories This method returns the details of all the execution histories for a job. Description Returns details of all executions histories for a job. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
PAGE 375
}, "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.312", "LastUpdateTime": "2018-09-14 14:00:29.312", "ExecutedBy": "admin", "JobId": 10016, "JobStatus": { "@odata.
PAGE 376
Table 129. 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.
PAGE 377
"@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-OME-ModularDNH1", "Value": "Running\nCompleted", "ExecutionHistoryId": 18683, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" } } ] } Table 130.
PAGE 378
} } "Status": 2020, "State": "", "JobType": "AlertSubscription_Task", "StartTime": "2017-06-06 10:00:00.00", "EndTime": "2017-06-07 10:00:00.00" Or { } "AllJobs": true, /api/JobService/Actions/JobService.DisableJobs POST method for JobService.DisableJobs This method disables the selected jobs. Description Disables the selected jobs.
PAGE 379
/api/JobService/Actions/JobService.RemoveJobs POST method for JobService.RemoveJobs This method deletes the selected jobs. Description Deletes the selected jobs.
PAGE 380
} } "Status": 2020, "State": "", "JobType": "", "StartTime": "", "EndTime": "" /api/JobService/Actions/JobService.RunJobs POST method for JobService.RunJobs This method runs the selected jobs. Description Runs the selected jobs.
PAGE 381
/api/JobService/Actions/JobService.StopJobs POST method for JobService.StopJobs This method stops the selected jobs. Description Stops the selected jobs.
PAGE 382
} } "State": "", "JobType": "", "StartTime": "", "EndTime": "" /api/JobService/Actions/JobService.Delete This API represents information about deleted jobs. POST method for /api/JobService/Actions/JobService.Delete This method returns information about deleted jobs. Description Returns information about deleted jobs.
PAGE 383
/api/JobService/Actions/JobService.Pause This API represents information about jobs that are stopped momentarily. POST method for /api/JobService/Actions/JobService.Pause This method returns information about jobs that are stopped momentarily. Description Returns information about jobs that are stopped momentarily.
PAGE 384
/api/JobService/Actions/JobService.ExecuteAction This API creates and runs jobs such as quick deploy, and compliance report. Create a job model payload to create and run the job to which the model is associated. POST method for /api/JobService/Actions/JobService.ExecuteAction This method returns status jobs that are performed in the system. Description Returns status of jobs that are performed in the system.
PAGE 385
11 Reset application Topics: • /api/ApplicationService/Actions/ApplicationService.ResetApplication /api/ApplicationService/Actions/ ApplicationService.ResetApplication This URI resets the application and select between resetting all data or only resetting the configuraiton. POST method for ResetApplication This method resets the application. You can either reset only the configuration or also clear all the data.
PAGE 386
12 Console version Topics: • /api/ApplicationService/Info /api/ApplicationService/Info This URI represents the product information. GET method for Info This method returns the product information. Description Returns the product information. Privilege VIEW HTTP response codes 200 Example response body { } 386 Console version "@odata.context": "/api/$metadata#ApplicationService.Info", "@odata.type": "#ApplicationService.Info", "@odata.
PAGE 387
13 Console capabilities Topics: • /api/ApplicationService/Capabilities /api/ApplicationService/Capabilities This URI represents the capabilities of the management console—OpenManage Enterprise or OME–Modular. GET method for Capabilities This method returns the capabilities of the management console—OME-Modular or OpenManage Enterprise. These two management consoles have different capabilities. Description Returns the capabilities of the management console.
PAGE 388
{ "@odata.type": "#ApplicationService.Capability", "Name": "SERVER_PORTS_NIC_TEAMING", "Description": "Capability bit to indicate that provided MX chassis supports server ports NIC teaming." }, { "@odata.type": "#ApplicationService.Capability", "Name": "OPTIMIZED_FABRIC_MANAGER_OPERATIONS", "Description": "Capability bit to indicate that provided MX chassis supports optimized fabric manager operations." } ] } Example of application capabilities of OpenManage Enterprise { "@odata.
PAGE 389
14 Search This resource enables you to search for navigation links and documents using query strings. Use the URIs in this resource to search for navigation links and documents by providing search query strings. Topics: • /api/SearchService/Actions/SearchService.Search /api/SearchService/Actions/SearchService.Search POST method for SearchService.Search This method performs a search using the query string that you provide and returns links to the corresponding navigation pages.
PAGE 390
"_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 131. Attributes Attribute name Description QueryString String to search. FilterType Indexes to be searched for the query string.
PAGE 391
15 Session Topics: • • • • • • /api/SessionService /api/SessionService/Sessions /api/SessionService/Sessions(Id) /api/SessionService/SessionConfiguration /api/SessionService/Actions/SessionService.SessionConfigurationUpdate /api/SessionService/Actions/SessionService.Logoff /api/SessionService This URI represents the collection of session services. GET method for SessionService This method returns a collection of the sessions services. Description Returns a collection of session services.
PAGE 392
Table 132. Attributes (continued) Attribute Name Description Sessions The link to the collection of active sessions. /api/SessionService/Sessions This URI represents a collection of active session services. GET method for Sessions This method returns the collection of active session service. Description Returns a collection of active session services. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(SessionService.Session)", "@odata.
PAGE 393
POST method for Sessions This method authenticates the user and establishes a session. Description Authenticates the user and establishes a session. Privilege SECURITY_SETUP HTTP response codes 200 Example request body { } Example response body { } "UserName":"root", "Password":"linux", "SessionType":"API" "Id": "7b723932-a119-4843-a5b7-7a122e4def99", "Description": "root", "Name": "API", "UserName": "root", "Password": null, "Roles": [ "ADMINISTRATOR" ], "IpAddress": "xx.xx.xx.
PAGE 394
/api/SessionService/Sessions(Id) This method represents the instance of a session. GET method for Sessions(Id) This method returns the sessions associated with the User ID. Description Returns the session associated with the user ID.
PAGE 395
HTTP response codes 204 /api/SessionService/SessionConfiguration GET method for SessionConfiguration 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. Privilege VIEW HTTP response codes 200 Example response body { "@odata.
PAGE 396
} ] } "SessionType": "Serial", "MaxSessions": 4, "SessionTimeout": 1320000, "MinSessionTimeout": 60000, "MaxSessionTimeout": 86400000, "MinSessionsAllowed": 1, "MaxSessionsAllowed": 4 /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.
PAGE 397
/api/SessionService/Actions/SessionService.Logoff This URI logs off your current session. POST method for session service log off This method log off the current session of the user. Description Logs off the current session of the user.
PAGE 398
16 APIs specific to OpenManage Enterprise – Modular Edition Topics: • • • • • • • • • • • • • • /api/ApplicationService/Settings /api/ApplicationService/Network/CurrentAddressConfiguration /api/ApplicationService/Network/AddressConfiguration /api/ApplicationService/Actions/ApplicationService.GetConfiguration /api/ApplicationService/Actions/ApplicationService.
PAGE 399
POST method for /api/ApplicationService/Settings This method returns the application service settings. Description Returns one or more application settings. You can get the name of the setting and the group, using this API. Privilege APPLIANCE_SETUP HTTP response codes 201 Example Response Body { "ConsoleSetting": [{ "Name": "WARRANTY_EXPIRY_SETTING", "DefaultValue": "90", "Value": "1", "DataType": "java.lang.
PAGE 400
"Enable": false, "EnableAutoConfiguration": true, "CurrentIPAddress": "", "CurrentGateway": "", "CurrentLinkLocalAddress": "", "UseDHCPForDNSServerNames": true, "CurrentPreferredDNSServer": "", "CurrentAlternateDNSServer": "" } }, "DnsSetting": { "DnsFQDName": "dell.example.com", "DnsDomainName": "example.com" } Table 136. Attributes Attribute name Description Ipv4Setting.Enable IPv4 network settings status. Ipv4Setting.EnableDHCP Obtain IPv4 via DHCP server status. Ipv4Setting.
PAGE 401
GET method for AddressConfiguration This method returns the network configuration. Description Returns the current network configuration. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Network.AddressConfiguration/ $entity", "@odata.type": "#Network.AddressConfiguration", "@odata.
PAGE 402
Example request body { "@odata.context": "/api/$metadata#Network.AddressConfiguration/ $entity", "@odata.type": "#Network.AddressConfiguration", "@odata.
PAGE 403
"EnableVLAN": false, "Id": 1 } }, "DnsConfiguration": { "RegisterWithDNS": false, "DnsName": "MX7000", "UseDHCPForDNSDomainName": false, "DnsDomainName": "", "Ipv4CurrentPreferredDNSServer": "192.168.1.2", "Ipv4CurrentAlternateDNSServer": "192.168.1.3", "Ipv6CurrentPreferredDNSServer": "", "Ipv6CurrentAlternateDNSServer": "", "FqdndomainName": "" }, "Delay": 0 Table 137. Attributes Attribute name Description EnableNIC Network interface controller for public networking access. Ipv4Configuration.
PAGE 404
/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.
PAGE 405
{ }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, "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.1#destinationAddress", "Value": "10.36.0.167" "Name": "RemoteSystemLog.1#Port", "Value": 514 "Name": "RemoteSystemLog.
PAGE 406
{ }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, 406 "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.2#Enable", "Value": false "Name": "SNMPAlerts.2#DestinationIP", "Value": null "Name": "SNMPAlerts.2#port", "Value": 0 "Name": "SNMPAlerts.
PAGE 407
{ }, { }, { }, { }, { }, { }, { }, { }, { "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.1#NTPServer3", "Value": null "Name": "TimeConfig.1#systemTime", "Value": "2018-09-25 08:39:07" "Name": "LocalAccessConfiguration.
PAGE 408
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 408 "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.1#Port", "Value": 161 "Name": "SNMPService.1#CommunityName", "Value": "public" "Name": "SSH.1#Enable", "Value": true "Name": "SSH.
PAGE 409
}, { }, { }, { }, { }, { }, { }, { }, { }, { "Name": "Network#SettingType", "Value": "Network" "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#UseD
PAGE 410
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "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-01PTCOME-Modular1234" "Name": "Network#GeneralSettings#UseDHCPForDomainName", "Value": true "Name": "Network#GeneralSettings#DnsDomainName", "
PAGE 411
}, { }, { }, { }, { }, { }, { "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.i3XRD7eYfKMlJOqMDe" }, { "Name": "Users.3#Name", "Value": "ravi" }, { "Name": "Users.3#Privilege", "Value": "10" }, { "Name": "Users.3#Enable", "Value": true }, { "Name": "Users.
PAGE 412
"Name": "Users.5#SHA256Password", "Value": "$2a $10$H0cK06cAnceieSNuaI3JT.TI8DfX49XkdVcNbHC4G2X92lAhCAstS" }, { "Name": "Users.5#Name", "Value": "OME-ModularMegatronTeam" }, { "Name": "Users.5#Privilege", "Value": "10" }, { "Name": "Users.5#Enable", "Value": true }, { "Name": "Users.5#objectGuid", "Value": "d22005b6-0ce5-40ed-88d0-7f7759b52f25" }, { "Name": "Users.5#Password", "Value": null }, { "Name": "Users.5#directoryType", "Value": "AD" }, { "Name": "Users.5#directoryName", "Value": "dell.
PAGE 413
{ }, { }, { }, { }, { }, { }, { }, { } } ] } ] } "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.1#CertValidationEnable", "Value": false "Name": "LDAP.1#certificateFile", "Value": "" Table 138.
PAGE 414
/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 request body 414 { "SystemConfiguration": { "Comments": [ "Export type is Normal,JSON" ], "Model": "POWEREDGE MX7000", "ServiceTag": "01PTCOME-Modular", "TimeStamp": "2018-09-25T13:39:10.933Z", "Components": [ { "FQDD": "MM.Embedded.
PAGE 415
{ }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, "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.
PAGE 416
{ }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, 416 "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.
PAGE 417
{ }, { }, { }, { }, { }, { }, { }, { "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.
PAGE 418
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 418 "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.
PAGE 419
}, { }, { }, { }, { }, { }, { }, { }, { "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"
PAGE 420
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Name": "Network#Ipv6Settings#StaticAlternateDNSServer", "Value": "" "Name": "Network#GeneralSettings#EnableNIC", "Value": true "Name": "Network#GeneralSettings#RegisterDNS", "Value": true "Name": "Network#GeneralSettings#DnsName", "Value": "MX-01PTCOME-Modular1234" "Name": "Network#GeneralSettings#UseDHCPForDomainName", "Value": true "Name": "Network#GeneralSettings#DnsDomainName", "Value": "" "Name": "Network#GeneralSettings#AutoNegotiation", "Value": tru
PAGE 421
}, { }, { }, { }, { }, { "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.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.
PAGE 422
{ }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, 422 "Name": "Users.5#Name", "Value": "OME-ModularMegatronTeam" "Name": "Users.5#Privilege", "Value": "10" "Name": "Users.5#Enable", "Value": true "Name": "Users.5#objectGuid", "Value": "d22005b6-0ce5-40ed-88d0-7f7759b52f25" "Name": "Users.5#Password", "Value": null "Name": "Users.5#directoryType", "Value": "AD" "Name": "Users.5#directoryName", "Value": "dell.com" "Name": "ActiveDirectory.1#name", "Value": "dell.
PAGE 423
{ }, { }, { }, { }, { }, { }, { } Example response body { } } ] } ] } "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.1#CertValidationEnable", "Value": false "Name": "LDAP.1#certificateFile", "Value": "" "JobId": 38758 Table 139.
PAGE 424
Brand /api/ApplicationService/Actions/ApplicationService.BrandInfo This URI represents the brand information. POST method for BrandInfo This method returns the brand information. Description Returns the brand information. Privilege VIEW HTTP response codes 200 Example response body { } "BrowserTitle": "globalNavigation.consoleBrowserTitle", "ConsoleTitle": "globalNavigation.
PAGE 425
OR { } Example response body { } "BrandType":"DEFAULT" 200 OK Multichassis management /api/ManagementDomainService This method represents the role of the chassis in a Multi-Chassis Management (MCM)domain. GET method for ManagementDomainService This method returns the role of the chassis in an MCM domain. Description Returns the role of the chassis in an MCM domain. Privilege VIEW HTTP response codes 200 Example response body Output — Standalone chassis: { "@odata.
PAGE 426
ManagementDomainService/ConfigurationTypes", "GetSyncFailureAlertTimeoutValues": { "@odata.id": "/api/ManagementDomainService/ GetSyncFailureAlertTimeoutValues" } } Output — Lead chassis: { "@odata.context": "/api/ $metadata#ManagementDomainService.ManagementDomainService", "@odata.type": "#ManagementDomainService.ManagementDomainService", "@odata.
PAGE 427
"GetSyncFailureAlertTimeoutValues": { "@odata.id": "/api/ManagementDomainService/ GetSyncFailureAlertTimeoutValues" } } Table 140. Attributes Attribute Description GroupId Unique group ID across different domains. DeviceGroupId Group configuration record ID. GroupName Name of the group. GroupDescription Description of the group. JoinApproval Join approval ● Automatic: Join requests from a standalone chassis are automatically approved.
PAGE 428
}, { }, { }, { }, { }, { } Example response body } "ConfigType": "ProxySettings", "Enabled": false "ConfigType": "TimeSettings", "Enabled": false "ConfigType": "SecuritySettings", "Enabled": false "ConfigType": "SessionConfiguration", "Enabled": false } ], "SyncFailureAlertTimeout": 30 "JobId": 36183, "Status": "Success" Request for editing a group { 428 "ConfigType": "Power", "Enabled": false Request for creating a group { Example request body "ConfigType": "LocalAccessConfiguration", "Enabled":
PAGE 429
}, { } Example response body } "JobId": 36181, "Status": "SUCCESS" Request for configuring static IPv4 on the lead chassis { } Example response body } "ConfigType": "LocalAccessConfiguration", "Enabled": false Request for editing a group { Example request body ] "Enabled": false "GroupName": "256", "GroupDescription": "", "JoinApproval": "Manual", "ConfigReplication": [ { "ConfigType": "UserAuthentication", "Enabled": false }, { "ConfigType": "NetworkServices", "Enabled": false }, { "ConfigType"
PAGE 430
"Status": "Success" } NOTE: You can use the API, /api/JobService/Jobs(JobId) for polling the job status. Table 141. Attributes Attribute Description GroupId Unique group ID across different domains. GroupName Name of the group. GroupDescription Description of the group. JoinApproval Join approval ● Automatic: Join requests from a stand-alone chassis are automatically approved. ● Manual: Join requests from a stand-alone chassis are queued on the lead for approval of the administrator.
PAGE 431
"@odata.context": "/api/ $metadata#Collection(ManagementDomainService.DiscoveredDomain)", "@odata.count": 3, "value": [ { "@odata.type": "#ManagementDomainService.DiscoveredDomain", "GroupId": "053ca12c-e181-4502-b4b5-7f5090bbf08c", "GroupName": "null", "GroupDescription": "", "PublicAddress": [ "10.35.0.
PAGE 432
Table 142. Attributes (continued) Attribute Description Address IP address of the domain. Name Name of the chassis. Description Description. 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: ● 3000 — LEAD ● 3001 — MEMBER ● 3002 — STANDALONE DomainRoleTypeValue Type of domain role.
PAGE 433
"Id": 3, "Name": "AlertDestinations", "Description": "Alert Destinations" }, { "@odata.type": "#ManagementDomainService.ConfigurationType", "@odata.id": "/api/ManagementDomainService/ConfigurationTypes(4)", "Id": 4, "Name": "LocalAccessConfiguration", "Description": "Local Access configuration" }, { "@odata.type": "#ManagementDomainService.ConfigurationType", "@odata.id": "/api/ManagementDomainService/ConfigurationTypes(5)", "Id": 5, "Name": "Power", "Description": "Power" }, { "@odata.
PAGE 434
/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 response body { "@odata.context": "$metadata#ManagementDomainService.ConfigurationType/ $entity", "@odata.
PAGE 435
HTTP response codes Example request body Example response body 200 N/A Output — Lead chassis: { "@odata.context": "/api/ $metadata#Collection(ManagementDomainService.Domain)", "@odata.count": 3, "value": [ { "@odata.type": "#ManagementDomainService.Domain", "@odata.id": "/api/ManagementDomainService/Domains(10071)", "Id": 10071, "DeviceId": 10054, "PublicAddress": [ "100.69.115.
PAGE 436
} ] } "Identifier": "75HK1S2", "DomainTypeId": 4000, "DomainTypeValue": "MSM", "DomainRoleTypeId": 3001, "DomainRoleTypeValue": "MEMBER", "Version": "1.20.00", "Local": false, "GroupId": "28bf881c-f736-440d-b327-2fb0b2d7fd55", "GroupName": "test", "BackupLead": false, "Capabilities": [ "LEADBACKUPCOMPATIBLE" ], "BackupLeadHealth": 2000 Output — Member chassis: { "@odata.context": "/api/ $metadata#Collection(ManagementDomainService.Domain)", "@odata.count": 2, "value": [ { "@odata.
PAGE 437
} ] } "BackupLeadHealth": 2000 Table 145. Attributes Attribute Description Id Record ID. DeviceId Device ID. Address IP address. Name Name of the chassis. Description Description of the chassis. Identifier Service Tag of the chassis. DomainTypeId Information for internal programmatic use. DomainTypeValue Information for internal programmatic use. DomainRoleTypeId ID of the domain role.
PAGE 438
/api/ManagementDomainService/Domains(Id) This URI represents the role of a specific chassis domain. GET method for Domains(Id) This method returns the role of a specific chassis domain. The chassis domain role is as follows: ● Chassis domain part of MCM group — LEAD or MEMBER ● Chassis domain not part of a MCM group — STANDALONE Description Returns the role of a specific chassis domain.
PAGE 439
Table 146. Attributes (continued) Attribute Description DomainRoleTypeValue Type of domain role. Possible values: ● LEAD ● MEMBER ● STANDALONE Version Version of OME–Modular. Local ● TRUE — Indicates that this domain is the local domain where the API is executed. ● FALSE — Indicates that this domain is the remote domain where the API is executed. GroupId Unique identifier of the group across different domains. GroupName Group name for the MCM domain group.
PAGE 440
Table 147. Attributes Attribute Description Id Record ID. JobId Job ID created for the operation. State Internal state of the request. Possible values: ● ● ● ● ● 1001 - Join approval is pending with the lead domain. 1002 - Join request is approved by the lead. 1004 - Onboarding is in progress. 1006 - Request is initiated to delete the member domain. 1007 - Request is in progress to delete the member domain. ● 1012 - Request to join group is initiated from the standalone chassis.
PAGE 441
Table 148. Attributes Attribute Description Id Record ID. JobId Job ID created for the operation. State Internal state of the request. Possible values: ● ● ● ● ● 1001 - Join approval is pending with the lead domain. 1002 - Join request is approved by the lead. 1004 - Onboarding is in progress. 1006 - Request is initiated to delete the member domain. 1007 - Request is in progress to delete the member domain. ● 1012 - Request to join group is initiated from the standalone chassis.
PAGE 442
} Example request body Example response body "Status": "APPROVED" Adding multiple domains to an MCM group [ { "GroupId": "be062037-30a5-4a8e-ae39-ee3bff4a8a29" } ] [ { "GroupId": "91e0b654-9de4-4a62-b5b1-c0da11d81b70" } ] Adding multiple domains to an MCM group { "JobId": 36128, "Status": "APPROVED" } Table 149. Attributes Attribute Description JobId Job ID created for the operation. Status Status of the operation. NOTE: The Status is always displayed as APPROVED.
PAGE 443
Table 150. Attributes Attribute Description GroupId Group ID of the lead domain. JobId Job ID for tracking the status of the join operation. Status Status of the join request. /api/ManagementDomainService/Actions/ ManagementDomainService.Leave POST method for ManagementDomainService.Leave This method enables a member chassis domain to leave an MCM domain group. This API is applicable only to member chassis domains. Description Enables a member chassis domain to leave an MCM domain group.
PAGE 444
{ ] Example response body { } } “Id”: 123, //Id from /api/ManagementDomainService/Domains "JobId": 36126, "Status": "SUCCESS" Table 152. Attributes Attribute Description JobId Job ID created for the operation. Status Status of the operation. NOTE: The Status is always displayed as SUCCESS. To track the status, use the JobId. /api/ManagementDomainService/Actions/ ManagementDomainService.DeleteGroup POST method for ManagementDomainService.DeleteGroup This method deletes an MCM domain group.
PAGE 445
Table 153. Attributes (continued) Attribute Description ● FAILED After the job is successful, use the JobId to poll the delete group status. If the job fails, retry the job. /api/ManagementDomainService/ GetSyncFailureAlertTimeoutValues This URI represents the possible failure alert timeout values, in minutes, to configure threshold on lead for backup sync.
PAGE 446
{ ] Example response body Example request body Example response body } "Id": 15964, "Approval":true Approving or rejecting one pending request { "Status": "SUCCESS" } Approving or rejecting multiple pending requests [ { "Id": 36197, "Approval": true }, { "Id": 36198, "Approval": false } ] Approving or rejecting multiple pending requests { "Status": "SUCCESS" } Table 154. Attributes Attribute name Description Id ID of the pending domain that requested to join the group.
PAGE 447
Example request body [{ }] Example response body { } "Id":25706 "JobId": 25857 Table 155. Attributes Attribute Description Id Member chassis identifier on the lead. JobId Job ID for tracking the status of unassigning the backup lead. NOTE: Use the API, /api/JobService/ Jobs(JobId) to poll the status of the assign JobId. /api/ManagementDomainService/Actions/ ManagementDomainService.
PAGE 448
/api/ManagementDomainService/Actions/ ManagementDomainService.UnassignBackupLead This URI unassigns the backup lead. POST method for unassigning backup lead This method unassigns the backup lead in the chassis group. Description Unassigns the backup lead. Privilege APPLIANCE_SETUP HTTP Response Code 200 Example request body [{ }] Example response body { } "Id":25706 "JobId": 25857 Table 157. Attributes Attribute Description Id Member chassis identifier on the lead.
PAGE 449
Example response body { } "JobId": 25857 Table 158. Attributes Attribute Description RollbackOnRecoverableError If this flag is passed as true, rollback is performed during promote failure and in a recoverable situation. PurgeLeadReferences If this flag is passed as true, all old lead references are purged on new lead during the promote process. JobId Job ID for tracking the status of the unassign backup lead operation.
PAGE 450
FIPS mode settings /api/ApplicationService/Security/SecurityConfiguration This URI represents the security configuration. GET method for SecurityConfiguration This method returns the security configuration. Description Returns the security configuration. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#ApplicationService.FIPSModeConfiguration/$entity", "@odata.type": "#ApplicationService.FIPSModeConfiguration", "@odata.
PAGE 451
"NodeTypes@odata.navigationLink": "/api/NetworkService/NodeTypes", "FabricHealthStatuses@odata.navigationLink": "/api/NetworkService/ FabricHealthStatuses", "FabricActivityTypes@odata.navigationLink": "/api/NetworkService/ FabricActivityTypes", "FabricActivityStatuses@odata.navigationLink": "/api/NetworkService/ FabricActivityStatuses", "PortRoles@odata.navigationLink": "/api/NetworkService/PortRoles", "PortBlinkStatuses@odata.
PAGE 452
"MessageArgs": [], "Severity": "Warning", "Resolution": "Make sure that the VLTi cables for all ISLs are connected and operational as per the selected fabric design.", "Category": "Audit", "DetailedDescription": "The SmartFabric is not healthy because one or more VLTi links are not connected.", "TimeStamp": "2020-04-20T07:30:12Z" }, { "MessageId": "NFAB0018", "Message": "The SmartFabric is not healthy because atleast one uplink must be configured.
PAGE 453
Example request body { "Name": "Fabric 1", "Description": "update 01", "OverrideLLDPConfiguration": "Disabled", "ScaleVLANProfile": "Enabled", "FabricDesignMapping": [ { "DesignNode": "Switch-A", "PhysicalNode": "CBJXLN2" }, { "DesignNode": "Switch-B", "PhysicalNode": "F13RPK2" } ], "FabricDesign": { "Name": "2xMX9116n_Fabric_Switching_Engines_in_different_chassis" } } Example for creating fabric Example response body { { } "Name": "Fabric11", "Description": "Fabric11", "OverrideLLDPConfiguration": "
PAGE 454
/api/NetworkService/FabricDesigns This URI represents the fabric designs. GET method for FabricDesigns This method returns a list of the fabric designs. Description Returns a list of fabric designs. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.FabricDesign)", "@odata.count": 3, "value": [ { "@odata.type": "#NetworkService.FabricDesign", "@odata.
PAGE 455
}, { }, { }, { }, { "DestinationInterface": "ethernet1/1/37" "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/38", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/38" "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/40", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/40" "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/39", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/39" } ], "FabricDesignNode": [ { "NodeName":
PAGE 456
{ }, { } ] } ] } "NodeName": "Switch-A", "ChassisName": "Chassis-X", "Slot": "Slot-A1", "Type": "WeaverSwitch" "NodeName": "Switch-B", "ChassisName": "Chassis-Y", "Slot": "Slot-A2", "Type": "WeaverSwitch" /api/NetworkService/Fabrics(Id) This URI represents a specific fabric in the fabric collection. GET method for Fabrics(Id) This method returns a specific fabric from the collection of fabrics. Description Returns a specific fabric.
PAGE 457
are not connected.", "MessageArgs": [], "Severity": "Warning", "Resolution": "Make sure that all the ISLs are connected as per the specification.", "Category": "Audit", "DetailedDescription": "", "TimeStamp": "2018-07-12T18:47:56Z" } ] }, "FabricDesignMapping": [ { "DesignNode": "Switch-A", "PhysicalNode": "41F2MN2" }, { "DesignNode": "Switch-B", "PhysicalNode": "41F4MN2" } ], "Switches@odata.navigationLink": "/api/NetworkService/ Fabrics('31db245a-9865-4a23-9697-4902cd2d5421')/Switches", "Servers@odata.
PAGE 458
} Example response body } ], "FabricDesign": { "Name":"2xMX9116n_Fabric_Switching_Engines_in_same_chassis " } TRUE Table 161. 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.
PAGE 459
} "NetworkLink": [ { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/37", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/37" }, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/38", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/38" }, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/40", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/40" }, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/39", "Destin
PAGE 460
{ "@odata.type": "#NetworkService.ValidationError", "@odata.
PAGE 461
"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.
PAGE 462
"Description": "Unable to validate the fabric because the design link ICL-1_FORWARD not connected as per design 2NodeHESameChassis.
PAGE 463
} ] POST method for Uplinks for a specific fabric This method creates an uplink. Description Creates an uplink. Privilege FABRIC_MANAGEMENT HTTP response code 201 Example request body { } Example response body "Name":"Uplink_Ethernet_Fabric-B", "Description":"Ethernet Uplink created from REST.", "MediaType":"Ethernet", "Ports":[ { "Id": "6ZB1XC2:ethernet1/1/41" }, { "Id": "5ZB1XC2:ethernet1/1/41" } ], "Networks":[ { "Id":95614 } ] Uplink Id Table 162.
PAGE 464
HTTP response codes Example response body 200 { "@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.
PAGE 465
Privilege FABRIC_MANAGEMENT HTTP response code 200 Example request body { "Id": "363ade54-a434-4e54-bf8e-0a2eefc5d2f7", "Name": "Ether", "Description": "Ethernet_Uplink", "MediaType": "Ethernet", "NativeVLAN": 1, "Ports": [ { "Id": "8Z3D0T2:ethernet1/1/41" }, { "Id": "D23RPK2:ethernet1/1/41" } ], "Networks": [ { "Id": 12715 }, { "Id": 12717 } ] } Example response body Example for creating MAC pools TRUE Example response body { "Name":"New Identity Pool 4", "EthernetSettings": { "Mac": { "IdentityCo
PAGE 466
} } }, "Wwpn": { "IdentityCount":85, "StartingAddress": "IAGAgICAgAA=" } Table 163. Attributes Attribute name Description ID The identifier of the target uplink. Name The target uplink name Description The target uplink description MediaType Indicates, type of uplink. For more information, see /api/ NetworkService/UplinkTypes. NativeVLAN VLAN number, user intends to configure uplink with, as untagged network.
PAGE 467
"value": [ { "@odata.type": "#NetworkService.Port", "@odata.
PAGE 468
} ] } "Description": "", "Type": "PhysicalEthernet", "MediaType": "Ethernet", "NodeServiceTag": "DPM4XC1", "PortNumber": "ethernet1/1/42", "Status": "Down", "AdminStatus": "Enabled", "CurrentSpeed": "0", "MaxSpeed": "0", "ConfiguredSpeed": "0", "OpticsType": "NotPresent", "BlinkStatus": "OFF", "Role": "Uplink" /api/NetworkService/Fabrics(Id)/Uplinks(Id)/Networks This URI represents the network details of a specific uplink in a fabric.
PAGE 469
} ] } "Type": 1, "CreatedBy": "root", "CreationTime": "2018-07-11 03:35:20.543", "UpdatedBy": null, "UpdatedTime": "2018-07-11 03:35:20.543", "InternalRefNWUUId": "4c55cc1e-d3ad-48a4-a836-5050437dbe20" /api/NetworkService/Fabrics('Id')/ NetworkService.GetApplicableUplinkNetworks This API represents uplink network information. POST method for /api/NetworkService/Fabrics('Id')/ NetworkService.GetApplicableUplinkNetworks This method returns the uplinks network information.
PAGE 470
api/NetworkService/Fabrics(arg1)/Servers This API gets details of the fabrics that are associated with servers. GET method for fabric details This method gets details of the fabrics that are associated with servers. Description Returns details of the fabrics associated with servers. Privilege VIEW HTTP response codes 200 Example response body 470 { "@odata.context": "/api/$metadata#Collection(DeviceService.Device)", "@odata.count": 2, "value": [ { "@odata.type": "#DeviceService.Device", "@odata.
PAGE 471
}, "DeviceManagement": [ { "ManagementId": 8608, "NetworkAddress": "100.69.115.234", "MacAddress": "4c:d9:8f:92:25:84", "ManagementType": 2, "InstrumentationName": "", "DnsName": "iDRAC-8YQ1B03", "ManagementProfile": [ { "ManagementProfileId": 8608, "ProfileId": "WSMAN_OOB", "ManagementId": 8608, "AgentName": "iDRAC", "Version": "4.00.00.00", "ManagementURL": "https:// 100.69.115.234:443", "HasCreds": 0, "Status": 1000, "StatusDateTime": "2020-04-25 13:00:51.
PAGE 472
"SystemUpTime": { "@odata.id": "/api/DeviceService/Devices(10056)/ SystemUpTime" }, "BlinkStatus": { "@odata.id": "/api/DeviceService/Devices(10056)/ BlinkStatus" }, "PowerUsageByDevice@odata.navigationLink": "/api/ DeviceService/Devices(10056)/PowerUsageByDevice", "DeviceBladeSlots@odata.navigationLink": "/api/DeviceService/ Devices(10056)/DeviceBladeSlots", "GraphicInfo": { "@odata.id": "/api/DeviceService/Devices(10056)/ GraphicInfo" }, "DeployRequired": { "@odata.
PAGE 473
"DeviceManagement": [ { "ManagementId": 8610, "NetworkAddress": "100.69.115.144", "MacAddress": "d0:94:66:87:87:b5", "ManagementType": 2, "InstrumentationName": "", "DnsName": "iDRAC-77BK1S2", "ManagementProfile": [ { "ManagementProfileId": 8610, "ProfileId": "WSMAN_OOB", "ManagementId": 8610, "AgentName": "iDRAC", "Version": "4.20.20.20", "ManagementURL": "https:// 100.69.115.144:443", "HasCreds": 0, "Status": 1000, "StatusDateTime": "2020-04-25 13:00:54.
PAGE 474
"@odata.id": "/api/DeviceService/Devices(10055)/ SystemUpTime" }, "BlinkStatus": { "@odata.id": "/api/DeviceService/Devices(10055)/ BlinkStatus" }, "PowerUsageByDevice@odata.navigationLink": "/api/ DeviceService/Devices(10055)/PowerUsageByDevice", "DeviceBladeSlots@odata.navigationLink": "/api/DeviceService/ Devices(10055)/DeviceBladeSlots", "GraphicInfo": { "@odata.id": "/api/DeviceService/Devices(10055)/ GraphicInfo" }, "DeployRequired": { "@odata.
PAGE 475
}, { }, { }, { }, { ] } "Id": "1ZB1XC2:ethernet1/1/43", "Name": "", "Description": "", "PortNumber": "1ZB1XC2:ethernet1/1/43" "Id": "1ZB1XC2:ethernet1/1/37", "Name": "", "Description": "", "PortNumber": "1ZB1XC2:ethernet1/1/37" "Id": "1ZB1XC2:ethernet1/1/36", "Name": "", "Description": "", "PortNumber": "1ZB1XC2:ethernet1/1/36" "Id": "1ZB1XC2:ethernet1/1/35", "Name": "", "Description": "", "PortNumber": "1ZB1XC2:ethernet1/1/35" "NodeServiceTag": "DPM4XC1", "Ports": [ { "Id": "DPM4XC1:ethernet1/1/37",
PAGE 476
}, { }, { } ] } ] } "Id": "DPM4XC1:ethernet1/1/38", "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/38" "Id": "DPM4XC1:ethernet1/1/36", "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/36" "Id": "DPM4XC1:ethernet1/1/42", "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/42" Table 164. Attributes Attribute name Description UplinkType ID of the uplink type. For more information, see /api/ NetworkService/UplinkTypes).
PAGE 477
Table 165. Attributes Attribute name Description ServersServiceTag This takes list of service tags of servers as input for targeted servers in the system. ServerProfile Container object that carries one or more server interface profiles as list. ServerInterfaceProfiles Details of the server profile. NativeVLAN A VLAN number that you can configure as an untagged network on the targeted server NIC interface.
PAGE 478
{ "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/HardwareLogs" } ], "SubSystemHealth": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/SubSystemHealth" } ], "RecentActivity": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/RecentActivity" } ], "InventoryTypes": { "@odata.
PAGE 479
/api/NetworkService/Fabrics(Id)/Servers This URI represents the servers of a specific fabric. GET method for Servers for a specific fabric This method returns the details of the severs of a specific fabric. Description Returns the servers that are part of a specific fabric. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 1, "value": [ { "@odata.
PAGE 480
"@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/RecentActivity" } ], "InventoryTypes": { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/InventoryTypes" }, "Settings": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/Settings" } ] } ] } /api/NetworkService/Fabrics(Id)/ISLLinks This URI represents the ISL links of a specific fabric.
PAGE 481
Fabrics('31db245a-9865-4a23-9697-4902cd2d5421')/ ISLLinks('41F4MN2%3Aethernet1%2F1%2F10%3A1')", "Id": "41F4MN2:ethernet1/1/10:1", "Source": { "ChassisName": "Chassis-19", "ChassisServiceTag": "GYFJ9N2", "Slot": "IOM-B2", "PortNumber": "41F4MN2:ethernet1/1/10:1", "PortName": null }, "Destination": { "ChassisName": "Chassis-19", "ChassisServiceTag": "GYFJ9N2", "Slot": "IOM-B1", "PortNumber": "41F2MN2:ethernet1/1/10:1", "PortName": null } }, { "@odata.type": "#NetworkService.ISLLink", "@odata.
PAGE 482
/api/NetworkService/Fabrics(Id)/Topology This URI represents the topology of the nodes and switches. GET method for Topology for a fabric This method returns the topology of all the nodes and switches in a fabric. Description Returns a topology of the nodes and switches. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#NetworkService.Topology/$entity", "@odata.type": "#NetworkService.Topology", "@odata.
PAGE 483
}, "DeviceSpecificData": { "@odata.id": null }, "DeviceManagement": [], "InventoryDetails": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/InventoryDetails" } ], "HardwareLogs": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/HardwareLogs" } ], "SubSystemHealth": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/SubSystemHealth" } ], "RecentActivity": [ { "@odata.
PAGE 484
Example response body { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 1, "value": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)", "Id": 0, "Type": 1000, "Identifier": "7IUJMNBGJ", "ChassisServiceTag": "9FHJSUIK1", "Model": "ServerModel1", "PowerState": 2, "Status": 3000, "AssetTag": "7IUJMNBGJ", "SystemId": 0, "DeviceName": "ServerNode", "LastInventoryTime": null, "DeviceCapabilities": [], "DeviceSubscription": { "@odata.
PAGE 485
} ] /api/NetworkService/Actions/NetworkService.RemoveFabrics POST method for NetworkService.RemoveFabrics This method deletes multiple fabrics. Description Deletes multiple fabrics. Privilege FABRIC_MANAGEMENT HTTP response codes 204 Example request body { } Example response body { } "FabricIds":["Fabric-1","Fabric-2'] "Fabric-1": true, "Fabric-2": true /api/NetworkService/Actions/NetworkService.RemoveUplinks POST method for NetworkService.
PAGE 486
/api/NetworkService/Fabrics(Id)/Topology/Nodes(Id)/ChildNodes This URI represents the child nodes for a specific node of a fabric topology. GET method for ChildNodes This method returns the child nodes for a specific node of a fabric topology. Description Returns the child nodes. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Collection(NetworkService.Node)", "@odata.count": 2, "value": [ { "@odata.type": "#NetworkService.Node", "@odata.
PAGE 487
"ChildNodes@odata.navigationLink": "/api/NetworkService/ Fabrics('43be623e-0d74-4f6d-87b3-3ea40bf6372d')/Topology/Nodes('Switch %3ADPM4XC1')/ChildNodes" } ] } /api/NetworkService/FabricDesigns(Id)/ NetworkService.GetApplicableNodes POST method for GetApplicableNodes This method returns the available nodes applicable to a fabric design. Description Returns applicable nodes.
PAGE 488
/api/NetworkService/UplinkTypes This URI represents the uplink types. GET method for UplinkTypes This method returns the uplink types. Description Returns the uplink types. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.UplinkType)", "@odata.count": 4, "value": [ { "@odata.type": "#NetworkService.UplinkType", "Id": 1, "Name": "Ethernet" }, { "@odata.type": "#NetworkService.UplinkType", "Id": 2, "Name": "FCoE" }, { "@odata.
PAGE 489
} "value": [ { "@odata.type": "#NetworkService.NodeType", "Id": 1, "Name": "CHASSIS" }, { "@odata.type": "#NetworkService.NodeType", "Id": 2, "Name": "NWIOM" }, { "@odata.type": "#NetworkService.NodeType", "Id": 3, "Name": "PORT" } ] /api/NetworkService/FabricActivityTypes This URI represents the activities that can be performed using fabrics. GET method for FabricActivityTypes This method returns the list of activities that can be performed using fabrics.
PAGE 490
} ] } /api/NetworkService/FabricActivityStatuses This URI represents the possible status values of the fabric activities. GET method for FabricActivityStatuses This method returns the possible status values of the fabric activities or jobs. Description Returns the possible status values of fabric activities or jobs. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.
PAGE 491
{ }, { }, { }, { } ] } "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2100", "Name": "Aborted" "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2101", "Name": "Paused" "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2102", "Name": "Stopped" "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2103", "Name": "Canceled" /api/NetworkService/FabricHealthStatuses This URI represents the possible health states of the fabric.
PAGE 492
} ] } "@odata.type": "#NetworkService.EnumerationEntry", "Id": "5000", "Name": "NOSTATUS" /api/NetworkService/MultiChassisDomain GET method for MultiChassisDomain This method provides access to the multi-chassis topology and validation errors. Description Provides access to the multi-chassis topology and validation errors. Privilege VIEW HTTP response codes 200 Example response body { "@odata.id": "/api/NetworkService/MultiChassisDomain", "Topology": { "@odata.
PAGE 493
/api/NetworkService/MultiChassisDomain/Topology/Nodes This URI represents all the nodes in an MCM group. GET method for Nodes in an MCM group This method returns the details of all the nodes in an MCM group. Description Returns the list of nodes in an MCM group and their details. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Collection(NetworkService.Node)", "@odata.count": 2, "value": [ { "@odata.type": "#NetworkService.Node", "@odata.
PAGE 494
/api/NetworkService/MultiChassisDomain/Topology/Nodes(Id) This URI represents a chassis node in an MCM group. GET method for Nodes(Id) in an MCM group This method returns the details of a chassis node in an MCM group. Description Returns the details of a chassis node in an MCM group. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#NetworkService.Node/$entity", "@odata.type": "#NetworkService.Node", "@odata.
PAGE 495
{ "@odata.type": "#NetworkService.Node", "@odata.id": "/api/NetworkService/MultiChassisDomain/Topology/ Nodes('Switch%3A1ZB1XC2')", "Id": "Switch:1ZB1XC2", "Type": "NETWORK_IOM", "ParentNodeId": "SKY00201234567890123456789012345", "Location": "IOM-B1", "NodeInformation": { "@odata.type": "#NetworkService.
PAGE 496
HTTP response codes Example response body 200 { "@odata.context": "/api/ $metadata#Collection(NetworkService.ValidationError)", "@odata.count": 5, "value": [ { "@odata.type": "#NetworkService.ValidationError", "@odata.
PAGE 497
chassis", "Timestamp": "1531280042" }, { "@odata.type": "#NetworkService.ValidationError", "@odata.
PAGE 498
ValidationErrors('43be623e-0d74-4f6d-87b3-3ea40bf6372d-ISL%5BICL-1_REVERSE%5D-NotFound-Issue')", "Id": "43be623e-0d74-4f6d-87b3-3ea40bf6372d-ISL-[ICL-1_REVERSE]NotFound-Issue", "MessageId": "NFAB0012", "Category": "FabricError", "SubCategory": "ISLError", "Severity": "Severity1", "ChassisName": "MX-SKY00201234567890123456789012345", "ChassisServiceTag": "SKY00201234567890123456789012345", "Description": "Unable to validate the fabric because the design link ICL-1_REVERSE not connected as per design 2NodeHES
PAGE 499
} ] } "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Unknown", "Name": "Unknown" /api/NetworkService/PortStatuses This URI represents the possible statuses of the ports. GET method for PortStatuses This method returns the possible statuses of a port. Description Returns the possible statuses of a port. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.count": 3, "value": [ { "@odata.
PAGE 500
Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.count": 0, "value":[ ] } /api/NetworkService/PortRoles This URI represents the possible roles of the ports. GET method for PortRoles This method returns the possible roles of a port. Description Returns the possible statuses of a port. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.
PAGE 501
api/NetworkService/ServerProfileBondingTechnologies This URI represents the server bonding technologies. GET method for server bonding technologies This method gets all applicable server bonding technologies. Description Gets all applicable server bonding technologies. Returns and empty list if the IOM containing the Fabric Manager. Privilege VIEW HTTP Response Code Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.
PAGE 502
"ServerServiceTag": "8ZJC0T2", "ServerInterfaceProfiles@odata.navigationLink": "/api/NetworkService/ ServerProfiles('8ZJC0T2')/ServerInterfaceProfiles" }, { "@odata.type": "#NetworkService.ServerProfile", "@odata.id": "/api/NetworkService/ServerProfiles('FFN70T2')", "Id": "FFN70T2", "ServerServiceTag": "FFN70T2", "ServerInterfaceProfiles@odata.navigationLink": "/api/NetworkService/ ServerProfiles('FFN70T2')/ServerInterfaceProfiles" }, { "@odata.type": "#NetworkService.ServerProfile", "@odata.
PAGE 503
"Id": "5099PH2", "ServerServiceTag": "5099PH2", "BondingTechnology": "LACP", "ServerInterfaceProfiles@odata.navigationLink": "/api/NetworkService/ ServerProfiles('5099PH2')/ServerInterfaceProfiles" } /api/NetworkService /ServerProfiles(arg1) This URI is used to update the service tag of server profiles in the Fabric Manager. GET method for updating server profile IDs This method returns the service tag of the server profile. Description Returns the service tag of the server profile in the Fabric Manager.
PAGE 504
} Example response body "ServerInterfaceProfiles": [{ "Id": "NIC.Mezzanine.1A-1-1", "NicBonded": false, "NativeVLAN": 2 }, { "Id": "NIC.Mezzanine.1A-2-1", "NativeVLAN": 1, "NicBonded": false, "Networks": [{ "Id": 10111 }] }] true Table 167. Attributes Attribute Description Id Server profile identifier. ServerServiceTag Service tag of the server. ServerInterfaceProfiles Sub payload that takes information that is associated with a server NIC.
PAGE 505
Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.ServerInterfaceProfile)", "@odata.count": 2, "value": [ { "@odata.type": "#NetworkService.ServerInterfaceProfile", "@odata.id": "/api/NetworkService/ServerProfiles('PFSTN16')/ ServerInterfaceProfiles('NIC.Mezzanine.1A-1-1')", "Id": "NIC.Mezzanine.1A-1-1", "OnboardedPort": "GQ61XC2:ethernet1/1/4", "NativeVLAN": 18, "Networks@odata.count": 2, "Networks": [ { "@odata.
PAGE 506
/api/NetworkService /ServerProfiles(arg1)/ ServerInterfaceProfiles(arg2) This URI returns the server profile ID of a server profile in the Fabric Manager. GET method for server interface profile IDs This method returns server interface profile IDs. Description Returns server interface profile ID of a server profile in the Fabric Manager. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#NetworkService.ServerInterfaceProfile/$entity", "@odata.
PAGE 507
} "InternalRefNWUUId": "991f2843-376e-49f3-a407-e5118f1d85ba" /api/NetworkService /ServerProfiles(arg1)/ ServerInterfaceProfiles(arg2)/Networks This URI returns tagged VLANs that are configured for server profiles. GET method for tagged VLANs configured for server interface profiles This method returns all tagged VLANs of a server interface profile. Description Returns all tagged VLANs that were configured for a specific server interface profile in the Fabric Manager.
PAGE 508
api/NetworkService/ServerProfiles(Id)/ServerInterfaceProfiles This URI gets a list of server interface profiles by server profile IDs. GET method for server interface profiles This method gets the server interface profiles by server profile IDs. Description Privilege VIEW HTTP Response Code Response /api/NetworkService/Actions/ NetworkService.ApplyServersInterfaceProfiles This URI updates one or more server profile IDs at a time. You can also use this URI to set multiple server profiles at a time.
PAGE 509
Table 169. Attributes Attribute Description JobId ID of the job that is created as part of the request. You can track the progress of the request using the Job ID. BondingTechnology Indicates the NIC bonding technology that is configured for the server profile. Enables the NIC teaming type that you want to configure for a profile. The supported options are: ● LACP ● Others ● NoTeaming NicBonded Indicates if the given NIC port participates in the NIC teaming. It is a binary attribute.
PAGE 510
Table 170. Attributes Attribute Description JobId ID of the job that is created as part of the request. You can track the progress of the request using the Job ID. BondingTechnology Indicates the NIC bonding technology that is configured for the server profile. Enables the NIC teaming type that you want to configure for a profile. The supported options are: ● LACP ● Others ● NoTeaming NicBonded Indicates if the given NIC port participates in the NIC teaming. It is a binary attribute.
PAGE 511
/api/NetworkService/Actions/ NetworkService.DeleteServerNetworks This API enables you to delete network profiles from an existing interface profile for one or many targeted servers. POST method for deleting server networks This method enables you to delete network profiles from an existing interface profile for one or many targeted servers. To run this API, you must have a server profile with NICs that were deployed using the server deployment process, on the system.
PAGE 512
{ }, { }, { }, { } ] } "@odata.type": "#NetworkService.FeatureCapability", "Name": "ServerBondingConfiguration" "@odata.type": "#NetworkService.FeatureCapability", "Name": "PortVLANConfiguration" "@odata.type": "#NetworkService.FeatureCapability", "Name": "FabricLLDPConfiguration" "@odata.type": "#NetworkService.FeatureCapability", "Name": "FCoEUplinkUntaggedVlanConfiguration" Port configuration in Fabrics /api/JobService/Jobs This URI enables you to configure the ports in fabrics.
PAGE 513
] } "TargetType": { "Id":4000, "Name":"DEVICE" } POST method for enabling or disabling auto-negotiation This method enables or disables auto-negotiation. Description Enables or disables auto-negotiation.
PAGE 514
Example request body "Params": [ { "Key":"operationName", "Value":"CONFIGURE_PORT_NAME_DESCRIPTION" }, { "Key":"interfaceId", "Value":"GF86XC2:1/1/9" }, { "Key":"name", "Value":"Port A" }, { "Key":"description", "Value":"This is Port A." } ], "Targets": [ { "Id":2664, "Data":"", "TargetType": { "Id":4000, "Name":"DEVICE" } } ] POST method for configuration port speed or breakout This method configures the port speed or breakout. Description Configures the port speed or breakout.
PAGE 515
}, { } "Value": "D23RPK2:port-group1/1/16" "Key": "operationName", "Value": "CONFIGURE_PORT_BREAK_OUT" } ], "JobType": { "@odata.type": "#JobService.JobType", "Id": 3, "Name": "DeviceAction_Task", "Internal": false } Table 171. 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.
PAGE 516
{ }, { } "Key":"assignmentMode", "Value":"1" "Key":"serverSlots", "Value": } ], "Targets": [ { "Id":, "Data":"", "TargetType": { "Id":1000, "Name":"DEVICE" } } ] Clear enclosure assignment POST method for clearing enclosure assignment Description Creates a job to clear the storage assignments in Enclosure Assigned mode.
PAGE 517
} Assign drives POST method for drive assignment Description Creates a job to assign individual storage drives to server slots.
PAGE 518
HTTP response codes Example request body 201 { } "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":
PAGE 519
} } "Value": "FORCE_ACTIVE" ], "Targets": [ { "Id":, "Data":"", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ] Clear configuration on SAS IOM POST method for clearing SAS IOM configuration Description Creates a job to clear the configuration on SAS IOM.
PAGE 520
Extract SAS IOM logs to NFS share POST method for exporting SAS IOM logs to NFS share Description Creates a job to extract logs from SAS IOM to a NFS share. Privilege STORAGE_MANAGEMENT HTTP response codes 201 Example request body { } "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.
PAGE 521
Example request body { } "Id": 0, "JobName": "Extract Log", "JobDescription": "Extract device log to CIFS location", "Schedule": "startnow", "State": "Enabled", "JobType": { "Id": 18, "Name": "DebugLogs_Task" }, "Targets": [ { "Id": e.g: 2614, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" }, { "Key": "shareAddress", "Value": e.g: "100.100.100.
PAGE 522
Quick Deploy /api/JobService/Jobs This URI represents Quick-Deploy jobs. POST method for Quick-Deploy Jobs This method creates a Quick-Deploy job. Description Creates a Quick-Deploy job.
PAGE 523
}, { }, { "Value":"0" "Key":"gatewayV6", "Value":"255.255.255.0" "Key":"SlotId=1", "Value":"SlotSelected=true;SlotType=3000;IPV4Address=10.27.0.1;IPV6Address=ax0" }, { "Key":"SlotId=2", "Value":"SlotSelected=true;SlotType=2000;IPV4Address=10.35.0.
PAGE 524
}, { }, { "Key": "gatewayV6", "Value": "255.255.255.0" "Key": "SlotId=1", "Value": "SlotSelected=true;SlotType=3000;IPV4Address=10.27.0.1;IPV6Address=ax0" }, { "Key": "SlotId=2", "Value": "SlotSelected=true;SlotType=2000;IPV4Address=10.35.0.25;IPV6Address=" } ] } Table 172. Attributes Attribute name Description Id ID of job. The default ID for POST is 0. JobName Name of the Quick-Deploy Job. JobDescription Description of the Quick-Deploy Job. Schedule The schedule to start the Job.
PAGE 525
Table 172. Attributes (continued) Attribute name Description ● SlotSelected=true or false. Indicates if the slot is selected for applying Quick Deploy. ● SlotType = The type of slot. ● Sled type is 2000. ● IPV4Address = IPV4 address to be set at slot level. ● PV6Address = IPV6 address to be set at slot level.
PAGE 526
PUT method for server profiles This method updates the server profile by ID. To run /api/NetworkService /ServerProfiles(arg1), you must have an existing server profile that is deployed on the system using the server deployment process. Description Updates the server profile. Privilege FABRIC_MANAGEMENT HTTP Response Code 201 Example request body { } Example response body "Id": "PFSTN16", "ServerServiceTag":"PFSTN16", "ServerInterfaceProfiles": [{ "Id": "NIC.Mezzanine.
PAGE 527
/api/NetworkService /ServerProfiles(arg1)/ ServerInterfaceProfiles This URI represents the server interface profiles information. GET method for Server Interface profiles This method returns all server interface profiles that are configured for a server on the Fabric Manager. Description Returns all server interface profiles that are configured for a server profile. Privilege VIEW HTTP Response Code 200 Example response body { "@odata.context": "/api/ $metadata#Collection(NetworkService.
PAGE 528
Table 175. Attributes Attribute Description Id NIC profile identifier. OnboardedPort IOM port that connected to the onboarded NIC. NativeVLAN Untagged VLAN configured for the NIC. /api/NetworkService /ServerProfiles(arg1)/ ServerInterfaceProfiles(arg2) This URI represents the server interface profiles information that is configured for a server profile on the Fabric Manager. GET method for NetworkService.
PAGE 529
"value": [ { "@odata.type": "#NetworkConfigurationService.Network", "@odata.id": "/api/NetworkService/ServerProfiles('PFSTN16')/ ServerInterfaceProfiles('NIC.Mezzanine.1A-1-1')/Networks(25076)", "Id": 25076, "Name": "10", "Description": "10", "VlanMaximum": 10, "VlanMinimum": 10, "Type": 1, "CreatedBy": "system", "CreationTime": "1970-01-31 00:08:21.946", "UpdatedBy": null, "UpdatedTime": "1970-01-31 00:08:21.946", "InternalRefNWUUId": "991f2843-376e-49f3-a407-e5118f1d85ba" }, { "@odata.
PAGE 530
} "CreatedBy": "system", "CreationTime": "1970-01-31 00:08:21.946", "UpdatedBy": null, "UpdatedTime": "1970-01-31 00:08:21.946", "InternalRefNWUUId": "991f2843-376e-49f3-a407-e5118f1d85ba" /api/NetworkService/Actions/ NetworkService.ApplyServersInterfaceProfiles This URI performs bulk update on one or more server profiles simultaneously. To run this URI, you must have a server profile that is deployed using the server deployment process, on the system.
PAGE 531
Template Service /api/TemplateService/Profiles This URI represents the profiles. NOTE: This API is not available in OpenManage Enterprise from version 3.4. GET method for Profiles This method returns the list of available profiles. Description Returns list of profiles. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Collection(TemplateService.Profile)", "@odata.count": 12, "value": [ {"@odata.type": "#TemplateService.Profile", "@odata.
PAGE 532
GET method for Profiles(Id) This method returns the details of a specific profile. Description Returns details of a specific profile. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#TemplateService.Profile/$entity", "@odata.type": "#TemplateService.Profile", "@odata.
PAGE 533
{ }, { }, { }, { }, { } ] } "@odata.type": "#TemplateService.ProfileState", "Id": 4, "Name": "DeploymentCompletedWithErrors" "@odata.type": "#TemplateService.ProfileState", "Id": 5, "Name": "DeploymentFailedOnNoTargetAvailable" "@odata.type": "#TemplateService.ProfileState", "Id": 10, "Name": "DeployedSuccessfully" "@odata.type": "#TemplateService.ProfileState", "Id": 11, "Name": "DeployedIOSuccessfully" "@odata.type": "#TemplateService.
PAGE 534
} ] } "@odata.type": "#TemplateService.ProfileUsage", "Id": 4, "Name": "ServiceTag" /api/TemplateService/Actions/TemplateService.AttachProfile This API represents information about server profiles that are created from templates. NOTE: This API is not available in OpenManage Enterprise from version 3.4. POST method for attaching profiles This method returns information about server profiles that are created from templates.
PAGE 535
POST method for /api/TemplateService/Actions/ TemplateService.AssociateProfile This method returns information about associated server profiles. Description Returns information about associated server profiles. Privilege TEMPLATE_MANAGEMENT HTTP response code 201 Example response body { } "SourceDeviceEntityId":1234, "DestinationSlotEntityId":1234 /api/TemplateService/Actions/TemplateService.UpdateProfile This API updates device-specific attributes in server profiles.
PAGE 536
POST method for migrating profiles This method migrates server profiles from one server to another. The system unassigns the identity from the server before the migration. Description Migrates server profiles from one server to another. The system unassigns the identity from the server before the migration.
PAGE 537
17 APIs specific to OpenManage Enterprise Topics: • • • • • • • • • • • • • • • • • • Application settings Console update Mobile Console Preferences Alerts Incoming Alerts Warranty Network Configuration Configuration compliance Troubleshoot service Query support service Groups service Profiles Devices Auto deploy Monitor Plugin Manager Power Metrics Application settings Console update /api/JobService/Jobs This URI updates the OpenManage Enterprise appliance.
PAGE 538
} "Name":"ConsoleUpdateExecution_Task" }, "Params": [ { "Key":"connectionProfile", "Value":"0" } ], "Targets": [ { "Id":500, "Data":"", "TargetType": { "Id":6000, "Name":"GROUP" } } ] /api/ConsoleUpdateService/Updates?$filter= Auto eq true This URI represents the update job status of the OpenManage Enterprise appliance. GET method for Updates?$filter= Auto eq true This method returns the update job status of OpenManage Enterprise. Description Returns the update job status of OpenManage Enterprise.
PAGE 539
GET method for UpdateBundleInfo This method returns the job status of the downloaded console update bundle of the OpenManage Enterprise appliance. Description Returns the update job status of the downloaded console update bundle of the OpenManage Enterprise appliance. Privilege VIEW HTTP response code 200 /api/ConsoleUpdateService/Actions/ ConsoleUpdateService.DeleteUpgradeBundle This URL deletes the downloaded console update bundle. NOTE: This API is available in OpenManage Enterprise 3.3.
PAGE 540
Mobile /api/AlertService/MobileSubscriptions This URI returns all mobile subscriptions. GET method for MobileSubscriptions This method returns all the mobile subscriptions. Description Returns all the mobile subscriptions. Privilege VIEW HTTP response codes 200 Example Response Body { "@odata.context": "$metadata#Collection(AlertService.MobileSubscription)", "@odata.count": 1, "value": [ { "@odata.
PAGE 541
Example Response Body { "@odata.context": "$metadata#AlertService.SubscriptionNotificationService/$entity", "@odata.id": "/api/AlertService/SubscriptionNotificationService", "Id": 1, "Status": 2, "Enabled": false, "DateLastRegistration": "1970-01-01 00:00:00.0", "StatusMessage": "The notification service is disabled or is initializing.", "Token": "", "URL": null, "DateLastCommFailure": "2017-08-08 19:50:00.087", "CommFailuresBackoff": "2017-08-08 19:50:00.087" } /api/AlertService/Actions/ AlertService.
PAGE 542
HTTP response codes Example Request Body 200 ["7cb19d45-cae5-4eesdf6-sdasdfsaaasd02daf-asd8aasd5fcefsdf00a85"] /api/AlertService/Actions/ AlertService.EnableSubscriptionNotificationService This URI enables the mobile subscription notifications. POST method for AlertService.EnableSubscriptionNotificationService This method enables notifications of mobile subscriptions. Description Enables notifications of mobile subscriptions.
PAGE 543
"SeverityType": 2, "SeverityName": "Info", "AlertDeviceId": 0, "AlertDeviceName": "10.210.137.100", "AlertDeviceType": 0, "AlertDeviceIpAddress": "xx.xx.xx.xx", "AlertDeviceMacAddress": null, "AlertDeviceIdentifier": null, "AlertDeviceAssetTag": null, "DefinitionId": -126170178, "CatalogName": "OMSA", "CategoryId": 1000, "CategoryName": "System Health", "SubCategoryId": 61, "SubCategoryName": "Redundancy", "StatusType": 2000, "StatusName": "Not-Acknowledged", "TimeStamp": "2018-09-10 17:45:46.
PAGE 544
"ConsoleSetting": [ { "Name": "DEVICE_PREFERRED_NAME", "DefaultValue": "SYSTEM_NAME", "Value": "PREFER_NETBIOS,PREFER_IDRAC_SYSTEM_HOSTNAME", "DataType": "", "GroupName": "" }, { "Name": "INVALID_DEVICE_HOSTNAME", "Value": "localhost,localhost.
PAGE 545
/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 Request Body { "ConsoleSetting": [{ "Name": "REPORTS_MAX_RESULTS_LIMIT", "Value": "0", "DataType": "java.lang.Integer", "GroupName": "" } ] } /api/ApplicationService/Settings POST method for ReportSettings Description Configures the maximum limit for the reports.
PAGE 546
{ } ] } "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.
PAGE 547
MX7000 Onboarding preferences to enable the Receive Chassis category alerts option Example Request Body MX7000 Onboarding preferences to enable Receive 'Chassis' category alerts option { "consoleSetting": [ { "name":"MX7000_ONBOARDING_PREF","defaultValue":"","value":"chassis", "dataType":"java.lang.String","groupName":"" } ] } Alerts https:///api/ApplicationService/Settings POST method for Alert Display settings Description Configures the alerts to be displayed on the alerts log page.
PAGE 548
} "UseSSL": true, "Credential": { "User": "root", "Password": "calvin" } https:///api/AlertService/AlertDestinations/Actions/ AlertDestinations.ApplySNMPConfig POST method for AlertDestinations.ApplySNMPConfig Description Configures the SNMP server for alerts. Privilege MONITORING_SETUP HTTP response codes 200 Example Request Body [ { }, { }, { }, { ] 548 } "Id": 1, "Enabled": true, "DestinationAddress": "10.32.19.
PAGE 549
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 Request Body [ { }, { }, { }, { ] } "Id": 1, "Enabled": true, "DestinationAddress": "100.69.123.
PAGE 550
} 550 "JobName": "SNMP Listener Configuration", "JobDescription": "SNMP Listener Task created from Alert Settings", "Schedule": "startnow", "State": "Enabled", "JobType": { "Id": 9, "Name": "ListenerConfiguration_Task" }, "Params": [ { "JobId": 0, "Key": "snmpCredentials", "Value": { "securityName": "root", "authenticationProtocol": "NONE", "authenticationPassphrase": "", "privacyProtocol": "NONE", "privacyPassphrase": "", "localizationEngineID": null, "community": "lex", "port": 162, "enableV3": true, "e
PAGE 551
Warranty https:///api/ApplicationService/Settings POST method for Warranty settings Description Creates the warranty settings. Privilege APPLIANCE_SETUP Example Request Body { "ConsoleSetting": [ { "Name": "WARRANTY_SCOREBOARD", "DefaultValue": "false", "Value": "true", "DataType": "java.lang.Boolean", "GroupName": "WARRANTY_SCOREBOARD" } ] } Network Configuration /api/ApplicationService/Network/AdapterConfigurations This URL returns all the network adapter information.
PAGE 552
"StaticSubnetMask": "", "StaticGateway": "", "UseDHCPForDNSServerNames": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "Ipv6Configuration": { "Enable": false, "EnableAutoConfiguration": false, "StaticIPAddress": "", "StaticPrefixLength": 0, "StaticGateway": "", "UseDHCPForDNSServerNames": false, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "ManagementVLAN": { "EnableVLAN": false, "Id": 0 }, "DnsConfiguration": { "RegisterWithDNS": false, "DnsName": "", "UseDHC
PAGE 553
"EnableNIC": true, "Ipv4Configuration": { "Enable": false, "EnableDHCP": false, "StaticIPAddress": "", "StaticSubnetMask": "", "StaticGateway": "", "UseDHCPForDNSServerNames": false, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "Ipv6Configuration": { "Enable": true, "EnableAutoConfiguration": true, "StaticIPAddress": "", "StaticPrefixLength": 0, "StaticGateway": "", "UseDHCPForDNSServerNames": false, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "ManagementVLAN": { "
PAGE 554
/api/ApplicationService/Network/AdapterConfigurations('ens33') This URL returns the network adapter information that is based on the interface name. NOTE: The interface name of the network adapter in an appliance varies based on the hypervisor. GET method for AdapterConfigurations('ens33') This URL returns the network adapter information that is based on the interface name. Description This method returns the network adapter information that is based on the interface name.
PAGE 555
"CurrentSubnetMask": "255.255.248.0", "CurrentGateway": "10.255.0.1", "UseDHCPForDNSServerNames": true, "Ipv4Dns": [ "XX.XX.X.X", "XX.X.X.
PAGE 556
"StaticPrefixLength": 0, "StaticGateway": "", "UseDHCPForDNSServerNames": false, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" } }, "ManagementVLAN": { "EnableVLAN": false, "Id": 0 }, "DnsConfiguration": { "RegisterWithDNS": false, "DnsName": "", "UseDHCPForDNSDomainName": false, "DnsDomainName": "", "FqdndomainName": "", "Ipv4CurrentPreferredDNSServer": "", "Ipv4CurrentAlternateDNSServer": "", "Ipv6CurrentPreferredDNSServer": "", "Ipv6CurrentAlternateDNSServer": "" }, "Delay": 0, "Primar
PAGE 557
\":\"\",\"ipv6CurrentAlternateDNSServer\":\"\",\"fqdndomainName \":\"\"},\"currentSettings\":{\"ipv4Address\":[],\"ipv4Gateway \":\"\",\"ipv4Dns\":[],\"ipv4Domain\":\"\",\"ipv6Address\": [],\"ipv6LinkLocalAddress\":\"\",\"ipv6Gateway\":\"\",\"ipv6Dns\": [],\"ipv6Domain\":\"\"},\"delay\":0,\"primaryInterface \":false,\"modifiedConfigs\":{}}" } ], "Visible": true, "Editable": true, "Builtin": false } Example for secondary interface Example request body { } Example for secondary interface "InterfaceName": "
PAGE 558
"Targets": [], "Params": [ { "JobId": 10085, "Key": "Nmcli_Update", "Value": "{\"interfaceName\":\"ens36\",\"profileName \":\"ens36\",\"enableNIC\":true,\"ipv4Configuration\":{\"enable \":true,\"enableDHCP\":true,\"staticIPAddress\":\"\",\"staticSubnetMask \":\"\",\"staticGateway\":\"\",\"useDHCPForDNSServerNames \":false,\"staticPreferredDNSServer\":\"\",\"staticAlternateDNSServer \":\"\"},\"ipv6Configuration\":{\"enable\":true,\"enableAutoConfiguration \":true,\"staticIPAddress\":\"\",\"staticPrefixLength
PAGE 559
Privilege VIEW HTTP response codes 200 / api/TemplateService/Baselines(ID)/ DeviceConfigComplianceReports This URI returns a report for a specific baseline. GET method for DeviceConfigComplianceReports Description Returns a report for a specific baseline. Privilege VIEW HTTP response codes 200 /api/TemplateService/Baselines(ID)/ DeviceConfigComplianceReports(ID)/DeviceComplianceDetails The URI returns the device reports for a specific report identification number and baseline.
PAGE 560
Example to create a TSR job Example request body { } Example to create a diagnostic job 560 "Id":0, "JobName":"TSR", "JobDescription":"TSRTask", "Schedule":"startnow", "State":"Enabled", "JobType": { "Id":125, "Name":"Diagnostic_Task" }, "Params": [ { "Key":"deviceTypes", "Value":"1000" }, { "Key":"operationName", "Value":"SERVER_EXECUTE_TSR" }, { "Key":"fileName", "Value":"TSR" }, { "Key":"OPERATION_NAME", "Value":"SERVER_EXECUTE_TSR" }, { "Key":"ShareType", "Value":"2" }, { "Key":"DataSelectorArrayIn"
PAGE 561
} "State":"Enabled", "JobType": { "Id":25, "Name":"Diagnostic_Task" }, "Params": [ { "Key":"deviceTypes", "Value":"1000" }, { "Key":"fileName", "Value":"FinalTest" }, { "Key":"operationName", "Value":"SERVER_DIAGNOSTIC" }, { "Key":"OPERATION_NAME", "Value":"SERVER_DIAGNOSTIC" }, { "Key":"ShareType", "Value":"2" }, { "Key":"RunMode", "Value":"0" }, { "Key":"RebootJobType", "Value":"2" }, { "Key":"ScheduledStartTime", "Value":"TIME_NOW" } ], "Targets": [ { "Id":3714, "Data":"", "TargetType": { "Id":3714, "Na
PAGE 562
● URI for remote diagnostic files—api/TroubleshootService/Files?$filter=DeviceId eq 25085 and DeviceOperation eq 'SERVER_DIAGNOSTIC' Privilege VIEW HTTP response codes 200 Example Response Body "value": [ { "@odata.type": "#TroubleshootService.FileResponseModel", "DeviceId": 25085, "DeviceOperation": "SERVER_EXECUTE_TSR", "JobId": 0, "FileName": "TSR.zip", "FilePath": "/shared/dell/omc/cifs/idrac/F3TPXK2/ SERVER_EXECUTE_TSR/TSR/TSR.zip" } ] Table 177.
PAGE 563
/api/TroubleShootService/Actions/ TroubleShootService.GetArchivedConsoleLogs This URI retrieves the appliance service logs. POST method for TroubleShootService.GetArchivedConsoleLogs This method retrieves the appliance service log files as a .ZIP file. Description Retrieves the appliance service log files. Privilege VIEW HTTP response codes 200 Example Response Body java.io.File /api/TroubleShootService/Actions/ TroubleShootService.
PAGE 564
$metadata#Collection(QuerySupportService.Query)", "@odata.count": 6, "value": [ { "@odata.type": "#QuerySupportService.Query", "@odata.id": "/api/QuerySupportService/Queries(10001)", "Id": 10001, "Name": "Device Overview Report", "UsageId": 2, "FilterText": "", "ContextId": 2, "Conditions": [], "ResultFields": [], "SortFields": [] }, { "@odata.type": "#QuerySupportService.Query", "@odata.
PAGE 565
[ } "FilterText": "", "ContextId": 2, "Conditions": { "LogicalOperatorId": 0, "LeftParen": true, "FieldId": 52, "OperatorId": 11, "Value": "PowerEdge", "RightParen": true } ], "ResultFields": [ 50, 53, 52 ], "SortFields": [] /api/QuerySupportService/QueryContextSummaries This URI represents summary information for all query contexts. GET method for QueryContextSummaries This method returns summary information for all Query Contexts.
PAGE 566
{ { } "Description": null, "BaseCategoryId": 2 }, "@odata.type": "#QuerySupportService.QueryContextSummary", "@odata.id": "/api/QuerySupportService/QueryContextSummaries(2)", "Id": 2, "Name": "Devices", "Description": null, "BaseCategoryId": 1 }, "@odata.type": "#QuerySupportService.QueryContextSummary", "@odata.
PAGE 567
HTTP response codes Example Response Body 200 { "@odata.context": "/api/$metadata#QuerySupportService.QueryContext/ $entity", "@odata.type": "#QuerySupportService.QueryContext", "@odata.
PAGE 568
] }, { } "Id": 5000, "Name": "No Status" "Id": 19, "Name": "Device Model", "TableId": 5, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 20, "Name": "Device Service Tag", "TableId": 5, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 23, "Name": "Device Asset Tag", "TableId": 5, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 15, "Name": "Sub-Category Prefix", "TableId": 4, "Description": null, "FieldT
PAGE 569
} ] "TableId": 1, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 2, "Name": "Alert Message", "TableId": 1, "Description": null, "FieldTypeId": 1, "StrMaxLen": 2048, "EnumOpts": [] } /api/QuerySupportService/QueryContexts(Id)/ QuerySupportService.GetFiltersForContext This URI represents summary information for all filters (queries) defined by using a specific Query Context. GET method for QuerySupportService.
PAGE 570
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 570 "Id": 1008, "Name": "Fibre Channel Switches", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1017, "Name": "HCI Appliances", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1014, "Name": "Hypervisor Systems", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1016, "Name": "Hyper-V Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1011, "Name": "Linux Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id"
PAGE 571
}, { }, { }, { }, { }, { }, { }, { }, { ] } "Id": 1002, "Name": "PowerEdge FX2", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1003, "Name": "PowerEdge M1000e", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1004, "Name": "PowerEdge VRTX", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1009, "Name": "Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1012, "Name": "Storage Devices", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1015, "Name": "VMware ESXi Serve
PAGE 572
Table 178. Attributes (continued) Attribute Description UsageId 1=Query Group, 2=Report FilterText Unused ContextId The Query Context identifier of the filter. It should match the Query Context ID in the request. /api/QuerySupportService/OperatorInfo This URI represents the supported logical operators of a query. GET method for OperatorInfo This method returns a list of supported logical operators for each field type. Description Returns a list of supported logical operators for each field type.
PAGE 573
"Name": "is null" }, { "Id": 10, "Name": "is not null" }, { "Id": 11, "Name": "begins with" }, { "Id": 12, "Name": "ends with" }, { "Id": 13, "Name": "before" }, { "Id": 14, "Name": "after" } ], "FieldTypes": [ { "FieldTypeId": 1, "Name": "String", "OperatorIds": [ 1, 2, 3, 4, 5, 6, 11, 12, 7, 8, 9, 10 ] }, { "FieldTypeId": 2, "Name": "Number", "OperatorIds": [ 1, 2, 3, 4, 5, 6, 9, 10 ] }, { "FieldTypeId": 3, "Name": "Date-Time", "OperatorIds": [ 1, 2, 13, 14, 9, 10 ] }, APIs specific to OpenManage Enterpr
PAGE 574
{ } ] "FieldTypeId": 4, "Name": "Enum", "OperatorIds": [ 1, 2, 9, 10 ] }, { "FieldTypeId": 5, "Name": "Boolean", "OperatorIds": [ 1, 2, 9, 10 ] } /api/QuerySupportService/Filters This URI represents summary information for all filters. GET method for Filters This method returns summary information for all filters. Description Returns summary information for all filters. Privilege VIEW HTTP response codes 200 Example Response Body { "@odata.
PAGE 575
{ }, { }, { }, { ] } } "@odata.type": "#QuerySupportService.Filter", "@odata.id": "/api/QuerySupportService/Filters(1007)", "Id": 1007, "Name": "Dell Networking Switches", "UsageId": 1, "FilterText": "", "ContextId": 2, "Conditions": [] "@odata.type": "#QuerySupportService.Filter", "@odata.id": "/api/QuerySupportService/Filters(1008)", "Id": 1008, "Name": "Fibre Channel Switches", "UsageId": 1, "FilterText": "", "ContextId": 2, "Conditions": [] "@odata.type": "#QuerySupportService.Filter", "@odata.
PAGE 576
} "FilterText": "", "ContextId": 2, "Conditions": [ { "LogicalOperatorId": "LeftParen": true, "FieldId": 59, "OperatorId": 1, "Value": "101", "RightParen": true }, { "LogicalOperatorId": "LeftParen": true, "FieldId": 59, "OperatorId": 1, "Value": "102", "RightParen": true }, { "LogicalOperatorId": "LeftParen": true, "FieldId": 59, "OperatorId": 1, "Value": "202", "RightParen": true }, { "LogicalOperatorId": "LeftParen": true, "FieldId": 59, "OperatorId": 1, "Value": "203", "RightParen": true } ] 0, 2, 2
PAGE 577
} Example Response Body { } "Description": "Test Group1", "GlobalStatus": 0, "ParentId": 0 "Id": 1564, "Name": "Test Group1", "Description": "Test Group1", "TypeId": 3000, "MembershipTypeId": 12, "GlobalStatus": 0, "ParentId": 0, "CreatedBy": "root", "UpdatedBy": "", "CreationTime": "2017-06-08 20:14:37.252", "UpdatedTime": "2017-06-08 20:14:37.
PAGE 578
HTTP response codes 200 Example Response Body { } "@odata.context": "$metadata#Collection(GroupService.StatusSummary)", "@odata.count": 3, "value": [ { "StatusType": 4000, "Count": 26 }, { "StatusType": 3000, "Count": 4 }, { "StatusType": 1000, "Count": 15 } ] /api/GroupService/Groups(Id)/EventStatusSummary This URI represents the events status counts. GET method for EventStatusSummary This method returns events status counts per status values.
PAGE 579
/api/GroupService/Groups(group id)/EventSeveritySummary? $filter=StatusType eq 2000 This URL returns the count of unacknowledged alerts. GET method for EventSeveritySummary?$filter=StatusType eq 2000 This method returns the count of unacknowledged alerts. Description Returns the count of unacknowledged alerts. /api/GroupService/Groups(group id)/EventSeveritySummary? $filter=StatusType eq 1000 This URL returns the count of acknowledged alerts.
PAGE 580
/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.
PAGE 581
} } "ParentId": 1021 /api/GroupService/Actions/GroupService.Clone This URI represents cloning of a group. POST method for GroupService.Clone This method clones a group. Description Clones a group. Privilege GROUP_MANAGEMENT HTTP response codes 200 Example Request Body { } "Id": 3164, "Name": "Test Group-My122-cloned", "Description": "Test Group123-4", "GlobalStatus": 0, "DefinitionId": 0, "ParentId": 12 /api/GroupService/Actions/GroupService.DeleteGroup This URI deletes a group.
PAGE 582
/api/GroupService/Actions/GroupService.AddMemberDevices This URI represents adding devices to a group. POST method for GroupService.AddMemberDevices This method adds devices to a group. Description Adds devices to a group. Privilege GROUP_MANAGEMENT HTTP response codes 204 Example Request Body } { "GroupId":2614, "MemberDeviceIds" : [2514] /api/GroupService/Actions/GroupService.RemoveMemberDevices This URI represents removing devices from a group. POST method for GroupService.
PAGE 583
Example Request Body { } "UserId" : 3864, "GroupIds" : [1314, 1264] Profiles /api/ProfileService/Profiles This URI is used to create one or more profiles. POST method for Profiles Description This method creates one or more profiles.
PAGE 584
/api/ProfileService/Profiles(arg) This URI is used to update the profile information, such as name, description, attributes, and boot ISO. PUT method for Profiles(arg) Description This method updates the profile information, such as name, description, attributes, and boot ISO.
PAGE 585
/api/ProfileService/Profiles(arg1)/AttributeDetails This URI retrieves the attribute information for a profile id. GET method for AttributeDetails Description This method retrieves the attribute information for a profile id. Privilege VIEW HTTP response codes 200 Example response body { } "ProfileId": 10079 /api/ProfileService/Actions/ProfileService.Rename This URI renames existing profiles. POST method for ProfileService.Rename Description This method renames existing profiles.
PAGE 586
/api/ProfileService/Actions/ProfileService.GetIdentityAttributes This URI retrieves the virtual identities associated with a profile id. POST method for ProfileService.GetIdentityAttributes Description This method retrieves the virtual identities associated with a profile id. Privilege VIEW HTTP response codes 200 Example request body { } "ProfileId": 10079 /api/ProfileService/Actions/ProfileService.AssignProfile This URI assigns a profile to a target device. POST method for ProfileService.
PAGE 587
} } /api/ProfileService/Actions/ ProfileService.AssignProfileForAutoDeploy This URI assigns profiles to the auto-deploy identifier. POST method for ProfileService.AssignProfileForAutoDeploy Description This method assigns profiles to the auto-deploy identifier.
PAGE 588
} "ProfileIds": [ 10079 ], "Schedule": { "RunNow": true, "RunLater": false, "Cron": "", "StartTime": "" }, "SelectAll": false, "Filters": "*" /api/ProfileService/Actions/ProfileService.MigrateProfile This URI migrates profiles from one device to another. POST method for ProfileService.MigrateProfile Description This method migrates profiles from one device to another.
PAGE 589
profils wizard which matches the filter condition { "SelectAll":true, } "Filters":"=contains(ProfileName,'test4')" /api/ProfileService/ProfileStates This URI retrieves the profile state information for all the profiles. GET method for ProfileStates Description This method retrieves the profile state information for all the profiles. Privilege VIEW HTTP response codes 200 /api/ProfileService/Actions/ProfileService.Delete This URI deletes the profiles. POST method for ProfileService.
PAGE 590
/api/ProfileService/Profiles(arg1) This URI deletes the given profile id. DELETE method for Profiles(arg1) Description This method deletes the given profile id. Privilege TEMPLATE_MANAGEMENT, AUTO_DEPLOY_MANAGEMENT HTTP response codes 204 /api/ProfileService/Actions/ ProfileService.GetInvalidTargetsForDeployTemplate This URI provides the invalid targets for template deployment. POST method for ProfileService.
PAGE 591
Devices /api/DeviceService/HostKeys This URL returns the list of known host keys. GET method for HostKeys Description This method returns the list of known host keys. Privilege DEVICE_CONFIGURATION HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Collection(DeviceService.HostKey)", "@odata.count": 1, "value": [ { "@odata.type": "#DeviceService.HostKey", "@odata.id": "/api/DeviceService/HostKeys(1)", "Id": 1, "Identifier": "1.1.1.
PAGE 592
BGzwI21orZm/ Bb3OG6VWGmha9X/6X159IUiHgSQxPrwAt9/ GvfPKDFuIsRgoTyPKHZEIOZru1oKBAAV5Sm8xt9o1H8ovn+M/ qNTuSKuAwLLmvBKqb +eWEGt4TVbq1A4Q0AxHkvJKlAhKYoOS0q6pJjYbi1chuy2wAYtS0JWc8OBG18UiaZq0S GFmbP7cq4bdys4A49tht239Zo9Dl4MEcPW2qtcMUgg7SknKbTbe7Uc3NtX73qPLa/ BSLMfsd7qGEwkPPtDGReB qTjrZhVB065Ecr2kjldvPp3U/cnHYycXMRxD4dIr3DhWB9V", "Type":"SSH_KNOWN_HOSTS" } } ] /api/DeviceService/Actions/DeviceService.ScanAndAddKeys This URL automatically scans and adds the known keys. POST method for DeviceService.
PAGE 593
/api/DeviceService/Actions/DeviceService.AddCredentialToDevice When an onboarding operation is initiated on the OpenManage Enterprise console, this URI is used to first add the credentials of the devices. This URI can be used to add credential information pertaining to management operations used for a particular target. POST method for DeviceService.AddCredentialToDevice Description Adds the credential information of devices when an onboarding job is initiated.
PAGE 594
{ }, { ] } } "@odata.type": "#AutoDeployService.AutoDeployTarget", "@odata.id": "/api/AutoDeployService/Targets(7)", "AutoDeployDeviceId": 7, "Identifier": "DT3Y6S1", "TemplateId": 9, "TemplateTypeId": 2, "TemplateName": "test-migrate", "GroupName": null, "IsBootToNetworkIso": false, "ShareIp": null, "ShareType": null, "IsoPath": null, "TaskId": 0, "TaskLastRunStatusId": 2200, "CreatedBy": "admin", "CreatedOn": "2019-05-15 17:24:29.411303" "@odata.type": "#AutoDeployService.AutoDeployTarget", "@odata.
PAGE 595
}, { }, { } ] } "Identifier": "AAD6AAA", "ResultCode": 0, "BaseEntityId": 10327 "Identifier": "DSF346FAD", "ResultCode": 1, "BaseEntityId": 0 "Identifier": "SR346HCF", "ResultCode": 0, "BaseEntityId": 10328 Table 181.
PAGE 596
Case 3: Select All with filters – to delete all the devices in the auto deploy wizard which matches the filter condition { "AutoDeployDeviceId":null, "SelectAll":true, "Filters":"contains(Identifier,'RR')&contains(TemplateName,'sample')" } /api/AutoDeployService/AutoDeploy After the identifiers are validated, this URL is used to complete the AutoDeploy request with the NetworkBootIso details.
PAGE 597
} Monitor Discovery service /api/DiscoveryConfigService/Jobs This URI represents the information of discovery tasks. GET method for Jobs This method returns the discovery job information with discovery request details. Description Returns the discovery job information. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(DiscoveryConfigService.DiscoveryJob)", "@odata.count": 5, "value": [ { "@odata.type": "#DiscoveryConfigService.
PAGE 598
}, { }, { }, { 598 "LastUpdateTime": "2018-09-13 19:12:24.777", "DiscoveryConfigGroupId": 7, "DiscoveryConfigExpectedDeviceCount": 256, "DiscoveryConfigDiscoveredDeviceCount": 31, "DiscoveryConfigEmailRecipient": null, "DiscoveredDevicesByType": [ { "DeviceType": "SERVER", "Count": 31 } ] "@odata.type": "#DiscoveryConfigService.DiscoveryJob", "@odata.
PAGE 599
} ] } "DiscoveryConfigEmailRecipient": null, "DiscoveredDevicesByType": [ { "DeviceType": "SERVER", "Count": 1 } ] Table 182. Attributes Attribute Description JobId ID of the discovery job. JobName Name of the discovery job. JobSchedule Discovery job schedule information. JobStartTime Start time of the discovery job. JobEndTime Completion time of the discovery job. JobProgress Percentage of discovery job completion. JobStatusId Status of the discovery job.
PAGE 600
} "Exclude":false ], "ConnectionProfileId":0, "ConnectionProfile":"{\"profileName\":\"\",\"profileDescription \":\"\",\"type\":\"DISCOVERY\",\"credentials\":[{\"id\":0,\"type \":\"WSMAN\",\"authType\":\"Basic\",\"modified\":false,\"credentials\": {\"username\":\"root\",\"password\":\"calvin\",\"caCheck \":false,\"cnCheck\":false,\"port\":443,\"retries\":3,\"timeout \":60,\"isHttp\":false,\"keepAlive\":false}}]}", "DeviceType":[ 1000 ] } ], "Schedule":{ "RunNow":true, "RunLater":false, "Cron":"startnow", "
PAGE 601
Example to schedule a discovery job Example request body Example to run discovery job with multiple protocols Example request body { "DiscoveryConfigGroupName":"Discovery-2017091613573232", "DiscoveryConfigGroupDescription":"null", "DiscoveryConfigModels":[ { "DiscoveryConfigId":916135732, "DiscoveryConfigDescription":"", "DiscoveryConfigStatus":"", "DiscoveryConfigTargets":[ { "DiscoveryConfigTargetId":0, "NetworkAddressDetail":"xx.xx.xx.
PAGE 602
\":false}},{\"id\":0,\"type\":\"SNMP\",\"authType\":\"Basic\",\"modified \":false,\"credentials\":{\"community\":\"public \",\"enableV1V2\":true,\"port\":161,\"retries\":3,\"timeout\":3}},{\"id \":0,\"type\":\"IPMI\",\"authType\":\"Basic\",\"modified \":false,\"credentials\":{\"username\":\"test\",\"password\":\"test \",\"privilege\":2,\"retries\":3,\"timeout\":59}},{\"id\":0,\"type \":\"SSH\",\"authType\":\"Basic\",\"modified\":false,\"credentials\": {\"username\":\"test\",\"isSudoUser\":false,\"password\"
PAGE 603
} Example for discovery of OME–Modular using OpenManage Enterprise with trap destination "CreateGroup":true, "TrapDestination":false Example request body { "DiscoveryConfigGroupName": "Discovery-testesx2", "DiscoveryConfigGroupDescription": "null", "DiscoveryConfigModels": [{ "DiscoveryConfigId": 916135421, "DiscoveryConfigDescription": "", "DiscoveryConfigStatus": "", "DiscoveryConfigTargets": [{ "DiscoveryConfigTargetId": 0, "NetworkAddressDetail": "x.x.x.
PAGE 604
} /api/DiscoveryConfigService/Actions/DiscoveryConfigService.Parse This URI represents discovery ranges parsed from a .CSV file. POST method for DiscoveryConfigService.Parse This method parses the discovery ranges from the .CSV file. Description Parses the discovery ranges from the .CSV file. Privilege DISCOVERY_MANAGEMENT HTTP response codes 201 Example request body { fileName="abc.csv" } /api/DiscoveryConfigService/DiscoveryConfigGroups(groupId) This URI updates a discovery task.
PAGE 605
"DiscoveryConfigTaskParam": [], "DiscoveryConfigTasks": [], "Schedule": { "RunNow": true, "RunLater": false, "Cron": "startnow" } Example response body }, "CreateGroup":true, "TrapDestination":false { "DiscoveryConfigGroupId": 11, "DiscoveryConfigGroupName": "Discovery-2018022611572222-updated", "DiscoveryConfigGroupDescription": "Discovery-2018022611572222updated", "DiscoveryStatusEmailRecipient": null, "DiscoveryConfigParentGroupId": 0, "CreateGroup": true, "DiscoveryConfigModels": [ { "DiscoveryConf
PAGE 606
Table 183. Attributes Attribute name Description GroupId Group Id DiscoveryName Discovery Name Description Definition for discovery Task Schedule Discovery job schedule information TaskId Id of the job ConnectionProfileId Connection profile Id DeviceTypeList List of all device types DiscoveryConfiglist Config details Server-initiated discovery /api/DiscoveryConfigService/Actions/ DiscoveryConfigService.
PAGE 607
/api/DiscoveryConfigService/Actions/ DiscoveryConfigService.SignalNodePresence This URI is used by iDRAC to initiate contact with OpenManage Enterprise console. However, this API is accessible from the OpenManage Enterprise console only when the client certificate of the servers is signed by the Dell CA. POST method for DiscoveryConfigService.SignalNodePresence Description This method is used by iDRAC to initiate contact with OpenManage Enterprise console.
PAGE 608
Privilege DISCOVERY_MANAGEMENT HTTP response codes 200 Example request body { } "NodeId": [1, 2] /api/DiscoveryConfigService/SignaledNodes This URI is used to view the information, and status of the servers added by using the server-initiated discovery feature. GET method for SignaledNodes Description This method is used to view the information, and status of the servers added by using the server-initiated discovery feature.
PAGE 609
Warranty service /api/WarrantyService/Warranties This URI represents the retrieval of warranty information from OpenManage Enterprise. GET method for Warranties This method returns warranty information from OpenManage Enterprise. Description Returns warranty information from OpenManage Enterprise. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "/api/$metadata#Collection(WarrantyService.Warranty)", "@odata.count": 1, "value": [ { "@odata.type": "#WarrantyService.
PAGE 610
Table 184. Attributes (continued) Attribute Description DaysRemaining Filter by remaining days for warranty expiry CustomerNumber Filter by customer number- default 0 OrderNumber Filter by order number - default 0 /api/WarrantyService/Actions/WarrantyService.WarrantyCount This URI represents the warranty counts based on Warranty Setting Criteria for scoreboard POST method for WarrantyService.WarrantyCount This method returns the count of warranty based on Warranty Setting Criteria for scoreboard.
PAGE 611
"@odata.context": "/api/$metadata#Collection(ReportService.ReportDef)", "@odata.count": 21, "value": [{ "@odata.type": "#ReportService.ReportDef", "@odata.id": "/api/ReportService/ReportDefs(10042)", "Id": 10042, "Name": "Alert Counts per Device Report", "Description": "This report contains alert counts per severity and totals per Device.", "IsBuiltIn": true, "LastEditedBy": "admin", "LastRunDate": "2018-09-11 15:36:17.05", "LastRunBy": "admin", "LastRunDuration": "0.
PAGE 612
} ], "FilterGroupId": 0, "QsmQuery": false, "ReportResults": { "@odata.id": "/api/ReportService/ReportDefs(10042)/ReportResults" } }] Table 185.
PAGE 613
}, { "Width":20, "Sequence":4, "Name":"Software Description" } ], "FilterGroupId":64, "QueryDefRequest":{ "ContextId":3, "ResultFields":[ { "FieldId":61 }, { "FieldId":64 }, { "FieldId":63 }, { "FieldId":99 }, { "FieldId":102 } ], "SortFields":[ } } ] PUT method for ReportDefs This method updates a report. Description Updates a report.
PAGE 614
} } "LogicalOperatorId": 1, "LeftParen": false, "FieldId": 65, "OperatorId": 1, "Value": "1000", "RightParen": false }], "ResultFields": [{ "FieldId": 71 }, { "FieldId": 68 }, { "FieldId": 69 }, { "FieldId": 70 }, { "FieldId": 65 }], "SortFields": [{ "FieldId": 65, "SortDir": 0 }] Table 186. 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.
PAGE 615
"Width": 20, "Sequence": 0 }, { "Id": 22, "Name": "Device Type", "Width": 20, "Sequence": 1 }, { "Id": 23, "Name": "Device Model", "Width": 20, "Sequence": 2 }, { "Id": 24, "Name": "Identifier", "Width": 20, "Sequence": 3 }, { "Id": 25, "Name": "Device Asset Tag", "Width": 25, "Sequence": 4 }, { "Id": 26, "Name": "Datacenter", "Width": 25, "Sequence": 5 }, { "Id": 27, "Name": "Aisle", "Width": 25, "Sequence": 6 }, { "Id": 28, "Name": "Rack", "Width": 25, "Sequence": 7 } ], "ResultRows@odata.
PAGE 616
"@odata.context": "/api/ $metadata#Collection(ReportService.ReportResultRow)", "@odata.count": 1, "value": [ { "@odata.type": "#ReportService.ReportResultRow", "Values": [ "iDRAC-792B0M2", "SERVER", "PowerEdge R640", "792B0M2", "", "", "", "" ] } ] } /api/ReportService/Actions/ReportService.RunReport This URI is used to run a report. POST method for Running Reports This method is used to run reports. Description Used to run reports.
PAGE 617
} "Format":"pdf" /api/ReportService/Actions/ReportService.DeleteReports This URI represents the reports deletion. POST method for ReportService.DeleteReports This method deletes all the reports. Description Deletes all the reports. Privilege REPORT_MANAGEMENT HTTP response codes 200 Example request body [1564] /api/ReportService/Actions/ReportService.CloneReport This URI represents cloning of a report. POST method for ReportService.CloneReport This method clones a report.
PAGE 618
Example request body { "ReportDefId":10037, "Format":"pdf", "EmailIds":"abcd@xyz.com" } MIB import service /api/MIBImportService/MIBS This URI represents the MIB traps. GET method for MIBS This method returns the traps imported from all the MIBs. All the traps with information are listed and they an be grouped based on the catalog name. Description Returns the traps imported from all the MIBs. Privilege VIEW HTTP response codes 200 Example request body { "@odata.
PAGE 619
} }] /api/MIBImportService/Actions/MIBImportService.Save This URI represents the saved traps from MIBs. POST method for MIBImportService.Save This method saves parsed traps from MIB in the appliance. This URI provides functionality to save traps already parsed from the MIB. Description Saves parsed traps from MIB in the appliance. Privilege TRAP_MANAGEMENT HTTP response codes 200 Example response body [{ "EnterpriseOid": ".1.3.6.1.4.1.674.10892.
PAGE 620
/api/MIBImportService/Actions/MIBImportService.Parse This URI represents the trap information by parsing MIBs. POST method for MIBImportService.Parse This method parses MIB files to get trap information. This URI accepts absolute file paths of the MIB file that need to be parsed. Description Parses MIB files to get trap information. Privilege TRAP_MANAGEMENT HTTP response codes 200 Example request body ["/tmp/parseMib/10892.mib"] /api/MIBImportService/Actions/MIBImportService.
PAGE 621
} "Name": "Unknown", "Description": "Unknown" }] /api/MIBImportService/MIBImportService/EventCatalogs This URI represents the event catalogs. GET method for EventCatalogs This method returns the event catalogs. Description Returns the event catalogs. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/ $metadata#Collection(MIBImportService.MIBEventCatalog)", "@odata.count": 46, "value": [{ "@odata.type": "#MIBImportService.MIBEventCatalog", "@odata.
PAGE 622
} }] Plugin Manager NOTE: The APIs in this section can be used only when the Power Manager plug-in is installed on OpenManage Enterprise. /api/PluginService/Plugins This URL returns the plug-in list. GET method for Plugins Description This method returns all the available plug-in. Privilege VIEW HTTP response codes 200 Example response body { "@odata.context": "/api/$metadata#Collection(PluginService.Plugin)", "@odata.count": 1, "value": [ { "@odata.type": "#PluginService.Plugin", "@odata.
PAGE 623
} ] Table 187. Attributes Attribute Description Id Plug-in ID 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.
PAGE 624
(CMC) Enterprise license, OpenManage Enterprise Power Manager leverages information from the OpenManage Enterprise console for platform-level power management. OpenManage Enterprise Power Manager then communicates with Integrated Dell Remote Access Controller (iDRAC) or CMC on each managed server or chassis to provide power-management data, as well as execution of control policy - making it easy for IT professionals to identify areas to gain efficiencies and cut wasteful costs.
PAGE 625
Table 188. Attributes Attribute Description Version Version of the plug-in. Description Description associated with the plug-in version. 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.
PAGE 626
Table 189. Attributes (continued) Attribute Description Compatible Is the plug-in version compatible with the given OpenManage Enterprise version or not? /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.
PAGE 627
Power Metrics NOTE: The APIs in this section can be used only when the Power Manager plug-in is installed on OpenManage Enterprise. /api/MetricService/Metrics This URL returns all the device or group metrics. NOTE: If the current temperature information of the constituent devices is not available, the most recent temperature information of a group displays an aggregation of the temperature values that were last collected by these constituent devices.
PAGE 628
Table 191. Attributes (continued) Attribute Description EntityType Type of entity—device or group. EntityId ID of an entity—device or group. MetricTypes Types of metrics supported. Duration Duration of metric data collection. SortOrder Order of metric data collected.
PAGE 629
Table 191. Attributes (continued) Attribute Description 6 One Month 7 Three Months 8 Six Months 9 One Year Sort Order 0 Descending 1 Ascending /api/MetricService/TopEnergyConsumption This URL represents the most high energy consumption. POST method for TopEnergyConsumption Description This method returns the information of the most high energy consumption.
PAGE 630
Table 192. 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.
PAGE 631
Table 193. 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 One week 6 Two weeks 7 One month 8 Three months 9 Six months 10 One year /api/MetricService/MetricTypes This URL returns all the supported metric types.
PAGE 632
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 632 "@odata.type": "#MetricService.MetricType", "Id": 3, "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.
PAGE 633
}, { }, { }, { }, { } ] } "@odata.type": "#MetricService.MetricType", "Id": 15, "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.
PAGE 634
}, { ] } } "Value": "176.0" "Type": "3", "Value": "192.75" Table 194. 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.
PAGE 635
} Example response body "Type": "Temperature" { } "PluginId": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625", "EntityId": 10079, "Type": "Temperature", "State": "Unknown", "UpperWarning": "100", "UpperCritical": "150", "LowerWarning": "70", "LowerCritical": "80" Table 195. 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.
PAGE 636
] } } "UpperCritical": 8, "UpperWarning": 7, "LowerCritical": 5, "LowerWarning": 6 Table 196.
PAGE 637
/api/MetricService/Actions/MetricService.SaveThreshold This URL configures the threshold of the device or group. POST method for MetricService.SaveThreshold Description This method configures the threshold of the device or group.
PAGE 638
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.
PAGE 639
"DeviceService":{"@odata.id": "/api/DeviceService"}, "OAuthService":{"@odata.id": "/api/OAuthService"}, "SessionService":{"@odata.id": "/api/SessionService"}, "AlertService":{"@odata.id": "/api/AlertService"} } }, "Id": "RootService", "Name": "Root Service", "Links":{ "Sessions":{ "@odata.id": "/redfish/v1/SessionService/Sessions" }, "Oem":{ } }, "RedfishVersion": "1.2.0", "CompositionService":{ "@odata.id": "/redfish/v1/CompositionService" }, "AccountService":{ "@odata.
PAGE 640
PAGE 641
PAGE 642
PAGE 643
MessageRegistryCollection_v1.xml">
PAGE 644
PAGE 645
PAGE 646
PAGE 647
Example response body { "@odata.
PAGE 648
/redfish/v1/SessionService This URI represents the collection of session services. GET method for SessionService This method returns a collection of session service. Description Returns a collection of session service. Privilege VIEW HTTP response codes 200 Example response body { } "@odata.context": "$metadata#SessionService.SessionService", "@odata.
PAGE 649
"@odata.context": "$metadata#Collection(SessionService.Session)", "@odata.count": 1, "value": [ { "@odata.id": "/api/SessionService/Sessions('7b723932-a119-4843a5b7-7a122e4def99')", "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:45.482" } ] } Table 199.
PAGE 650
} "StartTimeStamp": "2017-04-17 20:07:12.357", "LastAccessedTimeStamp": "2017-04-17 20:07:12.357" Table 200. Attributes Attribute name Description Id ID of the session service. UserName User name of the active session. Password Password of the active session. Roles Privilege assigned to the role. IpAddress IP Address of session source. StartTimeStamp Date and time when the session began. LastAccessedTimeStamp Date and time when the session was last accessed.
PAGE 651
DELETE method for Members(Id) This method deletes a session. Description Deletes a session. Privilege SECURITY_SETUP HTTP response code 204 Example request body /api/SessionService/Sessions/Sessions(‘7b723932-a119-4843a5b7-7a122e4def99’) Redfish—Account Service This resource enables you to access the account configuration. Using this resource, you can view the accounts and their roles, update the configuration of accounts, delete accounts, and so on.
PAGE 652
} "AccountLockoutCounterResetAfter": 900, "Accounts": { "@odata.id": "/redfish/v1/AccountService/Accounts" }, "Roles": { "@odata.id": "/redfish/v1/AccountService/Roles" } Table 201. 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.
PAGE 653
} Example response body { } "Id": "10", "Description": "OME-Modular User Accounts", "Name": "Account Service", "Status": { "State": "Enabled", "HealthRollup": "OK", "Health": "OK" }, "ServiceEnabled": false, "AuthFailureLoggingThreshold": 3, "MinPasswordLength": 8, "MaxPasswordLength": 20, "AccountLockoutThreshold": 3, "AccountLockoutDuration": 30, "AccountLockoutCounterResetAfter": 900 "Id": "10", "Description": "OME-Modular User Accounts", "Name": "Account Service", "Status": { "State": "Enabled", "H
PAGE 654
Table 202. Attributes (continued) Attribute name Description AccountLockoutThreshold The number of failed login attempts after which a user account is locked for the specified duration. 0 indicates that the account is never locked. 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.
PAGE 655
"Name": "compute", "Password": null, "UserName": "compute", "RoleId": "10", "Locked": false, "Enabled": true } ] } Table 203. Attributes Attribute name Description Id ID of the account. UserTypeId ID of the type of user. DirectoryServiceId ID of the directory service. Description Description of the user. Name Name of the user. This value is the same as user name. Password Password for the user. This value is not displayed while retrieving the details. UserName User name of the account.
PAGE 656
} "Locked": false, "IsBuiltin": false, "Enabled": true Table 204. Attributes Attribute name Description Id ID of the account. UserTypeId ID of the type of user. DirectoryServiceId ID of the directory service. Description Description of the user. Name Name of the user. This value is the same as user name. Password Password for the user. This value is not displayed when retrieving the details. UserName User name of the account. RoleId Role for the account.
PAGE 657
} "Links": null Table 205. Attributes Attribute name Description Id ID of the account. UserTypeId ID of the type of user. DirectoryServiceId ID of the directory service. Description Description of the user. Name Name of the user. This value is the same as user name. Password Password for the user. This value is not displayed when retrieving the details. UserName User name of the account. RoleId Role for the account. Locked Indicates whether the account is locked.
PAGE 658
Table 206. Attributes Attribute name Description Id ID of the account. UserTypeId ID of the type of user. DirectoryServiceId ID of the directory service. Description Description of the user. Name Name of the user. This value is the same as user name. Password Password for the user. This value is not displayed when retrieving the details. UserName User name of the account. RoleId Role for the account. Locked Indicates whether the account is locked.
PAGE 659
"value":[ { "@odata.type": "#Role.v1_2_2.Role", "@odata.id": "/redfish/v1/AccountService/Roles/Members('10')", "Id": "10", "Description": "Privileges to do all operations", "Name": "CHASSIS_ADMINISTRATOR", "IsPredefined": true }, { "@odata.type": "#Role.v1_2_2.Role", "@odata.id": "/redfish/v1/AccountService/Roles/Members('11')", "Id": "11", "Description": "Allowed to deploy services from a template and perform operations on service.
PAGE 660
Redfish—Message Registry This resource enables you to access the message services. Using this resource, you can access the messages services, base messages, and Event And Error Messages for error handling and audits. Use the URIs in this resource to access the message registry and the list of event and error messages. /redfish/v1/Registries This URI represents a collection of the message services. GET method for Registries This method returns a collection of message services.
PAGE 661
"en", "fr", "zh", "ja", "es", "de", "ko" ], "Registry": "OME-Modular 1.0", "Location":[ { "Language": "en", "Uri": "/redfish/v1/MessageRegistryCollection/ Members('EEMIRegistry.v1_0_0_en')" }, { "Language": "fr", "Uri": "/redfish/v1/MessageRegistryCollection/ Members('EEMIRegistry.v1_0_0_fr')" }, { "Language": "zh", "Uri": "/redfish/v1/MessageRegistryCollection/ Members('EEMIRegistry.v1_0_0_zh')" }, { "Language": "ja", "Uri": "/redfish/v1/MessageRegistryCollection/ Members('EEMIRegistry.
PAGE 662
"@odata.type": "#MessageRegistry.v1_0_0.MessageRegistry", "@odata.id": "/redfish/v1/MessageRegistryCollection/Members('Messages')", "Oem": null, "Id": "Messages", "Description": "This registry defines the MSM messages for Redfish", "Name": "OME-Modular EEMI Registry", "Language": "Messages", "RegistryPrefix": "OME-Modular", "RegistryVersion": "1.0.0", "OwningEntity": "DELL", "Messages":{ } } Redfish—Chassis This resource enables you to access the chassis details.
PAGE 663
redfish/v1/Chassis/Members(id) This method represents chassis instance information, by IDs. GET method for chassis members This method returns details about the chassis member. Description Returns details about chassis members. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/redfish/v1/$metadata#Chassis.v1_6_0.Chassis", "@odata.type": "#Chassis.v1_6_0.Chassis", "@odata.
PAGE 664
redfish/v1/Chassis/Members(id)/Power This API returns the chassis power information. GET method for chassis power information This method returns the chassis power information. Description Returns the health status of a specific device. Privilege VIEW HTTP response code 200 Example response body 664 { "@odata.context": "/redfish/v1/$metadata#Chassis.v1_6_0.Chassis", "@odata.type": "#Chassis.v1_6_0.Chassis", "@odata.
PAGE 665
redfish/v1/Chassis/Members(id)/Power/PowerControl() This API represents the power control information of the member chassis. Get method for power control information This method returns the power control information of the member chassis. Description Returns the power control information of the member chassis. Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/redfish/v1/$metadata#Power.v1_0_0.PowerControl", "@odata.type": "#Power.v1_0_0.
PAGE 666
"PowerSupplyType": "AC", "LineInputVoltage": 0, "PowerCapacityWatts": 0, "LastPowerOutputWatts": 0, "PartNumber": "", "Status":{ "HealthRollup": "OK", "Health": "OK" }, "RelatedItem":[ ], "Redundancy":[ ] } redfish/v1/Chassis/Members(id)/Thermal This API represents the chassis thermal information. GET method for thermal information This method returns the chassis thermal information. Description Returns the chassis thermal information.
PAGE 667
HTTP response code Example response body 200 { "@odata.context": "/redfish/v1/$metadata#Thermal.v1_0_0.Temperature", "@odata.type": "#Thermal.v1_0_0.Temperature", "@odata.id": "/redfish/v1/Chassis/Members('10054')/Thermal/ Temperatures('System.Modular.5')", "MemberId": "System.Modular.
PAGE 668
HTTP response code Example response body 200 { "@odata.context": "/redfish/v1/$metadata#Manager.v1_0_0.Manager", "@odata.type": "#Manager.v1_0_0.Manager", "@odata.id": "/redfish/v1/Managers/Members('25250')", "Id": "ChassisManager", "Description": "Chassis Manager", "Name": "Chassis Manager", "Actions":{ "#Manager.ForceFailover":{ "target": "/redfish/v1/Managers('ChassisManager')/Actions/ Manager.ForceFailover" }, "#Manager.Reset":{ "ResetType@Redfish.
PAGE 669
Table 209. Attributes Attribute name Description ResetType The allowed values are: ● ● ● ● On ForceOff Graceful Shutdown PowerCycle Some of the options work based on the type of the device. redfish/v1/Managers()/Actions/Manager.Reset This API represents chassis management. POST method to restart chassis This method restarts the chassis. Description Restarts the chassis. Privilege DEVICE_CONFIGURATION HTTP response code 202 Example request body { "ResetType": "" } Table 210.
PAGE 670
} "@odata.type": "#ComputerSystemCollection.ComputerSystemCollection", "@odata.id": "/redfish/v1/Systems", "Name": "Computer System Collection", "Members@odata.count": 2, "Members": [ { "@odata.id": "/redfish/v1/Systems/Members('10056')" }, { "@odata.id": "/redfish/v1/Systems/Members('10055')" } ] redfish/v1/Systems/Members(id) This API represents server information, by device IDs. GET method for systems This method returns server information, by device ID.
PAGE 671
{"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('14')"}, {"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('15')"}, {"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('16')"}, {"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('17')"} ] }, "AssetTag": "", "Manufacturer": "Dell Inc.
PAGE 672
}, "EthernetInterfaces":{ "@odata.id": "/redfish/v1/Systems/Members('10055')/EthernetInterfaces" }, "SimpleStorage":{ "@odata.id": "/redfish/v1/Systems/Members('10055')/SimpleStorage" }, "Storage":{ "@odata.id": "/redfish/v1/Systems/Members('10055')/Storage" } } redfish/v1/Systems/Members(id)/Processors This API represents server processor information. GET method for processors This method returns server processor information. Description Returns server processor information.
PAGE 673
Example response body { "@odata.context": "/redfish/v1/$metadata#Processor.v1_0_0.Processor", "@odata.type": "#Processor.v1_0_0.Processor", "@odata.id": "/redfish/v1/Systems/Members('10055')/Processors/ Members('9787')", "Id": "9787", "Name": "CPU.Socket.2", "Socket": "CPU.Socket.
PAGE 674
Members('15679')" }, { "@odata.id": "/redfish/v1/Systems/Members('10189')/EthernetInterfaces/ Members('15680')" }, { "@odata.id": "/redfish/v1/Systems/Members('10189')/EthernetInterfaces/ Members('15681')" } ] } redfish/v1/Systems/Members(id)/EthernetInterfaces/ Members(id) This API represents server Ethernet interface information, by IDs. GET method for Ethernet Interfaces by ID This method returns the server Ethernet Interface information, by Ethernet interface ID.
PAGE 675
Privilege VIEW HTTP response code 200 Example response body { "@odata.context": "/redfish/ v1/$metadata#SimpleStorageCollection.SimpleStorageCollection", "@odata.type": "#SimpleStorageCollection.SimpleStorageCollection", "@odata.id": "/redfish/v1/Systems/Members('10189')/SimpleStorage", "Name": "Simple Storage Collection", "Members@odata.count": 3, "Members":[ { "@odata.id": "/redfish/v1/Systems/Members('10189')/SimpleStorage/ Members('9807')" }, { "@odata.
PAGE 676
redfish/v1/Systems/Members('10055')/SimpleStorage/Members('10055')",…}, {"@odata.type": "#SimpleStorage.v1_0_0.SimpleStorage", "@odata.id": "/ redfish/v1/Systems/Members('10055')/SimpleStorage/Members('10056')",…} ] } redfish/v1/Systems/Members(id)/SimpleStorage/Members(id) This API represents the simple server storage details, by storage device ID. GET method for storage devices by ID This method returns the simple server storage details, by storage device ID.
PAGE 677
Table 211. Attributes Attribute name Description ResetType The allowed values are: ● ● ● ● PowerOn PowerOffNonGraceful PowerOffGraceful PowerCycle Redfish—CompositionService redfish/v1/CompositionService This API represents the composition service information. GET method for CompositionService This method returns the composition service information. Description Returns the composition service information. Privilege VIEW HTTP response code 200 Example response body { "@odata.
PAGE 678
Privilege VIEW HTTP response code 200 Example response body 678 { "@odata.context": "/redfish/ v1/$metadata#ResourceBlockCollection.ResourceBlockCollection", "@odata.type": "#ResourceBlockCollection.ResourceBlockCollection", "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks", "Description": "Resource Blocks in MX Chassis", "Name": "Resource Block Collection", "Members@odata.count": 24, "Members":[ { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Members('1')" }, { "@odata.
PAGE 679
Members('41')" }, { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('42')" }, { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('43')" }, { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('44')" }, { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('45')" }, { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ Members('46')" }, { "@odata.
PAGE 680
"Name": "Resource Block 20", "Status":{ "State": "Enabled", "HealthRollup": "OK", "Health": "OK" }, "CompositionStatus":{ "CompositionState": "Composed", "SharingCapable": false }, "ResourceBlockType":[ "ComputerSystem" ], "Links":{ "ComputerSystems":[ { "@odata.id": "/redfish/v1/Systems/Members('10189')" } ], "Chassis":[ { "@odata.id": "/redfish/v1/Chassis/Members('10189')" } ], "Zones":[ { "@odata.id": "/redfish/v1/CompositionService/ResourceZones/Members('3')" } ] }, "ComputerSystems@odata.
PAGE 681
{ "@odata.id": }, { "@odata.id": }, { "@odata.id": }, { "@odata.id": }, { "@odata.id": }, { "@odata.id": }, { "@odata.
PAGE 682
/redfish/v1/Systems/Members()/Actions/ ComputerSystem.AddResourceBlock This API represents addition of chassis to a chassis group. POST method for adding ResourceBlocks This method adds chassis to a chassis group. Description Adds chassis to a chassis group. Privilege DEVICE_CONFIGURATION HTTP response codes 202 Example request body { "ResourceBlock": { "@odata.