API Guide
Table Of Contents
- Active System Manager Release 8.2 API Reference Guide
- Overview
- Resource URI Endpoints
- Authentication Headers
- Generic Query Parameters
- HTTP Message Bodies
- Usage Examples
- Exception Handling
- Appendix A - API Reference
- /Authenticate/
- /Chassis/
- /Chassis/{refId}
- /Chassis/{refId}
- /Chassis/{refId}
- /Chassis/iom/ip/{ip}
- /Chassis/{refId}/sensorlog
- /Chassis/{refId}/sensorlog
- /Chassis/{serviceTag}/{type}
- /Chassis/{serviceTag}/{type}
- /Credential/
- /Credential/
- /Credential/{id}
- /Credential/{id}
- /Credential/{id}
- /DHCP/
- /DHCP/
- /Deployment/
- /Deployment/
- /Deployment/{id}
- /Deployment/{id}
- /Deployment/{id}
- /Deployment/export/csv
- /Deployment/defineService
- /Deployment/defineServiceDiff
- /Deployment/device/{deviceId}
- /Deployment/filter/{numOfDeployments}
- /Deployment/migrate/{serviceId}/{serverId}
- /Deployment/migrateServer/{serviceId}/{componentId}
- /Deployment/serverNetworking/{serviceId}/{serverId}
- /DeviceGroup/
- /DeviceGroup/
- /DeviceGroup/{refId}
- /DeviceGroup/{refId}
- /DeviceGroup/{refId}
- /DiscoveryRequest/
- /DiscoveryRequest/
- /DiscoveryRequest/{id}
- /DiscoveryRequest/{id}
- /DiscoveryRequest/chassislist
- /DiscoveryRequest/discoveryresult/{id}
- /FirmwareRepository/
- /FirmwareRepository/
- /FirmwareRepository/{id}
- /FirmwareRepository/{id}
- /FirmwareRepository/connection
- /FirmwareRepository/compliance
- /FirmwareRepository/compliance/{id}
- /FirmwareRepository/softwarecomponent
- /FirmwareRepository/softwarebundle/{id}
- /ManagedDevice/
- /ManagedDevice/
- /ManagedDevice/count
- /ManagedDevice/{refId}
- /ManagedDevice/{refId}
- /ManagedDevice/{refId}
- /ManagedDevice/firmware
- /ManagedDevice/export/csv
- /ManagedDevice/withcompliance
- /ManagedDevice/puppet/{certName}
- /ManagedDevice/puppet/{certName}
- /ManagedDevice/withcompliance/{refId}
- /NTP/
- /NTP/
- /NTP/
- /Network/
- /Network/
- /Network/export/csv
- /Network/{networkId}
- /Network/{networkId}
- /Network/{networkId}
- /Network/ipAddress/assign
- /Network/ipAddress/release
- /Network/{networkId}/usageids
- /Network/{networkId}/ipaddresses
- /OSRepository/
- /OSRepository/
- /OSRepository/{id}
- /OSRepository/{id}
- /OSRepository/{id}
- /OSRepository/sync/{id}
- /OSRepository/connection
- /Proxy/
- /Proxy/
- /Proxy/test
- /Server/
- /Server/count
- /Server/{refId}
- /Server/{refId}
- /Server/serviceTag/{serviceTag}
- /ServiceTemplate/
- /ServiceTemplate/
- /ServiceTemplate/{id}
- /ServiceTemplate/{id}
- /ServiceTemplate/{id}
- /ServiceTemplate/upload
- /ServiceTemplate/export
- /ServiceTemplate/{id}/copy
- /ServiceTemplate/export/csv
- /ServiceTemplate/uploadConfig
- /ServiceTemplate/updateParameters
- /ServiceTemplate/device/{deviceId}
- /ServiceTemplate/{id}/mapToPhysicalResources
- /ServiceTemplate/components/service/{serviceId}
- /ServiceTemplate/components/template/{templateId}
- /ServiceTemplate/service/{serviceId}/{componentType}
- /ServiceTemplate/template/{templateId}/{componentType}
- /Timezone/
- /Timezone/
- /Timezone/all
- /User/
- /User/
- /User/{userId}
- /User/{userId}
- /User/{userId}
- /WizardStatus/
- /WizardStatus/
- Appendix B - Model Reference
- BrownfieldStatus
- ComparatorValue
- CompliantState
- DeploymentHealthStatusType
- DeploymentStatusType
- DeviceHealth
- DeviceState
- DeviceType
- DiscoverDeviceType
- DiscoveryStatus
- DiskMediaType
- Health
- HotSpareStatus
- IOMLocationType
- IdentityType
- LogSeverity
- MediaType
- NetworkMode
- PhysicalType
- RepositoryState
- RepositoryStatus
- ServerSlotType
- ServiceTemplateComponentSubType
- ServiceTemplateComponentType
- ServiceTemplateSettingType
- UIRaidLevel
- UpdateType
- AsmDetailedMessage
- AuthenticateRequest
- AuthenticateResponse
- ChassisController
- ChassisPowerSupply
- Enclosure
- FirmwareInventory
- GroupUser
- IKVM
- IpAddress
- IpRange
- Link
- List
- MemoryInventory
- OSRepository
- ProcessorInventory
- RejectedServer
- SelectedNIC
- ServerJobStatus
- ServiceTemplateOption
- ServiceTemplateUploadRequest
- SoftwareComponent
- timeZone
- UsageIdList
- VM
- connected_switch
- dhcpSettings
- fc_interface
- logEntry
- ntpSettings
- proxySettings
- references
- testProxyResponse
- timeZone
- AsmDetailedMessageList
- DeploymentDevice
- DeviceDiscoveryRequest
- FirmwareComplianceComponents
- FirmwareUpdateRequest
- GregorianCalendar
- GroupUserList
- IOM
- LogicalNetworkIdentityInventory
- PhysicalDisk
- Server
- ServiceTemplateValid
- SoftwareBundle
- StaticNetworkConfiguration
- VirtualDiskConfiguration
- availableTimeZones
- credential
- wizardStatus
- Chassis
- ChassisLogEntry
- DeviceDiscoveryRequests
- LogicalNetworkInterface
- Network
- User
- VirtualDisk
- asmCredential
- Controller
- Partition
- RAIDConfiguration
- credentialList
- Interface
- SelectedServer
- DeploymentFilterResponse
- Fabric
- NetworkConfiguration
- ServerNetworkObjects
- ServiceTemplateSetting
- ServiceTemplateCategory
- component
- FirmwareRepository
- ServiceTemplate
- Deployment
- DiscoveredDevices
- DiscoveryResult
- FirmwareDeviceInventory
- DiscoveryRequest
- ManagedDevice
- ManagedDeviceList
- DeviceGroup
- DeviceGroupList
- Appendix C -Ruby Code Usage

Response Status Codes
Table 98. Response Status Codes
HTTP Status Code Reason
200 retrieved
400 Bad Request, verify id is correct
404 Bad Request, verify id is correct
/ManagedDevice/
Desciption
Retrieve all Devices from Inventory with filter.
Method
get
Response Class
[ ManagedDevice ]
Response Content-Type: application/xml, application/json
Parameters
Table 99. Parameters
Parameter Value Description Default Value Parameter
Type
Data Type
sort N/A Valid sort
columns:
displayName,se
rviceTag,refId,h
ealth,refType,de
viceType,ipAddr
ess,state,model,
statusMessage,
createdDate,cre
atedBy,updated
Date,updatedBy
,healthMessage,
compliant,infra
TemplateDate,i
nfraTemplateId,
serverTemplate
Date,serverTem
N/A query string
66