OpenManage Enterprise and OpenManage Enterprise - Modular Edition RESTful API Guide version 1.00.10 February 2019 Rev.
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. © 2018 - 2019 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents Chapter 1: About this document................................................................................................... 13 Chapter 2: Overview.................................................................................................................... 14 RESTful application programming interface................................................................................................................ 14 OData.....................................................................
/api/AccountService/Roles......................................................................................................................................45 /api/AccountService/Roles(Id)...............................................................................................................................46 /api/AccountService/ExternalAccountProvider.................................................................................................
/api/AlertService/AlertPolicies(Arg1)/PolicyCriteria(Arg2)............................................................................ 99 /api/AlertService/AlertPolicies(Arg1)/PolicyActions.......................................................................................100 /api/AlertService/AlertPolicies(Arg1)/PolicyActions(Arg2)........................................................................... 101 /api/AlertService/AlertActionTemplates.........................................................
/api/TemplateService/Actions/TemplateService.Import................................................................................ 151 /api/TemplateService/Actions/TemplateService.Deploy................................................................................ 151 /api/TemplateService/Actions/TemplateService.UpdateNetworkConfig..................................................152 Identity pools............................................................................................................
/api/DeviceService/Devices(Id)/Temperature....................................................................................................... 198 GET method for Temperature................................................................................................................................ 198 /api/DeviceService/Devices(Id)/Power................................................................................................................... 198 GET method for Power...........................
/api/GroupService/Groups(Id)/GroupDevicesSummary..................................................................................... 222 GET method for GroupDevicesSummary............................................................................................................ 222 /api/GroupService/Groups(Id)/SubGroups............................................................................................................ 223 GET method for SubGroups....................................................
Chapter 13: Console capabilities................................................................................................ 256 /api/ApplicationService/Capabilities......................................................................................................................... 256 GET method for Capabilities.................................................................................................................................. 256 Chapter 14: Search.....................................
/api/NetworkService/FabricDesign.....................................................................................................................308 /api/NetworkService/Fabrics(Id)......................................................................................................................... 310 /api/NetworkService/Fabrics(Id)/FabricDesigns............................................................................................. 313 /api/NetworkService/Fabrics(Id)/ValidationErrors...........
/api/JobService/Jobs............................................................................................................................................. 363 Chapter 17: APIs specific to OpenManage Enterprise.................................................................367 Application settings........................................................................................................................................................ 367 Console update....................................
/redfish/v1/AccountService/Accounts/Members(Id)....................................................................................424 /redfish/v1/AccountService/Roles/Members(Id)........................................................................................... 426 Redfish — Message Registry.......................................................................................................................................427 /redfish/v1/Registries..................................................
1 About this document This document contains information about the resource models for OpenManage Enterprise (OME) and OpenManage Enterprise - Modular Edition (OME - Modular). Each RESTful API specification includes the URI, method, parameters, request codes, and response codes. Some of the APIs are available only in OME and do not work if used in OME - Modular and the opposite way. Table 1. Supported REST API versions Product REST API version OpenManage Enterprise - Modular Edition 1.00.10 1.
2 Overview RESTful API support in OME and OME - Modular OME - Modular supports RESTful API. Support for APIs has also been improved for OME. Improved support for APIs on these products enhances the systems management capabilities. The RESTful interface is provided over HTTPS in JSON format based on ODATA v4 usable by clients, scripts, and browser-based GUIs. The APIs enable you to build console management tools based on common programming and scripting languages such as Python, Java, and C.
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 OME and delivers an agile, reliable, and comprehensive platform to manage PowerEdge MX-series servers, storage, and networking products. OME - Modular boosts services delivery and restores IT agility for growing businesses.
3 Key integration concepts This section describes the key integration concepts that are applicable to the use cases and resource model. Topics: • • • • • • • • • • • • • Base URI Security Authentication Authorization Resource addressing Resource operations Security considerations Data filtering Data sorting Data pagination Request headers Response codes Response headers Base URI REST API tree structure The console software provides a web-based hypermedia driven API using a simple folder structure.
Resource tree for OME - Modular OEM scheme Figure 1. Resource tree for OME - Modular OEM scheme Resource tree for OME OEM scheme Figure 2.
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.
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.
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.
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 Table 5.
Table 5. Roles and associated privileges for OME (continued) Privilege Roles ADMINISTRATOR DEVICE_MANAGER VIEWER Y Y Y VIEW Resource addressing Each managed resource must be uniquely addressable using a distinct URI. The URI syntax must be intuitive and should indicate the relationships with a parent resource. There are several ways to address specific resources either as instances of specific resource classes or within an associated parent context.
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. You can search for more details about this code using the Dell QRL app on your mobile device. Security considerations For performing update and delete operations, you must be authorized to perform the operations on the resource.
Get 5 th to 8 th devices from the Device collection /api/DeviceService/Devices?$skip=4&$top=4 Get first four devices from the Device collection /api/DeviceService/Devices?$top=4 NOTE: For more information about $skip and $top, see OData Version 4.0 Part 1: Protocol at docs.oasis-open.org. Request headers The request header represents headers in the client HTTPS request that are used to communicate client-preferences to the service end point.
Table 8. HTTP response codes (continued) Request Response code Not found 404 - Resource not found Invalid request method 405 - Invalid request method Internal server error 500 - Internal server error Service unavailable 503 - Service unavailable For more information about response codes, see Status Code Definitions on the W3.org website. Response headers The following table lists a few examples of response headers: Table 9.
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 Input: Output: { "@odata.context": "$metadata#Network.
/api/ApplicationService/Network/CurrentAddressConfiguration This URI represents the current network IP configuration. GET method for CurrentAddressConfiguration This method returns the current network IP configuration. Description Returns the current network IP configuration. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Network.CurrentAddressConfiguration/ $entity", "@odata.type": "#Network.CurrentAddressConfiguration", "@odata.
Table 10. Attributes (continued) Attribute name Description Ipv4Setting.CurrentPreferredDNSServer Current IPv4 DNS preferred server. Ipv4Setting.CurrentAlternateDNSServer Current IPv4 DNS alternate server. Ipv6Setting.Enable IPv6 network settings status. Ipv6Setting.EnableAutoConfiguration IPv6 via DHCP server status. Ipv6Setting.CurrentIPAddress Current IPv6 address. Ipv6Setting.CurrentGateway Current IPv6 prefix length. Ipv6Setting.CurrentLinkLocalAddress Current IPv6 gateway address.
"StaticPrefixLength": 0, "StaticGateway": "", "UseDHCPForDNSServerNames": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" } }, "ManagementVLAN": { "EnableVLAN": false, "Id": 1 }, "DnsConfiguration": { "RegisterWithDNS": false, "DnsName": "MX7000", "UseDHCPForDNSDomainName": false, "DnsDomainName": "" }, "Delay": 0 PUT method for AddressConfiguration This method updates the network configuration. Description Updates the network configuration.
"DnsName": "MX-MSMST01", "UseDHCPForDNSDomainName": false, "DnsDomainName": "" } }, "Delay": 0 Output: { "EnableNIC": true, "Ipv4Configuration": { "Enable": true, "EnableDHCP": true, "StaticIPAddress": "", "StaticSubnetMask": "", "StaticGateway": "", "UseDHCPForDNSServerNames": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "Ipv6Configuration": { "Enable": false, "EnableAutoConfiguration": true, "StaticIPAddress": "", "StaticPrefixLength": 0, "StaticGateway": "", "UseDHCPForDNSSe
Table 11. Attributes (continued) Attribute name Description Ipv4Configuration.StaticAlternateDNSServer Set Static IPv4 DNS alternate server. Ipv6Configuration.Enable Enable IPv6 network settings. Ipv6Configuration.EnableAutoConfiguration Obtain IPv6 using DHCPv6 server or router advertisements (RA). Ipv6Configuration.StaticIPAddress Set Static IPv6 address. Ipv6Configuration.StaticPrefixLength Set Static IPv6 prefix length. Ipv6Configuration.StaticGateway Set Static IPv6 gateway address.
PUT method for WebServerConfiguration This method updates the web-server configuration. Description Updates the web-server configuration. To apply the changes, the web services restart. Privilege APPLIANCE_SETUP HTTP response codes 200 Example Input: { "TimeOut": 4, "PortNumber": 8778, "EnableWebServer": true } Output: { "@odata.context": "$metadata#Network.WebServerConfiguration/$entity", "@odata.
Privilege APPLIANCE_SETUP HTTP response codes 200 Example Input: { "TimeZone": "TZ_ID_11", "EnableNTP": false, "PrimaryNTPAddress": null, "SecondaryNTPAddress1": null, "SecondaryNTPAddress2": null, "SystemTime": "2017-35-23 21:35:18" } Output: { "TimeZone": "TZ_ID_11", "EnableNTP": false, "PrimaryNTPAddress": null, "SecondaryNTPAddress1": null, "SecondaryNTPAddress2": null, "SystemTime": "2017-35-23 21:35:18" } Table 12. Attributes Attribute name Description TimeZone The timezone to use.
}, … { } ] } "Id": "TZ_ID_38", "Name": "(GMT+01:00) Brussels, Copenhagen, Madrid, Paris" "Utcoffsetminutes": 330, "Id": "TZ_ID_66", "Name": "(GMT+05:30) Sri Jayawardenepura" Table 13. Attributes Attribute Description Utcoffsetminutes The number of minutes this time zone is offset from UTC. Id The ID of the time zone. Name The name or location of the time zone. /api/ApplicationService/Network/ProxyConfiguration This URI represents the proxy configuration.
Example Input: { "IpAddress": null, "PortNumber": 0, "EnableAuthentication": false, "EnableProxy": false, "Username": null, "Password": null } Output: { "IpAddress": null, "PortNumber": 0, "Username": null, "Password": null, "EnableAuthentication": false, "EnableProxy": false } Table 14. Attributes Attribute name Description IpAddress Proxy Address, if HTTP Proxy Settings is enabled. PortNumber Port number, if HTTP Proxy Settings is enabled.
"HealthRollup": "OK", "Health": "OK" } }, "ServiceEnabled": false, "AuthFailureLoggingThreshold": 3, "MinPasswordLength": 8, "MaxPasswordLength": 20, "AccountLockoutThreshold": 3, "AccountLockoutDuration": 30, "AccountLockoutCounterResetAfter": 900, "EnableIpRangeAddress": false, "IpRangeAddress": null, "ByUserName": false, "ByIPAddress": false, "Actions": null, "Accounts": [ { "@odata.id": "/api/AccountService/Accounts" } ], "Roles": [ { "@odata.
Table 15. Attributes (continued) Attribute Description ByIPAddress Configure this service by IP address. PUT method for AccountService This method updates the user account configurations. Description Updates account-level configurations for the accounts.
Table 16. Attributes Attribute Description Id Uniquely identifies the resource within the collection of like resources. 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 whether this service is enabled or disabled.
} "value": [ { "@odata.id": "/api/AccountService/Accounts('1814')", "Id": "1814", "UserTypeId": 1, "DirectoryServiceId": 0, "Description": "root", "Name": "root", "Password": null, "UserName": "root", "RoleId": "10", "Locked": false, "IsBuiltin": true, "Enabled": true, "Permissions": [ { "@odata.id": "/api/AccountService/Accounts('1814')/Permissions" } ] } ] Table 17. Attributes Attribute Description Id Uniquely identifies the resource within the collection. UserTypeId Type of user.
} "UserName": "user1", "RoleId": "10", "Locked": false, "Enabled": true Output: { "Id": "2964", "UserTypeId": 1, "DirectoryServiceId": 0, "Name": "user1", "Password": null, "UserName": "user1", "Description": "user1 description", "Oem": null, "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true } Table 18. Attributes Attribute Description Id Uniquely identifies the resource within the collection. UserTypeId Type of user. DirectoryServiceId Directory service ID.
{ } "@odata.context": "$metadata#AccountService.Account/$entity", "@odata.id": "/api/AccountService/Accounts('1814')", "Id": "1814", "UserTypeId": 1, "DirectoryServiceId": 0, "Description": "root", "Name": "root", "Password": null, "UserName": "root", "RoleId": "10", "Locked": false, "IsBuiltin": true, "Enabled": true, "Permissions": [ { "@odata.id": "/api/AccountService/Accounts('1814')/Permissions" } ] Table 19.
} "RoleId": "10", "Locked": false, "Enabled": true Output: { "Id": "2964", "UserTypeId": 1, "DirectoryServiceId": 0, "Name": "user1", "Password": null, "UserName": "user1", "Description": "user1 description", "Oem": null, "RoleId": "10", "Locked": false, "IsBuiltin": false, "Enabled": true } Table 20. Attributes Attribute Description Id Uniquely identifies the resource within the collection. UserTypeId Type of user. DirectoryServiceId Directory service ID. Description Description for the user.
/api/AccountService/Accounts(userId)/Permissions This URI represents the permissions for an account. GET method for Permissions This method lists the permissions for an account. Description Lists the permissions for an account. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AccountService.Permission)", "@odata.count": 1, "value": [ { "Id": 3214, "UserId": 3164, "RoleId": 10, "Entities": [ 64 ] } ] } Table 22.
Output: Table 23. Attributes Attribute Description AccountIds Account IDs to be enabled. /api/AccountService/Actions/AccountService.Disable This URI enables you to disable multiple accounts. POST method for AccountService.Disable This method disables multiple accounts. Description Disables multiple accounts. Privilege SECURITY_SETUP HTTP response codes 204 Example Input: { "AccountIds":[3164,3264] } Output: Table 24. Attributes Attribute Description AccountIds Account IDs to be disabled.
Table 25. Attributes Attribute Description AccountIds Account IDs to be deleted. /api/AccountService/Roles This URI represents the user roles. GET method for Roles This method returns a list of roles and the respective privileges. Description Returns a list of user roles and respective privileges. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AccountService.Role)", "@odata.count": 5, "value": [ { "@odata.
/api/AccountService/Roles(Id) This URI represents the details of a user role. GET method for Roles(Id) This method returns the details of a user role. Description Returns the details of a user role. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AccountService.Role)", "@odata.count": 5, "value": [ { "@odata.
/api/AccountService/ExternalAccountProvider This URI represents the collection of external account providers. GET method for ExternalAccountProvider This method returns the details of the default LDAP and AD ports and network timeouts. Description Returns the LDAP and AP ports and network timeouts. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#ExternalAccountProvider.ExternalAccountProvider/$entity", "@odata.
/api/AccountService/ExternalAccountProvider/ DirectoryServiceType This URI represents the collection of directory types. GET method for DirectoryServiceType This method returns the collection of directory types. Description Returns a collection of directory types. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(ExternalAccountProvider.DirectoryServiceType)", "@odata.
Example Input: Output: { "@odata.context": "$metadata#Collection(ExternalAccountProvider.ADAccountProvider)", "@odata.count": 1, "value": [ { "@odata.id": "/api/AccountService/ExternalAccountProvider/ ADAccountProvider(1264)", "Id": 1264, "Name": "Dell Servers", "ServerType": "MANUAL", "ServerName": [ "ausdc12amer29.amer.dell.
} "10.35.195.1" ], "UserName": "test", "Password": null, "ServerPort": 3268, "NetworkTimeOut": 300, "SearchTimeOut": 300, "CertificateValidation": false, "CertificateFile": null Table 30. Attributes Attribute Description Id Active Directory or LDAP server ID. ServerType Server type of the directory—DNS or Manual. ServerName Server name of the directory service. UserName User name of the directory service. Password Password of the directory service. ServerPort Port of the directory Service.
"ServerName": [ "ausdc12amer29.amer.dell.com" ], "UserName": "Admin", "Password": "XXXXXX", "ServerPort": 3268, "SsoEnablement": false, "KerberosFile": null, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": null, "Groups": [ { "@odata.id": "/api/AccountService/ExternalAccountProvider/ ADAccountProvider(1264)/Groups" } ] } ] } PUT method for ADAccountProvider(Id) This method updates the details of a specific Active Directory server in the collection.
Table 31. Attributes (continued) Attribute name Description Name Directory name. ServerType Server type of the directory—DNS or Manual. ServerName Server name of the directory service. UserName User name of the directory service. Password Password of the directory service. ServerPort Port of the directory service. NetworkTimeOut Network timeout value. SearchTimeOut Search timeout value. CertificateValidation Enable or disable certificate validation for the directory service.
} "CertificateFile": null Example for ServerType: DNS Input: { "Name": "AD", "ServerType": "DNS", "ServerName": [ ], "DnsServer": [ "dell.com" ], "GroupDomain": "dell.com", "UserName": null, "Password": "", "ServerPort": 3269, "NetworkTimeOut": 120, "SearchTimeOut": 120, "CertificateValidation": false, "CertificateFile": "" } Output: { "Name": "AD", "ServerType": "DNS", "ServerName": [ "ausdcdell1.dell.com", "rdudc12dell01.dell.com", "pendc12dell01.dell.com", "ausdc12dell02.dell.com", "ausdc12dell01.dell.
Table 32. Attributes (continued) Attribute name Description 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/ LDAPAccountProvider This URI represents the collection of LDAP Directory Services. GET method for LDAPAccountProvider This method returns the collection of LDAP Directory Service.
POST method for LDAPAccountProvider This method adds an LDAP Directory Service. Description Adds an LDAP Directory Service. Privilege SECURITY_SETUP HTTP response codes 200 Example Input: { "Name": "seaquest", "Id":1, "ServerType": "DNS", "ServerName": ["10.35.195.
Table 33. Attributes (continued) Attribute name Description SearchFilter Search type. NetworkTimeOut Network timeout value. SearchTimeOut Search timeout value. CertificateValidation Enable or disable certificate validation for the directory service. CertificateFile Certificate file for authentication. /api/AccountService/ExternalAccountProvider/ LDAPAccountProvider(Id) This URI represents a specific LDAP server within the collection of LDAP Directory Service.
PUT method for LDAPAccountProvider(Id) This method updates the details of a server of the LDAP Directory Service. Description Updates the details of an LDAP server. Privilege SECURITY_SETUP HTTP response codes 200 Example Input: { "Name": "seaquest", "Id":2964, "ServerType": "DNS", "ServerName": ["10.35.195.
Table 34. Attributes (continued) Attribute name Description NetworkTimeOut Network timeout value. SearchTimeOut Search timeout value. CertificateValidation Enable or disable certificate validation for the directory service. CertificateFile Certificate file for authentication. /api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.TestLDAPConnection This URI enables you to test the LDAP Directory Service connection. POST method for ExternalAccountProvider.
} "CertificateFile": "" Example for ServerType: DNS Input: { "Name": "LDAP", "ServerType": "DNS", "ServerName": [ ], "DnsServer": [ "dell.
Table 35. Attributes (continued) Attribute name Description ServerType Server type of the directory—DNS or Manual. ServerName Server name of the directory service. UserName User name of the directory service. Password Password of the directory service. BaseDistinguishedName Domain names for search base. Example: dc=dell, dc=com. AttributeUserLogin User login details. AttributeGroupMembership Group member information. SearchFilter Search type. NetworkTimeOut Network timeout value.
Table 36. Attributes (continued) Attribute name Description OrganizationalUnit Organization unit of the directory service. DistinguishedName Distinguished name of the directory service. DomainComponent Domain name of the directory service. ObjectGuid Unique ObjectGuid for the group. /api/AccountService/ExternalAccountProvider/Actions/ ExternalAccountProvider.DeleteExternalAccountProvider This URI enables you to delete an Active Directory or an LDAP Directory Service.
] "DirectortyServiceId": 0, "Description": "admin", "Name": "MSMMegatronTeam", "Password": "", "UserName": "MSMMegatronTeam", "RoleId": "10", "Locked": false, "Enabled": true, "ObjectGuid": "d22005b6-0ce5-40ed-88d0-7f7759b52f25" }, { "UserTypeId": 2, "DirectortyServiceId": 0, "Description": "admin", "Name": "MSMDevelopmentTeam", "Password": "", "UserName": "MSMDevelopmentTeam", "RoleId": "10", "Locked": false, "Enabled": true, "ObjectGuid": "21dd5985-602f-48a2-bde5-dde50eefb422" } Output: [ { "Id": "4664"
Table 38. Attributes (continued) Attribute name Description Password Password for the user. When retrieving the details, Password is not displayed. UserName Username of the account. RoleId Role for the account. Locked Indicates if the account is locked. IsBuiltin Indicates if the account is an in-built account. Enabled Indicates if the account is enabled. ObjectGuid Unique group ID for directory service.
Example Input: Output: { "@odata.context": "/api/ $metadata#ApplicationService.FIPSModeConfiguration/$entity", "@odata.type": "#ApplicationService.FIPSModeConfiguration", "@odata.id": "/api/ApplicationService/Security/SecurityConfiguration", "FipsMode": "OFF" } /api/ApplicationService/Certificate This URI represents the certificates resource. GET method for Certificate This method returns the details of the certificates. Description Returns the details of the security certificates.
Table 39. Attributes (continued) Attribute name Description Value.ValidTo Date till which the certificate is valid. Value.IssuedBy Who the certificate is issued by. Value.IssuedBy.DistinguishedName Distinguished name of the certificate issuer. Value.IssuedBy.DepartmentName The department which issued the certificate. Value.IssuedBy.BusinessName Business name by which the certificate is issued. Value.IssuedBy.Locality Locality of the certificate issuer. Value.IssuedBy.
ZZjn06u+QFf9RRDyaXkX2bNpeAXGZBpG8KbSrk9chyLAyLMCAwEAAaAlMCMGCSqG SIb3DQEJBzEWExRBIGNoYWxsZW5nZSBwYXNzd29yZDANBgkqhkiG9w0BAQUFAAOB gQCxcBNjn5PYe5+NPmD+LjEF+XB34XCZvh4QrCsECyK6B2jRXLP39SxABFlxxd3w D+tddrxy6/8pDdSLMl8FqcV9HLrgJqFn5ue+pA3BLjtkZaM9cxVWHtFZst64WF4v hioJNM68xeFObTxWS99lKufKF8dWKkbQessaABq3yQMikw== -----END CERTIFICATE REQUEST----- Table 40. Attributes Attribute name Description DistinguishedName Distinguished name of the certificate issuer.
Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AlertDestinations.SNMPConfiguration)", "@odata.count": 4, "value": [ { "Id": 1, "Enabled": true, "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" } }, { "Id": 2, "Enabled": true, "DestinationAddress": "100.97.1.
NOTE: By default, you can configure up to four destinations for syslog/SNMP and the responses are sent to each destination. If there is no information in the response, PortNumber is displayed as 0. api/AlertService/AlertDestinations/Actions/ AlertDestinations.ApplySNMPConfig POST method for AlertDestinations.ApplySNMPConfig This method configures SNMP. Description Configures SNMP. Privilege MONITORING_SETUP HTTP response codes 200 Example Input: [ { "Enabled": true, "DestinationAddress": "100.97.1.
}, { }, { }, { ] } }, "SnmpV3Credential": null "Id": 2, "Enabled": true, "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" }, "SnmpV3Credential": null "Id": 3, "Enabled": false, "DestinationAddress": "100.97.1.185", "PortNumber": 162, "Version": "SNMPV2", "SnmpV1V2Credential": { "Community": "public" }, "SnmpV3Credential": null "Id": 4, "Enabled": true, "DestinationAddress": "100.97.1.
Example Input: Output: { "@odata.context": "$metadata#Collection(AlertDestinations.SyslogConfiguration)", "@odata.count": 4, "value": [ { "Id": 1, "Enabled": true, "DestinationAddress": "100.97.10.17", "PortNumber": 514 }, { "Id": 2, "Enabled": true, "DestinationAddress": "100.97.10.17", "PortNumber": 514 }, { "Id": 3, "Enabled": true, "DestinationAddress": "10.19.12.1", "PortNumber": 514 }, { "Id": 4, "Enabled": true, "DestinationAddress": "100.97.1.23", "PortNumber": 514 } ] } Table 43.
Example Input: [ { "Enabled": true, "DestinationAddress": "PortNumber": 514 }, { "Enabled": true, "DestinationAddress": "PortNumber": 514 }, { "Enabled": true, "DestinationAddress": "PortNumber": 514 }, { "Enabled": true, "DestinationAddress": "PortNumber": 514 } ] Output: [ { "Id": 1, "Enabled": true, "DestinationAddress": "PortNumber": 514 }, { "Id": 2, "Enabled": true, "DestinationAddress": "PortNumber": 514 }, { "Id": 3, "Enabled": true, "DestinationAddress": "PortNumber": 514 }, { "Id": 4, "Enabled":
/api/AlertService/AlertDestinations/SMTPConfiguration This URI represents the SMTP configuration. GET method for SMTPConfiguration This method returns a collection of SMTP configuration. Description Returns a collection of SMTP configuration. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AlertDestinations.SMTPConfiguration)", "@odata.count": 1, "value": [ { "DestinationAddress": "10.35.12.
} Output: { "DestinationAddress": "10.35.12.7", "PortNumber": 25, "UseCredentials": false, "UseSSL": false, "Credential": null } Table 46. Attributes Attribute name Description DestinationAddress Destination address of SMTP. PortNumber Port number of SMTP. UseCredentials Indicates if credentials are used. UseSSL Indicates if SSL is used. User User name Password Password /api/AlertService/AlertDestinations/Actions/ AlertDestinations.SendTestTrap POST method for AlertDestinations.
5 Alerts Topics: • • • Alert logs Alert policies Alert definitions Alert logs /api/AlertService/Alerts This URI represents the alerts. Table 48. Filters Filter name Description Top Top records to return. Default value is 100. Skip Max records to skip. Default value is 0. Orderby Order to apply to the output. Id Filter by event ID. Default value is 0. AlertDeviceId Filter by device ID. Default value is 0. AlertDeviceIdentifier Filter by device identifier.
Example Input: Output: { "@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": "10.36.0.
Table 49. Attributes (continued) Attribute name Description SubCategoryName Sub category name associated to alert. StatusType ID of status type. StatusName Name of status type. TimeStamp Date and time when the alert was raised. Message Message describing the issue. 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.
} "AlertMessageType": "REDFISH" Table 50. Attributes Attribute name Description Id Event record ID. SeverityType ID of severity. SeverityName Name of severity. AlertDeviceId ID of device. AlertDeviceName Name of device. AlertDeviceType Device type ID. AlertDeviceIpAddress IP address of device. AlertDeviceMacAddress MAC address of device. AlertDeviceIdentifier Identifier or Service Tag of device. AlertDeviceAssetTag Asset tag of device.
HTTP response codes Example 200 Input: Output: { "@odata.context": "$metadata#Collection(AlertService.AlertCategories)", "@odata.count": 3, "value": [ { "@odata.
/api/AlertService/AlertCategories('Name') This URI represents the alert categories for a specific catalog within the collection. GET method for AlertCategories('Name') This method returns the alert categories for a specific catalog. Description Returns the details of a specific alert category. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#AlertService.AlertCategories/$entity", "@odata.
/api/AlertService/AlertSeverities This URI represents the alert severities. GET method for AlertSeverities This method returns all the severities applicable to an alert. Description Returns all the severities applicable to an alert. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AlertService.AlertSeverity)", "@odata.count": 5, "value": [ { "@odata.
/api/AlertService/AlertSeverities(Id) This URI represents a specific alert severity. GET method for AlertSeverities(Id) This method returns the details of a specific alert severity. Description Returns the details of a specific alert severity. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#AlertService.AlertSeverity/$entity", "@odata.id": "/api/AlertService/AlertSeverities(1)", "Id": 1, "Name": "Unknown", "Description": "Unknown" } Table 54.
{ } ] } "@odata.id": "/api/AlertService/AlertStatuses(2000)", "Id": 2000, "Name": "Not-Acknowledged", "Description": "The event was not acknowledged" Table 55. Attributes Attribute name Description Id ID of the alert status. Name Name of the alert status Description Description of the alert status. /api/AlertService/AlertStatus(Id) This URI represents a specific alert status within the collection. GET method for AlertStatus(Id) This method returns the details of a specific alert status.
Table 57. Filters (continued) Filter name Description Skip Maximum records to skip. Default value is 0. Id Filter by event ID. Default value is 0. GET method for AlertCatalogs This method returns the catalogs applicable to events. Description Returns the catalogs applicable to events. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AlertService.AlertCatalog)", "@odata.count": 9, "value": [ { "@odata.
/api/AlertService/AlertCatalogs(Id) This URI represents a specific alert catalog. GET method for AlertCatalogs(Id) This method returns the details of a specific alert catalog. Description Returns the details of a specific alert catalog. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#AlertService.AlertCatalog/$entity", "@odata.
} "EventTimestamp": "2016-11-19T10:54:26+0000", "EventType": "Alert", "MemberId": "bbdbfb20-ae33-11e6-a44b-1866da78fcba", "Message": "The system board battery is low.", "MessageArgs": ["arg1", “arg2”], "MessageId": "BAT0000", "Severity": "Warning" Output: /api/AlertService/Actions/AlertService.Acknowledge POST method for AlertService.Acknowledge This method acknowledges the alerts. Description Acknowledges alerts.
Table 60. Attributes (continued) Attribute Description 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.Unacknowledge POST method for AlertService.
Table 61. Attributes (continued) Attribute Description DeviceIds List of IDs of devices. DeviceType Device type ID. Severity ID of severity. StatusType ID of status type. StartDate Start date and time when the alerts were raised. EndDate End date and time when the alerts were raised. 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.
Table 62. Attributes (continued) Attribute Description AllAlerts True or False. Determines if action should be taken for all alerts. Filters Optional filters to specify when AllAlerts is True. DeviceIds List of IDs of devices. DeviceType Device type ID. Severity ID of severity. StatusType ID of status type. StartDate Start date and time when the alerts were raised. EndDate End date and time when the alerts were raised. SourceName Source of the alert.
{ "@odata.id": "/api/AlertService/AlertPolicies(314)", "Id": 314, "Name": "Default OnDemand Health Policy", "Description": "This policy is applicable to all devices. A health task will be triggered if category is for system health.
Table 64. Attributes (continued) Attribute name Description Description Description associated with the policy. Enabled Indicates if the policy is enabled or disabled. DefaultPolicy Indicates if the policy is the default policy or pre-seeded. State State associated with the policy. Visible Indicate if the policy is visible or hidden. PolicyData CatalogName Name of the catalogs associated with the policy. This field is checked during policy evaluation.
Privilege MONITORING_SETUP HTTP response codes 201 Example Input: { "Id": 0, "Name": "Policy", "Description": "Policy", "Enabled": true, "DefaultPolicy": false, "PolicyData": { "Catalogs": [ { "CatalogName": "iDRAC", "Categories": [0], "SubCategories": [0] }, { "CatalogName": "Application", "Categories": [0], "SubCategories": [0] } ], "Severities": [16, 1, 2, 4, 8], "Devices": [1714], "Groups": [], "DeviceTypes": [1000], "Schedule": { "StartTime": "2016-06-06 15:02:46.
"DefaultPolicy": false, "Editable": true, "Visible": true, "PolicyData": { "Catalogs": [ { "CatalogName": "iDRAC", "Categories": [ 0 ], "SubCategories": [ 0 ] }, { "CatalogName": "Application", "Categories": [ 0 ], "SubCategories": [ 0 ] } ], "Severities": [ 16, 1, 2, 4, 8 ], "Devices": [ 1714 ], "DeviceTypes": [ 1000 ], "Groups": [], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.
}, { "Name": "from", "Value": "MCSIApplication@Dell.
] 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.id": "/api/AlertService/AlertPolicies(314)/PolicyCriteria" } ] Table 65.
Table 65. Attributes (continued) Attribute name Description Severities List of severities associated to the policy. This field is checked during policy evaluation. Devices List of devices associated to the policy. This field is checked during policy evaluation. DevicesTypes List of devices types associated to the policy. Groups List of groups associated to the policy. This field is checked during policy evaluation. Schedule StartTime Start event-time to verify.
{ "CatalogName": "Application", "Categories": [0], "SubCategories": [0] } ], "Severities": [ 16, 1, 2, 4, 8 ], "Devices": [1914], "Groups": [], "DeviceTypes": [1000], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.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.
0 ], "SubCategories": [ 0 ] } ], "Severities": [ 16, 1, 2, 4, 8 ], "Devices": [ 1914 ], "DeviceTypes": [ 1000 ], "Groups": [], "Schedule": { "StartTime": "2016-06-06 15:02:46.000", "EndTime": "2017-06-06 15:02:46.
"TypeParams": [ { "Name": "maxLength", "Value": "255" } ] ] } } } ], "TemplateId": 50 }, "State": true /api/AlertService/AlertPolicies(Arg1)/PolicyCriteria This URI represents the criteria used for matching the policy with incoming events. The criteria determine if the policy can trigger any actions. Table 66. Filters Attribute name Description Top Top records to return. Default value is 100. Skip Maximum records to skip. Default value is 0. Arg1 Filter by list of policies IDs.
} ] } "ComparisonTypeName": "Equal" Table 67. Attributes Attribute name Description Id ID of the criteria. PolicyId ID of policy with which the criteria is associated. Parameter Any extra parameter that can be used in the criteria. Value Expression that is used during policy evaluation with events. Type ID of the criteria type. TypeName Name of the criteria type. ComparisonType ID of comparison type. ComparisonTypeName Name of comparison type.
Table 68. Attributes (continued) Attribute name Description Value Expression that is used during policy evaluation with events. Type ID of the criteria type. TypeName Name of the criteria type. ComparisonType ID of comparison type. ComparisonTypeName Name of comparison type. /api/AlertService/AlertPolicies(Arg1)/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.
Table 70. Attributes Attribute name Description Id ID of the criteria. PolicyId ID of the policy with which the action is associated. Name Name of the action. Parameters Extra parameter that can be added to the action. TemplateId ID of the action template associated with the action. Template Id ID of the template. Name Name of the template. Description Additional description of the template. Disabled Indicates if template is enabled or disabled.
Table 71. Attributes (continued) Attribute name Description Name Name of the action. Parameters Extra parameter that can be added to the action. TemplateId ID of the action template associated with the action. Template Id ID of the template. Name Name of the template. Description Extra description of the template. Disabled Indicates if template is enabled or disabled. ParameterDetails List of other parameter that the template can carry and apply.
{ }, { } ] } "@odata.id": "/api/AlertService/AlertActionTemplates(80)", "Id": 80, "Name": "OnDemandHealth", "Description": "OnDemandHealth", "Disabled": false, "ParameterDetails": [] "@odata.id": "/api/AlertService/AlertActionTemplates(100)", "Id": 100, "Name": "Ignore", "Description": "Ignore", "Disabled": false, "ParameterDetails": [] Table 72. Attributes Attribute name Description Id ID of the action template. Name Name of the action template. Description Description of the action template.
Table 73. Attributes (continued) Attribute name Description Name Name of the action template. Description Extra description of the action template. Disabled Indicates if the template is enabled or disabled. ParameterDetails Extra parameter that the template can carry and apply. /api/AlertService/Actions/AlertService.EnableAlertPolicies POST method for AlertService.EnableAlertPolicies This method enables the selected alert policies. Description Enables the selected alert policies.
Output: /api/AlertService/Actions/AlertService.RemoveAlertPolicies POST method for AlertService.RemoveAlertPolicies This method removes the selected set of alert policies or all the alert policies. Description Removes the selected alerts policies.
HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(AlertService.AlertMessageDefinition)", "@odata.count": 3, "value": [ { "@odata.id": "/api/AlertService/ AlertMessageDefinitions('RAC9000')", "MessageId": "RAC9000", "Prefix": "RAC", "SequenceNo": 9000, "Message": "Device has become non compliant.", "RecommendedAction": "No response action is required.
/api/AlertService/AlertMessageDefinitions(Id) This URI represents a specific message definition. GET method for AlertMessageDefinitions(Id) This method returns the details of a specific message definition. Description Returns the definitions of a specific message. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#AlertService.AlertMessageDefinition/ $entity", "@odata.
/api/AlertService/AlertMessageDefinitionsCategories This URI represents the alert definition categories. GET method for AlertMessageDefinitionsCategories This method returns the list of alert definition categories. Description Returns the alert definition categories. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(AlertService.AlertMessageDefinitionCategory)", "@odata.count": 6, "value": [ {"@odata.type": "#AlertService.
"@odata.context": "/api/ $metadata#AlertService.AlertMessageDefinitionCategory/$entity", "@odata.type": "#AlertService.AlertMessageDefinitionCategory", "@odata.id": "/api/AlertService/ AlertMessageDefinitionsCategories('Audit')", "Category": "Audit", "SubCategoriesDetails": [ { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Debug" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Devices" }, { "@odata.type": "#AlertService.
{ "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Link" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Log Event" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Management Module" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Memory" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Node" }, { "@odata.
"#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Support Assist" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "System Info" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "Temperature" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "UEFI Event" }, { "@odata.type": "#AlertService.AlertMessageDefinitionSubCategories", "SubCategory": "User Tracking" }, { "@odata.
6 Configure Topics: • • • • Firmware Deploy 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 created in the appliance. Description Returns the list of catalogs. Privilege VIEW HTTP response codes 200 Example Input: { 112 Configure "@odata.context": "/api/$metadata#Collection(UpdateService.Catalogs)", "@odata.count": 1, "value": [ { "@odata.
}, { }, { }, { }, { } ] } "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.
/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 Input: Output: { "@odata.context": "/api/$metadata#UpdateService.Catalogs/$entity", "@odata.type": "#UpdateService.Catalogs", "@odata.id": "/api/UpdateService/Catalogs(28)", "Id": 28, "Filename": "CatalogA00.
api/UpdateService/Baselines This URI represents the baselines. GET method for Baselines This method returns the baselines. Description Returns the baselines. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(UpdateService.Baselines)", "@odata.count": 6, "value": [ { "@odata.type": "#UpdateService.Baselines", "@odata.
POST method for Baselines This method creates a baseline. Description Creates a baseline. Privilege BASELINE_MANAGEMENT HTTP response codes 201 Example Input: { "Name": "Testedi", "Description": "myname", "CatalogId": 23 , "RepositoryId": 13, "DowngradeEnabled": true, "Is64Bit": false, "Targets": [ { "Type": { "Name": "DEVICE" } } ] } Output: api/UpdateService/Baselines(Id) This URI represents a specific baseline.
"Targets": [ { "Id": 25025, "Type": { "Id": 1000, "Name": "DEVICE" } }, { "Id": 25028, "Type": { "Id": 1000, "Name": "DEVICE" } }, { "Id": 25029, "Type": { "Id": 1000, "Name": "DEVICE" } }, { "Id": 25030, "Type": { "Id": 1000, "Name": "DEVICE" } }, { "Id": 25031, "Type": { "Id": 1000, "Name": "DEVICE" } }, { "Id": 25033, "Type": { "Id": 1000, "Name": "DEVICE" } }, { "Id": 25035, "Type": { "Id": 1000, "Name": "DEVICE" } }, { "Id": 25580, "Type": { "Id": 1000, "Name": "DEVICE" } }, { "Id": 25585, "Type": { "I
"DeviceComplianceReports@odata.navigationLink": "/api/UpdateService/ Baselines(8)/DeviceComplianceReports" } /api/UpdateService/Baselines(Id)/DeviceComplianceReports This URI represents the compliance reports for baselines. GET method for DeviceComplianceReports This method returns the compliance report for a specific baseline. Description Returns the compliance report for a baseline. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.
HTTP response codes Example 200 Input: Output: { "@odata.context": "/api/$metadata#UpdateService.DeviceComplianceReport/ $entity", "@odata.type": "#UpdateService.DeviceComplianceReport", "@odata.
"PrerequisiteInfo": "", "ImpactAssessment": "", "Uri": "http://www.dell.com/support/home/us/en/19/Drivers/ DriversDetails?driverId=9DWNX", "RebootRequired": true, "ComplianceStatus": "CRITICAL", "ComplianceDependencies": [] } ] } /api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)/ ComponentComplianceReports(Id) This URI represents the compliance report for a specific component. GET method for ComponentComplianceReports(Id) This method returns the compliance report for a specific component.
/api/UpdateService/Actions/UpdateService.UploadFile POST method for UploadFile This method uploads a file to the specified location. Description Uploads a file. Privilege DEVICE_UPDATE HTTP response codes 200 Example Header: Content-Type: application/octet-stream Input: Output: 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.
/api/UpdateService/Actions/UpdateService.RemoveBaselines POST method for RemoveBaselines This method deletes baselines. Description Deletes baselines. Privilege BASELINE_MANAGEMENT HTTP response codes 204 Example Input: { "BaselineIds":[13] } Output: /api/UpdateService/Actions/UpdateService.GetSingleDupDetails POST method for GetSingleDupDetails This method returns the details of a specific Dell Update Package (DUP). Description Returns the details of a specific DUP.
Privilege DEVICE_UPDATE HTTP response codes 200 Example Input: { "SingleUpdateReportFileToken": "1481131455800", "SingleUpdateReportTargets": [1600,1601,1602,1603] ---OR--"SingleUpdateReportBaseline": [1700] ---OR--"SingleUpdateReportGroup": [1700] ---OR--} Output: [ { "DeviceId": 1674, "DeviceReport": { "ComponentUpdateAction": "UPGRADE", "DeviceTypeId": "1000", "ComponentCurrentVersion": "2.10.10.10", "ComponentUriInformation": null, "DeviceTypeName": "SERVER", "ComponentVersion": "2.30.30.
"ComponentCriticality": "Recommended", "DeviceId": "1682", "DeviceServiceTag": "7T2W1V1", "IsCompliant": "CRITICAL", "ComponentTargetIdentifier": "25227", "ComponentSourceName": "DCIM:INSTALLED#iDRAC.Embedded.1-1#IDRACinfo", "ComponentRebootRequired": "false", "ComponentUniqueIdentifier": "JHF76X50-00LW64", "DeviceModel": "PowerEdge T320", "ComponentName": "IDRAC @ Lifecycle Controller V.,2.30.30.30, A00" } } ] /api/UpdateService/Actions/ UpdateService.
] } } ], "DeviceComplianceReports": [ { "Id": 5, "DeviceId": 25019, "ServiceTag": "testing", "DeviceModel": "POWEREDGE MX7000", "DeviceTypeId": 2000, "DeviceTypeName": "MX-testing", "DeviceName": null, "FirmwareStatus": "Compliant", "ComplianceStatus": "OK", "RebootRequired": false, "ComponentComplianceReports": [] } ] /api/UpdateService/Actions/UpdateService.GetCertDetails POST method for GetCertDetails This method returns the details of a certificate. Description Returns the details of a certificate.
Deploy /api/TemplateService/TemplateTypes This URI represents the types of templates. GET method for TemplateTypes This method returns information about each type of template, indicating the types of devices for which configuration is supported, such as chassis and servers. Description Returns information for each supported template type. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(TemplateService.TemplateTypeModel)", "@odata.
/api/TemplateService/TemplateViewTypes This URI represents the different features that support template operations. GET method for TemplateViewTypes This method returns the features that support template operations. Description Returns the features that support templates operations. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(TemplateService.TemplateViewTypeModel)", "@odata.count": 5, "value": [ { "@odata.
/api/TemplateService/Templates This URI represents the templates. GET method for Templates This method returns the details of all available templates. Table 79. Filters Filter name Description Top Top records to return. Default value is 100. Skip Maximum records to skip. Default value is 0. Orderby Order to apply to the output. SearchFilter Search type. Description Returns the details of all templates. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.
}, { "ViewTypeId": 4, "TaskId": 0, "HasIdentityAttributes": false, "Status": 0, "IdentityPoolId": 0, "IsBuiltIn": true, "CreatedBy": "system", "CreationTime": "2017-11-30 19:02:11.200378", "LastUpdatedBy": null, "LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(2)/Views" } ] "@odata.
}, { }, { "ViewTypeId": 4, "TaskId": 0, "HasIdentityAttributes": false, "Status": 0, "IdentityPoolId": 0, "IsBuiltIn": true, "CreatedBy": "system", "CreationTime": "2017-11-30 19:02:11.200378", "LastUpdatedBy": null, "LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(5)/Views" } ] "@odata.
Storage ", "SourceDeviceId": 0, "TypeId": 2, "ViewTypeId": 4, "TaskId": 0, "HasIdentityAttributes": false, "Status": 0, "IdentityPoolId": 0, "IsBuiltIn": true, "CreatedBy": "system", "CreationTime": "2017-11-30 19:02:11.200378", "LastUpdatedBy": null, "LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(8)/Views" } ] } ] } NOTE: For information about template attributes, see the Attributes table under GET method for Templates(Id).
Table 80. Attributes (continued) Attribute Description ● ● ● ● ● ● ● ● iDRAC System BIOS NIC LifeCycleController RAID EventFilters All To get the entire device configuration, useAll. /api/TemplateService/Templates(Id) This URI represents a specific template. GET method for Templates(Id) This method returns the details of a specific template. Description Returns the details of a specific template. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.
Table 81. Attributes (continued) Attribute Description Description Definition for the template. SourceDeviceId The identifier of the device whose configuration was used as a reference for creating the template. TypeId Template type. For more information, see / TemplateService/TemplateTypes. ViewTypeId Template View type. For more information, see / TemplateService/TemplateViewTypes. TaskId The identifier of the task that created the template.
} ] } Output: ID of the template DELETE method for Templates(Id) This method deletes a template. Description Deletes a specific template. Privilege DEVICE_CONFIGURATION HTTP response codes 204 Example Input: Output: /api/TemplateService/Templates(Id)/Views This URI represents the views of a specific template. 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.
}, { "@odata.type": "#TemplateService.AttributeView", "@odata.id": "/api/TemplateService/Templates(1)/Views(2)", "Id": 2, "Name": "SystemSpecific", "Description": "The hierarchy consists of unique system specific related component classes, groups (from the attribute registry) and attributes.", "AttributeViewDetails": { "@odata.id": "/api/TemplateService/Templates(1)/Views(2)/ AttributeViewDetails" }, " HYPERLINK "mailto:DeviceAttributeViewDetails@odata.navigationLink" DeviceAttributeViewDetails@odata.
Table 82. Attributes Attribute Description Id Unique identifier for a template view. Name The name of the view. Description Identifies the template data and its structure provided by this view. /api/TemplateService/Templates(Id)/Views(Id)/ AttributeViewDetails This URI represents the attribute details of a specific view of a template. GET method for AttributeViewDetails This method returns the details for all attributes applicable to a specific template view..
{ }, { }, { }, { }, { }, { } { Restart", }, { "AttributeId": 3561, "CustomId": 0, "AttributeEditInfoId": 1856, "DisplayName": "LCAttributes 1 VirtualAddressManagement", "Description": null, "Value": "Console", "IsReadOnly": false, "IsIgnored": false "AttributeId": 3563, "CustomId": 0, "AttributeEditInfoId": 1858, "DisplayName": "LCAttributes 1 Provisioning Server", "Description": null, "Value": null, "IsReadOnly": false, "IsIgnored": false "AttributeId": 3559, "CustomId": 0, "AttributeEditInfoId":
"AttributeId": 3564, "CustomId": 0, "AttributeEditInfoId": 1859, "DisplayName": "LCAttributes 1 BIOS Reset To Defaults Requested", }, { }, { ] } "Description": null, "Value": "False", "IsReadOnly": false, "IsIgnored": false "AttributeId": 3565, "CustomId": 0, "AttributeEditInfoId": 1860, "DisplayName": "LCAttributes 1 Automatic Update Feature", "Description": null, "Value": "Disabled", "IsReadOnly": false, "IsIgnored": false "AttributeId": 3566, "CustomId": 0, "AttributeEditInfoId": 1861, "DisplayName
/api/TemplateService/Templates(Id)/Views(Id)/ AttributeViewDetails/TemplateEditInfoDetails This URI represents the editable attributes of a specific view of a template. GET method for TemplateEditInfoDetails This method returns the editable attributes of a specific view of a template. Description Returns the editable attributes of a view of a template. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#TemplateService.
}, { }, { }, { } ] } "TextMaxLength": 223, "ValueMin": 0, "ValueMax": 0, "DependencyText": null, "OptionSetId": 0, "DefaultOptionId": 0, "GenericNameId": 2255 "Id": 2692, "DataType": 18, "Description": null, "IsReadOnly": true, "IsSecure": false, "TextMinLength": 0, "TextMaxLength": 32, "ValueMin": 0, "ValueMax": 0, "DependencyText": null, "OptionSetId": 0, "DefaultOptionId": 0 "Id": 2693, "DataType": 12, "Description": null, "IsReadOnly": true, "IsSecure": false, "TextMinLength": 0, "TextMaxLength":
HTTP response codes Example 200 Input: Output: { "@odata.context": "/api/$metadata#TemplateService.AttributeViewDetail/ $entity", "@odata.id": "/api/TemplateService/Templates(10)/Views(4)/ DeviceAttributeViewDetails(0)", "Id": 4, "Name": "NetworkSpecific", "Description": "The hierarchy consists of network related component classes, groups (from the attribute registry) and attributes.
] }, { }, { 142 Configure } "CustomId": 43, "AttributeEditInfoId": 0, "DisplayName": "Vlan UnTagged", "Description": null, "Value": "0", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] "GroupNameId": 1, "DisplayName": "Port ", "Sub ttributeGroups": [ "GroupNameId": 2, "DisplayName": "P "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3350, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", "Description": null, "Value": "30", "IsReadO
] }, { Bandwidth", } "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] "GroupNameId": 1, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 4, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3388, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", "Description": null, "Value": "30", "IsReadOnly": false, "IsI
"DisplayName": "Partition n Maximum TX Bandwidth", }, { }, { ] }, { Bandwidth", } ] Configure "AttributeId": 0, "CustomId": 47, "AttributeEditInfoId": 0, "DisplayName": "Vlan UnTagged", "Description": null, "Value": "0", "IsReadOnly": false, "IsIgnored": false "GroupNameId": 2, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 2, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3484, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "
"DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 3, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3503, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", }, { Bandwidth", ] }, { Bandwidth", } "Description": null, "Value": "20", "IsReadOnly": false, "IsIgnored": false "AttributeId": 3504, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX "Description": null, "Value":
} "Attributes": [] ], "Attributes": [] } ], "Attributes": [] } ], "TemplateEditInfoDetails": { "@odata.id": "/api/TemplateService/Templates(10)/Views(4)/ DeviceAttributeViewDetails(0)/TemplateEditInfoDetails" } } /api/TemplateService/Profiles This URI represents the profiles. GET method for Profiles This method returns the list of available profiles. Description Returns list of profiles. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.
/api/TemplateService/Profiles(Id) This URI represents a specific profile. GET method for Profiles(Id) This method returns the details of a specific profile. Description Returns details of a specific profile. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#TemplateService.Profile/$entity", "@odata.type": "#TemplateService.Profile", "@odata.
/api/TemplateService/Actions/ TemplateService.GetAssignedIdentities POST method for TemplateService.GetAssignedIdentities This method returns a list of virtual identities reserved for a specified target device. The reply also includes boot option attributes. Description Returns a list of virtual identities for a specific target device.
}, { }, { } ] } ] } ] } ] } ] } "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": 0, "DisplayName": "iSCSI
Privilege TEMPLATE_MANAGEMENT HTTP response codes 200 Example Input: { "SourceEntityId" : 13, "ForceMigrate" : false } Output: /api/TemplateService/Actions/TemplateService.Clone POST method for TemplateService.Clone This method creates a clone of a template. Description Clones a template.
Name=\"LCAttributes.1#VirtualAddressManagement\">Console \n\nMatch firmware of replaced part\nApply always \nOff \nEnabled\n
"ShareDetail": { "IpAddress": "1.2.3.4", "ShareName": "1.2.3.4", "User": "bootToIsoUsername", "Password": "bootToIsoPassword" } } }, "Attributes": [], "Options": { "ShutdownType": 0, "TimeToWaitBeforeShutdown": 300, "EndHostPowerState": 1 }, "Schedule": { "RunNow": true, "RunLater": false } Output: ID of created task /api/TemplateService/Actions/ TemplateService.UpdateNetworkConfig POST method for TemplateService.UpdateNetworkConfig This method updates the network configuration parameters of a template.
{ }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { ] } "Id": 3351, "Value": "100", "IsIgnored": false "Id": 3369, "Value": "20", "IsIgnored": false "Id": 3370, "Value": "100", "IsIgnored": false "Id": 3388, "Value": "30", "IsIgnored": false "Id": 3389, "Value": "100", "IsIgnored": false "Id": 3431, "Value": "20", "IsIgnored": false "Id": 3432, "Value": "100", "IsIgnored": false "Id": 3484, "Value": "30", "IsIgnored": false "Id": 3485, "Value": "100", "IsIgnored": false "Id": 3503,
} ] } "Untagged": 25455, "Tagged": [25531,25532] Identity pools /api/IdentityPoolService/IdentityPools This URI represents the identity pools. GET method for IdentityPools This method returns the details of all identity pools. Description Returns identity pools. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(IdentityPoolService.IdentityPool)", "@odata.count": 2, "value": [ { "@odata.type": "#IdentityPoolService.
"SubnetMask": "255.255.255.0", "Gateway": null, "PrimaryDnsServer": null, "SecondaryDnsServer": null } }, "FcoeSettings": { "Mac": { "IdentityCount": 240, "StartingMacAddress": "FBQUFBQB" } }, "FcSettings": { "Wwnn": { "IdentityCount": 260, "StartingAddress": "IAAWFhYWFgE=" }, "Wwpn": { "IdentityCount": 260, "StartingAddress": "IAEWFhYWFgE=" } }, "UsageCounts": { "@odata.id": "/api/IdentityPoolService/IdentityPools(1)/ UsageCounts" }, "UsageIdentitySets@odata.
}, "FcoeSettings": { "Mac": { "IdentityCount": 75, "StartingMacAddress": "cHBwcHAA" } }, "FcSettings": { "Wwnn": { "IdentityCount": 85, "StartingAddress": "IACAgICAgAA=" }, "Wwpn": { "IdentityCount": 85, "StartingAddress": "IAGAgICAgAA=" } }, "UsageCounts": { "@odata.id": "/api/IdentityPoolService/IdentityPools(10)/ UsageCounts" }, "UsageIdentitySets@odata.
{ } "IdentityCount":75, "StartingMacAddress": "cHBwcHAA" } }, "FcSettings": { "Wwnn": { "IdentityCount":85, "StartingAddress": "IACAgICAgAA=" }, "Wwpn": { "IdentityCount":85, "StartingAddress": "IAGAgICAgAA=" } } Output: /api/IdentityPoolService/IdentityPools(Id) This URI represents a specific identity pool. GET method for IdentityPools(Id) This method returns the details of a specific identity pool. Description Returns a specific identity pool.
}, "InitiatorConfig": { "IqnPrefix": "Iqn.MyIqnPrefix" }, "InitiatorIpPoolSettings": null }, "FcoeSettings": { "Mac": { "IdentityCount": 75, "StartingMacAddress": "cHBwcHAA" } }, "FcSettings": { "Wwnn": { "IdentityCount": 85, "StartingAddress": "IACAgICAgAA=" }, "Wwpn": { "IdentityCount": 85, "StartingAddress": "IAGAgICAgAA=" } }, "UsageCounts": { "@odata.id": "/api/IdentityPoolService/IdentityPools(4)/UsageCounts" }, "UsageIdentitySets@odata.
} }, "FcoeSettings": { "Mac": { "IdentityCount": 75, "StartingMacAddress": "cHBwcHAA" } }, "FcSettings": { "Wwnn": { "IdentityCount": 85, "StartingAddress": "IACAgICAgAA=" }, "Wwpn": { } } } "IdentityCount": 85, "StartingAddress": "IAGAgICAgAA=" Output: DELETE method for IdentityPools(Id) This method deletes an identity pool. Description Deletes an identity pool.
} "@odata.type": "#IdentityPoolService.UsageCounts", "@odata.
[ { "@odata.type": "#IdentityPoolService.UsageIdentitySet", "@odata.id": "/api/IdentityPoolService/IdentityPools(4)/ UsageIdentitySets(1)", "IdentitySetId": 1, "Name": "Ethernet", "Details@odata.navigationLink": "/api/IdentityPoolService/ IdentityPools(4)/UsageIdentitySets(1)/Details" }, { "@odata.type": "#IdentityPoolService.UsageIdentitySet", "@odata.id": "/api/IdentityPoolService/IdentityPools(4)/ UsageIdentitySets(2)", "IdentitySetId": 2, "Name": "iSCSI", "Details@odata.
"Details@odata.navigationLink": "/api/IdentityPoolService/ IdentityPools(4)/UsageIdentitySets(1)/Details" } /api/IdentityPoolService/IdentityPools(Id)/ UsageIdentitySets(Id)/Details This URI represents usage details for a specific identity pool and identity set (protocol). GET method for Details of UsageIdentitySets(Id) This method returns the usage details for a specific identity pool and identity set or protocol.
} ] } "NicIdentifier": "NIC in Mezzanine 1B Port 1 Partition 1", "DeviceInfo": { "ChassisName": "MX-LCX", "SlotNumber": "7", "ServerName": "idrac-SRVC333", "ManagementIp": "10.215.2.134" } /api/IdentityPoolService/IdentityStates This URI represents the identity states for the identities in an identity pool. GET method for IdentityStates This method returns the identity states, such as Reserved and Assigned, for the identities in an identity pool. Description Returns identity states.
Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#IdentityPoolService.IdentityState/ $entity", "@odata.type": "#IdentityPoolService.IdentityState", "@odata.id": "/api/IdentityPoolService/IdentityStates(1)", "Id": 1, "Name": "Reserved", "Description": "Assigned to a profile; deployment pending." } /api/IdentityPoolService/Actions/ IdentityPoolService.DeleteIdentityPools POST method for IdentityPoolService.
HTTP response codes Example 200 Input: Output: { "@odata.context": "/api/ $metadata#Collection(NetworkConfigurationService.Network)", "@odata.count": 2, "value": [ { "@odata.id": "/api/NetworkConfigurationService/Networks(42214)", "Id": 42214, "Name": "Network-1", "Description": "", "VlanMaximum": 3, "VlanMinimum": 3, "Type": 1, "CreatedBy": "root", "CreationTime": "1970-01-01 01:01:48.181", "UpdatedBy": null, "UpdatedTime": "1970-01-01 01:01:48.181", "InternalRefNWUUId": 0 }, { "@odata.
Table 84. Attributes (continued) Attribute name Description InternalRefId Reference ID used for internal purposes. POST method for Networks This method creates a network. Description Creates a network. Privilege TEMPLATE_MANAGEMENT HTTP response codes 201 Example Input: { "Name": "abc-1", "Description": "abc", "VlanMaximum": 19, "VlanMinimum": 19, "Type": 1 } Output: { "@odata.context": "/api/$metadata#NetworkConfigurationService.Network/ $entity", "@odata.
} "@odata.id": "/api/NetworkConfigurationService/Networks(42214)", "Id": 42214, "Name": "Network-1", "Description": "abc", "VlanMaximum": 3, "VlanMinimum": 3, "Type": 1, "CreatedBy": "root", "CreationTime": "1970-01-01 01:01:48.181", "UpdatedBy": null, "UpdatedTime": "1970-01-01 01:01:48.181", "InternalRefNWUUId": 0 PUT method for Networks(Id) This method updates an existing network. Description Updates a network.
/api/NetworkConfigurationService/NetworkTypes This URI represents the supported network types. GET method for NetworkTypes This method returns a list of the supported network types. Description Returns a list of network types. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(NetworkConfigurationService.NetworkType)", "@odata.count": 11, "value": [ { "@odata.
/api/NetworkConfigurationService/NetworkTypes(Id) This URI represents a specific network type within the collection. GET method for NetworkTypes(Id) This method returns the details of a specific network type. Description Returns the details of a specific network type. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#NetworkConfigurationService.NetworkType/$entity", "@odata.
} ] } "Name": "Bronze" Table 86. Attributes Attribute name Description Id ID of the QoS type. Name Name of the QoS type. /api/NetworkConfigurationService/QosTypes(Id) This URI represents a specific QoS type within the collection. GET method for QosTypes(Id) This method returns a specific QoS type. Description Returns a specific QoS type. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#NetworkConfigurationService.QosType/ $entity", "@odata.
7 Devices Topics: • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • /api/DeviceService /api/DeviceService/Devices /api/DeviceService/Devices(Id) /api/DeviceService/Devices(Id)/InventoryDetails /api/DeviceService/Devices(Id)/InventoryDetails(InventoryType) /api/DeviceService/Devices(Id)/Settings('ReplicableChassisConfigurations') /api/DeviceService/Devices(Id)/HardwareLogs /api/DeviceService/Devices(Id)/SubSystemHealth /api/DeviceService/Devices(Id)/RecentActivity /api/DeviceService/Devices(Id)/In
Example Input: Output: { "@odata.context": "$metadata#DeviceService.DeviceService", "@odata.id": "/api/DeviceService", "Actions": null, "Devices": [ { "@odata.id": "/api/DeviceService/Devices" } ], "DeviceStatuses": [ { "@odata.id": "/api/DeviceService/DeviceStatuses" } ], "DeviceType": [ { "@odata.id": "/api/DeviceService/DeviceType" } ], "PowerStates": [ { "@odata.id": "/api/DeviceService/PowerStates" } ], "DeviceSummary": [ { "@odata.
"value": [ { "@odata.id": "/api/DeviceService/Devices(3315)", "Id": 3315, "Type": 1000, "Identifier": "SVCTG06", "DeviceServiceTag": "SVCTG06", "ChassisServiceTag": "SKY0028", "Model": "PowerEdge MX740c", "PowerState": 18, "ManagedState": 5000, "Status": 1000, "ConnectionState": false, "AssetTag": null, "SystemId": 1893, "DeviceName": "WIN-02GODDHDJTC", "LastInventoryTime": "2017-09-05 09:00:11.186", "LastStatusTime": "2017-09-06 08:30:06.
{ "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails" } ], "HardwareLogs": [ { "@odata.id": "/api/DeviceService/Devices(3315)/ HardwareLogs" } ], "SubSystemHealth": [ { "@odata.id": "/api/DeviceService/Devices(3315)/ SubSystemHealth" } ], "RecentActivity": [ { "@odata.id": "/api/DeviceService/Devices(3315)/ RecentActivity" } ], "InventoryTypes": { "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryTypes" }, "LogSeverities": { "@odata.
} {…}, {…}, {…} /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 Input: Output: { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 5, "value": [ { "@odata.
"DeviceSpecificData": null, "SlotConfiguration": { "ChassisId": "4165", "SlotNumber": "6", "SledBlockPowerOn": "None blocking", "ChassisName": "GUI PT", "SlotName": "Sled-6", "ChassisServiceTag": "SKY0028", "SlotType": "2000" }, "DeviceManagement": [ { "ManagementId": 5003, "NetworkAddress": "10.35.0.
"@odata.id": "/api/DeviceService/Devices(3315)/BlinkStatus" }, "PowerUsageByDevice": [ { "@odata.id": "/api/DeviceService/Devices(3315)/ PowerUsageByDevice" } ], "Faults": [ { "@odata.id": "/api/DeviceService/Devices(3315)/Faults" } ], "DeviceBladeSlots": [ { "@odata.id": "/api/DeviceService/Devices(3315)/ DeviceBladeSlots" } ], "GraphicInfo": { "@odata.
}, { }, { }, { }, { mode]", }, { }, { mode]", }, { ] } "Description": "Lewisburg PCI Express Root Port #1", "DatabusWidth": "Unknown", "SlotLength": "Unknown", "SlotType": "Unknown" "Id": 129, "SlotNumber": "HostBridge.Embedded.1-1", "Manufacturer": "Intel Corporation", "Description": "Intel Corporation", "DatabusWidth": "Unknown", "SlotLength": "Unknown", "SlotType": "Unknown" "Id": 130, "SlotNumber": "Video.Embedded.1-1", "Manufacturer": "Matrox Electronics Systems Ltd.
}, { ] } "CurrentSpeed": 1600, "SlotNumber": "CPU.Socket.1", "Status": 2000, "NumberOfCores": 8, "NumberOfEnabledCores": 8, "BrandName": "Intel", "ModelName": "Genuine Intel(R) CPU 0000%@", "InstanceId": "CPU.Socket.1", "Voltage": "1.8" "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('serverNetworkInterfaces')", "InventoryType": "serverNetworkInterfaces", "InventoryInfo": [] }, { "@odata.
InventoryDetails('serverRaidControllers')", "InventoryType": "serverRaidControllers", "InventoryInfo": [ { "Id": 20, "DeviceId": 0, "Name": "Lewisburg SATA Controller [AHCI mode]", "Fqdd": "AHCI.Embedded.2-1", "Status": 2000, "StatusTypeString": "UNKNOWN", "RollupStatus": 2000, "RollupStatusString": "UNKNOWN", "CacheSizeInMb": 0, "PciSlot": 0 }, { "Id": 19, "DeviceId": 0, "Name": "Lewisburg SSATA Controller [AHCI mode]", "Fqdd": "AHCI.Embedded.
{ }, { }, { }, { }, { ] } "Id": 111, "PowerState": 8 "Id": 112, "PowerState": 10 "Id": 113, "PowerState": 11 "Id": 114, "PowerState": 12 "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('deviceLicense')", "InventoryType": "deviceLicense", "InventoryInfo": [ { "SoldDate": "2016-06-12 14:48:13.000", "LicenseBound": 4, "EvalTimeRemaining": 0, "AssignedDevices": "iDRAC.Embedded.
}, { }, { }, { }, { }, { assigned Storage" }, { capability.
}, { }, { }, { }, { }, { }, { ] } "Id": 378, "CapabilityType": { "CapabilityId": 3, "Name": "POWER_CONTROL_RESET", "Description": "Power reset hard/graceful" } "Id": 379, "CapabilityType": { "CapabilityId": 2, "Name": "POWER_CONTROL_OFF", "Description": "Power Down hard/graceful" } "Id": 380, "CapabilityType": { "CapabilityId": 1, "Name": "POWER_CONTROL_ON", "Description": "Power up" } "Id": 381, "CapabilityType": { "CapabilityId": 32, "Name": "REMOTE_SSH", "Description": "14G specific features" } "
}, { "InventoryInfo": [ { "Id": 19, "Rack": "78", "Aisle": "Lakeln", "Datacenter": "AlladiaAnoop" } ] "@odata.id": "/api/DeviceService/Devices(3315)/ InventoryDetails('deviceManagement')", "InventoryType": "deviceManagement", "InventoryInfo": [ { "ManagementId": 5003, "IpAddress": "10.35.0.
"InstanceId": "DCIM:PREVIOUS#iDRAC.Embedded.1-1#IDRACinfo" }, { "Version": "0.3.0", "InstallationDate": "2017-06-16T01:22:28Z", "Status": "Installed", "SoftwareType": "BIOS", "ComponentId": "159", "DeviceDescription": "BIOS", "InstanceId": "DCIM:INSTALLED#741__BIOS.Setup.
}, { ] } "InstanceId": "DCIM:INSTALLED#803__CPLD.Embedded.1" "@odata.
} "InventoryInfo": [ { "Id": 145, "Status": 2000, "SubsystemName": }, { "Id": 146, "Status": 1000, "SubsystemName": }, { "Id": 147, "Status": 1000, "SubsystemName": }, { "Id": 148, "Status": 1000, "SubsystemName": }, { "Id": 149, "Status": 3000, "SubsystemName": }, { "Id": 150, "Status": 1000, "SubsystemName": }, { "Id": 151, "Status": 1000, "SubsystemName": }, { "Id": 152, "Status": 2000, "SubsystemName": } ] "cpuRollupStatus" "sysMemPrimaryStatus" "voltRollupStatus" "batteryRollupStatus" "licensingR
HTTP response codes Example 200 Input: /api/DeviceService/Devices(25004)/InventoryDetails('deviceSoftware') Output: { "@odata.context": "/api/$metadata#DeviceService.InventoryDetail/ $entity", "@odata.type": "#DeviceService.InventoryDetail", "@odata.id": "/api/DeviceService/Devices(25009)/ InventoryDetails('deviceSoftware')", "InventoryType": "deviceSoftware", "InventoryInfo": [ {"Version": "0.3.
] } NA } Output: Table 87. Attributes Attribute Description SettingType Defines the setting type that must be applied. The setting here is, "ReplicableChassisConfigurations" Configurations Defines the configuration you want to apply. The Configurations attribute requires the Type and Replicate flag. Type The configuration you want to apply. The Type attribute supports "AlertDestination" or "TimeConfigurations". Replicate Boolean flag to determine if you prefer to set the configuration or not.
}, { "LogId": "DCIM:LifeCycleLog:286449", "LogCategory": "Audit", "DateFormat": "CIM" "LogTimestamp": "20170907053540.000000-300", "LogSequenceNumber": 286412, "LogSeverity": 1000, "LogComment": "[set comment here]", "LogMessageId": "USR0030", "LogMessage": "Successfully logged in using root, from 10.32.19.194 and wsman.", "LogId": "DCIM:LifeCycleLog:286412", "LogCategory": "Audit", "DateFormat": "CIM" }, { "LogTimestamp": "20170907053540.
{ }, { }, { }, { }, { } ] } "SubSystem": "Voltage", "RollupStatus": "1000" "SubSystem": "Current", "RollupStatus": "1000" "SubSystem": "Processor", "RollupStatus": "2000" "SubSystem": "Memory", "RollupStatus": "2000" "SubSystem": "Temperature", "RollupStatus": "1000" /api/DeviceService/Devices(Id)/RecentActivity This URI represents the recent activities for a specific device. GET method for RecentActivity This method returns the recent activities for a specific device.
"Value": "Running\nSlot ID passed null cannot perform Quick Deploy.\nTask Failed. Execution has completed", "TaskName": "Deployment and Configuration Check", "ExecutionHistoryId": 8, "TaskId": 4015, "TaskType": 24 } ] } /api/DeviceService/Devices(Id)/InventoryTypes This URI represents the inventory types for a specific device. GET method for InventoryTypes This method returns the inventory types for a specific device. Description Returns the inventory types for a specific device.
/api/DeviceService/Devices(Id)/LogSeverities This URI represents the log severities for a specific device. GET method for LogSeverities This method returns the log-severity details for a specific device. Description Returns the log-severity details for a specific device. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#DeviceService.LogSeverities/$entity", "@odata.
} ] /api/DeviceService/Devices(Id)/Settings('Type') This URI represents a specific type of setting for a device. The settings differ depending on the type of device. To see the list of available settings, use the Get method on the Device(Id)/ Settings URI.
} } "TertiaryDNS": "" Example for network settings for Chassis Input: Output: { "@odata.context": "/api/$metadata#DeviceService.DeviceSetting/$entity", "@odata.type": "#DeviceService.DeviceSetting", "@odata.
} "@odata.id": "/api/DeviceService/Devices(25773)/Settings('Network')", "SettingType": "Network", "MgmtVLANId": "", "EnableMgmtVLANId": false, "IomIPv4Settings": { "EnableIPv4": true, "EnableDHCP": true, "StaticIPAddress": "10.35.176.185", "StaticSubnetMask": "255.255.255.0", "StaticGateway": "10.35.176.
"EnableIPv4": true, "EnableDHCP": true, "StaticIPAddress": "", "StaticSubnetMask": "", "StaticGateway": "", "UseDHCPObtainDNSServerAddresses": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" } }, "Ipv6Settings": { "EnableIPv6": false, "EnableAutoconfiguration": true, "StaticIPv6Address": "", "StaticPrefixLength": "0", "StaticGateway": "", "UseDHCPv6ObtainDNSServerAddresses": true, "StaticPreferredDNSServer": "", "StaticAlternateDNSServer": "" }, "GeneralSettings": { "EnableNIC": true,
} } /api/DeviceService/Devices(Id)/Temperature This URI represents the temperature settings of a specific device. GET method for Temperature This method returns the temperature details of a specific device. Description Returns the temperature details of a specific device. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#DeviceService.TemperatureResponseModel/ $entity", "@odata.
} "minimumPower": "65535", "peakPower": "73", "DateFormat": "CIM", "systemEnergyConsumption": "0.000", "Since": "20170414145039.000000-300", "peakPowerTimeStamp": "20170414145039.000000-300", "power": "0", "peakPowerUnit": "watt", "minimumPowerUnit": "watt" /api/DeviceService/Devices(Id)/BlinkStatus This URI represents the LED-blink status of a specific device. GET method for BlinkStatus This method returns the LED-blink status of a specific device.
} "avgPower": "0", "systemEnergyConsumptionUnit": "killowatt-hour", "systemEnergyConsumptionTimeStamp": "20170907071147.450000-300", "powerUnit": "watt", "minimumPowerTimeStamp": "19691231180000.000000-360", "avgPowerUnit": "watt", "minimumPower": "65535", "peakPower": "73", "DateFormat": "CIM", "systemEnergyConsumption": "0.000", "Since": "20170414145039.000000-300", "peakPowerTimeStamp": "20170414145039.
} ] } "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 Input: Output: { "@odata.context": "$metadata#DeviceService.GraphicInfo/$entity", "@odata.
/api/DeviceService/PowerStates This URI represents the power states of the devices. GET method for PowerStates This method returns a list of the power states that the devices can be in. Description Returns a list of power states. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(DeviceService.PowerState)", "@odata.
{ }, { }, { }, { }, { } ] } "GlobalStatus": 1000, "Name": "NORMAL", "Description": "The device is running normal." "GlobalStatus": 2000, "Name": "UNKNOWN", "Description": "Status is not determined." "GlobalStatus": 3000, "Name": "WARNING", "Description": "The device has warning state." "GlobalStatus": 4000, "Name": "CRITICAL", "Description": "The device is in critical state." "GlobalStatus": 5000, "Name": "NOSTATUS", "Description": "The device/group does not have a valid status.
}, { }, { } ] } "DeviceType": 4000, "Name": "NETWORK_IOM", "Description": "NETWORK IO Module Device" "DeviceType": 3000, "Name": "STORAGE", "Description": "Storage Device" "DeviceType": 8000, "Name": "STORAGE_IOM", "Description": "Storage IOM Device" /api/DeviceService/DeviceSummary This URI represents the summary of the devices statuses. In the response, devices of the same type are grouped. GET method for DeviceSummary This method returns the summary of device statuses.
{ }, { }, { "@odata.id": "/api/DeviceService/DeviceSummary(2000)", "DeviceType": 2000, "TotalCount": 1, "DeviceStatusSummary": [ { "StatusType": 1000, "Count": 0 }, { "StatusType": 2000, "Count": 0 }, { "StatusType": 3000, "Count": 0 }, { "StatusType": 4000, "Count": 1 }, { "StatusType": 5000, "Count": 0 } ] "@odata.
}, { }, { }, { } 206 Devices ] } ] } "StatusType": 4000, "Count": 0 "StatusType": 5000, "Count": 0 "@odata.id": "/api/DeviceService/DeviceSummary(3000)", "DeviceType": 3000, "TotalCount": 1, "DeviceStatusSummary": [ { "StatusType": 1000, "Count": 0 }, { "StatusType": 2000, "Count": 1 }, { "StatusType": 3000, "Count": 0 }, { "StatusType": 4000, "Count": 0 }, { "StatusType": 5000, "Count": 0 } ] "@odata.
/api/DeviceService/DeviceSlotType This URI represents the slot types. GET method for DeviceSlotType This method returns a list of the available slot types. Description Returns a list of slot types. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(DeviceService.DeviceSlotType)", "@odata.count": 6, "value": [ { "SlotType": 1000, "SlotName": "UNKNOWN", "Description": "Slot type is unknown.
/api/DeviceService/DeviceSettingsMetadata This URI represents the settings metadata. GET method for DeviceSettingsMetadata This method returns a list of device-settings metadata. Description Returns a list of settings metadata. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(DeviceService.DeviceSettingsMetadata)", "@odata.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Key": "ENABLE_ONCE_AFTER_RESET", "Value": "Enable Once After Reset", "Description": "Dhcp Provisioning is enable once after reset" "Id": 8000, "Property": "networkSpeed", "Key": "10_MB", "Value": "10 MB", "Description": "Network speed is 10 MB" "Id": 9000, "Property": "networkSpeed", "Key": "100_MB", "Value": "100 MB", "Description": "Network speed is 100 MB" "Id": 10000, "Property": "networkSpeed", "Key": "1_GB", "Value": "1 GB", "Description": "
}, { }, { } ] } "Description": "LCD access is view only" "Id": 18000, "Property": "lcdAccess", "Key": "VIEW_AND_MODIFY", "Value": "View and Modify", "Description": "LCD access is view and modify" "Id": 19000, "Property": "redundancyPolicy", "Key": "PSU_REDUNDANCY", "Value": "PSU Redundancy", "Description": "Redundancy policy type is PSU redundancy" /api/DeviceService/GlobalExcludes This URI represents the globally excluded ranges.
}, { } ] } "Identifier": "R930PR0", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 3, "NetworkAddress": "10.35.0.45" } ] "@odata.id": "/api/DeviceService/GlobalExcludes(4)", "Id": 4, "Identifier": "IPRange2", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 4, "NetworkAddress": "10.35.0.101-10.35.0.255" } ] POST method for GlobalExcludes This method globally excludes ranges. Description Globally excludes ranges.
} "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 0, "NetworkAddress": "10.37.0.101-10.37.0.255" } ] /api/DeviceService/Actions/ DeviceService.EditNetworkRange This URI edits the global exclusion ranges. POST method for DeviceService.EditNetworkRange This method edits ranges in global exclusion. Description Edits ranges in global exclusion.
/api/DeviceService/Actions/ DeviceService.ValidateExcludes This URI validates global exclusion. POST method for DeviceService.ValidateExcludes This method validates ranges in global exclusion. Description Validates ranges in global exclusion. Privilege APPLIANCE_SETUP HTTP response codes 200 Example Input: { "Id": 0, "Identifier": "IPRange2", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 0, "NetworkAddress": "10.37.0.*" }, { "Id": 0, "NetworkAddress": "10.37.0.0-10.35.0.
8 Diagnostic Topics: • /api/DeviceService/Devices(Id)/Actions/DeviceService.Diagnostic /api/DeviceService/Devices(Id)/Actions/ DeviceService.Diagnostic This URI allows you to execute supported diagnostic commands. POST method for DeviceService.Diagnostic This method executes the supported diagnostics commands. Description Executes supported diagnostic commands.
9 Groups Topics: • • • • • • • • • • • • • • /api/GroupService/Groups /api/GroupService/Groups(Id) /api/GroupService/Groups(Id)/Devices /api/GroupService/Groups(Id)/GroupDevicesSummary /api/GroupService/Groups(Id)/SubGroups /api/GroupService/Groups(Id)/GroupHierarchy /api/GroupService/GroupTypes /api/GroupService/GroupTypes(Id) /api/GroupService/MembershipTypes /api/GroupService/MembershipTypes(Id) /api/GroupService/AllGroupsHierarchy /api/GroupService/Actions/GroupService.
} ] } "MembershipTypeId": 24, "Devices": [ { "@odata.id": "/api/GroupService/Groups(64)/Devices" } ], "AllLeafDevices": [ { "@odata.id": "/api/GroupService/Groups(64)/AllLeafDevices" } ], "GroupHierarchy": [ { "@odata.id": "/api/GroupService/Groups(64)/GroupHierarchy" } ], "SubGroups": [ { "@odata.id": "/api/GroupService/Groups(64)/SubGroups" } ], "GroupDevicesSummary": [ { "@odata.id": "/api/GroupService/Groups(64)/GroupDevicesSummary" } ] Table 88.
Table 88. Attributes (continued) Attribute name Description Link Devices Group link to list group devices. AllLeafDevices Group link to list all group sub groups devices. GroupHierarchy Group link to list the group hierarchy. SubGroup Group link to display the list of sub groups of this group. GroupDevicesSummary Group link to display a summary of all group devices. Table 89. Filters Attribute name Description Top Top records to return. Default value is 100. Skip Max records to skip.
{ } "@odata.context": "$metadata#GroupService.Group/$entity", "@odata.id": "/api/GroupService/Groups(64)", "Id": 64, "Name": "All Devices", "Description": "Group associated to all devices.", "GlobalStatus": 5000, "ParentId": 0, "CreationTime": "2017-06-08 18:48:27.069", "UpdatedTime": "2017-06-08 21:15:01.746", "CreatedBy": "system", "UpdatedBy": "", "Visible": true, "DefinitionId": 500, "DefinitionDescription": "Root group for all Types of Devices.
Table 90. Attributes (continued) Attribute name Description 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. SubGroup Group link to display the list of sub groups of this group.
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 Input: { "Id": 1564 } Output: Table 91. 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.
"DeviceCapabilities": [ 32, 1, 2, 3, 4, 7, 9, 12, 13, 14, 15, 16, 17, 30, 31 ], "DeviceSubscription": null, "DeviceSpecificData": null, "SlotConfiguration": {}, "DeviceManagement": [ { "ManagementId": 5003, "NetworkAddress": "fe80::f68e:38ff:fecf:15ba", "MacAddress": "", "ManagementURL": "https://10.36.0.30", "ManagementType": 2, "InstrumentationName": "WIN-02GODDHDJTC", "DnsName": "idrac-SVCTAG", "Status": 1000 }, { "ManagementId": 5002, "NetworkAddress": "10.36.0.
} ], "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.
} "@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 93. Attributes Attribute name Description Id ID of the group. /api/GroupService/Groups(Id)/SubGroups This URI represents the subgroups of a specific group.
"ParentId": 64, "CreationTime": "2017-06-08 21:34:42.681", "UpdatedTime": "2017-06-08 21:34:42.681", "CreatedBy": "root", "UpdatedBy": "", "Visible": true, "DefinitionId": 400, "DefinitionDescription": "UserDefined", "TypeId": 3000, "MembershipTypeId": 12, "Devices": [ { "@odata.id": "/api/GroupService/Groups(19164)/Devices" } ], "AllLeafDevices": [ { "@odata.id": "/api/GroupService/Groups(19164)/AllLeafDevices" } ], "GroupHierarchy": [ { "@odata.
Table 94. Attributes (continued) Attribute name Description ● ● ● ● MembershipTypeId 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. SubGroup Group link to display the list of sub groups of this group.
/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 Input: Output: { "@odata.context": "$metadata#Collection(GroupService.GroupType)", "@odata.count": 5, "value": [ { "@odata.id": "/api/GroupService/GroupTypes(1000)", "Id": 1000, "Name": "Internal Group", "Description": "Internal group.
/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 Input: Output: { "@odata.context": "$metadata#GroupService.GroupType/$entity", "@odata.id": "/api/GroupService/GroupTypes(1000)", "Id": 1000, "Name": "Internal Group", "Description": "Internal group.
}, { } ] } "Name": "Static", "Description": "Static type" "@odata.id": "/api/GroupService/MembershipTypes(24)", "Id": 24, "Name": "Dynamic", "Description": "Dynamic type" Table 98. 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.
/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 Input: Output: { "@odata.context": "$metadata#Collection(GroupService.GroupHierarchy)", "@odata.
Output: /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.
Example Input: { “IncludeLeafs”: true, // optional parameter, if not included then default if false “Privileges”: [[] // ex. [“DEVICE_UPDATE”] } Output: List of groups on which the user the specified privilege.
10 Monitor Topics: • • Audit logs Jobs Audit logs /api/ApplicationService/AuditLogs This URI represents a collection of audit logs of the system. GET method for AuditLogs This method returns a collection of audit logs of the system. Description Returns a collection of audit logs. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(ApplicationService.AuditLog)", "@odata.count": 7, "value": [ { "@odata.
/api/ApplicationService/AuditLogs(Id) This URI represents a specific audit log within the collection. GET method for AuditLogs(Id) This method returns the details of a specific event or error message. Description Returns the details of a specific event or error message. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(ApplicationService.AuditLog)", "@odata.count": 7, "value": [ { "@odata.
Jobs /api/JobService/Jobs This URI represents all the jobs. GET method for Jobs This method returns the details of all the jobs. Description Returns details of all the jobs. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(JobService.Job)", "@odata.count": 1, "value": [ { "@odata.type": "#JobService.Job", "@odata.
"Name": "Completed" }, "JobType": { "@odata.type": "#JobService.JobType", "Id": 8, "Name": "Inventory_Task", "Internal": false }, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2020, "Name": "Scheduled" }, "ExecutionHistories@odata.navigationLink": "/api/JobService/ Jobs(10016)/ExecutionHistories" } ] } Table 101. Filters Filter name Description Top Top records to return. Default value is 100. Skip Max records to skip. Default value is 0. JobType/Id Filter by job type.
Table 102. Attributes (continued) Attribute Description UpdatedBy User who updated the job. Visible Indicates whether the job is visible. Editable Indicates whether the job can be edited. BuiltIn Indicates if the job is internal. Targets Job targets. Params Parameters for the job. LastRunStatus Indicates the status of the last instance of the job execution. JobStatus Job completion status.
} ] } Output: { "Id": 26097, "JobName": "Inventory Task Device", "JobDescription": "Inventory Task Device", "NextRun": null, "LastRun": null, "StartTime": null, "EndTime": null, "Schedule": "startnow", "State": "Enabled", "CreatedBy": "root", "UpdatedBy": null, "LastRunStatus": { "Id": 2200, "Name": "NotRun" }, "JobType": { "Id": 8, "Name": "Inventory_Task", "Internal": false }, "JobStatus": { "Id": 2080, "Name": "New" }, "Targets": [ { "JobId": 26097, "Id": 25915, "Data": "", "TargetType": { "Id": 1000,
Example Input: Output: { "@odata.context": "/api/$metadata#JobService.Job/$entity", "@odata.type": "#JobService.Job", "@odata.id": "/api/JobService/Jobs(10016)", "Id": 10016, "JobName": "Default Inventory Task", "JobDescription": "Default Inventory Task", "NextRun": "2018-09-14 15:30:00.0", "LastRun": "2018-09-14 15:00:00.
Table 103. Attributes (continued) Attribute Description JobName Name of the job. JobDescription Description of the job. JobType Type of the job. NextRun The next time when the job will be executed. LastRun The last time when the job was executed. StartTime Start time of the job. EndTime End time of the job. Schedule Job schedule (cron string). State Indicates whether the job is enabled or disabled. CreatedBy User who created the job. UpdatedBy User who updated the job.
} "JobName":"Inventory Task", "JobDescription":"Inventory Task", "Schedule":"startnow", "State":"Enabled", "JobType": { "Id":8, "Name":"Inventory_Task" }, "Targets": [ { "Id": 25915, "Data": "", "TargetType": { "Id":1000, "Name":"DEVICE" } } ] Output: { "Id": 26097, "JobName": "Inventory Task", "JobDescription": "Inventory Task", "NextRun": null, "LastRun": "2018-09-14 15:31:13.
Table 104. Attributes Attribute Description Id ID of the job to be updated. DELETE method for Jobs(Id) This method deletes a specific job. Description Deletes a job. Privilege JOB_MANAGEMENT HTTP response codes 204 Example Input: Output: Table 105. Attributes Attribute Description Id ID of the job to be deleted. /api/JobService/JobStatuses This URI represents the status of all the jobs. GET method for JobStatuses This method returns the status of all the jobs.
}, { }, { }, { }, { }, { }, { }, { }, { }, { } ] } "@odata.id": "/api/JobService/JobStatuses(2040)", "Id": 2040, "Name": "Starting" "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2050)", "Id": 2050, "Name": "Running" "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2060)", "Id": 2060, "Name": "Completed" "@odata.type": "#JobService.JobStatus", "@odata.
/api/JobService/JobStatuses(Id) This URI represents the status of a job. GET method for JobStatuses(Id) This method returns the details of a specific job status. Description Returns details of a specific job status. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#JobService.JobStatus/$entity", "@odata.type": "#JobService.JobStatus", "@odata.id": "/api/JobService/JobStatuses(2030)", "Id": 2030, "Name": "Queued" } Table 107.
{ }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 244 Monitor "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(5)", "Id": 5, "Name": "Update_Task", "Internal": false "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(8)", "Id": 8, "Name": "Inventory_Task", "Internal": false "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(15)", "Id": 15, "Name": "RollbackSoftware_Task", "Internal": false "@odata.
}, { }, { }, { } ] } "@odata.id": "/api/JobService/JobTypes(38)", "Id": 38, "Name": "MCMOffBoarding_Task", "Internal": false "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(39)", "Id": 39, "Name": "MCMGroupCreation_Task", "Internal": false "@odata.type": "#JobService.JobType", "@odata.id": "/api/JobService/JobTypes(41)", "Id": 41, "Name": "ProfileUpdate_Task", "Internal": false "@odata.type": "#JobService.JobType", "@odata.
Table 109. Attributes Attribute Description Id ID of the job type. Name Name of the job type. Internal Indicates whether the job is internal. /api/JobService/Jobs(Id)/ExecutionHistories This URI represents all the execution histories for a job. GET method for ExecutionHistories This method returns the details of all the execution histories for a job. Description Returns details of all executions histories for a job. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.
{ "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" }, "ExecutionHistoryDetails@odata.navigationLink": "/api/JobService/ Jobs(10016)/ExecutionHistories(18811)/ExecutionHistoryDetails" }, { "@odata.type": "#JobService.ExecutionHistory", "@odata.id": "/api/JobService/Jobs(10016)/ ExecutionHistories(18774)", "Id": 18774, "JobName": "Default Inventory Task", "Progress": "100", "StartTime": "2018-09-14 14:00:00.526", "EndTime": "2018-09-14 14:00:29.
} ] Table 110. Attributes Attribute Description Id Job execution history detail ID. JobName Name of the job. Progress Percentage of completion. StartTime The start time of job execution. EndTime The end time of job execution. Schedule Job schedule (cron string). State Indicates whether the job is enabled or disabled. LastUpdatedTime Timestamp when the job-execution history was last updated. ExecutedBy Details of who executed the job. JobId Job associated with the execution history.
}, { } "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" "@odata.type": "#JobService.ExecutionHistoryDetail", "@odata.id": "/api/JobService/Jobs(10016)/ ExecutionHistories(18683)/ExecutionHistoryDetails(7137)", "Id": 7137, "Progress": "100", "StartTime": "2018-09-14 13:00:00.324", "EndTime": "2018-09-14 13:00:11.948", "Key": "MX-MSMDNH1", "Value": "Running\nCompleted", "ExecutionHistoryId": 18683, "JobStatus": { "@odata.type": "#JobService.
Or Input: { "Filters": { "Status": 2020, "State": "", "JobType": "AlertSubscription_Task", "StartTime": "2017-06-06 10:00:00.00", "EndTime": "2017-06-07 10:00:00.00" } } Or Input: { "AllJobs": true, } Output: /api/JobService/Actions/JobService.DisableJobs POST method for JobService.DisableJobs This method disables the selected jobs. Description Disables the selected jobs.
/api/JobService/Actions/JobService.RemoveJobs POST method for JobService.RemoveJobs This method deletes the selected jobs. Description Deletes the selected jobs.
} "JobIds": [100,200,300], Or Input: { "Filters": { "Status": 2020, "State": "", "JobType": "AlertSubscription_Task", "StartTime": "2017-06-06 10:00:00.00", "EndTime": "2017-06-07 10:00:00.00" } } Or Input: { "AllJobs": true, } Output: /api/JobService/Actions/JobService.StopJobs POST method for JobService.StopJobs This method stops the selected jobs. Description Stops the selected jobs.
Output: Monitor 253
11 Reset application Topics: • /api/ApplicationService/Actions/ApplicationService.ResetApplication /api/ApplicationService/Actions/ ApplicationService.ResetApplication This URI resets the application and select between resetting all data or only resetting the configuraiton. POST method for ResetApplication This method resets the application. You can either reset only the configuration or also clear all the data.
12 Console version Topics: • /api/ApplicationService/Info /api/ApplicationService/Info This URI represents the product information. GET method for Info This method returns the product information. Description Returns the product information. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#ApplicationService.Info/$entity", "@odata.type": "#ApplicationService.Info", "@odata.
13 Console capabilities Topics: • /api/ApplicationService/Capabilities /api/ApplicationService/Capabilities This URI represents the capabilities of the management console—OME or OME - Modular. GET method for Capabilities This method returns the capabilities of the management console—OME or OME - Modular. These two management consoles have different capabilities. Description Returns the capabilities of the management console.
Example of application capabilities of OME. { "@odata.context": "/api/ $metadata#Collection(ApplicationService.Capability)", "@odata.count": 7, "value": [ { "@odata.type": "#ApplicationService.Capability", "Name": "DEVICE_MANAGEMENT", "Description": "This capability tells whether the console is capable of restricting execution of tasks based on onboarded and notonboarded devices" }, { "@odata.type": "#ApplicationService.
14 Search This resource enables you to search for navigation links and documents using query strings. Use the URIs in this resource to search for navigation links and documents by providing search query strings. Topics: • • /api/SearchService/Actions/SearchService.Search /api/SearchService/Actions/SearchService.GetDocument /api/SearchService/Actions/SearchService.Search POST method for SearchService.
"_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 112. Attributes Attribute name Description QueryString String to search. FilterType Indexes to be searched for the query string. Took Indicates the time taken for the search to be completed.
/api/SearchService/Actions/ SearchService.GetDocument POST method for SearchService.GetDocument This method searches for the document name you provide and returns the document that you can save. Description Returns the document corresponding to the search string. Privilege VIEW HTTP response codes 200 Example Input: { "FileName":"Whitepaper-PCSV-1.0.pdf" } Output: A window appears prompting you to select the location for saving the file. Table 113.
15 Session Topics: • • • /api/SessionService /api/SessionService/Sessions /api/SessionService/Sessions(Id) /api/SessionService This URI represents the collection of session services. GET method for SessionService This method returns a collection of the sessions services. Description Returns a collection of session services. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#SessionService.SessionService", "@odata.
/api/SessionService/Sessions This URI represents a collection of active session services. GET method for Sessions This method returns the collection of active session service. Description Returns a collection of active session services. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(SessionService.Session)", "@odata.count": 1, "value": [ { "@odata.
Privilege SECURITY_SETUP HTTP response codes 200 Example Input: { "UserName":"root", "Password":"linux", "SessionType":"API" } Output: { "Id": "7b723932-a119-4843-a5b7-7a122e4def99", "Description": "root", "Name": "API", "UserName": "root", "Password": null, "Roles": [ "ADMINISTRATOR" ], "IpAddress": "10.210.136.38", "StartTimeStamp": "2017-04-17 20:07:12.357", "LastAccessedTimeStamp": "2017-04-17 20:07:12.357" } Table 116. Attributes Attribute Name Description UserName The Session user name.
Example Input: { "UserName":"root", "Password":"linux", "SessionType":"API" } Output: { "Id": "7b723932-a119-4843-a5b7-7a122e4def99", "Description": "root", "Name": "API", "UserName": "root", "Password": null, "Roles": [ "ADMINISTRATOR" ], "IpAddress": "10.210.136.38", "StartTimeStamp": "2017-04-17 20:07:12.357", "LastAccessedTimeStamp": "2017-04-17 20:07:12.357" } Table 117. Attributes Attribute Name Description Id The unique identifier of the SessionService. UserName The session user name.
16 APIs specific to OpenManage Enterprise Modular Edition Topics: • • • • • • • • • /api/ApplicationService/Actions/ApplicationService.GetConfiguration /api/ApplicationService/Actions/ApplicationService.ApplyConfiguration Brand Multichassis management FIPS mode settings Fabric management Port configuration in Fabrics Storage management Quick Deploy /api/ApplicationService/Actions/ ApplicationService.GetConfiguration POST method for ApplicationService.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 266 "Name": "WebServer.1#WebserverEnable", "Value": true "Name": "Preference.1#DeviceName", "Value": "SLOT_NAME" "Name": "LoginSecurity.1#Id", "Value": "10" "Name": "LoginSecurity.1#LockoutFailCount", "Value": 3 "Name": "LoginSecurity.1#LockoutFailCountTime", "Value": 30 "Name": "LoginSecurity.1#LockoutPenaltyTime", "Value": 900 "Name": "LoginSecurity.1#IPRangeAddr", "Value": null "Name": "LoginSecurity.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Name": "RemoteSystemLog.3#Port", "Value": 0 "Name": "RemoteSystemLog.4#RemoteSyslogEnable", "Value": false "Name": "RemoteSystemLog.4#destinationAddress", "Value": null "Name": "RemoteSystemLog.4#Port", "Value": 0 "Name": "ChassisPower.1#SystemInputPowerCap", "Value": "6763" "Name": "ChassisPower.1#RedundancyPolicy", "Value": "NO_REDUNDANCY" "Name": "ChassisPower.1#EnablePowerCap", "Value": true "Name": "SNMPAlerts.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Name": "SNMPAlerts.3#DestinationIP", "Value": null "Name": "SNMPAlerts.3#port", "Value": 0 "Name": "SNMPAlerts.3#version", "Value": null "Name": "SNMPAlerts.3#CommunityString", "Value": null "Name": "SNMPAlerts.4#Enable", "Value": false "Name": "SNMPAlerts.4#DestinationIP", "Value": null "Name": "SNMPAlerts.4#port", "Value": 0 "Name": "SNMPAlerts.4#version", "Value": null "Name": "SNMPAlerts.
{ }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, "Name": "QuickSync.1#Access", "Value": "READ_WRITE" "Name": "QuickSync.1#InactivityTimerEnable", "Value": true "Name": "QuickSync.1#InactivityTimeout", "Value": 120 "Name": "QuickSync.1#ReadAuthentication", "Value": true "Name": "QuickSync.1#WifiEnable", "Value": true "Name": "EmailAlertsConf.1#DestinationEmailAddress", "Value": "10.36.0.167" "Name": "EmailAlertsConf.
{ }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Name": "Racadm.1#Enable", "Value": true "Name": "Proxy.1#ipAddress", "Value": null "Name": "Proxy.1#Port", "Value": 0 "Name": "Proxy.1#user", "Value": null "Name": "Proxy.1#password", "Value": null "Name": "Proxy.1#enableAuthentication", "Value": false "Name": "Proxy.
}, { }, { }, { }, { }, { }, { "Name": "Network#Ipv6Settings#EnableIPv6", "Value": false "Name": "Network#Ipv6Settings#EnableAutoconfiguration", "Value": true "Name": "Network#Ipv6Settings#StaticIPv6Address", "Value": "" "Name": "Network#Ipv6Settings#StaticPrefixLength", "Value": "0" "Name": "Network#Ipv6Settings#StaticGateway", "Value": "" "Name": "Network#Ipv6Settings#UseDHCPv6ObtainDNSServerAddresses", "Value": true }, { "Name": "Network#Ipv6Settings#StaticPreferredDNSServer", "Value": "" }, { "Name": "
"Value": "$2a $10$0MAfJwXIdGRvp2wtQQMS6OzcdOH8aD9kiFrX8wy8Ltxb2UFaVP9GW" }, { "Name": "Users.1#Name", "Value": "root" }, { "Name": "Users.1#Privilege", "Value": "10" }, { "Name": "Users.1#Enable", "Value": true }, { "Name": "Users.1#Password", "Value": null }, { "Name": "Users.2#userType", "Value": 1 }, { "Name": "Users.2#SHA256Password", "Value": "$2a $10$zpVUzQIfE3nCOpodYXiz9.A.rr6SAkYcovyTEd49hxL7N83ZeqkqK" }, { "Name": "Users.2#Name", "Value": "ravi2" }, { "Name": "Users.
}, { "Name": "Users.4#SHA256Password", "Value": "$2a $10$ntDJPWAkaB5oemKyzLQPG.M5HliotxOby.q9cHPg2XIiYgPZjannC" }, { "Name": "Users.4#Name", "Value": "MK" }, { "Name": "Users.4#Privilege", "Value": "10" }, { "Name": "Users.4#Enable", "Value": true }, { "Name": "Users.4#Password", "Value": null }, { "Name": "Users.5#userType", "Value": 2 }, { "Name": "Users.5#SHA256Password", "Value": "$2a $10$H0cK06cAnceieSNuaI3JT.TI8DfX49XkdVcNbHC4G2X92lAhCAstS" }, { "Name": "Users.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { } } ] } ] } "Name": "ActiveDirectory.1#Domain", "Value": "dell.com" "Name": "ActiveDirectory.1#Port", "Value": 3269 "Name": "ActiveDirectory.1#NetworkTimeout", "Value": 120 "Name": "ActiveDirectory.1#SearchTimeout", "Value": 120 "Name": "ActiveDirectory.1#CertValidationEnable", "Value": false "Name": "ActiveDirectory.1#certificateFile", "Value": "" "Name": "LDAP.1#name", "Value": "LDAP Dell" "Name": "LDAP.
Table 118. Attributes (continued) Attribute Description Comments User-defined comments. Model Chassis model. ServiceTag Chassis Service Tag. TimeStamp Time stamp when the configuration is retrieved. Components Components for which the configuration is retrieved. FQDD A key for each setting. Attributes Key-value pairs of attributes. Name Attribute name. Value Attribute value. /api/ApplicationService/Actions/ ApplicationService.ApplyConfiguration POST method for ApplicationService.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 276 "Value": "10" "Name": "LoginSecurity.1#LockoutFailCount", "Value": 3 "Name": "LoginSecurity.1#LockoutFailCountTime", "Value": 30 "Name": "LoginSecurity.1#LockoutPenaltyTime", "Value": 900 "Name": "LoginSecurity.1#IPRangeAddr", "Value": null "Name": "LoginSecurity.1#LockoutByUsernameEnable", "Value": false "Name": "LoginSecurity.1#LockoutByIPEnable", "Value": true "Name": "LoginSecurity.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Value": null "Name": "RemoteSystemLog.4#Port", "Value": 0 "Name": "ChassisPower.1#SystemInputPowerCap", "Value": "6763" "Name": "ChassisPower.1#RedundancyPolicy", "Value": "NO_REDUNDANCY" "Name": "ChassisPower.1#EnablePowerCap", "Value": true "Name": "SNMPAlerts.1#Enable", "Value": true "Name": "SNMPAlerts.1#DestinationIP", "Value": "10.36.0.167" "Name": "SNMPAlerts.1#port", "Value": 162 "Name": "SNMPAlerts.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Value": null "Name": "SNMPAlerts.3#CommunityString", "Value": null "Name": "SNMPAlerts.4#Enable", "Value": false "Name": "SNMPAlerts.4#DestinationIP", "Value": null "Name": "SNMPAlerts.4#port", "Value": 0 "Name": "SNMPAlerts.4#version", "Value": null "Name": "SNMPAlerts.4#CommunityString", "Value": null "Name": "TimeConfig.1#TimeZone", "Value": "TZ_ID_11" "Name": "TimeConfig.1#NTPEnable", "Value": false "Name": "TimeConfig.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Name": "QuickSync.1#InactivityTimeout", "Value": 120 "Name": "QuickSync.1#ReadAuthentication", "Value": true "Name": "QuickSync.1#WifiEnable", "Value": true "Name": "EmailAlertsConf.1#DestinationEmailAddress", "Value": "10.36.0.167" "Name": "EmailAlertsConf.1#portNumber", "Value": 25 "Name": "EmailAlertsConf.1#useCredentials", "Value": false "Name": "EmailAlertsConf.1#useSSL", "Value": false "Name": "EmailAlertsConf.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Name": "Proxy.1#Port", "Value": 0 "Name": "Proxy.1#user", "Value": null "Name": "Proxy.1#password", "Value": null "Name": "Proxy.1#enableAuthentication", "Value": false "Name": "Proxy.
{ }, { }, { }, { "Name": "Network#Ipv6Settings#StaticIPv6Address", "Value": "" "Name": "Network#Ipv6Settings#StaticPrefixLength", "Value": "0" "Name": "Network#Ipv6Settings#StaticGateway", "Value": "" "Name": "Network#Ipv6Settings#UseDHCPv6ObtainDNSServerAddresses", "Value": true }, { "Name": "Network#Ipv6Settings#StaticPreferredDNSServer", "Value": "" }, { "Name": "Network#Ipv6Settings#StaticAlternateDNSServer", "Value": "" }, { "Name": "Network#GeneralSettings#EnableNIC", "Value": true }, { "Name": "Net
}, { }, { }, { }, { "Value": "10" "Name": "Users.1#Enable", "Value": true "Name": "Users.1#Password", "Value": null "Name": "Users.2#userType", "Value": 1 "Name": "Users.2#SHA256Password", "Value": "$2a $10$zpVUzQIfE3nCOpodYXiz9.A.rr6SAkYcovyTEd49hxL7N83ZeqkqK" }, { "Name": "Users.2#Name", "Value": "ravi2" }, { "Name": "Users.2#Privilege", "Value": "10" }, { "Name": "Users.2#Enable", "Value": true }, { "Name": "Users.2#Password", "Value": null }, { "Name": "Users.
}, { }, { }, { }, { }, { "Name": "Users.4#Privilege", "Value": "10" "Name": "Users.4#Enable", "Value": true "Name": "Users.4#Password", "Value": null "Name": "Users.5#userType", "Value": 2 "Name": "Users.5#SHA256Password", "Value": "$2a $10$H0cK06cAnceieSNuaI3JT.TI8DfX49XkdVcNbHC4G2X92lAhCAstS" }, { "Name": "Users.5#Name", "Value": "MSMMegatronTeam" }, { "Name": "Users.5#Privilege", "Value": "10" }, { "Name": "Users.5#Enable", "Value": true }, { "Name": "Users.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { } } ] } ] } "Value": 120 "Name": "ActiveDirectory.1#SearchTimeout", "Value": 120 "Name": "ActiveDirectory.1#CertValidationEnable", "Value": false "Name": "ActiveDirectory.1#certificateFile", "Value": "" "Name": "LDAP.1#name", "Value": "LDAP Dell" "Name": "LDAP.1#serverType", "Value": "MANUAL" "Name": "LDAP.1#DomainController1", "Value": "10.36.0.167" "Name": "LDAP.1#Port", "Value": 636 "Name": "LDAP.
Table 119. Attributes (continued) Attribute Description TimeStamp Time stamp when the configuration is retrieved. Components Components for which the configuration is retrieved. FQDD A key for each setting. Attributes Key-value pairs of attributes. Name Attribute name. Value Attribute value. Brand /api/ApplicationService/Actions/ApplicationService.BrandInfo This URI represents the brand information. POST method for BrandInfo This method returns the brand information.
/api/ApplicationService/Actions/ApplicationService.ActivateBrand This URI allows you to change the branding between the default brand or de-branded. POST method for ActivateBrand This method activates the default brand or keeps the environment de-branded. Description Activate the default brand or keep it de-branded, based on the provided brand type.
"PendingDomains@odata.navigationLink": "/api/ManagementDomainService/ PendingDomains", "DiscoveredDomains@odata.navigationLink": "/api/ ManagementDomainService/DiscoveredDomains", "ConfigurationTypes@odata.navigationLink": "/api/ ManagementDomainService/ConfigurationTypes" } Output — Member chassis: { "@odata.context": "/api/ $metadata#ManagementDomainService.ManagementDomainService", "@odata.type": "#ManagementDomainService.ManagementDomainService", "@odata.
} "Enabled": true ] }, "Actions": null, "Domains@odata.navigationLink": "/api/ManagementDomainService/Domains", "PendingDomains@odata.navigationLink": "/api/ManagementDomainService/ PendingDomains", "DiscoveredDomains@odata.navigationLink": "/api/ ManagementDomainService/DiscoveredDomains", "ConfigurationTypes@odata.navigationLink": "/api/ ManagementDomainService/ConfigurationTypes" } Table 120. Attributes Attribute Description GroupId Unique group ID across different domains.
}, { }, { }, { }, { }, { }, { } ] } "Enabled": true "ConfigType": "AlertDestinations", "Enabled": false "ConfigType": "TimeSettings", "Enabled": false "ConfigType": "ProxySettings", "Enabled": false "ConfigType": "SecuritySettings", "Enabled": false "ConfigType": "NetworkServices", "Enabled": false "ConfigType": "LocalAccessConfiguration", "Enabled": false Output: { "JobId": 36183, "Status": "Success" } Example for editing a group Input: { "GroupId": "91e0b654-9de4-4a62-b5b1-c0da11d81b70", "DeviceGroup
}, { } ] } "Enabled": false "ConfigType": "LocalAccessConfiguration", "Enabled": false Output: { "JobId": 36181, "Status": "SUCCESS" } Table 121. 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 standalone chassis are automatically approved.
$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.
Table 122. 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.
} ] Table 123. Attributes Attribute Description Id ID of the configuration. Name Name of the configuration. Description Description of the configuration. /api/ManagementDomainService/ConfigurationTypes(Id) This URI represents a specific configuration type supported on the management domain service. GET method for ConfigurationTypes(Id) This method returns the details of a specific configuration type supported on the domain service.
If you execute this API on the LEAD, one domain representing each MEMBER in the group and one domain representing the LEAD is returned. For example, a group with 10 chassis (1 Lead and 9 members) returns information for 10 domains. If you execute this API on a MEMBER, one domain representing the MEMBER (itself) and one domain representing the LEAD is returned. Description Returns the role of this chassis domain.
}, { } ] } "DomainRoleTypeId": 3001, "DomainRoleTypeValue": "MEMBER", "Version": "1", "Local": true, "GroupId": "8e5c5534-8435-47f9-bf79-65498caf7b54", "GroupName": "Example-GroupName" "@odata.type": "#ManagementDomainService.Domain", "@odata.id": "/api/ManagementDomainService/Domains(25717)", "Id": 25717, "DeviceId": 0, "PublicAddress": [ "10.36.0.
} ] } "DomainTypeId": 4000, "DomainTypeValue": "MSM", "DomainRoleTypeId": 3001, "DomainRoleTypeValue": "MEMBER", "Version": "1", "Local": false, "GroupId": "8e5c5534-8435-47f9-bf79-65498caf7b54", "GroupName": "Example-GroupName" Table 125. 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.
Description Returns the role of a specific chassis domain. ● Part of MCM — LEAD or MEMBER ● Not part of MCM — STANDALONE Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#ManagementDomainService.Domain/$entity", "@odata.
Table 126. Attributes (continued) Attribute Description ● 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. /api/ManagementDomainService/PendingDomains This URI represents the pending domain-related requests. GET method for PendingDomains This method returns a list of pending requests that are made for joining an MCM domain group.
Table 127. Attributes (continued) Attribute Description ● 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. ● 1013 - This onboard state is displayed only on stand-alone chassis when the lead approves the pending join request and initiates the onboarding. Address IP address of the onboarding chassis.
Table 128. Attributes (continued) Attribute Description State Internal state of the request. Possible values: ● ● ● ● ● 1001 - Join approval is pending with the lead domain. 1002 - Join request is approved by the lead. 1004 - Onboarding is in progress. 1006 - Request is initiated to delete the member domain. 1007 - Request is in progress to delete the member domain. ● 1012 - Request to join group is initiated from the standalone chassis.
{ ] [ ] } { } "GroupId": "be062037-30a5-4a8e-ae39-ee3bff4a8a29" "GroupId": "91e0b654-9de4-4a62-b5b1-c0da11d81b70" Output: { "JobId": 36128, "Status": "APPROVED" } Table 129. Attributes Attribute Description JobId Job ID created for the operation. Status Status of the operation. NOTE: The Status is always displayed as APPROVED. To track the status of the job, use the JobID. /api/ManagementDomainService/Actions/ ManagementDomainService.Join POST method for ManagementDomainService.
/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. Privilege APPLIANCE_SETUP HTTP response codes 200 Example Input: Output: { "JobId": 13664, "Status": "SUCCESS" } Table 131.
Table 132. 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. Description Deletes an MCM domain group.
/api/ManagementDomainService/Actions/ ManagementDomainService.ApproveJoin POST method for ManagementDomainService.ApproveJoin If the group is created with manual onboarding policy, this method enables the lead domain administrator to approve or reject pending requests that are made for joining a MCM domain group. Description Approves or rejects pending requests for joining a MCM domain group.
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 Input: Output: { "@odata.context": "/api/ $metadata#ApplicationService.FIPSModeConfiguration/$entity", "@odata.type": "#ApplicationService.FIPSModeConfiguration", "@odata.
}, "UplinkTypes@odata.navigationLink": "/api/NetworkService/UplinkTypes", "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.
"MessageId": "NFAB0017", "Message": "The network fabric is not healthy because all ISLs are not connected.", "MessageArgs": [], "Severity": "Warning", "Resolution": "Make sure that all the ISLs are connected as per the specification.", "Category": "Audit", "DetailedDescription": "", "TimeStamp": "2018-07-18T05:29:52Z" }, { "MessageId": "NFAB0018", "Message": "The network fabric is not healthy because uplinks are not configured.
Example Input: { "Name":"Fabric-1", "Description":"This is a fabric.", "FabricDesignMapping": [ { "DesignNode":"Switch-A", "PhysicalNode":"DPM4XC1" }, { "DesignNode":"Switch-B", "PhysicalNode":"DPM4XC2" } ], "FabricDesign": { "Name":"2xMX9116n_Fabric_Switching_Engines_in_same_chassis" } } Output: (Fabric-Id) To get the value of FabricDesign.Name, use the /api/NetworkService/FabricDesigns API. The structure of FabricDesignMapping changes depending on the fabric design.
}, { }, { "SourceNode": "Switch-A", "SourceInterface": "ethernet1/1/9", "DestinationNode": "Switch-B", "DestinationInterface": "ethernet1/1/9" } ], "FabricDesignNode": [ { "NodeName": "Switch-A", "ChassisName": "Chassis-X", "Slot": "Slot-A1", "Type": "ModularSwitch" }, { "NodeName": "Switch-B", "ChassisName": "Chassis-X", "Slot": "Slot-A2", "Type": "ModularSwitch" } ] "@odata.type": "#NetworkService.FabricDesign", "@odata.
{ "@odata.type": "#NetworkService.FabricDesign", "@odata.
Example Input: Output: { "@odata.context": "/api/$metadata#NetworkService.Fabric/$entity", "@odata.type": "#NetworkService.Fabric", "@odata.
"Topology": { "@odata.id": "/api/NetworkService/ Fabrics('31db245a-9865-4a23-9697-4902cd2d5421')/Topology" }, "ISLLinks@odata.navigationLink": "/api/NetworkService/ Fabrics('31db245a-9865-4a23-9697-4902cd2d5421')/ISLLinks" } PUT method for Fabrics(Id) This method updates a fabric. Description Updates a specific fabric. Privilege FABRIC_MANAGEMENT HTTP response codes 200 Example Input: { "Id":"123e4567-e89b-12d3-a456-426655440000", "Name":"Fabric-1", "Description":"This is a fabric.
DELETE method for Fabrics(Id) This method deletes a specific fabric. Description Deletes a specific fabric. Privilege FABRIC_MANAGEMENT HTTP response codes 204 Example Input: Output: /api/NetworkService/Fabrics(Id)/FabricDesigns This URI represents the fabric design for a specific fabric. GET method for FabricDesigns for a specific fabric This method returns the fabric design of a specific fabric. Description Returns the fabric design of a specific fabric.
} "FabricDesignNode": [ { "NodeName": "Switch-A", "ChassisName": "Chassis-X", "Slot": "Slot-A1", "Type": "WeaverSwitch" }, { "NodeName": "Switch-B", "ChassisName": "Chassis-Y", "Slot": "Slot-A2", "Type": "WeaverSwitch" } ] /api/NetworkService/Fabrics(Id)/ValidationErrors This URI represents the validation errors for a specific fabric. GET method for ValidationErrors for a specific fabric This method returns the validation errors of a specific fabric.
"DestinationNode": "", "DestinationInterface": "" }, "RecommendedAction": "Make sure that the I/O Modules are in different slots", "Timestamp": "1531891792" }, { "@odata.type": "#NetworkService.ValidationError", "@odata.
}, { "@odata.type": "#NetworkService.ValidationError", "@odata.
/api/NetworkService/Fabrics(Id)/Uplinks This URI represents the uplinks of a specific fabric. GET method for Uplinks for a specific fabric This method returns the uplinks of a specific fabric. Description Returns the uplinks of a specific fabric. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(NetworkService.Uplink)", "@odata.count": 1, "value": [ { "@odata.type": "#NetworkService.Uplink", "@odata.
} } "Id":"8KWYERN1:e102-009-0" ], "Networks": [ { "Id":8756 } ] Output: Uplink Id Table 136. Attributes Attribute name Description ID The identifier of the fabric. Name The fabric name. Description The fabric name description. MediaType Type of the uplink. For more information, see api/ NetworkService/UplinkTypes. ID (Ports) Port ID(s). ID (Networks) Network ID(s). /api/NetworkService/Fabrics(Id)/Uplinks(Id) This URI represents a specific uplink in a fabric.
d6d8-4fc5-98b7-cb9030e8008e')/Ports", "Networks@odata.navigationLink": "/api/NetworkService/ Fabrics('43be623e-0d74-4f6d-87b3-3ea40bf6372d')/Uplinks('bda43da9d6d8-4fc5-98b7-cb9030e8008e')/Networks" } PUT method for Uplinks(Id) This method updates a specific uplink. Description Updates a specific uplink. Privilege FABRIC_MANAGEMENT HTTP response codes 201 Example Input: { "Id":"123e4567-e89b-12d3-a456-426655440012", "Name":"Fabric-1", "Description":"This is a fabric.
/api/NetworkService/Fabrics(Id)/Uplinks(Id)/Ports This URI represents the uplink ports of a specific uplink in a fabric. GET method for Ports for a specific uplink This method returns the uplink ports of a specific uplink in a fabric. Description Returns the uplink ports. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(NetworkService.Port)", "@odata.count": 4, "value": [ { "@odata.type": "#NetworkService.Port", "@odata.
d6d8-4fc5-98b7-cb9030e8008e')/Ports('1ZB1XC2%3Aethernet1%2F1%2F40')", "Id": "1ZB1XC2:ethernet1/1/40", "Name": "", "Description": "", "Type": "PhysicalEthernet", "MediaType": "Ethernet", "NodeServiceTag": "1ZB1XC2", "PortNumber": "ethernet1/1/40", "Status": "Down", "AdminStatus": "Enabled", "CurrentSpeed": "0", "MaxSpeed": "0", "ConfiguredSpeed": "0", "OpticsType": "NotPresent", "BlinkStatus": "OFF", "Role": "Uplink" }, { "@odata.type": "#NetworkService.Port", "@odata.
"@odata.type": "#NetworkConfigurationService.Network", "@odata.id": "/api/NetworkService/ Fabrics('43be623e-0d74-4f6d-87b3-3ea40bf6372d')/Uplinks('bda43da9d6d8-4fc5-98b7-cb9030e8008e')/Networks(25375)", "Id": 25375, "Name": "1", "Description": "1", "VlanMaximum": 11, "VlanMinimum": 11, "Type": 1, "CreatedBy": "root", "CreationTime": "2018-07-11 03:35:11.590", "UpdatedBy": null, "UpdatedTime": "2018-07-11 03:35:11.590", "InternalRefNWUUId": "fd4d9ece-732e-4beb-8613-ab986889fe43" }, { "@odata.
"Model": null, "PowerState": 2, "Status": 1000, "AssetTag": "8KWYERN1", "SystemId": 0, "DeviceName": "Weaver1Node", "LastInventoryTime": null, "DeviceCapabilities": [], "DeviceSubscription": { "@odata.id": null }, "DeviceSpecificData": { "@odata.id": null }, "DeviceManagement": [], "InventoryDetails": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/InventoryDetails" } ], "HardwareLogs": [ { "@odata.
/api/NetworkService/Fabrics(Id)/Servers This URI represents the servers of a specific fabric. GET method for Servers for a specific fabric This method returns the details of the severs of a specific fabric. Description Returns the servers that are part of a specific fabric. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 1, "value": [ { "@odata.
[ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/RecentActivity" } ], "InventoryTypes": { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/InventoryTypes" }, "Settings": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Servers(0)/Settings" } ] } ] } /api/NetworkService/Fabrics(Id)/ISLLinks This URI represents the ISL links of a specific fabric.
}, { } "@odata.type": "#NetworkService.ISLLink", "@odata.
} ] /api/NetworkService/Fabrics(Id)/Topology This URI represents the topology of the nodes and switches. GET method for Topology for a fabric This method returns the topology of all the nodes and switches in a fabric. Description Returns a topology of the nodes and switches. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#NetworkService.Topology/$entity", "@odata.type": "#NetworkService.Topology", "@odata.
"PowerState": 2, "Status": 1000, "AssetTag": "8KWYERN1", "SystemId": 0, "DeviceName": "Weaver1Node", "LastInventoryTime": null, "DeviceCapabilities": [], "DeviceSubscription": { "@odata.id": null }, "DeviceSpecificData": { "@odata.id": null }, "DeviceManagement": [], "InventoryDetails": [ { "@odata.id": "/api/NetworkService/Fabrics('123e4567-e89b-12d3a456-426655440000')/Switches(0)/InventoryDetails" } ], "HardwareLogs": [ { "@odata.
/api/NetworkService/Fabrics(Id)/Topology/Nodes(Id) This URI represents a specific node of a fabric topology. GET method for Nodes(Id) This method returns the details of a specific node of a fabric topology. Description Returns the details of a specific node. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(DeviceService.Device)", "@odata.count": 1, "value": [ { "@odata.
[ { "@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.
}, "ChildNodes@odata.navigationLink": "/api/NetworkService/ Fabrics('43be623e-0d74-4f6d-87b3-3ea40bf6372d')/Topology/Nodes('Switch %3A1ZB1XC2')/ChildNodes" }, { "@odata.type": "#NetworkService.Node", "@odata.id": "/api/NetworkService/ Fabrics('43be623e-0d74-4f6d-87b3-3ea40bf6372d')/Topology/Nodes('Switch %3ADPM4XC1')", "Id": "Switch:DPM4XC1", "Type": "NETWORK_IOM", "ParentNodeId": "SKY00201234567890123456789012345", "Location": "IOM-B2", "NodeInformation": { "@odata.type": "#NetworkService.
/api/NetworkService/Actions/NetworkService.RemoveUplinks POST method for NetworkService.RemoveUplinks This method deletes multiple fabric uplinks. Description Deletes multiple fabric uplinks. Privilege FABRIC_MANAGEMENT HTTP response codes 200 Example Input: { "FabricId":"FabricId", "UplinkIds":["id1","id2"] } Output: { "id1": true, "id2": true } /api/NetworkService/FabricDesigns(Id)/ NetworkService.
A2","Type":"WeaverSwitch" }, "ApplicableNodes": [ { "ServiceTag":"DPM4XC2","Slot":"IOM-B2","ChassisName":"MXSKY002P1234567890123456789012345","ChassisServiceTag":"SKY002P12345678901234567890 } ] } ] } /api/NetworkService/Fabrics(Id)/ NetworkService.GetApplicableUplinkPorts POST method for GetApplicableUplinkPorts This method returns the available uplink ports applicable to a fabric design. Description Returns applicable uplink ports.
}, { }, { 334 ] } "Name": "", "Description": "", "PortNumber": "1ZB1XC2:ethernet1/1/36" "Id": "1ZB1XC2:ethernet1/1/35", "Name": "", "Description": "", "PortNumber": "1ZB1XC2:ethernet1/1/35" "NodeServiceTag": "DPM4XC1", "Ports": [ { "Id": "DPM4XC1:ethernet1/1/37", "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/37" }, { "Id": "DPM4XC1:ethernet1/1/40", "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/40" }, { "Id": "DPM4XC1:ethernet1/1/41", "Name": "", "Description": "
} ] } ] } "Name": "", "Description": "", "PortNumber": "DPM4XC1:ethernet1/1/42" Table 137. Attributes Attribute name Description UplinkType ID of the uplink type. For more information, see /api/ NetworkService/UplinkTypes). /api/NetworkService/UplinkTypes This URI represents the uplink types. GET method for UplinkTypes This method returns the uplink types. Description Returns the uplink types. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.
/api/NetworkService/NodeTypes This URI represents the node types. GET method for NodeTypes This method returns the node types. Description Returns the node types. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/$metadata#Collection(NetworkService.NodeType)", "@odata.count": 3, "value": [ { "@odata.type": "#NetworkService.NodeType", "Id": 1, "Name": "CHASSIS" }, { "@odata.type": "#NetworkService.NodeType", "Id": 2, "Name": "NWIOM" }, { "@odata.
[ { }, { }, { }, { }, { } ] } "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Create", "Name": "Create" "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Upgrade", "Name": "Upgrade" "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Delete", "Name": "Delete" "@odata.type": "#NetworkService.EnumerationEntry", "Id": "ReplaceNode", "Name": "ReplaceNode" "@odata.type": "#NetworkService.
}, { }, { }, { }, { }, { }, { }, { }, { }, { } ] } "Name": "Starting" "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2050", "Name": "Running" "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2060", "Name": "Completed" "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2070", "Name": "Failed" "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2080", "Name": "New" "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2090", "Name": "Warning" "@odata.
Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.count": 5, "value": [ { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "1000", "Name": "NORMAL" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "3000", "Name": "WARNING" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "4000", "Name": "CRITICAL" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "2000", "Name": "UNKNOWN" }, { "@odata.
/api/NetworkService/MultiChassisDomain/Topology This URI represents the topology of an MCM group. GET method for Topology in a multichassis domain This method returns the topology of a group with multiple chassis. Description Returns the topology of a group. Privilege VIEW HTTP response codes 200 Example Input: Output: { /api/$metadata#NetworkService.Topology/$entity", "@odata.type": "#NetworkService.Topology", "@odata.id": "/api/NetworkService/MultiChassisDomain/Topology", "Nodes@odata.
"Model": "POWEREDGE MX7000", "PowerState": 17, "Name": "MX-SKY002P1234567890123456789012345" }, "ChildNodes@odata.navigationLink": "/api/NetworkService/ MultiChassisDomain/Topology/Nodes('Chassis %3ASKY002P1234567890123456789012345')/ChildNodes" }, { "@odata.type": "#NetworkService.Node", "@odata.
"ServiceTag": "SKY00201234567890123456789012345", "DeviceId": 25003, "Model": "POWEREDGE MX7000", "PowerState": 17, "Name": "MX-SKY00201234567890123456789012345" }, "ChildNodes@odata.navigationLink": "/api/NetworkService/ MultiChassisDomain/Topology/ Nodes('Chassis:SKY00201234567890123456789012345')/ChildNodes" } /api/NetworkService/MultiChassisDomain/Topology/Nodes(Id)/ ChildNodes This URI represents the switch nodes for a specific chassis node in an MCM group.
"ParentNodeId": "SKY00201234567890123456789012345", "Location": "IOM-B2", "NodeInformation": { "@odata.type": "#NetworkService.NodeInformation", "Status": 1000, "Type": "WeaverSwitch", "ServiceTag": "DPM4XC1", "DeviceId": 25005, "Model": "MX9116n Fabric Engine", "Slot": "IOM-B2", "SwitchMode": "Fabric", "PowerState": 17, "Name": "IOM-B2" }, "ChildNodes@odata.
}, "RecommendedLink": { "SourceNode": "DPM4XC1", "SourceInterface": "DPM4XC1:ethernet1/1/41", "DestinationNode": "1ZB1XC2", "DestinationInterface": "1ZB1XC2:ethernet1/1/41" }, "RecommendedAction": "Make sure that the links are connected as per design.", "Timestamp": "1531280042" }, { "@odata.type": "#NetworkService.ValidationError", "@odata.
"RecommendedAction": "Make sure that the links are connected as per design.", "Timestamp": "1531280042" }, { "@odata.type": "#NetworkService.ValidationError", "@odata.
} ] /api/NetworkService/PortAdminStatuses This URI represents the possible admin statuses of the ports. GET method for PortAdminStatuses This method returns the possible admin statuses of a port. Description Returns the possible admin statuses of a port. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.count": 3, "value": [ { "@odata.type": "#NetworkService.
Example Input: Output: { "@odata.context": "/api/ $metadata#Collection(NetworkService.EnumerationEntry)", "@odata.count": 3, "value": [ { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Disabled", "Name": "Disabled" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Enabled", "Name": "Enabled" }, { "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Unknown", "Name": "Unknown" } ] } /api/NetworkService/PortRoles This URI represents the possible roles of the ports.
{ }, { } ] } "@odata.type": "#NetworkService.EnumerationEntry", "Id": "Uplink", "Name": "Uplink" "@odata.type": "#NetworkService.EnumerationEntry", "Id": "ISL", "Name": "ISL" /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.
HTTP response codes Example 201 { "Id": "PFSTN16", "ServerServiceTag":"PFSTN16", "ServerInterfaceProfiles": [{ "Id": "NIC.Mezzanine.1-2-1", "NativeVLAN":25, "Networks": [{ "Id": 25365 }, { "Id": 25484 }] }, { "Id": "NIC.Mezzanine.1-1-1" }] } Output: true Table 139. Attributes Attribute Description Id Server profile identifier. ServerServiceTag Service tag of the server. ServerInterfaceProfiles Sub payload that takes information associated with a server NIC.
{ "@odata.context": "/api/ $metadata#Collection(NetworkService.ServerInterfaceProfile)", "@odata.count": 2, "value": [ { "@odata.type": "#NetworkService.ServerInterfaceProfile", "@odata.id": "/api/NetworkService/ServerProfiles('PFSTN16')/ ServerInterfaceProfiles('NIC.Mezzanine.1A-1-1')", "Id": "NIC.Mezzanine.1A-1-1", "OnboardedPort": "GQ61XC2:ethernet1/1/4", "NativeVLAN": 18, "Networks@odata.count": 2, "Networks": [ { "@odata.type": "#NetworkConfigurationService.Network", "@odata.
/api/NetworkService /ServerProfiles(arg1)/ ServerInterfaceProfiles(arg2) This URI returns the server profile ID of a server profile in the Fabric Manager. GET method for server interface profile IDs This method returns server interface profile IDs. Description Returns server interface profile ID of a server profile in the Fabric Manager. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "/api/ $metadata#NetworkService.ServerInterfaceProfile/$entity", "@odata.
} "UpdatedBy": null, "UpdatedTime": "1970-01-31 00:08:21.946", "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.
/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. A job is created in the OME - Modular web interface to track the progress of the server profile configuration task. NOTE: To run the API, you must have an existing server profile, which is deployed using the server deployment process, in the system.
Port configuration in Fabrics /api/JobService/Jobs This URI enables you to configure the ports in fabrics. Port configuration operation The APIs in this group use the Job Service and leverage existing inputs. You can change the parameters and targets, as shown in the examples. POST method for configuring MTU This method configures the MTU range. Description Configures the minimum and maximum MTU values.
HTTP response codes Example 201 Input: "Params": [ { "Key":"operationName", "Value":"CONFIGURE_ AUTO_NEG" }, { "Key":"enableInterfaceIds", "Value":"GF86XC2:1/1/9,GF86XC2:1/1/10" }, { "Key":"disableInterfaceIds", "Value":"GF86XC2:1/1/9,GF86XC2:1/1/10" } ], "Targets": [ { "Id":2664, "Data":"", "TargetType": { "Id":4000, "Name":"DEVICE" } } ] Output: POST method for updating port name and description This method updates the port name and description. Description Updates port name and description.
] } "Id":2664, "Data":"", "TargetType": { "Id":4000, "Name":"DEVICE" } Output: POST method for configuration port speed This method configures the port speed. Description Configures the port speed.
NOTE: Ensure that you refer the right parameters in the provided Input snippet. For example, for configuring MTU speed, use Speed as the key and 1000 as the value. Storage management These APIs enable you to perform storage-management operations in OME - Modular. The URI for these operation is /api/ JobService/Jobs. Assign enclosure POST method for enclosure assignment Description Creates a job to assign the entire storage in an enclosure to one or more server slots.
Clear enclosure assignment POST method for clearing enclosure assignment Description Creates a job to clear the storage assignments in Enclosure Assigned mode.
}, "Params":[ { "Key":"operationName", "Value":"ASSIGN_STORAGE" }, { "Key":"assignmentMode", "Value":"2" }, { "Key":"driveSlotIds", "Value": }, { "Key":"serverSlots", "Value": } ], "Targets":[ { "Id":, "Data":"", "TargetType":{ "Id":1000, "Name":"DEVICE" } } ] } Output: Clear drive assignment POST method for clearing drive assignment Description Creates a job to clear drive assignments to server slots.
], "Targets":[ { "Id":, "Data":"", "TargetType":{ "Id":1000, "Name":"DEVICE" } } ] } Output: Force-activate a SAS IOM POST method for force-activating a SAS IOM Description Creates a job to force-activate a SAS IOM.
Clear configuration on SAS IOM POST method for clearing SAS IOM configuration Description Creates a job to clear the configuration on SAS IOM.
"Id": 18, "Name": "DebugLogs_Task" }, "Targets": [ { "Id": e.g: 2614, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" }, { "Key": "shareAddress", "Value": e.g: "100.100.100.100" }, { "Key": "shareName", "Value": e.
"Params": [ { "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS" }, { "Key": "shareAddress", "Value": e.g: "100.100.100.100" }, { "Key": "shareName", "Value": "/var/cifs" }, { "Key": "shareType", "Value": "CIFS" }, { "Key": "userName", "Value": "" }, { "Key": "password", "Value": "" }, { "Key": "domainName", "Value": "" } ] } Output: Quick Deploy /api/JobService/Jobs This URI represents Quick-Deploy jobs.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Value":"SERVER_QUICK_DEPLOY" "Key":"deviceId", "Value":"1016" "Key":"rootCredential", "Value":"calvin" "Key":"networkTypeV4", "Value":"Static" "Key":"protocolTypeV4", "Value":"true" "Key":"subnetMaskV4", "Value":"255.255.255.0" "Key":"gatewayV4", "Value":"255.255.255.0" "Key":"networkTypeV6", "Value":"Static" "Key":"protocolTypeV6", "Value":"true" "Key":"prefixLength", "Value":"0" "Key":"gatewayV6", "Value":"255.255.255.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Key": "deviceId", "Value": "1016" "Key": "rootCredential", "Value": "calvin" "Key": "networkTypeV4", "Value": "Static" "Key": "protocolTypeV4", "Value": "true" "Key": "subnetMaskV4", "Value": "255.255.255.0" "Key": "gatewayV4", "Value": "255.255.255.0" "Key": "networkTypeV6", "Value": "Static" "Key": "protocolTypeV6", "Value": "true" "Key": "prefixLength", "Value": "0" "Key": "gatewayV6", "Value": "255.255.255.
Table 143. Attributes (continued) Attribute name Description Name Name of the job type. Params operationName Name of the Quick-Deploy operation. deviceId Device ID indicates the Chassis ID. rootCredential Root user password. networkTypeV4 Indicates if the IPv4 is static or dynamic. protocolTypeV4 Indicates whether IPv4 protocol is selected. subnetMaskV4 IPv4 Subnetwork mask associated with the configuration. Applicable when static IPv4 is selected.
17 APIs specific to OpenManage Enterprise Topics: • • • • • Application settings Troubleshoot service Query support service Groups service Monitor Application settings Console update /api/JobService/Jobs This URI updates the OpenManage Enterprise appliance. POST method for Jobs This method updates the OpenManage Enterprise appliance. Description Updates the OpenManage Enterprise appliance.
} ] } } "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. Privilege VIEW HTTP response code 200 Example Output: { "@odata.context": "/api/ $metadata#Collection(ConsoleUpdateService.Update)", "@odata.
"@odata.context": "$metadata#Collection(AlertService.MobileSubscription)", "@odata.count": 1, "value": [ { "@odata.
/api/AlertService/Actions/AlertService.CreateEditMobileSubscription This URI represents creating mobile subscriptions. POST method for CreateEditMobileSubscription This method creates mobile subscriptions. The AlertPolicyId must be configured in the appliance before creating the subscription. Description Creates mobile subscriptions.
Example Input: { "Enable":"false" } /api/AlertService/Actions/AlertService.FilterAlertsByPolicy This URI filters the alerts by using the policy ID. GET method for AlertService.FilterAlertsByPolicy This method returns alerts based on the policy ID. Description Returns alerts based on the policy ID. Privilege VIEW HTTP response codes 200 Example Input: { "PolicyId": 14164, "Top": 2, "Skip": 1 } Output: { "@odata.context": "/api/$metadata#Collection(AlertService.Alert)", "@odata.
varbind>1.3.6.1.4.1.674.10892.1.5000.10.2.0OID1.31.3.6.1.4.1.674.10892.1.5000.10.3.0OctetString1.3.6.1.4.1.674.10892.1.5000.10.4.0Integer3201.3.6.1.4.1.674.10892.1.5000.10.5.0Integer3201.3.6.1.4.1.674.10892.1.5000.10.6.
{ } Example to create a diagnostic job "Key":"OPERATION_NAME", "Value":"SERVER_EXECUTE_TSR" }, { "Key":"ShareType", "Value":"2" }, { "Key":"DataSelectorArrayIn", "Value":"[3]" // Collect Logs types }, { "Key":"user_eula_Agreement", "Value":"true" }, { "Key":"ScheduledStartTime", "Value":"TIME_NOW" } ], "Targets": [ { "Id":25085, "Data":"", "TargetType": { "Id":25085, "Name":"SERVER" } } ] Input: { "Id":0, "JobName":"FinalTest", "JobDescription":"amit612", "Schedule":"startnow", "State":"Enabled", "JobTyp
} "Key":"RunMode", "Value":"0" }, { "Key":"RebootJobType", "Value":"2" }, { "Key":"ScheduledStartTime", "Value":"TIME_NOW" } ], "Targets": [ { "Id":3714, "Data":"", "TargetType": { "Id":3714, "Name":"SERVER" } } ] /api/TroubleshootService/Files This URI returns TechSupport Report (TSR) or diagnostic log files. GET method for Files This method returns TechSupport Report (TSR) or diagnostic log files. Description Returns TechSupport Report (TSR) or diagnostic log files.
Table 144. Attributes (continued) Attribute Description DeviceOperation 'SERVER_DIAGNOSTIC' to retrieve diagnostic files 'SERVER_EXECUTE_TSR' to retrieve TSR files /api/TroubleshootService/Actions/ TroubleshootService.GetTroubleshootDocument This URI represents TSR/Diagnostic job reports. POST method for TroubleshootService.GetTroubleshootDocument This method extracts TSR/Diagnostic job reports. Description Extracts TSR/Diagnostic job reports.
/api/TroubleShootService/Actions/ TroubleShootService.DeleteArchivedConsoleLogs This URI deletes archived console logs on the appliance. POST method for TroubleShootService.DeleteArchivedConsoleLogs This method deletes all available archived console logs on the appliance. This method ensures no archived logs are present on the file system.
} ] "ResultFields": [], "SortFields": [] }, { "@odata.type": "#QuerySupportService.Query", "@odata.id": "/api/QuerySupportService/Queries(10007)", "Id": 10007, "Name": "Warranty Report", "UsageId": 2, "FilterText": "", "ContextId": 2, "Conditions": [], "ResultFields": [], "SortFields": [] } /api/QuerySupportService/Queries(Id) This URI represents detailed information for a specific query. GET method for QuerySupportService/Queries(Id) This method returns summary information for a specific query.
/api/QuerySupportService/QueryContextSummaries This URI represents summary information for all query contexts. GET method for QueryContextSummaries This method returns summary information for all Query Contexts. A Query Context defines a hierarchical set of tables and fields that are used to define queries for dynamic groups (query groups) and reports. Description This method returns summary information for all Query Contexts. Privilege VIEW HTTP response codes 200 Example 378 Output: { "@odata.
/api/QuerySupportService/QueryContextSummary(Id) This URI represents summary information for a single query context. GET method for QueryContextSummary(Id) This method returns summary information for a specific query context. Description Returns summary information for a specific query context.. Privilege VIEW HTTP response codes 200 Example Output: { "@odata.context": "/api/ $metadata#QuerySupportService.QueryContextSummary/$entity", "@odata.type": "#QuerySupportService.
"ParentTableId": 2 }, { "Id": 1, "Name": "Alert", "Description": null, "ParentTableId": -1 } ], "Fields": [ { "Id": 17, "Name": "Device Name", "TableId": 5, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 18, "Name": "Device Global Status", "TableId": 5, "Description": null, "FieldTypeId": 4, "StrMaxLen": 0, "EnumOpts": [ { "Id": 1000, "Name": "Normal" }, { "Id": 2000, "Name": "Unknown" }, { "Id": 3000, "Name": "Warning" }, { "Id": 4000, "Name": "Critical" }, { "Id": 5000,
} ] "TableId": 5, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 15, "Name": "Sub-Category Prefix", "TableId": 4, "Description": null, "FieldTypeId": 1, "StrMaxLen": 20, "EnumOpts": [] }, { "Id": 16, "Name": "Sub-Category Description", "TableId": 4, "Description": null, "FieldTypeId": 1, "StrMaxLen": 256, "EnumOpts": [] }, { "Id": 3, "Name": "Alert Status", "TableId": 1, "Description": null, "FieldTypeId": 4, "StrMaxLen": 0, "EnumOpts": [ { "Id": 1000, "Name": "Acknowle
/api/QuerySupportService/QueryContexts(Id)/ QuerySupportService.GetFiltersForContext This URI represents summary information for all filters (queries) defined by using a specific Query Context. GET method for QuerySupportService.GetFiltersForContext This method returns summary filter information for all queries defined by using a specific Query Context. For the QuerySupportService, the term 'filter' refers to the row selection conditions for a query—WHERE part of a SQL statement.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { "Id": 1016, "Name": "Hyper-V Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1011, "Name": "Linux Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1000, "Name": "Modular Systems", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1006, "Name": "Network Devices", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1025, "Name": "Non-Dell Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1023, "Name
}, { }, { }, { }, { }, { ] } "Id": 1009, "Name": "Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1012, "Name": "Storage Devices", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1015, "Name": "VMware ESXi Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1018, "Name": "VxRAIL", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1024, "Name": "Windows Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 1019, "Name": "XC", "UsageId": 1, "FilterText": "", "
Privilege VIEW HTTP response codes 200 Example Output: { "@odata.context": "/api/$metadata#QuerySupportService.OperatorInfo/ $entity", "@odata.type": "#QuerySupportService.OperatorInfo", "@odata.
[ { "FieldTypeId": 1, "Name": "String", "OperatorIds": [ 1, 2, 3, 4, 5, 6, 11, 12, 7, 8, 9, 10 ] }, { "FieldTypeId": 2, "Name": "Number", "OperatorIds": [ 1, 2, 3, 4, 5, 6, 9, 10 ] }, { "FieldTypeId": 3, "Name": "Date-Time", "OperatorIds": [ 1, 2, 13, 14, 9, 10 ] }, { "FieldTypeId": 4, "Name": "Enum", "OperatorIds": [ 1, 2, 9, 10 ] }, { "FieldTypeId": 5, "Name": "Boolean", "OperatorIds": [ 1, 2, 9, 10 ] } 386 APIs specific to OpenManage Enterprise
} ] /api/QuerySupportService/Filters This URI represents summary information for all filters. GET method for Filters This method returns summary information for all filters. Description Returns summary information for all filters. Privilege VIEW HTTP response codes 200 Example Output: { "@odata.context": "/api/ $metadata#Collection(QuerySupportService.Filter)", "@odata.count": 23, "value": [ { "@odata.type": "#QuerySupportService.Filter", "@odata.
}, { } ] } "@odata.id": "/api/QuerySupportService/Filters(1000)", "Id": 1000, "Name": "Modular Systems", "UsageId": 1, "FilterText": "", "ContextId": 2, "Conditions": [] "@odata.type": "#QuerySupportService.Filter", "@odata.id": "/api/QuerySupportService/Filters(1006)", "Id": 1006, "Name": "Network Devices", "UsageId": 1, "FilterText": "", "ContextId": 2, "Conditions": [] /api/QuerySupportService/Filters(Id) This URI represents detailed information for a query filter.
} ] "LeftParen": true, "FieldId": 59, "OperatorId": 1, "Value": "202", "RightParen": true }, { "LogicalOperatorId": 2, "LeftParen": true, "FieldId": 59, "OperatorId": 1, "Value": "203", "RightParen": true } Groups service /api/GroupService/Groups This URI represents the groups. POST method for Groups This method creates a group. Description Creates a group.
/api/GroupService/Groups(Id)/SubGroups(Id) This URI represents a subgroup within a group. While using this URI, provide the ID of the parent group and the ID of the subgroup. DELETE method for SubGroups(Id) This method deletes a subgroup. Description Deletes a subgroup. Privilege DEVICE_CONFIGURATION HTTP response codes 204 Example Input: Output: Table 147. Attributes Attribute name Description Id—Groups(Id) ID of the parent group. Id—SubGroups(Id) ID of the subgroup.
/api/GroupService/Groups(Id)/EventStatusSummary This URI represents the events status counts. GET method for EventStatusSummary This method returns events status counts per status values. Description Returns events status counts per status values. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(GroupService.StatusSummary)", "@odata.
HTTP response codes Example 200 Input { "GroupModel": { "Id": 0, "Name": "00000", "Description": "GroupPermissionTest", "GlobalStatus": 0, "DefinitionId": 0, "MembershipTypeId":24, "ParentId": 0 }, "GroupModelExtension" :{ "FilterId":0, "ContextId":2, "Conditions":[{ "LogicalOperatorId":1, "LeftParen":false, "FieldId":9, "OperatorId":1, "Value":"1000", "RightParen":false }] } } /api/GroupService/Actions/GroupService.UpdateGroup This URI represents the updates to a group. PUT method for GroupService.
/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 Input: { "Id": 3164, "Name": "Test Group-My122-cloned", "Description": "Test Group123-4", "GlobalStatus": 0, "DefinitionId": 0, "ParentId": 12 } /api/GroupService/Actions/GroupService.DeleteGroup This URI represents deleting a group. POST method for GroupService.
Example Input: { "GroupId":2614, "MemberDeviceIds" : [2514] } /api/GroupService/Actions/GroupService.RemoveMemberDevices This URI represents removing devices from a group. POST method for GroupService.RemoveMemberDevices This method removes device(s) from a group. Description Removes device(s) from a group. Privilege GROUP_MANAGEMENT HTTP response codes 204 Example Input: { "GroupId":2614, "MemberDeviceIds" : [2514] } /api/GroupService/Actions/GroupService.
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 Output: { "@odata.context": "/api/ $metadata#Collection(DiscoveryConfigService.DiscoveryJob)", "@odata.count": 5, "value": [ { "@odata.type": "#DiscoveryConfigService.
}, { }, { }, { 396 "DiscoveredDevicesByType": [ { "DeviceType": "SERVER", "Count": 31 } ] "@odata.type": "#DiscoveryConfigService.DiscoveryJob", "@odata.id": "/api/DiscoveryConfigService/Jobs(25120)", "JobId": 25120, "JobName": "Amit", "JobDescription": "Amit", "JobSchedule": "", "JobStartTime": "2018-09-13 16:48:22.428", "JobEndTime": "2018-09-13 00:00:00.0", "JobProgress": "100", "JobStatusId": 2102, "JobNextRun": "2018-09-13 16:25:04.
} ] } ] } Table 148. Attributes Attribute Description JobId ID of the discovery job. JobName Name of the discovery job. JobSchedule Discovery job schedule information. JobStartTime Start time of the discovery job. JobEndTime Completion time of the discovery job. JobProgress Percentage of discovery job completion. JobStatusId Status of the discovery job. For example, Complete, Failed, and so on. JobNextRun If discovery job is scheduled, returns the next schedule time.
\":\"\",\"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", "StartTime":"", "EndTime":"" }, "CreateGroup":true, "TrapDestination":false } Example to run discovery job at a l
"DiscoveryConfigStatus":"", "DiscoveryConfigTargets":[ { "DiscoveryConfigTargetId":0, "NetworkAddressDetail":"10.0.0.0", "AddressType":30, "Disabled":false, "Exclude":false } ], "ConnectionProfileId":0, "ConnectionProfile":"{\"profileName\":\"\",\"profileDescription \":\"\",\"type\":\"DISCOVERY\",\"credentials\":[{\"id\":0,\"type \":\"WSMAN\",\"authType\":\"Basic\",\"modified\":false,\"credentials\": {\"username\":\"root\",\"password\":\"calvin\",\"caCheck \":false,\"cnCheck\":false,\"port\":443,\"retries\"
\",\"modified\":false,\"credentials\":{\"username\":\"test\",\"password \":\"test\",\"caCheck\":false,\"cnCheck\":false,\"port\":443,\"retries \":2,\"timeout\":4,\"isHttp\":false,\"keepAlive\":false}}]}", "DeviceType":[ 1000, 2000, 5000, 7000 ] } ], "Schedule":{ "RunNow":true, "RunLater":false, "Cron":"startnow", "StartTime":"", "EndTime":"" }, "CreateGroup":true, "TrapDestination":false } /api/DiscoveryConfigService/Actions/ DiscoveryConfigService.
Example Input: { fileName="abc.csv" } /api/DiscoveryConfigService/DiscoveryConfigGroups(groupId) This URI updates a discovery task. PUT method for DiscoveryConfigGroups(groupId) This method edits a discovery task. Description Edits a discovery task.
{ "DiscoveryConfigId": 331105536, "DiscoveryConfigDescription": "", "DiscoveryConfigStatus": "", "DiscoveryConfigTargets": [ { "DiscoveryConfigTargetId": 0, "NetworkAddressDetail": "10.35.0.0-10.35.0.255", "SubnetMask": null, "AddressType": 1, "Disabled": false, "Exclude": false } ], "ConnectionProfileId": 0, "ConnectionProfile": "{\"profileName \":\"\",\"profileDescription\":\"\",\"type\":\"DISCOVERY\",\"credentials \":[{\"id\":0,\"type\":\"REDFISH\",\"authType\":\"Basic\",\"modified \":false,\"credential
} "@odata.context": "/api/$metadata#Collection(WarrantyService.Warranty)", "@odata.count": 1, "value": [ { "@odata.type": "#WarrantyService.Warranty", "@odata.id": "/api/WarrantyService/Warranties(25110)", "Id": 25110, "DeviceId": 25102, "DeviceModel": "PowerEdge C6420", "DeviceIdentifier": "GT2T0M2", "DeviceType": 1000, "CountryLookupCode": "N/A", "CustomerNumber": 0, "LocalChannel": "N/A", "OrderNumber": 0, "SystemShipDate": "0001-01-01 00:00:00.
Example Input: { "NumberOfActiveWarranties":0, "NumberOfWarrantiesExpiringSoon":0, "NumberOfExpiredWarranties":0, "ScoreBoard": false } Output: { "NumberOfActiveWarranties": 16, "NumberOfWarrantiesExpiringSoon": 0, "NumberOfExpiredWarranties": 41, "ScoreBoard": false } Report service /api/ReportService/ReportDefs This URI represents the OpenManage Enterprise report definitions. GET method for ReportDefs This method returns the definitions of reports. Description Returns the definitions of reports.
} }, { "Id": 1002, "Name": "Device Type", "Width": 20, "Sequence": 3 }, { "Id": 1003, "Name": "Device Model", "Width": 30, "Sequence": 4 }, { "Id": 1004, "Name": "Critical", "Width": 20, "Sequence": 5 }, { "Id": 1005, "Name": "Warning", "Width": 20, "Sequence": 6 }, { "Id": 1006, "Name": "Normal", "Width": 20, "Sequence": 7 }, { "Id": 1007, "Name": "Info", "Width": 20, "Sequence": 8 }, { "Id": 1008, "Name": "Total", "Width": 20, "Sequence": 9 } ], "FilterGroupId": 0, "QsmQuery": false, "ReportResults": { "
Table 150. Attributes (continued) Attribute Description QueryDef Information on the filters and context of the report ColumnNames Column names in the report FilterGroupId ID of the filter group in the report POST method for ReportDefs This method creates a report. Description Creates a report.
], "SortFields":[ } } ] PUT method for ReportDefs This method updates a report. Description Updates a report.
/api/ReportService/ReportDefs(Id)/ReportResults This URI represents the results of a report. GET method for ReportResults This method returns results of a report. Description Returns results of a report. Privilege VIEW HTTP response codes 200 Example 408 Output: { "@odata.context": "/api/$metadata#ReportService.ReportResult/$entity", "@odata.type": "#ReportService.ReportResult", "@odata.
"Sequence": 7 } ], "ResultRows@odata.navigationLink": "/api/ReportService/ ReportDefs(10031)/ReportResults/ResultRows" } /api/ReportService/ReportDefs(Id)/ReportResults/ResultRows This URI represents the rows of the report results. GET method for ResultRows This method returns rows in the report results. Description Returns rows in the report results. Privilege VIEW HTTP response codes 200 Example Output: { "@odata.context": "/api/ $metadata#Collection(ReportService.ReportResultRow)", "@odata.
} "FilterGroupId":0 /api/ReportService/Actions/ReportService.DownloadReport The URI represents the download of reports. POST method for ReportService.DownloadReport This method downloads all the reports. Description Downloads all the reports. Privilege VIEW HTTP response codes 200 Example Input: { "ReportDefId":1564, "Format":"pdf" } /api/ReportService/Actions/ReportService.DeleteReports This URI represents the reports deletion. POST method for ReportService.
Example Input: { "ReportDefId":"25074", "ReportDefName":"new clone report" } MIB import service /api/MIBImportService/MIBS This URI represents the MIB traps. GET method for MIBS This method returns the traps imported from all the MIBs. 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 Input: { "@odata.
/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 Ouput: [{ "EnterpriseOid": ".1.3.6.1.4.1.674.10892.
Privilege TRAP_MANAGEMENT HTTP response codes 200 Example Input: ["/tmp/parseMib/10892.mib"] /api/MIBImportService/Actions/MIBImportService.Delete This URI represents the deletion of MIBs. POST method for MIBImportService.Delete This method deletes all the MIB files and the corresponding traps from the system. Description Deletes all the MIB files and the corresponding traps from the system.
/api/MIBImportService/MIBImportService/EventCatalogs This URI represents the event catalogs. GET method for EventCatalogs This method returns the event catalogs. Description Returns the event catalogs. Privilege VIEW HTTP response codes 200 Example Output: { "@odata.context": "/api/ $metadata#Collection(MIBImportService.MIBEventCatalog)", "@odata.count": 46, "value": [{ "@odata.type": "#MIBImportService.MIBEventCatalog", "@odata.
18 Redfish resource model Dell EMC incrementally improves the support for API and the associated operations during the life cycle of the products. The limited Redfish implementation follows the industry-standard DMTF specifications. For more information, see the documentation available on the DMTF website.
} ] } Table 151. Attributes Attribute name Description Id ID of the session service. ServiceEnabled Indicates if the session service is enabled or disabled. SessionTimeout The period of time after which the session is timed out. /redfish/v1/SessionService/Sessions/Members This URI represents the active session services. GET method for Members This method returns a collection of the active session services. Description Returns a collection of the active session services.
Table 152. Attributes (continued) Attribute name Description StartTimeStamp Date and time when the session began. LastAccessedTimeStamp Date and time when the session was last accessed. POST method for Members This method authenticates a user and establishes a session. Description Establishes a session.
/redfish/v1/SessionService/Sessions/Members(Id) This URI represents a specific session. GET method for Members(Id) This method returns the details of a specific session. Description Returns the details of a session.
/redfish/v1/AccountService This URI represents the account configuration of all the accounts. GET method for AccountService This method returns the account configuration of all the accounts. Description Returns the account configuration. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#AccountService.v1_0_2.AccountService", "@odata.
Table 154. Attributes (continued) Attribute name Description Health Health of the resource. MinPasswordLength Minimum length of the password. MaxPasswordLength Maximum length of the password. ServiceEnabled Indicates if the service is enabled or disabled. AuthFailureLoggingThreshold The number of authorization failures after which the failure attempt is logged in the Manager log.
"HealthRollup": "OK", "Health": "OK", "Oem": null } }, "Oem": null, "AuthFailureLoggingThreshold": 3, "MinPasswordLength": 8, "MaxPasswordLength": 20, "AccountLockoutThreshold": 3, "AccountLockoutDuration": 30, "AccountLockoutCounterResetAfter": 900, "IpRangeAddress": null, "ServiceEnabled": false, "ByUserName": false, "ByIPAddress": false, "EnableIpRangeAddress": false Table 155. Attributes Attribute name Description ID ID of the account service. Description Description of the account service.
/redfish/v1/AccountService/Accounts/Members This URI represents a collection of all the accounts. GET method for Members This method returns a collection of all the accounts. Description Returns a collection of all the accounts. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#Collection(ManagerAccount.v1_0_2.ManagerAccount)", "@odata.count": 1, "value": [ { "@odata.
Table 156. Attributes (continued) Attribute name Description Enabled Indicates whether the account is enabled. POST method for Members This method creates an account. Description Creates an account.
/redfish/v1/AccountService/Accounts/Members(Id) This URI represents a specific account within the collection. GET method for Members(Id) This method returns the details of a specific account. Description Returns the details of a specific account. Privilege VIEW HTTP response codes 200 Example Input: Output: { "@odata.context": "$metadata#ManagerAccount.v1_0_2.ManagerAccount/ $entity", "@odata.
PUT method for Members(Id) This method changes the settings of an account. Description Modifies an account.
DELETE method for Members(Id) This method deletes an account. Description Deletes an account. Privilege SECURITY_SETUP HTTP response codes 204 Example Input: Output: Table 160. Attributes Attribute name Description Id ID of the account to be deleted. /redfish/v1/AccountService/Roles/Members(Id) This URI represents the role details of a specific account. GET method for Members(Id) This method returns the details of the role for a specific account. Description Returns the details of a role.
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.
HTTP response codes Example 200 Input: Output: { "@odata.context": "/redfish/ v1/$metadata#ChassisCollection.ChassisCollection", "@odata.type": "#ChassisCollection.ChassisCollection", "@odata.id": "/redfish/v1/Chassis", "Description": null, "Name": "Chassis Collection", "Oem": null, "Members@odata.count": 8, "Members": [ { "@odata.id": "/redfish/v1/Chassis/Members('25013')" }, { "@odata.id": "/redfish/v1/Chassis/Members('25014')" }, { "@odata.id": "/redfish/v1/Chassis/Members('25012')" }, { "@odata.
Example Input: Output: { "@odata.context": "/redfish/ v1/$metadata#ComputerSystemCollection.ComputerSystemCollection", "@odata.type": "#ComputerSystemCollection.ComputerSystemCollection", "@odata.id": "/redfish/v1/Systems", "Description": null, "Name": "Computer System Collection", "Oem": null, "Members@odata.count": 2, "Members": [ { "@odata.id": "/redfish/v1/Systems/Members('25010')" }, { "@odata.
