Reference Guide
Table Of Contents
- OpenManage Enterprise Version 3.5 and OpenManage Enterprise - Modular Edition Version 1.20.10 RESTful API Guide
- 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
- 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
- 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
- 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(Id)/Settings('ReplicableChassisConfigurations')
- /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
- 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
- Monitor
- Audit logs
- Jobs
- /api/JobService/Jobs
- /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
- 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
- /api/NetworkService/Fabrics
- /api/NetworkService/FabricDesigns
- /api/NetworkService/Fabrics(Id)
- /api/NetworkService/Fabrics(Id)/FabricDesigns
- /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/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.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
- 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
- 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
/api/AccountService/Actions/AccountService.Disable.................................................................................... 47
/api/AccountService/Actions/AccountService.Delete..................................................................................... 47
/api/AccountService/Roles......................................................................................................................................48
/api/AccountService/Roles(Id)...............................................................................................................................49
/api/AccountService/ExternalAccountProvider................................................................................................. 50
/api/AccountService/ExternalAccountProvider/DirectoryServiceType....................................................... 51
/api/AccountService/ExternalAccountProvider/ADAccountProvider...........................................................51
/api/AccountService/ExternalAccountProvider/ADAccountProvider(Id)................................................... 53
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.TestADConnection.................................................................................................. 55
/api/AccountService/ExternalAccountProvider/LDAPAccountProvider..................................................... 57
/api/AccountService/ExternalAccountProvider/LDAPAccountProvider(Id).............................................. 59
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.TestLDAPConnection.............................................................................................. 61
/api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.SearchGroups.....63
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.DeleteExternalAccountProvider...........................................................................64
/api/AccountService/Actions/AccountService.ImportExternalAccountProvider...................................... 64
/api/AccountService/ExternalAccountProvider/OpenIDConnectProvider................................................. 66
/api/AccountService/ExternalAccountProvider/OpenIDConnectProvider('OIDCProviderID').............. 66
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.EnableOIDCProviders..............................................................................................67
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.DisableOIDCProviders............................................................................................ 68
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.DeleteOIDCProviders..............................................................................................68
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.TestOIDCProvider................................................................................................... 69
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.TestOIDCProviderRegistrationStatus.................................................................69
Security and certificate management.......................................................................................................................... 70
/api/ApplicationService/Security............................................................................................................................70
/api/ApplicationService/Security/SecurityConfiguration.................................................................................70
/api/ApplicationService/Certificate........................................................................................................................71
/api/ApplicationService/Actions/ApplicationService.GenerateCSR..............................................................72
/api/ApplicationService/Actions/ApplicationService.UploadCertificate.......................................................73
/api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.DSCertificate...... 73
Monitoring and alert notifications................................................................................................................................. 74
api/AlertService/AlertDestinations/SNMPConfiguration................................................................................. 74
api/AlertService/AlertDestinations/Actions/AlertDestinations.ApplySNMPConfig...................................75
/api/AlertService/AlertDestinations/SyslogConfiguration............................................................................... 77
api/AlertService/AlertDestinations/Actions/AlertDestinations.ApplySyslogConfig...................................78
/api/AlertService/AlertDestinations/SMTPConfiguration................................................................................79
/api/AlertService/AlertDestinations/Actions/AlertDestinations.SendTestTrap.........................................80
Chapter 5: Alerts.........................................................................................................................82
Alert logs..............................................................................................................................................................................82
/api/AlertService/Alerts............................................................................................................................................82
/api/AlertService/Alerts?$filter=contains(UserName,'admin')...................................................................... 84
/api/AlertService/Alerts?$filter=StatusType eq 2000..................................................................................... 84
/api/AlertService/Alerts?$filter=StatusType eq 1000......................................................................................88
4
Contents