Developers Guide
Table Of Contents
- OpenManage Enterprise Version 3.7 and OpenManage Enterprise - Modular Edition Version 1.30.00 RESTful API Guide
- Contents
- About this document
- Overview
- Key integration concepts
- Application settings
- Network
- Security and user management
- /api/AccountService
- /api/AccountService/Accounts
- /api/AccountService/Accounts(Id)
- /api/AccountService/Accounts(userId)/Permissions
- /api/AccountService/Actions/AccountService.GetPrivileges
- /api/AccountService/Actions/AccountService.GetPrivilegesForUser
- /api/AccountService/Actions/AccountService.GetUserDetail
- /api/AccountService/Actions/AccountService.Enable
- /api/AccountService/Actions/AccountService.Disable
- /api/AccountService/Actions/AccountService.Delete
- /api/AccountService/Roles
- /api/AccountService/Roles(Id)
- /api/AccountService/ExternalAccountProvider
- /api/AccountService/ExternalAccountProvider/DirectoryServiceType
- /api/AccountService/ExternalAccountProvider/ADAccountProvider
- /api/AccountService/ExternalAccountProvider/ADAccountProvider(Id)
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.TestADConnection
- /api/AccountService/ExternalAccountProvider/LDAPAccountProvider
- /api/AccountService/ExternalAccountProvider/LDAPAccountProvider(Id)
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.TestLDAPConnection
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.SearchGroups
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.DeleteExternalAccountProvider
- /api/AccountService/Actions/AccountService.ImportExternalAccountProvider
- /api/AccountService/ExternalAccountProvider/OpenIDConnectProvider
- /api/AccountService/ExternalAccountProvider/OpenIDConnectProvider('OIDCProviderID')
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.EnableOIDCProviders
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.DisableOIDCProviders
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.DeleteOIDCProviders
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.TestOIDCProvider
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.TestOIDCProviderRegistrationStatus
- Security and certificate management
- /api/ApplicationService/Security
- /api/ApplicationService/Security/SecurityConfiguration
- /api/ApplicationService/Certificate
- /api/ApplicationService/Actions/ApplicationService.GenerateCSR
- /api/ApplicationService/Actions/ApplicationService.UploadCertificate
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.DSCertificate
- Monitoring and alert notifications
- api/AlertService/AlertDestinations/SNMPConfiguration
- api/AlertService/AlertDestinations/Actions/AlertDestinations.ApplySNMPConfig
- /api/AlertService/AlertDestinations/SyslogConfiguration
- api/AlertService/AlertDestinations/Actions/AlertDestinations.ApplySyslogConfig
- /api/AlertService/AlertDestinations/SMTPConfiguration
- /api/AlertService/AlertDestinations/Actions/AlertDestinations.SendTestTrap
- api/ApplicationService/SystemResourceUsage
- Alerts
- Alert logs
- /api/AlertService/Alerts
- /api/AlertService/Alerts?$filter=contains(UserName,'admin')
- /api/AlertService/Alerts?$filter=StatusType eq 2000
- /api/AlertService/Alerts?$filter=StatusType eq 1000
- /api/AlertService/Alerts?$filter=StatusType eq 1
- /api/AlertService/Alerts(Id)
- /api/AlertService/AlertCategories
- /api/AlertService/AlertCategories('Name')
- /api/AlertService/AlertSeverities
- /api/AlertService/AlertSeverities(Id)
- /api/AlertService/AlertStatuses
- /api/AlertService/AlertStatuses(Id)
- /api/AlertService/AlertCatalogs
- /api/AlertService/AlertCatalogs(Id)
- /api/AlertService/Events
- /api/AlertService/Actions/AlertService.Acknowledge
- /api/AlertService/Actions/AlertService.Unacknowledge
- /api/AlertService/Actions/AlertService.RemoveAlerts
- Alert policies
- /api/AlertService/AlertPolicies
- /api/AlertService/AlertPolicies(Id)
- /api/AlertService/AlertPolicies(Arg1)/PolicyCriteria
- /api/AlertService/AlertPolicies(Arg1)/PolicyCriteria(Arg2)
- /api/AlertService/AlertPolicies(Arg1)/PolicyActions
- /api/AlertService/AlertPolicies(Arg1)/PolicyActions(Arg2)
- /api/AlertService/AlertActionTemplates
- /api/AlertService/AlertActionTemplates(Id)
- /api/AlertService/Actions/AlertService.EnableAlertPolicies
- /api/AlertService/Actions/AlertService.DisableAlertPolicies
- /api/AlertService/Actions/AlertService.RemoveAlertPolicies
- Alert definitions
- Alert logs
- Configure
- Firmware
- /api/UpdateService/Catalogs
- /api/UpdateService/Catalogs(Id)
- /api/UpdateService/Baselines
- api/UpdateService/Baselines(Id)
- /api/UpdateService/Actions/UpdateService.GetBaselinesForDevices
- api/UpdateService/FirmwareBaselineSummary
- /api/UpdateService/Actions/UpdateService.CheckBaselinesAssociation
- /api/UpdateService/ComplianceStatuses
- /api/UpdateService/Baselines(Id)/DeviceComplianceReports
- /api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)
- /api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)/ComponentComplianceReports
- /api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)/ComponentComplianceReports(Id)
- /api/UpdateService/Actions/UpdateService.UploadFile
- /api/UpdateService/Actions/UpdateService.RemoveFile
- /api/UpdateService/Actions/UpdateService.RefreshCatalogs
- /api/UpdateService/Actions/UpdateService.RemoveCatalogs
- /api/UpdateService/Actions/UpdateService.RemoveBaselines
- /api/UpdateService/RollbackSoftwares
- /api/UpdateService/Actions/UpdateService.GetSingleDupDetails
- /api/UpdateService/Actions/UpdateService.GetSingleDupReport
- /api/UpdateService/Actions/UpdateService.GetBaselinesReportByDeviceids
- /api/UpdateService/Actions/UpdateService.GetCertDetails
- Template Service
- /api/TemplateService/TemplateTypes
- /api/TemplateService/TemplateViewTypes
- /api/TemplateService/Templates
- /api/TemplateService/Templates(Id)
- api/TemplateService/Templates(26)
- /api/TemplateService/Templates(Id)/Views
- /api/TemplateService/Templates(Id)/Views(Id)
- /api/TemplateService/Templates(Id)/Views(Id)/AttributeViewDetails
- /api/TemplateService/Templates(Id)/Views(Id)/AttributeViewDetails/TemplateEditInfoDetails
- /api/TemplateService/Templates(Id)/Views(Id)/DeviceAttributeViewDetails(Id)
- /api/TemplateService/Templates(26)/Views(9)/DeviceAttributeViewDetails(10176)
- /api/TemplateService/Actions/TemplateService.AssignIdentities
- /api/TemplateService/Actions/TemplateService.GetAssignedIdentities
- /api/TemplateService/Actions/TemplateService.FreeReservedIdentities
- /api/TemplateService/Actions/TemplateService.Clone
- /api/TemplateService/Actions/TemplateService.Export
- /api/TemplateService/Actions/TemplateService.Import
- /api/TemplateService/Actions/TemplateService.Deploy
- /api/TemplateService/Actions/TemplateService.UpdateNetworkConfig
- /api/TemplateService/Actions/TemplateService.RemoveBaseline
- /api/TemplateService/Actions/TemplateService.Remediate
- api/TemplateService/Actions/TemplateService.IsSocRunning
- api/TemplateService/Actions/TemplateService.RefreshSummary
- Identity pools
- /api/IdentityPoolService/IdentityPools
- /api/IdentityPoolService/IdentityPools(Id)
- /api/IdentityPoolService/IdentityPools(Id)/UsageCounts
- /api/IdentityPoolService/IdentityPools(Id)/UsageIdentitySets
- /api/IdentityPoolService/IdentityPoolsI(Id)/UsageIdentitySets(Id)
- /api/IdentityPoolService/IdentityPools(Id)/UsageIdentitySets(Id)/Details
- /api/IdentityPoolService/IdentityStates
- /api/IdentityPoolService/IdentityStates(Id)
- /api/IdentityPoolService/Actions/IdentityPoolService.DeleteIdentityPools
- Network Configuration Service
- /api/NetworkConfigurationService/Networks
- /api/NetworkConfigurationService/Networks(Id)
- /api/NetworkConfigurationService/NetworkTypes
- /api/NetworkConfigurationService/NetworkTypes(Id)
- /api/NetworkConfigurationService/QosTypes
- /api/NetworkConfigurationService/QosTypes(Id)
- /api/NetworkConfigurationService/Actions/NetworkConfigurationService.RemoveNetworks
- api/NetworkConfigurationService/Actions/NetworkConfigurationService.ImportVLANDefinitions
- api/NetworkConfigurationService/Actions/NetworkConfigurationService.ExportVLANDefinitions
- api/NetworkConfigurationService/Actions/NetworkConfigurationService.ValidateNetworkDefinitionFile
- /api/NetworkConfigurationService/ReplicableChassisSettings
- Firmware
- Devices
- /api/DeviceService
- /api/DeviceService/Devices
- /api/DeviceService/Devices?$filter=Type eq 1000
- /api/DeviceService/Devices(Id)
- /api/DeviceService/Devices(Id)/InventoryDetails
- /api/DeviceService/Devices(Id)/InventoryDetails(InventoryType)
- /api/DeviceService/Devices(Device_ID)/InventoryDetails('deviceManagement')
- /api/DeviceService/Devices(Id)/Settings('ReplicableChassisConfigurations')
- /api/DeviceService/Devices(DEVICE_ID)/Settings('NetworkServices')
- /api/DeviceService/Devices(Device_ID)/Settings('LocalAccessConfiguration')
- /api/DeviceService/Devices(Id)/HardwareLogs
- /api/DeviceService/Devices(Id)/SubSystemHealth
- /api/DeviceService/Devices(Id)/RecentActivity
- /api/DeviceService/Devices(Id)/InventoryTypes
- /api/DeviceService/Devices(Id)/LogSeverities
- /api/DeviceService/Devices(Id)/Settings
- /api/DeviceService/Devices(Id)/Settings('Type')
- /api/DeviceService/Devices(Id)/Temperature
- /api/DeviceService/Devices(Id)/BlinkStatus
- /api/DeviceService/Devices(Id)/PowerUsageByDevice
- /api/DeviceService/Devices(Id)/DeviceBladeSlots
- /api/DeviceService/Devices(Id)/GraphicInfo
- /api/DeviceService/Devices(Id)/DeployRequired
- /api/DeviceService/Devices(Id)/SystemUpTime
- /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.UploadFSDCertificate
- /api/DeviceService/PowerStates
- /api/DeviceService/DeviceStatuses
- /api/DeviceService/DeviceType
- /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.SetTermState
- /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.GetTermState
- /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.GetComputeIPs
- /api/DeviceService/DeviceSummary
- /api/DeviceService/DeviceSummary(Type)
- api/DeviceService/Actions/DeviceService.DevicesPrivilegesAction
- /api/DeviceService/Actions/DeviceService.DevicesByPrivilegesAction
- /api/DeviceService/Actions/DeviceService.ExecuteAction
- /api/DeviceService/DeviceSlotType
- /api/DeviceService/DeviceSettingsMetadata
- /api/DeviceService/GlobalExcludes
- /api/DeviceService/Actions/DeviceService.AddNetworkRange
- /api/DeviceService/Actions/DeviceService.EditNetworkRange
- /api/DeviceService/Actions/DeviceService.RemoveFromExclusion
- /api/DeviceService/Actions/DeviceService.ValidateExcludes
- /api/DeviceService/Actions/DeviceService.RemoveDevices
- DeviceService_/api/ConnectionStateReasons
- DeviceService_/api/ConnectionStateReasons(arg1)
- Diagnostic
- Groups
- /api/GroupService/Groups
- /api/GroupService/Groups(Id)
- /api/GroupService/Groups(Id)/Devices
- /api/GroupService/Groups(Id)/GroupDevicesSummary
- /api/GroupService/Groups(group id)/AllLeafDeviceSummaries
- /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000
- /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0
- /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0&$orderby=Identifier asc
- /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.AddMemberDevices
- /api/GroupService/Actions/GroupService.GroupsPrivilegesAction
- /api/GroupService/Actions/GroupService.GroupsByPrivilegesAction
- GroupService_/api/Groups/Devices(arg1)
- GroupService_/api/Groups/AllLeaveDevices(arg1)
- GroupService_/api/Groups/AllLeafDevicesSummary(arg1)
- Monitor
- Audit logs
- Jobs
- /api/JobService/Jobs
- GET method for Jobs
- POST method for Jobs
- POST method for updating firmware using compliance method
- POST method for updating firmware using Individual Package method
- POST method for configuring chassis name
- POST method for setting slot names for blade servers
- POST method for quick deploy of sleds
- POST method for quick deploy of IOM
- POST method for configuring Forward Error Correction for IOM ports
- POST method for IOM power off operation
- POST method for rolling back firmware update using device method
- POST method for rolling back firmware update using catalog method
- POST method for rolling back firmware update using browse method
- POST method for failover of management module
- POST method for chassis backup
- POST method for chassis restore
- POST method for exporting chassis profiles
- Jobs_POST method for test connection
- POST method for chassis extract logs—local share
- POST method for chassis extract logs NFS share
- POST method for chassis extract logs CIFS share
- POST method for device based reseat for compute storage or IOM
- POST method for slot based reseat for compute storage or IOM
- POST method for chassis power off operation
- POST method for blade server or sled power off operation
- POST method for slot based iDRAC reset operation
- POST method for force reset of management module
- POST method for blink LED
- POST method for power cycle system—cold boot
- POST method for system reseat
- POST method for reset iDRAC
- POST method for configure port breakout
- POST method for toggle port status
- POST method for group inventory
- POST method for device inventory
- POST method for extracting device logs
- POST method for extracting SupportAssist collection
- POST method for reset temperature metric values
- POST method for generic end host ports
- /api/JobService/Jobs(Id)
- /api/JobService/JobStatuses
- /api/JobService/JobStatuses(Id)
- /api/JobService/JobTypes
- /api/JobService/JobTypes(Id)
- /api/JobService/Jobs(Id)/ExecutionHistories
- /api/JobService/Jobs(Id)/ExecutionHistories(Id)
- /api/JobService/Actions/JobService.EnableJobs
- /api/JobService/Actions/JobService.DisableJobs
- /api/JobService/Actions/JobService.RemoveJobs
- /api/JobService/Actions/JobService.Schedule
- /api/JobService/Actions/JobService.RunJobs
- /api/JobService/Actions/JobService.StopJobs
- /api/JobService/Actions/JobService.Resume
- /api/JobService/Actions/JobService.ExecuteAction
- /api/JobService/Jobs
- Reset application
- Console version
- Console capabilities
- Search
- Session
- APIs specific to OpenManage Enterprise – Modular Edition
- /api/ApplicationService/Settings
- /api/ApplicationService/Network/CurrentAddressConfiguration
- /api/ApplicationService/Network/AddressConfiguration
- /api/ApplicationService/Actions/ApplicationService.GetConfiguration
- /api/ApplicationService/Actions/ApplicationService.ApplyConfiguration
- Brand
- Multichassis management
- /api/ManagementDomainService
- /api/ManagementDomainService/DiscoveredDomains
- /api/ManagementDomainService/ConfigurationTypes
- /api/ManagementDomainService/ConfigurationTypes(Id)
- /api/ManagementDomainService/Domains
- /api/ManagementDomainService/Domains(Id)
- /api/ManagementDomainService/PendingDomains
- /api/ManagementDomainService/PendingDomains(Id)
- /api/ManagementDomainService/Actions/ManagementDomainService.Domains
- /api/ManagementDomainService/Actions/ManagementDomainService.Join
- /api/ManagementDomainService/Actions/ManagementDomainService.Leave
- /api/ManagementDomainService/Actions/ManagementDomainService.Delete
- /api/ManagementDomainService/Actions/ManagementDomainService.DeleteGroup
- /api/ManagementDomainService/GetSyncFailureAlertTimeoutValues
- /api/ManagementDomainService/Actions/ManagementDomainService.ApproveJoin
- /api/ManagementDomainService/Actions/ManagementDomainService.AssignBackupLead
- /api/ManagementDomainService/Actions/ManagementDomainService.ReassignBackupLead
- /api/ManagementDomainService/Actions/ManagementDomainService.UnassignBackupLead
- /api/ManagementDomainService/Actions/ManagementDomainService.PromoteBackupLead
- /api/ManagementDomainService/Actions/ManagementDomainService.RetireLead
- FIPS mode settings
- Fabric management
- api/NetworkService/Actions/NetworkService.CreateFabric
- /api/NetworkService/Actions/NetworkService.UpdateFabric
- /api/NetworkService/Actions/NetworkService.DeleteFabrics
- /api/NetworkService
- /api/NetworkService/Fabrics
- /api/NetworkService/FabricDesigns
- /api/NetworkService/Fabrics(Id)
- /api/NetworkService/Fabrics(Id)/FabricDesign
- /api/NetworkService/FabricDesigns(arg1)
- /api/NetworkService/Fabrics(Id)/ValidationErrors
- /api/NetworkService/Fabrics(Id)/Uplinks
- /api/NetworkService/Fabrics(Id)/Uplinks(Id)
- /api/NetworkService/Fabrics(Id)/Uplinks(Id)/Ports
- /api/NetworkService/PortFECCapabilities
- /api/NetworkService/Fabrics(Id)/Uplinks(Id)/Networks
- /api/NetworkService/Fabrics('Id')/NetworkService.GetApplicableUplinkNetworks
- api/NetworkService/Fabrics(arg1)/NetworkService.GetApplicableUplinkUntaggedNetworks
- api/NetworkService/Fabrics(arg1)/Servers
- /api/NetworkService/Fabrics(Id)/NetworkService.GetApplicableUplinkPorts
- api/NetworkService/Actions/NetworkService.UpdateServerUntaggedVLAN
- /api/NetworkService/Fabrics(Id)/Switches
- /api/NetworkService/Fabrics(arg1)/Actions/NetworkService.GetUnallocatedSwitches
- /api/NetworkService/Fabrics(arg1)/Actions/NetworkService.ReplaceSwitch
- /api/NetworkService/Fabrics(Id)/Servers
- /api/NetworkService/Fabrics(Id)/Topology
- /api/NetworkService/Fabrics(Id)/Topology/Nodes
- /api/NetworkService/Fabrics(Id)/Topology/Nodes(Id)
- /api/NetworkService/Actions/NetworkService.RemoveFabrics
- /api/NetworkService/Actions/NetworkService.RemoveUplinks
- /api/NetworkService/FabricDesigns(Id)/NetworkService.GetApplicableNodes
- /api/NetworkService/UplinkTypes
- /api/NetworkService/NodeTypes
- /api/NetworkService/FabricActivityTypes
- /api/NetworkService/FabricActivityStatuses
- /api/NetworkService/FabricHealthStatuses
- /api/NetworkService/MultiChassisDomain
- /api/NetworkService/MultiChassisDomain/Topology
- /api/NetworkService/MultiChassisDomain/Topology/Nodes
- /api/NetworkService/MultiChassisDomain/Topology/Nodes(Id)
- /api/NetworkService/MultiChassisDomain/Topology/Nodes(Id)/ChildNodes
- /api/NetworkService/MultiChassisDomain/ValidationErrors
- /api/NetworkService/PortAdminStatuses
- /api/NetworkService/PortStatuses
- /api/NetworkService/PortBlinkStatuses
- /api/NetworkService/PortRoles
- api/NetworkService/ServerProfileBondingTechnologies
- api/NetworkService/ServerProfiles
- api/NetworkService/ServerProfiles(Id)
- /api/NetworkService /ServerProfiles(arg1)
- /api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles
- /api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)
- /api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)/Networks
- api/NetworkService/ServerProfiles(Id)/ServerInterfaceProfiles
- /api/NetworkService/Actions/NetworkService.ApplyServersInterfaceProfiles
- /api/NetworkService/Actions/NetworkService.ModifyServerProfiles
- /api/NetworkService/Actions/NetworkService.AddServerNetworks
- /api/NetworkService/Actions/NetworkService.DeleteServerNetworks
- /api/NetworkService/FeatureCapabilities
- NetworkService/Fabrics(arg1)/Multicast
- api/NetworkService/Fabrics(arg1)/Multicast/MulticastNetworks
- api/NetworkService/MulticastApplicableNetworks
- Port configuration in Fabrics
- Storage management
- Quick Deploy
- Server NIC VLAN configuration
- /api/NetworkService /ServerProfiles(arg1)
- /api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles
- /api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)
- /api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)/Networks
- /api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)/Networks (arg3)
- /api/NetworkService/Actions/NetworkService.ApplyServersInterfaceProfiles
- Template Service
- /api/TemplateService/Profiles
- /api/TemplateService/Profiles(Id)
- /api/TemplateService/ProfileState
- /api/TemplateService/ProfileUsage
- /api/TemplateService/Actions/TemplateService.AttachProfile
- /api/TemplateService/Actions/TemplateService.AssociateProfile
- /api/TemplateService/Actions/TemplateService.UpdateProfile
- /api/TemplateService/Actions/TemplateService.MigrateProfile
- /api/TemplateService/Actions/TemplateService.DetachProfile
- TemplateService/AttributeRegistryDetail
- APIs specific to OpenManage Enterprise
- Application settings
- Console update
- /api/JobService/Jobs
- /api/ConsoleUpdateService/Updates?$filter= Auto eq true
- /api/ConsoleUpdateService/UpdateBundleInfo
- /api/ConsoleUpdateService/Actions/ConsoleUpdateService.DeleteUpgradeBundle
- /api/ConsoleUpdateService/Actions/ConsoleUpdateService.DownloadBundle
- /api/ConsoleUpdateService/LastUpdateResult
- Mobile
- /api/AlertService/MobileSubscriptions
- /api/AlertService/SubscriptionNotificationService
- /api/AlertService/Actions/AlertService.CreateEditMobileSubscription
- /api/AlertService/Actions/AlertService.DeleteMobileSubscription
- /api/AlertService/Actions/AlertService.EnableSubscriptionNotificationService
- /api/AlertService/Actions/AlertService.FilterAlertsByPolicy
- Console Preferences
- Alerts
- Incoming Alerts
- Warranty
- Network Configuration
- Configuration compliance
- Troubleshoot service
- Query support service
- /api/QuerySupportService/Queries
- /api/QuerySupportService/Queries(Id)
- /api/QuerySupportService/QueryContextSummaries
- /api/QuerySupportService/QueryContextSummary(Id)
- /api/QuerySupportService/QueryContexts(Id)
- /api/QuerySupportService/QueryContexts(Id)/QuerySupportService.GetFiltersForContext
- /api/QuerySupportService/OperatorInfo
- /api/QuerySupportService/Filters
- /api/QuerySupportService/Filters(Id)
- Groups service
- /api/GroupService/Groups
- /api/GroupService/Groups(Id)/SubGroups(Id)
- /api/GroupService/Groups(Id)/DeviceStatusSummary
- /api/GroupService/Groups(Id)/EventStatusSummary
- /api/GroupService/Groups(group id)/EventSeveritySummary?$filter=StatusType eq 2000
- /api/GroupService/Groups(group id)/EventSeveritySummary?$filter=StatusType eq 1000
- /api/GroupService/Groups(group id)/EventSeveritySummary$filter=StatusType eq 1
- /api/GroupService/GroupAudits
- /api/GroupService/Actions/GroupService.CreateGroup
- /api/GroupService/Actions/GroupService.UpdateGroup
- /api/GroupService/Actions/GroupService.Clone
- /api/GroupService/Actions/GroupService.DeleteGroup
- /api/GroupService/Actions/GroupService.AddMemberDevices
- /api/GroupService/Actions/GroupService.RemoveMemberDevices
- /api/GroupService/Actions/GroupService.AddUserToGroups
- Profiles
- /api/ProfileService/Profiles
- /api/ProfileService/Profiles(arg)
- /api/ProfileService/ProfileUsage
- /api/ProfileService/Profiles(arg1)/AttributeDetails
- /api/ProfileService/Actions/ProfileService.Rename
- /api/ProfileService/Actions/ProfileService.GetTargetSpecificAttributes
- /api/ProfileService/Actions/ProfileService.GetIdentityAttributes
- /api/ProfileService/Actions/ProfileService.AssignProfile
- /api/ProfileService/Actions/ProfileService.AssignProfileForAutoDeploy
- /api/ProfileService/Actions/ProfileService.SyncProfiles
- /api/ProfileService/Actions/ProfileService.MigrateProfile
- /api/ProfileService/Actions/ProfileService.UnassignProfiles
- /api/ProfileService/ProfileStates
- /api/ProfileService/Actions/ProfileService.Delete
- /api/ProfileService/Profiles(arg1)
- /api/ProfileService/Actions/ProfileService.GetInvalidTargetsForDeployTemplate
- /api/ProfileService/Actions/ProfileService.GetInvalidTargetsForAssignProfile
- Devices
- Auto deploy
- Monitor
- Discovery service
- Server-initiated discovery
- /api/DiscoveryConfigService/Actions/DiscoveryConfigService.UploadNodeInfo
- /api/DiscoveryConfigService/Actions/DiscoveryConfigService.SignalNodePresence
- /api/DiscoveryConfigService/Actions/DiscoveryConfigService.DiscoverNodes
- /api/DiscoveryConfigService/Actions/DiscoveryConfigService.DeleteSignaledNodes
- /api/DiscoveryConfigService/SignaledNodes
- Warranty service
- Report service
- /api/ReportService/ReportDefs
- /api/ReportService/ReportDefs(Id)/ReportResults
- /api/ReportService/ReportDefs(Id)/ReportResults/ResultRows
- /api/ReportService/Actions/ReportService.RunReport
- /api/ReportService/Actions/ReportService.DownloadReport
- /api/ReportService/Actions/ReportService.DeleteReports
- /api/ReportService/Actions/ReportService.CloneReport
- /api/ReportService/Actions/ReportService.EmailReport
- MIB import service
- /api/MIBImportService/MIBS
- /api/MIBImportService/Actions/MIBImportService.Save
- /api/MIBImportService/Actions/MIBImportService.Parse
- /api/MIBImportService/Actions/MIBImportService.Delete
- /api/MIBImportService/MIBImportService/EventSeverities
- /api/MIBImportService/MIBImportService/EventCatalogs
- /api/MIBImportService/MIBImportService/EventCategories
- Plugin Manager
- Power Metrics
- Redfish resource model
- Redfish—ServiceRoot
- Redfish—SessionService
- Redfish—Account Service
- Redfish—Message Registry
- Redfish—Chassis
- /redfish/v1/Chassis
- GET method for Chassis
- redfish/v1/Chassis/Members(id)
- redfish/v1/Chassis/Members(id)/Power
- redfish/v1/Chassis/Members(id)/Power/PowerControl(
) - redfish/v1/Chassis/Members(id)/Power/PowerSupplies(
) - redfish/v1/Chassis/Members(id)/Thermal
- redfish/v1/Chassis/Members(id)/Thermal/Temperatures(
) - redfish/v1/Chassis/Members(id)/Thermal/Fans(
) - redfish/v1/Managers/Members(
) - redfish/v1/Chassis/Members(id)/Actions/Oem/DellChassis.VirtualReseat
- redfish/v1/Chassis/Members(id)/Actions/Chassis.Reset
- redfish/v1/Managers(
)/Actions/Manager.Reset
- /redfish/v1/Chassis
- Redfish—Systems
- /redfish/v1/Systems
- redfish/v1/Systems/Members(id)
- redfish/v1/Systems/Members(id)/Processors
- redfish/v1/Systems/Members(id)/Processors/Members(id)
- redfish/v1/Systems/Members(id)/EthernetInterfaces
- redfish/v1/Systems/Members(id)/EthernetInterfaces/Members(id)
- redfish/v1/Systems/Members(id)/SimpleStorage
- redfish/v1/Systems/Members(id)/SimpleStorage/Members
- redfish/v1/Systems/Members(id)/SimpleStorage/Members(id)
- redfish/v1/Systems/Members(id)/Actions/ComputerSystem.Reset
- Redfish—CompositionService
- redfish/v1/CompositionService
- redfish/v1/CompositionService/ResourceBlocks
- redfish/v1/CompositionService/ResourceBlocks/Members(
) - redfish/v1/CompositionService/ResourceZones
- redfish/v1/CompositionService/ResourceZones/Members(
) - /redfish/v1/Systems/Members(
)/Actions/ComputerSystem.AddResourceBlock - /redfish/v1/Systems/Members(
)/Actions/ComputerSystem.RemoveResourceBlock
- Redfish—EventService
- Redfish—OpenManage Enterprise License Manager
- Redfish—Telemetry
- /redfish/v1/TelemetryService
- /redfish/v1/TelemetryService/MetricDefinitions
- /redfish/v1/TelemetryService/MetricDefinitions/ID
- /redfish/v1/TelemetryService/MetricReports
- /redfish/v1/TelemetryService/MetricReports/ID
- /redfish/v1/TelemetryService/MetricReportDefinitions
- /redfish/v1/TelemetryService/Triggers
- /redfish/v1/TelemetryService/Triggers/ID
- Managers
- Redfish—OpenID Connect Provider
- /api/AccountService/ExternalAccountProvider/OpenIDConnectProvider
- /api/AccountService/ExternalAccountProvider/OpenIDConnectProvider(‘OIDCProviderID’)
- /api/AccountService/ExternalAccountProvider /OpenIDConnectProvider(‘ID’)
- /api/AccountService/ExternalAccountProvider/OpenIDConnectProviders
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.EnableOIDCProviders
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.TestOIDCProvider
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider. DisableOIDCProviders
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.DeleteOIDCProviders
- /api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.TestOIDCProviderRegistrationStatus
Table 148. Attributes (continued)
Attribute Description
State Internal state of the request. Possible values:
● 1001 - Join approval is pending with the lead domain.
● 1002 - Join request is approved by the lead.
● 1004 - Onboarding is in progress.
● 1006 - Request is initiated to delete the member domain.
● 1007 - Request is in progress to delete the member
domain.
● 1012 - Request to join group is initiated from the stand-
alone 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.
Name Name of the onboarding chassis.
Description Description of the onboarding chassis.
Identifier Service tag of the onboarding chassis.
Domain type Information for internal programmatic use.
Version Version of OME–Modular of the onboarding chassis.
/api/ManagementDomainService/PendingDomains(Id)
This URI represents a specific pending domain-related requests in the collection of pending requests.
GET method for PendingDomains(Id)
This method returns a specific pending request that is made for joining an MCM domain group.
Description
Returns a specific pending request for joining an MCM domain group.
Privilege VIEW
HTTP response
codes
200
Example
response body
{
"@odata.context": "$metadata#ManagementDomainService.PendingDomain/
$entity",
"@odata.id": "/api/ManagementDomainService/PendingDomains(15964)",
"Id": 15964,
"JobId": 0,
"State": 1001,
"Address": "fde1:53ba:e9a0:de14:1a66:daff:fe76:4de5",
"Name": "cmc-MEM123",
"Description": "Chassis-MEM123",
"Identifier": "MEM123",
"DomainType": "OME-Modular",
"Version": "VERSION",
}
530 APIs specific to OpenManage Enterprise – Modular Edition