Managers

ActionInfo 1.4.2⁠


Version	v1.4
Release	2023.2

Description⁠

The ActionInfo schema defines the supported parameters and other information for a Redfish action. Supported parameters can differ among vendors and even among resource instances. This data can ensure that action requests from applications contain supported parameters.

Properties⁠

Property	Type	Attributes	Notes
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
Parameters [ {	array		The list of parameters included in the specified Redfish action.
AllowableNumbers (v1.3+) [ ]	array (string, null)	read-only	The allowable numeric values or duration values, inclusive ranges of values, and incremental step values for this parameter as applied to this action target.
AllowablePattern (v1.3+)	string	read-only (null)	The allowable pattern for this parameter as applied to this action target.
AllowableValueDescriptions (v1.4+) [ ]	array (string, null)	read-only	Descriptions of allowable values for this parameter.
AllowableValues [ ]	array (string, null)	read-only	The allowable values for this parameter as applied to this action target.
ArraySizeMaximum (v1.2+)	integer	read-only (null)	The maximum number of array elements allowed for this parameter.
ArraySizeMinimum (v1.2+)	integer	read-only (null)	The minimum number of array elements required for this parameter.
DataType	string (enum)	read-only (null)	The JSON property type for this parameter. For the possible property values, see DataType in Property details.
MaximumValue (v1.1+)	number	read-only (null)	The maximum supported value for this parameter.
MinimumValue (v1.1+)	number	read-only (null)	The minimum supported value for this parameter.
Name	string	read-only required	The name of the parameter for this action.
ObjectDataType	string	read-only (null)	The data type of an object-based parameter.
Required	boolean	read-only	An indication of whether the parameter is required to complete this action.
} ]

Property details⁠

DataType⁠

The JSON property type for this parameter.

string	Description
Boolean	A boolean.
Number	A number.
NumberArray	An array of numbers.
Object	An embedded JSON object.
ObjectArray	An array of JSON objects.
String	A string.
StringArray	An array of strings.

Example response⁠

{
    "@odata.type": "#ActionInfo.v1_5_0.ActionInfo",
    "Id": "ResetActionInfo",
    "Name": "Reset Action Info",
    "Parameters": [
        {
            "Name": "ResetType",
            "Required": true,
            "DataType": "String",
            "AllowableValues": [
                "On",
                "ForceOff",
                "GracefulShutdown",
                "GracefulRestart",
                "ForceRestart",
                "Nmi",
                "ForceOn",
                "PushPowerButton"
            ]
        }
    ],
    "@odata.id": "/redfish/v1/Systems/1/ResetActionInfo"
}

EthernetInterface 1.12.4⁠


Version	v1.12
Release	2023.3

Description⁠

The EthernetInterface schema represents a single, logical Ethernet interface or network interface controller (NIC).

URIs⁠

