GET – Manager Instance
Request
This is the schema definition for a Manager.
Examples of managers are BMCs, Enclosure Managers, Management Controllers and other subsystems assigned manageability functions.
GET https://{{ip}}/redfish/v1/Managers/{{manager_instance}}
Content-Type: application/json
Response
The response is a JSON object that contains the following parameters:
Name | Type | Read only | Description | ||||
| (OData Attributes) | Refer to OData Support | ||||||
Oem | Object | AMI Manager OEM Properties | |||||
| Name | Type | Read only | Description | ||||
@odata.type | String | True | Refer to OData Support | ||||
| VirtualMedia | Object | True | Refer to Managers Self OEM Properties. | ||||
| ManagerBootConfiguration | Object | False | |||||
| ManagerServiceInfo | Object | True | |||||
Id(M) | String | True | Refer to Resource Type Definitions | ||||
Name(M) | String | True | |||||
Description | String | True | |||||
ManagerType | String | True | An enumeration property that represents the type of manager that this resource represents. | ||||
Enum | Description | ||||||
BMC | A controller which provides management functions for a single computer system. | ||||||
Links | Object | True | Refer to Link Properties. | ||||
ServiceEntryPointUUID | String | True | The UUID of the Redfish Service provided by this manager. Refer to Resource Type Definitions | ||||
UUID | String | True | The Universal Unique Identifier (UUID) for this Manager. Refer to Resource Type Definitions | ||||
Model | String | True | Model number of this manager as defined by the manufacturer. | ||||
DateTime | String | False | The current DateTime (with offset) for the manager, used to set or read time. Note
| ||||
DateTimeLocalOffset | String | False | The time offset from UTC that the DateTime property is set to in format: +06:00. Note The valid range is -12:00 to +14:00. Please refer the following link for the allowable values within the above specified range. | ||||
FirmwareVersion | String | True | The firmware version of this Manager. | ||||
SerialConsole | Object | Information about the Serial Console service provided by this manager. | |||||
CommandShell | Object | Information about the Command Shell service provided by this manager. | |||||
GraphicalConsole | Object | The information about the Graphical Console (KVM-IP) service of this manager. | |||||
Actions | Object | True | Managers allows the user to perform Actions like Reset. It can also contain an Oem Object under this Actions if any. | ||||
Status | Object | True | Refer toResource Properties for Resource Oem. | ||||
EthernetInterfaces(N) | Object | True | A reference to a collection of NICs that this manager uses for network communication. It is here that clients will find NIC configuration options and settings. | ||||
SerialInterfaces(N) | Object | True | A reference to a collection of serial interfaces that this manager uses for serial and console communication. It is here that clients will find serial configuration options and settings. | ||||
NetworkProtocol(N) | Object | True | A reference to the network services and their settings that the manager controls. It is here that clients will find network configuration options as well as network services. | ||||
LogServices(N) | Object | True | A reference to a collection of Logs used by the manager. | ||||
VirtualMedia(N) | Object | True | A reference to the Virtual Media services for this particular manager. Note Link will be present only when Virtual Media is enabled in the Manager, BMC in this case. | ||||
Redundancy(N)(C) | Array | True | Redundancy information for the managers of this system. Note platform-specific porting needed. | ||||
Redundancy@odata.count | Number | True | An integer representing the number of items in a collection. | ||||
HostInterfaces(N) | This is a reference to a collection of Host Interfaces that this manager uses for local host communication. It is here that clients will find Host Interface configuration options and settings. | ||||||
AutoDSTEnabled | Boolean | True | The value of this property shall contain the enabled status of the automatic Daylight-Saving Time (DST) adjustment of the manager's DateTime. It shall be true if Automatic DST adjustment is enabled and false if disabled. Note platform-specific porting needed. | ||||
PowerState | String | True | The value of this property shall contain the power state of the Manager. | ||||
| VirtualMedia | ||||||
Name | Type | Read Only | Description | |||
CDInstances | Number | True | Specifies the number of CD instances allowed for redirection. | |||
RMediaStatus | String | True | Specifies the current status of RMedia settings. | |||
ManagerBootConfiguration | ||||||
Name | Type | Read Only | Description | |||
| ManagerBootMode | Array | False | This property shall specify the Enum supported by ManagerBootMode. | |||
Enum | Description | |||||
| SoftReset | Added SoftReset in Boot Option | |||||
| ResetTimeout | ResetTimeout support is Boot Option | |||||
| ManagerServiceInfo | ||||||
Name | Type | Read Only | Description | |||
| CommandShellServiceInfo | Object | True | The property contains objects related to CommandShell service. | |||
Name | Type | Read only | Description | |||
IPMI | Object | True | The property contains an object that contains property MaxConcurrenceSession of protocol IPMI. | |||
SSH | Object | True | The property contains an object that contains property MaxConcurrenceSession of protocol SSH. Note This property will not be displayed in the response if the value from back-end is not applicable. | |||
| Links | Object | True | The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource. | |||
Name | Type | Read only | Description | |||
NetworkProtocol | Object | True | The property contains an URI related to NetworkProtocol resource, “/redfish/v1/Managers/Self/NetworkProtocol” | |||
Name | Type | Read Only | Description |
ManagerForServers(N) | Array | True | An array of references to the systems that this manager has control over. Note platform-specific porting needed. |
ManagerForServers@odata.count | Number | True | An integer representing the number of items in a collection. |
ManagerForSwitches(N) | Array | True | An array of references to the switches that this manager has control over. Note platform-specific porting needed. |
ManagerForSwitches@odata.count | Number | True | An integer representing the number of items in a collection. |
ManagerForChassis@odata.count | Number | True | An integer representing the number of items in a collection. |
ManagerForChassis(N) | Array | True | An array of references to the chassis that this manager hascontrol over. Note platform-specific porting needed. |
ManagerInChassis(N) | Array | True | This property shall contain a reference to the chassis where this manager is located. |
| ActiveSoftwareImage(N) | Array | True | This property shall contain a link to the SoftwareInventory resource that represent the active firmware image for this manager. Note platform-specific porting needed. |
| ActiveSoftwareImage@odata.count | Number | True | An integer representing the number of items in a collection. |
| SoftwareImages(N) | Array | True | This property shall contain an array of links to the SoftwareInventory resources that represent the firmware images that apply to this manager. Note platform-specific porting needed. |
| SoftwareImages@odata.count | Number | True | An integer representing the number of items in a collection. |
Name | Type | Read only | Description | |
ServiceEnabled | Boolean | False | Indicates if the service is enabled for this manager. Note
| |
MaxConcurrentSessions | String | True | Indicates the maximum number of concurrent services sessions supported by the implementation regardless of protocol. Minimum Value:0. Note platform-specific porting needed. | |
ConnectTypesSupported | Array | True | The value of ConnectTypesSupported shall be an array of the enumerations provided here. | |
Enum | Description | |||
Telnet(Not Supported) | The controller supports a Serial Console connection using the Telnet protocol. | |||
IPMI | The controller supports a Serial Console connection using the IPMI Serial-over-LAN (SOL) protocol. | |||
Oem(Not Supported) | The controller supports a Serial Console connection using an OEM-specific protocol. | |||
Name | Type | Read only | Description | |
ServiceEnabled | Boolean | False | Indicates if the service is enabled for this manager. Note This property will be true if any one of the protocols is enabled in the ConnectTypesSupported. If IPMI is present in ConnectTypesSupported then CommandShell cannot be disabled. If IPMI is not present, then this property will be true if any one of the services in the ConnectTypesSupported is Enabled. If this property is patched to true, then all the other services in ConnectTypesSupported will be enabled. | |
MaxConcurrentSessions | String | True | Indicates the maximum number of concurrent services sessions supported by the implementation regardless of protocol. Minimum Value:0. Note
| |
| ConnectTypesSupported | Array | True | The value of ConnectTypesSupported shall be an array of the enumerations provided here. | |
Enum | Description | |||
SSH | The controller supports a CommandShell connection using the SSH protocol. Note There is no limit for SSH sessions and maximum session is not applicable. | |||
Telnet(Not Supported) | The controller supports a CommandShell connection using the Telnet protocol. | |||
IPMI | The controller supports a CommandShell connection using the IPMI protocol. | |||
Oem(Not Supported) | The controller supports a CommandShell connection using an OEM-specific protocol. | |||
Name | Type | Read only | Description | |
ServiceEnabled | Boolean | False | Indicates if the service is enabled for this manager. | |
MaxConcurrentSessions | String | True | Indicates the maximum number of concurrent services sessions supported by the implementation regardless of protocol. Minimum Value:0. | |
ConnectTypesSupported | Array | True | This object is used to enumerate the Graphical Console connection types allowed by the implementation. | |
Enum | Description | |||
KVMIP | The controller supports a Graphical Console connection using a KVM-IP (redirection of Keyboard, Video, Mouse over IP) protocol. | |||
Oem(Not Supported) | The controller supports a Graphical Console connection using an OEM-specific protocol. | |||