/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/EthernetInterfaces/{EthernetInterfaceId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/EthernetInterfaces/{EthernetInterfaceId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/OperatingSystem/Containers/EthernetInterfaces/{EthernetInterfaceId}
/redfish/v1/Managers/{ManagerId}/EthernetInterfaces/{EthernetInterfaceId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/EthernetInterfaces/{EthernetInterfaceId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/OperatingSystem/Containers/EthernetInterfaces/{EthernetInterfaceId}
/redfish/v1/Systems/{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}
/redfish/v1/Systems/{ComputerSystemId}/OperatingSystem/Containers/EthernetInterfaces/{EthernetInterfaceId}

Properties⁠

Property	Type	Attributes	Notes
Actions (v1.3+) {}	object		The available actions for this resource.
AutoNeg	boolean	read-write (null)	An indication of whether the speed and duplex are automatically negotiated and configured on this interface.
DHCPv4 (v1.4+) {	object		DHCPv4 configuration for this interface.
DHCPEnabled (v1.4+)	boolean	read-write (null)	An indication of whether DHCP v4 is enabled on this Ethernet interface.
FallbackAddress (v1.5+)	string (enum)	read-write (null)	DHCPv4 fallback address method for this interface. For the possible property values, see FallbackAddress in Property details.
UseDNSServers (v1.4+)	boolean	read-write (null)	An indication of whether this interface uses DHCP v4-supplied DNS servers.
UseDomainName (v1.4+)	boolean	read-write (null)	An indication of whether this interface uses a DHCP v4-supplied domain name.
UseGateway (v1.4+)	boolean	read-write (null)	An indication of whether this interface uses a DHCP v4-supplied gateway.
UseNTPServers (v1.4+)	boolean	read-write (null)	An indication of whether the interface uses DHCP v4-supplied NTP servers.
UseStaticRoutes (v1.4+)	boolean	read-write (null)	An indication of whether the interface uses DHCP v4-supplied static routes.
}
DHCPv6 (v1.4+) {	object		DHCPv6 configuration for this interface.
OperatingMode (v1.4+)	string (enum)	read-write (null)	Determines the DHCPv6 operating mode for this interface. For the possible property values, see OperatingMode in Property details.
UseDNSServers (v1.4+)	boolean	read-write (null)	An indication of whether the interface uses DHCP v6-supplied DNS servers.
UseDomainName (v1.4+)	boolean	read-write (null)	An indication of whether this interface uses a DHCP v6-supplied domain name.
UseNTPServers (v1.4+)	boolean	read-write (null)	An indication of whether the interface uses DHCP v6-supplied NTP servers.
UseRapidCommit (v1.4+)	boolean	read-write (null)	An indication of whether the interface uses DHCP v6 rapid commit mode for stateful mode address assignments. Do not enable this option in networks where more than one DHCP v6 server is configured to provide address assignments.
}
EthernetInterfaceType (v1.6+)	string (enum)	read-only (null)	The type of interface. For the possible property values, see EthernetInterfaceType in Property details.
FQDN	string	read-write (null)	The complete, fully qualified domain name that DNS obtains for this interface.
FullDuplex	boolean	read-write (null)	An indication of whether full-duplex mode is enabled on the Ethernet connection for this interface.
HostName	string	read-write (null)	The DNS host name, without any domain information.
InterfaceEnabled	boolean	read-write (null)	An indication of whether this interface is enabled.
IPv4Addresses [ { } ]	array (object)		The IPv4 addresses currently in use by this interface. See the v1_1_5.v1_1_5 schema for details on this property.
IPv4StaticAddresses (v1.4+) [ { } ]	array (object)	(null)	The IPv4 static addresses assigned to this interface. See `IPv4Addresses` for the addresses in use by this interface. See the v1_1_5.v1_1_5 schema for details on this property.
IPv6Addresses [ { } ]	array (object)		The IPv6 addresses currently in use by this interface. See the v1_1_5.v1_1_5 schema for details on this property.
IPv6AddressPolicyTable [ {	array		An array that represents the RFC6724-defined address selection policy table.
Label	integer	read-write (null)	The IPv6 label, as defined in RFC6724, section 2.1.
Precedence	integer	read-write (null)	The IPv6 precedence, as defined in RFC6724, section 2.1.
Prefix	string	read-write (null)	The IPv6 address prefix, as defined in RFC6724, section 2.1.
} ]
IPv6DefaultGateway	string	read-only (null)	The IPv6 default gateway address in use on this interface.
IPv6Enabled (v1.12+)	boolean	read-write (null)	An indication of whether IPv6 is enabled on this interface.
IPv6StaticAddresses [ { } ]	array (object)	(null)	The IPv6 static addresses assigned to this interface. See `IPv6Addresses` for the addresses in use by this interface. See the v1_1_5.v1_1_5 schema for details on this property.
IPv6StaticDefaultGateways (v1.4+) [ { } ]	array (object)	(null)	The IPv6 static default gateways for this interface. See the v1_1_5.v1_1_5 schema for details on this property.
Links (v1.1+) {	object	required on create	The links to other resources that are related to this resource.
AffiliatedInterfaces (v1.10+) [ {	array		The links to the Ethernet interfaces that are affiliated with this interface, such as a VLAN or a team that uses this interface.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Chassis (v1.3+) {}	object		The link to the chassis that contains this Ethernet interface.
Endpoints (v1.1+) [ {	array		An array of links to the endpoints that connect to this Ethernet interface.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
HostInterface (v1.2+) {}	object		The link to a Host Interface that is associated with this Ethernet interface.
NetworkDeviceFunction (v1.6+, deprecated v1.7) {}	object	(null)	The link to the parent network device function and is only used when representing one of the VLANs on that network device function, such as is done in Unix. Deprecated in v1.7 and later. This property has been deprecated in favor of `NetworkDeviceFunctions` as each `EthernetInterface` could represent more than one `NetworkDeviceFunction`.
NetworkDeviceFunctions (v1.7+) [ {	array		The link to the network device functions that constitute this Ethernet interface.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
Ports (v1.9+) [ {	array		The links to the ports providing this Ethernet interface.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
RelatedInterfaces (v1.9+) [ {	array	required on create	The links to the Ethernet interfaces that constitute this Ethernet interface.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
}
LinkStatus (v1.1+)	string (enum)	read-only (null)	The link status of this interface, or port. For the possible property values, see LinkStatus in Property details.
MACAddress	string	read-write (null)	The currently configured MAC address of the interface, or logical port.
MaxIPv6StaticAddresses	integer	read-only (null)	The maximum number of static IPv6 addresses that can be configured on this interface.
MTUSize	integer	read-write (null)	The currently configured maximum transmission unit (MTU), in bytes, on this interface.
NameServers [ ]	array (string)	read-only	The DNS servers in use on this interface.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PermanentMACAddress	string	read-only (null)	The permanent MAC address assigned to this interface, or port.
RoutingScope (v1.11+)	string (enum)	read-only (null)	The routing scope for this interface. For the possible property values, see RoutingScope in Property details.
SpeedMbps	integer (Mbit/s)	read-write (null)	The current speed, in Mbit/s, of this interface.
StatelessAddressAutoConfig (v1.4+) {	object		Stateless address autoconfiguration (SLAAC) parameters for this interface.
IPv4AutoConfigEnabled (v1.4+)	boolean	read-write (null)	An indication of whether IPv4 stateless address autoconfiguration (SLAAC) is enabled for this interface.
IPv6AutoConfigEnabled (v1.4+)	boolean	read-write (null)	An indication of whether IPv6 stateless address autoconfiguration (SLAAC) is enabled for this interface.
}
StaticNameServers (v1.4+) [ ]	array (string, null)	read-write	The statically-defined set of DNS server IPv4 and IPv6 addresses.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
TeamMode (v1.9+)	string (enum)	read-write (null)	The team mode for this interface. For the possible property values, see TeamMode in Property details.
UefiDevicePath	string	read-only (null)	The UEFI device path for this interface.
VLAN {}	object		If this network interface supports more than one VLAN, this property is absent. VLAN collections appear in the `Links` property of this resource. See the VLanNetworkInterface.v1_3_1 schema for details on this property.
VLANs (deprecated v1.7) {}	object		The link to a collection of VLANs, which applies only if the interface supports more than one VLAN. If this property applies, the `VLANEnabled` and `VLANId` properties do not apply. Deprecated in v1.7 and later. This property has been deprecated in favor of newer methods indicating multiple VLANs.

Property details⁠

EthernetInterfaceType⁠

The type of interface.

string	Description
Physical	A physical Ethernet interface.
Virtual	A virtual Ethernet interface.

FallbackAddress⁠

DHCPv4 fallback address method for this interface.

string	Description
AutoConfig	Fall back to an autoconfigured address.
None	Continue attempting DHCP without a fallback address.
Static	Fall back to a static address specified by `IPv4StaticAddresses`.

idRef⁠


@odata.id	string (URI)	read-only	The unique identifier for a resource.

LinkStatus⁠

The link status of this interface, or port.

string	Description
LinkDown	No link is detected on this interface, but the interface is connected.
LinkUp	The link is available for communication on this interface.
NoLink	No link or connection is detected on this interface.

OperatingMode⁠

Determines the DHCPv6 operating mode for this interface.

string	Description
Disabled	DHCPv6 is disabled.
Enabled (v1.8+)	DHCPv6 is enabled.
Stateful (deprecated v1.8)	DHCPv6 stateful mode. Deprecated in v1.8 and later. This property has been deprecated in favor of `Enabled`. The control between 'stateful' and 'stateless' is managed by the DHCP server and not the client.
Stateless (deprecated v1.8)	DHCPv6 stateless mode. Deprecated in v1.8 and later. This property has been deprecated in favor of `Enabled`. The control between 'stateful' and 'stateless' is managed by the DHCP server and not the client.

RoutingScope⁠

The routing scope for this interface.

string	Description
External	Externally accessible.
HostOnly	Only accessible to a dedicated interface on the host.
Internal	Only accessible to internal networking on the host, such as when virtual machines or containers are allowed to communicate with each other on the same host system as well as a dedicated interface on the hosting system.
Limited	Accessible through IP translation provided by the hosting system.

TeamMode⁠

The team mode for this interface.

string	Description
ActiveBackup	One interface in the team is active and the others are kept in standby until a failure occurs.
AdaptiveLoadBalancing	Packets are transmitted and received based upon the current load of each interface in the team.
AdaptiveTransmitLoadBalancing	Packets are transmitted based upon the current load of each interface in the team.
Broadcast	Packets are transmitted on all interfaces in the team.
IEEE802_3ad	The interfaces in the team create an IEEE802.3ad link aggregation group.
None	No teaming.
RoundRobin	Packets are transmitted in sequential order from the teamed interfaces.
XOR	Transmitting is determined based upon a hash policy.

Example response⁠

{
    "@odata.type": "#EthernetInterface.v1_12_4.EthernetInterface",
    "Id": "1",
    "Name": "Ethernet Interface",
    "Description": "Manager NIC 1",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "LinkStatus": "LinkUp",
    "PermanentMACAddress": "12:44:6A:3B:04:11",
    "MACAddress": "12:44:6A:3B:04:11",
    "SpeedMbps": 1000,
    "AutoNeg": true,
    "FullDuplex": true,
    "MTUSize": 1500,
    "HostName": "web483",
    "FQDN": "web483.contoso.com",
    "NameServers": [
        "names.contoso.com"
    ],
    "IPv4Addresses": [
        {
            "Address": "192.168.0.10",
            "SubnetMask": "255.255.252.0",
            "AddressOrigin": "DHCP",
            "Gateway": "192.168.0.1"
        }
    ],
    "DHCPv4": {
        "DHCPEnabled": true,
        "UseDNSServers": true,
        "UseGateway": true,
        "UseNTPServers": false,
        "UseStaticRoutes": true,
        "UseDomainName": true
    },
    "DHCPv6": {
        "OperatingMode": "Enabled",
        "UseDNSServers": true,
        "UseDomainName": false,
        "UseNTPServers": false,
        "UseRapidCommit": false
    },
    "StatelessAddressAutoConfig": {
        "IPv4AutoConfigEnabled": false,
        "IPv6AutoConfigEnabled": true
    },
    "IPv4StaticAddresses": [
        {
            "Address": "192.168.88.130",
            "SubnetMask": "255.255.0.0",
            "Gateway": "192.168.0.1"
        }
    ],
    "IPv6AddressPolicyTable": [
        {
            "Prefix": "::1/128",
            "Precedence": 50,
            "Label": 0
        }
    ],
    "MaxIPv6StaticAddresses": 1,
    "IPv6StaticAddresses": [
        {
            "Address": "fc00:1234::a:b:c:d",
            "PrefixLength": 64
        }
    ],
    "IPv6StaticDefaultGateways": [
        {
            "Address": "fe80::fe15:b4ff:fe97:90cd",
            "PrefixLength": 64
        }
    ],
    "IPv6DefaultGateway": "fe80::214:c1ff:fe4c:5c4d",
    "IPv6Addresses": [
        {
            "Address": "fe80::1ec1:deff:fe6f:1e24",
            "PrefixLength": 64,
            "AddressOrigin": "SLAAC",
            "AddressState": "Preferred"
        },
        {
            "Address": "fc00:1234::a:b:c:d",
            "PrefixLength": 64,
            "AddressOrigin": "Static",
            "AddressState": "Preferred"
        },
        {
            "Address": "2001:1:3:5::100",
            "PrefixLength": 64,
            "AddressOrigin": "DHCPv6",
            "AddressState": "Preferred"
        },
        {
            "Address": "2002:2:5::1ec1:deff:fe6f:1e24",
            "PrefixLength": 64,
            "AddressOrigin": "SLAAC",
            "AddressState": "Preferred"
        }
    ],
    "StaticNameServers": [
        "192.168.150.1",
        "fc00:1234:200:2500"
    ],
    "VLAN": {
        "VLANEnable": true,
        "VLANId": 101
    },
    "@odata.id": "/redfish/v1/Systems/437XR1138R2/EthernetInterfaces/12446A3B0411"
}

Manager 1.22.0⁠


Version	v1.22
Release	2025.2

Description⁠

In Redfish, a manager is a systems management entity that can implement or provide access to a Redfish service. Examples of managers are BMCs (baseboard management controllers), enclosure managers, management controllers, and other subsystems that are assigned manageability functions. An implementation can have multiple managers, which might be directly accessible through a Redfish-defined interface.

URIs⁠

/redfish/v1/Managers/{ManagerId}

Properties⁠

Property	Type	Attributes	Notes
Actions {	object		The available actions for this resource.
#Manager.ForceFailover {}	object		The `ForceFailover` action forces a failover of this manager to the manager used in the parameter. For more information, see the Actions section below.
#Manager.ModifyRedundancySet {}	object		The `ModifyRedundancySet` operation adds members to or removes members from a redundant group of managers. For more information, see the Actions section below.
#Manager.Reset {}	object		The reset action resets/reboots the manager. For more information, see the Actions section below.
#Manager.ResetToDefaults (v1.8+) {}	object		The reset action resets the manager settings to factory defaults. This can cause the manager to reset. For more information, see the Actions section below.
#Manager.UpdateSecurityMode (v1.21+) {}	object		The update security mode action updates the security mode for the manager. This can cause the manager to reset and reset other settings to factory defaults. Services might require the `ResetToDefaults` action to clear the security mode. For more information, see the Actions section below.
}
AdditionalFirmwareVersions (v1.15+) {}	object		The additional firmware versions of the manager. See the SoftwareInventory.v1_13_0 schema for details on this property.
AutoDSTEnabled (v1.4+)	boolean	read-write	An indication of whether the manager is configured for automatic Daylight Saving Time (DST) adjustment.
Certificates (v1.13+) {}	object		The link to a collection of certificates for device identity and attestation.
CommandShell {	object		The manager's command line user interface or command shell service.
ConnectTypesSupported [ ]	array (string (enum))	read-only	This property enumerates the command shell connection types that the implementation allows. For the possible property values, see ConnectTypesSupported in Property details.
MaxConcurrentSessions	integer	read-only	The maximum number of service sessions, regardless of protocol, that this manager can support.
ServiceEnabled	boolean	read-write	An indication of whether the service is enabled for this manager.
}
DateTime	string (date-time)	read-write (null)	The current date and time with UTC offset of the manager.
DateTimeLocalOffset	string	read-write (null)	The time offset from UTC that the `DateTime` property is in `+HH:MM` format.
DateTimeSource (v1.20+)	string (enum)	read-write (null)	The source of the date and time of this manager, such as NTP, RTC, or firmware. For the possible property values, see DateTimeSource in Property details.
DaylightSavingTime (v1.19+) {	object		The daylight saving time settings for this manager.
EndDateTime (v1.19+)	string (date-time)	read-write	The end date and time with UTC offset of daylight saving time.
OffsetMinutes (v1.19+)	integer	read-write	The daylight saving time offset in minutes.
StartDateTime (v1.19+)	string (date-time)	read-write	The start date and time with UTC offset of daylight saving time.
TimeZoneName (v1.19+)	string	read-write	The time zone of the manager when daylight saving time is in effect.
}
DedicatedNetworkPorts (v1.16+) {}	object		The dedicated network ports of the manager.
EthernetInterfaces {}	object		The link to a collection of NICs that this manager uses for network communication.
FirmwareVersion	string	read-only (null)	The firmware version of this manager.
GraphicalConsole {	object		The manager's graphical console service.
ConnectTypesSupported [ ]	array (string (enum))	read-only	This property enumerates the graphical console connection types that the implementation allows. For the possible property values, see ConnectTypesSupported in Property details.
MaxConcurrentSessions	integer	read-only	The maximum number of service sessions, regardless of protocol, that this manager can support.
ServiceEnabled	boolean	read-write	An indication of whether the service is enabled for this manager.
}
HostInterfaces (v1.3+) {}	object		The link to a collection of host interfaces that this manager uses for local host communication. Clients can find host interface configuration options and settings in this navigation property.
LastResetTime (v1.9+)	string (date-time)	read-only	The date and time when the manager was last reset or rebooted.
Links {	object		The links to other resources that are related to this resource.
ActiveSoftwareImage (v1.6+) {}	object		The link to the software inventory resource that represents the active firmware image for this manager.
ManagedBy (v1.9+) [ {	array		The array of links to the managers responsible for managing this manager.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
ManagerForChassis [ {	array		An array of links to the chassis this manager controls.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
ManagerForFabrics (v1.22+) [ {	array		An array of links to the fabrics that this manager controls.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
ManagerForManagers (v1.9+) [ {	array		An array of links to the managers that are managed by this manager.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
ManagerForServers [ {	array		An array of links to the systems that this manager controls.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
ManagerForSwitches (v1.4+) [ {	array		An array of links to the switches that this manager controls.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
ManagerInChassis (v1.1+) {}	object		The link to the chassis where this manager is located.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
SelectedNetworkPort (v1.18+) {}	object	(null)	The network port currently used by this manager. This allows selection of shared or dedicated ports for managers that support one or the other. For managers that always have their dedicated port enabled, this allows the selection of which shared port to use.
SoftwareImages (v1.6+) [ {	array		The images that are associated with this manager.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
}
Location (v1.11+) {}	object		The location of the manager. See the v1_23_0.v1_23_0 schema for details on this property.
LocationIndicatorActive (v1.11+)	boolean	read-write (null)	An indicator allowing an operator to physically locate this resource.
LogServices {}	object		The link to a collection of logs that the manager uses.
ManagerDiagnosticData (v1.14+) {}	object	(null)	The diagnostic data for this manager.
ManagerType	string (enum)	read-only	The type of manager that this resource represents. For the possible property values, see ManagerType in Property details.
Manufacturer (v1.7+)	string	read-only (null)	The manufacturer of this manager.
Measurements (v1.13+, deprecated v1.14) [ { } ]	array (object)		An array of DSP0274-defined measurement blocks. See the SoftwareInventory.v1_13_0 schema for details on this property. Deprecated in v1.14 and later. This property has been deprecated in favor of the `ComponentIntegrity` resource.
Model	string	read-only (null)	The model information of this manager, as defined by the manufacturer.
NetworkProtocol {}	object		The link to the network services and their settings that the manager controls.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
OEMSecurityMode (v1.21+)	string	read-only (null)	The OEM-specific security compliance mode(s) that the manager is currently configured to enforce.
PartNumber (v1.7+)	string	read-only (null)	The part number of the manager.
PowerState (v1.2+)	string (enum)	read-only (null)	The current power state of the manager. For the possible property values, see PowerState in Property details.
Redundancy [ {	array		The redundancy information for the managers of this system.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
RemoteAccountService (v1.5+) {}	object		The link to the account service resource for the remote manager that this resource represents.
RemoteRedfishServiceUri (v1.5+)	string (URI)	read-only (null)	The URI of the Redfish service root for the remote manager that this resource represents.
SecurityMode (v1.21+)	string (enum)	read-only	The security compliance mode that the manager is currently configured to enforce. For the possible property values, see SecurityMode in Property details.
SecurityPolicy (v1.16+) {}	object	(null)	The security policy settings for this manager.
SerialConsole (deprecated v1.10) {	object		The serial console service that this manager provides. Deprecated in v1.10 and later. This property has been deprecated in favor of the `SerialConsole` property in the `ComputerSystem` resource.
ConnectTypesSupported [ ]	array (string (enum))	read-only	This property enumerates the serial console connection types that the implementation allows. For the possible property values, see ConnectTypesSupported in Property details.
MaxConcurrentSessions	integer	read-only	The maximum number of service sessions, regardless of protocol, that this manager can support.
ServiceEnabled	boolean	read-write	An indication of whether the service is enabled for this manager.
}
SerialInterfaces {}	object		The link to a collection of serial interfaces that this manager uses for serial and console communication.
SerialNumber (v1.7+)	string	read-only (null)	The serial number of the manager.
ServiceEntryPointUUID	string (uuid)	read-only (null)	The UUID of the Redfish service that is hosted by this manager.
ServiceIdentification (v1.15+)	string	read-write (null)	A product instance identifier displayed in the Redfish service root.
SharedNetworkPorts (v1.16+) {}	object		The shared network ports of the manager.
SparePartNumber (v1.11+)	string	read-only (null)	The spare part number of the manager.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
TimeZoneName (v1.10+)	string	read-write	The time zone of the manager.
USBPorts (v1.12+) {}	object		The USB ports of the manager.
UUID	string (uuid)	read-only (null)	The UUID for this manager.
Version (v1.17+)	string	read-only (null)	The hardware version of this manager.
VirtualMedia (deprecated v1.10) {}	object		The link to the virtual media services for this particular manager. Deprecated in v1.10 and later. This property has been deprecated in favor of the `VirtualMedia` property in the `ComputerSystem` resource.

Actions⁠

ForceFailover⁠

Description

The ForceFailover action forces a failover of this manager to the manager used in the parameter.

Action URI

{Base URI of target resource}/Actions/Manager.ForceFailover

Action parameters

Parameter Name	Type	Attributes	Notes
NewManager {}	object	required	The manager to which to fail over.

Request Example

{
    "NewManager": [
        {
            "@odata.id": "/redfish/v1/Managers/3"
        }
    ]
}

ModifyRedundancySet⁠

Description

The ModifyRedundancySet operation adds members to or removes members from a redundant group of managers.

Action URI

{Base URI of target resource}/Actions/Manager.ModifyRedundancySet

Action parameters

Parameter Name	Type	Attributes	Notes
Add [ {	array	optional	An array of managers to add to the redundancy set.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
Remove [ {	array	optional	An array of managers to remove from the redundancy set.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]

Request Example

{
    "Add": [
        {
            "@odata.id": "/redfish/v1/Managers/4"
        }
    ]
}

Reset⁠

Description

The reset action resets/reboots the manager.

Action URI

{Base URI of target resource}/Actions/Manager.Reset

Action parameters

Parameter Name	Type	Attributes	Notes
ResetType	string (enum)	optional	The type of reset. For the possible property values, see ResetType in Property details.

Request Example

{
    "ResetType": "ForceRestart"
}

ResetToDefaults (v1.8+)⁠

Description

The reset action resets the manager settings to factory defaults. This can cause the manager to reset.

Action URI

{Base URI of target resource}/Actions/Manager.ResetToDefaults

Action parameters

Parameter Name	Type	Attributes	Notes
ResetType	string (enum)	required	The type of reset to defaults. For the possible property values, see ResetType in Property details.

Request Example

{
    "ResetType": "PreserveNetworkAndUsers"
}

UpdateSecurityMode (v1.21+)⁠

Description

The update security mode action updates the security mode for the manager. This can cause the manager to reset and reset other settings to factory defaults. Services might require the ResetToDefaults action to clear the security mode.

Action URI

{Base URI of target resource}/Actions/Manager.UpdateSecurityMode

Action parameters

Parameter Name	Type	Attributes	Notes
OEMSecurityMode	string	optional	The OEM-specific security mode to apply to the manager.
SecurityMode	string (enum)	required	The security mode to apply to the manager. For the possible property values, see SecurityMode in Property details.

Request Example

{
    "SecurityMode": "CNSA_1_0"
}

Property details⁠

ConnectTypesSupported⁠

In CommandShell:⁠

This property enumerates the command shell connection types that the implementation allows.

string	Description
IPMI	The controller supports a command shell connection through the IPMI Serial Over LAN (SOL) protocol.
Oem	The controller supports a command shell connection through an OEM-specific protocol.
SSH	The controller supports a command shell connection through the SSH protocol.
Telnet	The controller supports a command shell connection through the Telnet protocol.

In GraphicalConsole:⁠

This property enumerates the graphical console connection types that the implementation allows.

string	Description
KVMIP	The controller supports a graphical console connection through a KVM-IP (redirection of Keyboard, Video, Mouse over IP) protocol.
Oem	The controller supports a graphical console connection through an OEM-specific protocol.

In SerialConsole:⁠

This property enumerates the serial console connection types that the implementation allows.

string	Description
IPMI	The controller supports a serial console connection through the IPMI Serial Over LAN (SOL) protocol.
Oem	The controller supports a serial console connection through an OEM-specific protocol.
SSH	The controller supports a serial console connection through the SSH protocol.
Telnet	The controller supports a serial console connection through the Telnet protocol.

DateTimeSource⁠

The source of the date and time of this manager, such as NTP, RTC, or firmware.

string	Description
Firmware	The date and time is set and held by firmware.
Host	The date and time is retrieved from the host.
NTP	The date and time source is a Network Time Protocol (NTP) server.
PTP	The date and time source is a Precision Time Protocol (PTP) server.
RTC	The date and time is retrieved from the manager's real time clock (RTC).

idRef⁠


@odata.id	string (URI)	read-only	The unique identifier for a resource.

ManagerType⁠

The type of manager that this resource represents.

string	Description
AuxiliaryController	A controller that provides management functions for a particular subsystem or group of devices as part of a larger system.
BMC	A controller that provides management functions for one or more computer systems. Commonly known as a BMC (baseboard management controller). Examples of this include a BMC dedicated to one system or a multi-host manager providing BMC capabilities to multiple systems.
EnclosureManager	A controller that provides management functions for a chassis, group of devices, or group of systems with their own BMCs (baseboard management controllers). An example of this is a manager that aggregates and orchestrates management functions across multiple BMCs in an enclosure.
FabricManager (v1.22+)	A controller that primarily monitors or manages the operation of a group of fabric attached nodes and switches.
ManagementController	A controller that primarily monitors or manages the operation of a device or system.
RackManager	A controller that provides management functions for a whole or part of a rack. An example of this is a manager that aggregates and orchestrates management functions across multiple managers, such as enclosure managers and BMCs (baseboard management controllers), in a rack.
Service (v1.4+)	A software-based service that provides management functions.

PowerState⁠

The current power state of the manager.

string	Description
Off	The resource is powered off. The components within the resource might continue to have AUX power.
On	The resource is powered on.
Paused	The resource is paused.
PoweringOff	A temporary state between on and off. The components within the resource can take time to process the power off action.
PoweringOn	A temporary state between off and on. The components within the resource can take time to process the power on action.

ResetType⁠

In Actions: Reset:⁠

The type of reset.

string	Description
ForceOff	Turn off the unit immediately (non-graceful shutdown).
ForceOn	Turn on the unit immediately.
ForceRestart	Shut down immediately and non-gracefully and restart the unit.
FullPowerCycle	Full power cycle the unit immediately (non-graceful). Behaves like removing utility lines, followed by restoring utility lines to the resource.
GracefulRestart	Shut down gracefully and restart the unit.
GracefulShutdown	Shut down gracefully and power off.
Nmi	Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system.
On	Turn on the unit.
Pause	Pause execution on the unit but do not remove power. This is typically a feature of virtual machine hypervisors.
PowerCycle	Power cycle the unit immediately (non-graceful). Behaves like a power removal, followed by a power restore to the resource.
PushPowerButton	Simulate the pressing of the physical power button on this unit.
Resume	Resume execution on the paused unit. This is typically a feature of virtual machine hypervisors.
Suspend	Write the state of the unit to disk before powering off. This allows for the state to be restored when powered back on.

In Actions: ResetToDefaults:⁠

The type of reset to defaults.

string	Description
PreserveNetwork	Reset all settings except network settings to factory defaults.
PreserveNetworkAndUsers	Reset all settings except network and local usernames/passwords to factory defaults.
ResetAll	Reset all settings to factory defaults.

SecurityMode⁠

The security mode to apply to the manager.

string	Description
CNSA_1_0	This security mode indicates the implementation meets NSA Commercial National Security Algorithm Suite 1.0 requirements. This mode requires FIPS 140-2 compliance.
CNSA_2_0	This security mode indicates the implementation meets NSA Commercial National Security Algorithm Suite 2.0 requirements. This mode requires FIPS 140-3 compliance.
Default	This security mode indicates the implementation is in a vendor-specific default security state that does not match any other value.
FIPS_140_2	This security mode indicates the implementation complies with FIPS 140-2.
FIPS_140_3	This security mode indicates the implementation complies with FIPS 140-3.
OEM	This security mode indicates the implementation is in an OEM-specific security state.
SuiteB	This security mode indicates the implementation meets NSA Suite B cryptographic standards for Top Secret installations. This mode requires FIPS 140-2 compliance.

Example response⁠

{
    "@odata.type": "#Manager.v1_24_0.Manager",
    "Id": "BMC",
    "Name": "Manager",
    "ManagerType": "BMC",
    "Description": "Contoso BMC",
    "ServiceEntryPointUUID": "92384634-2938-2342-8820-489239905423",
    "UUID": "58893887-8974-2487-2389-841168418919",
    "Model": "Joo Janta 200",
    "FirmwareVersion": "4.4.6521",
    "DateTime": "2015-03-13T04:14:33+06:00",
    "DateTimeLocalOffset": "+06:00",
    "DateTimeSource": "NTP",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "PowerState": "On",
    "GraphicalConsole": {
        "ServiceEnabled": true,
        "MaxConcurrentSessions": 2,
        "ConnectTypesSupported": [
            "KVMIP"
        ]
    },
    "CommandShell": {
        "ServiceEnabled": true,
        "MaxConcurrentSessions": 4,
        "ConnectTypesSupported": [
            "Telnet",
            "SSH"
        ]
    },
    "HostInterfaces": {
        "@odata.id": "/redfish/v1/Managers/9/HostInterfaces"
    },
    "NetworkProtocol": {
        "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol"
    },
    "EthernetInterfaces": {
        "@odata.id": "/redfish/v1/Managers/BMC/NICs"
    },
    "SerialInterfaces": {
        "@odata.id": "/redfish/v1/Managers/BMC/SerialInterfaces"
    },
    "LogServices": {
        "@odata.id": "/redfish/v1/Managers/BMC/LogServices"
    },
    "VirtualMedia": {
        "@odata.id": "/redfish/v1/Systems/437XR1138R2/VirtualMedia"
    },
    "Links": {
        "ManagerForServers": [
            {
                "@odata.id": "/redfish/v1/Systems/437XR1138R2"
            }
        ],
        "ManagerForChassis": [
            {
                "@odata.id": "/redfish/v1/Chassis/1U"
            }
        ],
        "ManagerInChassis": {
            "@odata.id": "/redfish/v1/Chassis/1U"
        }
    },
    "Actions": {
        "#Manager.Reset": {
            "target": "/redfish/v1/Managers/BMC/Actions/Manager.Reset",
            "ResetType@Redfish.AllowableValues": [
                "ForceRestart",
                "GracefulRestart"
            ]
        }
    },
    "@odata.id": "/redfish/v1/Managers/BMC"
}

ActionInfo 1.4.2⁠​

Description⁠​

Properties⁠​

Property details⁠​

DataType⁠​

Example response⁠​

EthernetInterface 1.12.4⁠​

Description⁠​

URIs⁠​

Properties⁠​

Property details⁠​

EthernetInterfaceType⁠​

FallbackAddress⁠​

idRef⁠​

LinkStatus⁠​

OperatingMode⁠​

RoutingScope⁠​

TeamMode⁠​

Example response⁠​

Manager 1.22.0⁠​

Description⁠​

URIs⁠​

Properties⁠​

Actions⁠​

ForceFailover⁠​

ModifyRedundancySet⁠​

Reset⁠​

ResetToDefaults (v1.8+)⁠​

UpdateSecurityMode (v1.21+)⁠​

Property details⁠​

ConnectTypesSupported⁠​

In CommandShell:⁠​

In GraphicalConsole:⁠​

In SerialConsole:⁠​

DateTimeSource⁠​

idRef⁠​

ManagerType⁠​

PowerState⁠​

ResetType⁠​

In Actions: Reset:⁠​

In Actions: ResetToDefaults:⁠​

SecurityMode⁠​

Example response⁠​

ActionInfo 1.4.2⁠

Description⁠

Properties⁠

Property details⁠

DataType⁠

Example response⁠

EthernetInterface 1.12.4⁠

Description⁠

URIs⁠

Properties⁠

Property details⁠

EthernetInterfaceType⁠

FallbackAddress⁠

idRef⁠

LinkStatus⁠

OperatingMode⁠

RoutingScope⁠

TeamMode⁠

Example response⁠

Manager 1.22.0⁠

Description⁠

URIs⁠

Properties⁠

Actions⁠

ForceFailover⁠

ModifyRedundancySet⁠

Reset⁠

ResetToDefaults (v1.8+)⁠

UpdateSecurityMode (v1.21+)⁠

Property details⁠

ConnectTypesSupported⁠

In CommandShell:⁠

In GraphicalConsole:⁠

In SerialConsole:⁠

DateTimeSource⁠

idRef⁠

ManagerType⁠

PowerState⁠

ResetType⁠

In Actions: Reset:⁠

In Actions: ResetToDefaults:⁠

SecurityMode⁠

Example response⁠