Перейти к основному содержимому

Managers

ActionInfo 1.4.2

 
Versionv1.4
Release2023.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

PropertyTypeAttributesNotes
Oem {}objectThe OEM extension property. See the Resource schema for details on this property.
Parameters [ {arrayThe list of parameters included in the specified Redfish action.
      AllowableNumbers (v1.3+) [ ]array (string, null)read-onlyThe 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+)stringread-only
(null)
The allowable pattern for this parameter as applied to this action target.
      AllowableValueDescriptions (v1.4+) [ ]array (string, null)read-onlyDescriptions of allowable values for this parameter.
      AllowableValues [ ]array (string, null)read-onlyThe allowable values for this parameter as applied to this action target.
      ArraySizeMaximum (v1.2+)integerread-only
(null)
The maximum number of array elements allowed for this parameter.
      ArraySizeMinimum (v1.2+)integerread-only
(null)
The minimum number of array elements required for this parameter.
      DataTypestring
(enum)
read-only
(null)
The JSON property type for this parameter. For the possible property values, see DataType in Property details.
      MaximumValue (v1.1+)numberread-only
(null)
The maximum supported value for this parameter.
      MinimumValue (v1.1+)numberread-only
(null)
The minimum supported value for this parameter.
      Namestringread-only requiredThe name of the parameter for this action.
      ObjectDataTypestringread-only
(null)
The data type of an object-based parameter.
      Requiredbooleanread-onlyAn indication of whether the parameter is required to complete this action.
} ]

Property details

DataType

 

The JSON property type for this parameter.

stringDescription
BooleanA boolean.
NumberA number.
NumberArrayAn array of numbers.
ObjectAn embedded JSON object.
ObjectArrayAn array of JSON objects.
StringA string.
StringArrayAn 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

 
Versionv1.12
Release2023.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

PropertyTypeAttributesNotes
Actions (v1.3+) {}objectThe available actions for this resource.
AutoNegbooleanread-write
(null)
An indication of whether the speed and duplex are automatically negotiated and configured on this interface.
DHCPv4 (v1.4+) {objectDHCPv4 configuration for this interface.
      DHCPEnabled (v1.4+)booleanread-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+)booleanread-write
(null)
An indication of whether this interface uses DHCP v4-supplied DNS servers.
      UseDomainName (v1.4+)booleanread-write
(null)
An indication of whether this interface uses a DHCP v4-supplied domain name.
      UseGateway (v1.4+)booleanread-write
(null)
An indication of whether this interface uses a DHCP v4-supplied gateway.
      UseNTPServers (v1.4+)booleanread-write
(null)
An indication of whether the interface uses DHCP v4-supplied NTP servers.
      UseStaticRoutes (v1.4+)booleanread-write
(null)
An indication of whether the interface uses DHCP v4-supplied static routes.
}
DHCPv6 (v1.4+) {objectDHCPv6 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+)booleanread-write
(null)
An indication of whether the interface uses DHCP v6-supplied DNS servers.
      UseDomainName (v1.4+)booleanread-write
(null)
An indication of whether this interface uses a DHCP v6-supplied domain name.
      UseNTPServers (v1.4+)booleanread-write
(null)
An indication of whether the interface uses DHCP v6-supplied NTP servers.
      UseRapidCommit (v1.4+)booleanread-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.
FQDNstringread-write
(null)
The complete, fully qualified domain name that DNS obtains for this interface.
FullDuplexbooleanread-write
(null)
An indication of whether full-duplex mode is enabled on the Ethernet connection for this interface.
HostNamestringread-write
(null)
The DNS host name, without any domain information.
InterfaceEnabledbooleanread-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 [ {arrayAn array that represents the RFC6724-defined address selection policy table.
      Labelintegerread-write
(null)
The IPv6 label, as defined in RFC6724, section 2.1.
      Precedenceintegerread-write
(null)
The IPv6 precedence, as defined in RFC6724, section 2.1.
      Prefixstringread-write
(null)
The IPv6 address prefix, as defined in RFC6724, section 2.1.
} ]
IPv6DefaultGatewaystringread-only
(null)
The IPv6 default gateway address in use on this interface.
IPv6Enabled (v1.12+)booleanread-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+) {objectrequired on createThe links to other resources that are related to this resource.
      AffiliatedInterfaces (v1.10+) [ {arrayThe links to the Ethernet interfaces that are affiliated with this interface, such as a VLAN or a team that uses this interface.
            @odata.idstring
(URI)
read-onlyThe unique identifier for a resource.
      } ]
      Chassis (v1.3+) {}objectThe link to the chassis that contains this Ethernet interface.
      Endpoints (v1.1+) [ {arrayAn array of links to the endpoints that connect to this Ethernet interface.
            @odata.idstring
(URI)
read-onlyThe unique identifier for a resource.
      } ]
      HostInterface (v1.2+) {}objectThe 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+) [ {arrayThe link to the network device functions that constitute this Ethernet interface.
            @odata.idstring
(URI)
read-onlyThe unique identifier for a resource.
      } ]
      Oem {}objectThe OEM extension property. See the Resource schema for details on this property.
      Ports (v1.9+) [ {arrayThe links to the ports providing this Ethernet interface.
            @odata.idstring
(URI)
read-onlyThe unique identifier for a resource.
      } ]
      RelatedInterfaces (v1.9+) [ {arrayrequired on createThe links to the Ethernet interfaces that constitute this Ethernet interface.
            @odata.idstring
(URI)
read-onlyThe 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.
MACAddressstringread-write
(null)
The currently configured MAC address of the interface, or logical port.
MaxIPv6StaticAddressesintegerread-only
(null)
The maximum number of static IPv6 addresses that can be configured on this interface.
MTUSizeintegerread-write
(null)
The currently configured maximum transmission unit (MTU), in bytes, on this interface.
NameServers [ ]array (string)read-onlyThe DNS servers in use on this interface.
Oem {}objectThe OEM extension property. See the Resource schema for details on this property.
PermanentMACAddressstringread-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.
SpeedMbpsinteger
(Mbit/s)
read-write
(null)
The current speed, in Mbit/s, of this interface.
StatelessAddressAutoConfig (v1.4+) {objectStateless address autoconfiguration (SLAAC) parameters for this interface.
      IPv4AutoConfigEnabled (v1.4+)booleanread-write
(null)
An indication of whether IPv4 stateless address autoconfiguration (SLAAC) is enabled for this interface.
      IPv6AutoConfigEnabled (v1.4+)booleanread-write
(null)
An indication of whether IPv6 stateless address autoconfiguration (SLAAC) is enabled for this interface.
}
StaticNameServers (v1.4+) [ ]array (string, null)read-writeThe statically-defined set of DNS server IPv4 and IPv6 addresses.
Status {}objectThe 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.
UefiDevicePathstringread-only
(null)
The UEFI device path for this interface.
VLAN {}objectIf 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) {}objectThe 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.

stringDescription
PhysicalA physical Ethernet interface.
VirtualA virtual Ethernet interface.

FallbackAddress

 

DHCPv4 fallback address method for this interface.

stringDescription
AutoConfigFall back to an autoconfigured address.
NoneContinue attempting DHCP without a fallback address.
StaticFall back to a static address specified by IPv4StaticAddresses.

idRef

 
@odata.idstring
(URI)
read-onlyThe unique identifier for a resource.

LinkStatus

 

The link status of this interface, or port.

stringDescription
LinkDownNo link is detected on this interface, but the interface is connected.
LinkUpThe link is available for communication on this interface.
NoLinkNo link or connection is detected on this interface.

OperatingMode

 

Determines the DHCPv6 operating mode for this interface.

stringDescription
DisabledDHCPv6 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.

stringDescription
ExternalExternally accessible.
HostOnlyOnly accessible to a dedicated interface on the host.
InternalOnly 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.
LimitedAccessible through IP translation provided by the hosting system.

TeamMode

 

The team mode for this interface.

stringDescription
ActiveBackupOne interface in the team is active and the others are kept in standby until a failure occurs.
AdaptiveLoadBalancingPackets are transmitted and received based upon the current load of each interface in the team.
AdaptiveTransmitLoadBalancingPackets are transmitted based upon the current load of each interface in the team.
BroadcastPackets are transmitted on all interfaces in the team.
IEEE802_3adThe interfaces in the team create an IEEE802.3ad link aggregation group.
NoneNo teaming.
RoundRobinPackets are transmitted in sequential order from the teamed interfaces.
XORTransmitting 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

 
Versionv1.22
Release2025.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

PropertyTypeAttributesNotes
Actions {objectThe available actions for this resource.
      #Manager.ForceFailover {}objectThe 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 {}objectThe ModifyRedundancySet operation adds members to or removes members from a redundant group of managers. For more information, see the Actions section below.
      #Manager.Reset {}objectThe reset action resets/reboots the manager. For more information, see the Actions section below.
      #Manager.ResetToDefaults (v1.8+) {}objectThe 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+) {}objectThe 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+) {}objectThe additional firmware versions of the manager. See the SoftwareInventory.v1_13_0 schema for details on this property.
AutoDSTEnabled (v1.4+)booleanread-writeAn indication of whether the manager is configured for automatic Daylight Saving Time (DST) adjustment.
Certificates (v1.13+) {}objectThe link to a collection of certificates for device identity and attestation.
CommandShell {objectThe manager's command line user interface or command shell service.
      ConnectTypesSupported [ ]array (string
(enum))
read-onlyThis property enumerates the command shell connection types that the implementation allows. For the possible property values, see ConnectTypesSupported in Property details.
      MaxConcurrentSessionsintegerread-onlyThe maximum number of service sessions, regardless of protocol, that this manager can support.
      ServiceEnabledbooleanread-writeAn indication of whether the service is enabled for this manager.
}
DateTimestring
(date-time)
read-write
(null)
The current date and time with UTC offset of the manager.
DateTimeLocalOffsetstringread-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+) {objectThe daylight saving time settings for this manager.
      EndDateTime (v1.19+)string
(date-time)
read-writeThe end date and time with UTC offset of daylight saving time.
      OffsetMinutes (v1.19+)integerread-writeThe daylight saving time offset in minutes.
      StartDateTime (v1.19+)string
(date-time)
read-writeThe start date and time with UTC offset of daylight saving time.
      TimeZoneName (v1.19+)stringread-writeThe time zone of the manager when daylight saving time is in effect.
}
DedicatedNetworkPorts (v1.16+) {}objectThe dedicated network ports of the manager.
EthernetInterfaces {}objectThe link to a collection of NICs that this manager uses for network communication.
FirmwareVersionstringread-only
(null)
The firmware version of this manager.
GraphicalConsole {objectThe manager's graphical console service.
      ConnectTypesSupported [ ]array (string
(enum))
read-onlyThis property enumerates the graphical console connection types that the implementation allows. For the possible property values, see ConnectTypesSupported in Property details.
      MaxConcurrentSessionsintegerread-onlyThe maximum number of service sessions, regardless of protocol, that this manager can support.
      ServiceEnabledbooleanread-writeAn indication of whether the service is enabled for this manager.
}
HostInterfaces (v1.3+) {}objectThe 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-onlyThe date and time when the manager was last reset or rebooted.
Links {objectThe links to other resources that are related to this resource.
      ActiveSoftwareImage (v1.6+) {}objectThe link to the software inventory resource that represents the active firmware image for this manager.
      ManagedBy (v1.9+) [ {arrayThe array of links to the managers responsible for managing this manager.
            @odata.idstring
(URI)
read-onlyThe unique identifier for a resource.
      } ]
      ManagerForChassis [ {arrayAn array of links to the chassis this manager controls.
            @odata.idstring
(URI)
read-onlyThe unique identifier for a resource.
      } ]
      ManagerForFabrics (v1.22+) [ {arrayAn array of links to the fabrics that this manager controls.
            @odata.idstring
(URI)
read-onlyThe unique identifier for a resource.
      } ]
      ManagerForManagers (v1.9+) [ {arrayAn array of links to the managers that are managed by this manager.
            @odata.idstring
(URI)
read-onlyThe unique identifier for a resource.
      } ]
      ManagerForServers [ {arrayAn array of links to the systems that this manager controls.
            @odata.idstring
(URI)
read-onlyThe unique identifier for a resource.
      } ]
      ManagerForSwitches (v1.4+) [ {arrayAn array of links to the switches that this manager controls.
            @odata.idstring
(URI)
read-onlyThe unique identifier for a resource.
      } ]
      ManagerInChassis (v1.1+) {}objectThe link to the chassis where this manager is located.
      Oem {}objectThe 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+) [ {arrayThe images that are associated with this manager.
            @odata.idstring
(URI)
read-onlyThe unique identifier for a resource.
      } ]
}
Location (v1.11+) {}objectThe location of the manager. See the v1_23_0.v1_23_0 schema for details on this property.
LocationIndicatorActive (v1.11+)booleanread-write
(null)
An indicator allowing an operator to physically locate this resource.
LogServices {}objectThe link to a collection of logs that the manager uses.
ManagerDiagnosticData (v1.14+) {}object
(null)
The diagnostic data for this manager.
ManagerTypestring
(enum)
read-onlyThe type of manager that this resource represents. For the possible property values, see ManagerType in Property details.
Manufacturer (v1.7+)stringread-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.
Modelstringread-only
(null)
The model information of this manager, as defined by the manufacturer.
NetworkProtocol {}objectThe link to the network services and their settings that the manager controls.
Oem {}objectThe OEM extension property. See the Resource schema for details on this property.
OEMSecurityMode (v1.21+)stringread-only
(null)
The OEM-specific security compliance mode(s) that the manager is currently configured to enforce.
PartNumber (v1.7+)stringread-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 [ {arrayThe redundancy information for the managers of this system.
      @odata.idstring
(URI)
read-onlyThe unique identifier for a resource.
} ]
RemoteAccountService (v1.5+) {}objectThe 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-onlyThe 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) {objectThe 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-onlyThis property enumerates the serial console connection types that the implementation allows. For the possible property values, see ConnectTypesSupported in Property details.
      MaxConcurrentSessionsintegerread-onlyThe maximum number of service sessions, regardless of protocol, that this manager can support.
      ServiceEnabledbooleanread-writeAn indication of whether the service is enabled for this manager.
}
SerialInterfaces {}objectThe link to a collection of serial interfaces that this manager uses for serial and console communication.
SerialNumber (v1.7+)stringread-only
(null)
The serial number of the manager.
ServiceEntryPointUUIDstring
(uuid)
read-only
(null)
The UUID of the Redfish service that is hosted by this manager.
ServiceIdentification (v1.15+)stringread-write
(null)
A product instance identifier displayed in the Redfish service root.
SharedNetworkPorts (v1.16+) {}objectThe shared network ports of the manager.
SparePartNumber (v1.11+)stringread-only
(null)
The spare part number of the manager.
Status {}objectThe status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
TimeZoneName (v1.10+)stringread-writeThe time zone of the manager.
USBPorts (v1.12+) {}objectThe USB ports of the manager.
UUIDstring
(uuid)
read-only
(null)
The UUID for this manager.
Version (v1.17+)stringread-only
(null)
The hardware version of this manager.
VirtualMedia (deprecated v1.10) {}objectThe 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 NameTypeAttributesNotes
      NewManager {}objectrequiredThe 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 NameTypeAttributesNotes
      Add [ {arrayoptionalAn array of managers to add to the redundancy set.
            @odata.idstring
(URI)
read-onlyThe unique identifier for a resource.
      } ]
      Remove [ {arrayoptionalAn array of managers to remove from the redundancy set.
            @odata.idstring
(URI)
read-onlyThe 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 NameTypeAttributesNotes
      ResetTypestring
(enum)
optionalThe 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 NameTypeAttributesNotes
      ResetTypestring
(enum)
requiredThe 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 NameTypeAttributesNotes
      OEMSecurityModestringoptionalThe OEM-specific security mode to apply to the manager.
      SecurityModestring
(enum)
requiredThe 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.

stringDescription
IPMIThe controller supports a command shell connection through the IPMI Serial Over LAN (SOL) protocol.
OemThe controller supports a command shell connection through an OEM-specific protocol.
SSHThe controller supports a command shell connection through the SSH protocol.
TelnetThe controller supports a command shell connection through the Telnet protocol.
In GraphicalConsole:

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

stringDescription
KVMIPThe controller supports a graphical console connection through a KVM-IP (redirection of Keyboard, Video, Mouse over IP) protocol.
OemThe 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.

stringDescription
IPMIThe controller supports a serial console connection through the IPMI Serial Over LAN (SOL) protocol.
OemThe controller supports a serial console connection through an OEM-specific protocol.
SSHThe controller supports a serial console connection through the SSH protocol.
TelnetThe 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.

stringDescription
FirmwareThe date and time is set and held by firmware.
HostThe date and time is retrieved from the host.
NTPThe date and time source is a Network Time Protocol (NTP) server.
PTPThe date and time source is a Precision Time Protocol (PTP) server.
RTCThe date and time is retrieved from the manager's real time clock (RTC).

idRef

 
@odata.idstring
(URI)
read-onlyThe unique identifier for a resource.

ManagerType

 

The type of manager that this resource represents.

stringDescription
AuxiliaryControllerA controller that provides management functions for a particular subsystem or group of devices as part of a larger system.
BMCA 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.
EnclosureManagerA 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.
ManagementControllerA controller that primarily monitors or manages the operation of a device or system.
RackManagerA 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.

stringDescription
OffThe resource is powered off. The components within the resource might continue to have AUX power.
OnThe resource is powered on.
PausedThe resource is paused.
PoweringOffA temporary state between on and off. The components within the resource can take time to process the power off action.
PoweringOnA 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.

stringDescription
ForceOffTurn off the unit immediately (non-graceful shutdown).
ForceOnTurn on the unit immediately.
ForceRestartShut down immediately and non-gracefully and restart the unit.
FullPowerCycleFull power cycle the unit immediately (non-graceful). Behaves like removing utility lines, followed by restoring utility lines to the resource.
GracefulRestartShut down gracefully and restart the unit.
GracefulShutdownShut down gracefully and power off.
NmiGenerate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system.
OnTurn on the unit.
PausePause execution on the unit but do not remove power. This is typically a feature of virtual machine hypervisors.
PowerCyclePower cycle the unit immediately (non-graceful). Behaves like a power removal, followed by a power restore to the resource.
PushPowerButtonSimulate the pressing of the physical power button on this unit.
ResumeResume execution on the paused unit. This is typically a feature of virtual machine hypervisors.
SuspendWrite 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.

stringDescription
PreserveNetworkReset all settings except network settings to factory defaults.
PreserveNetworkAndUsersReset all settings except network and local usernames/passwords to factory defaults.
ResetAllReset all settings to factory defaults.

SecurityMode

 

The security mode to apply to the manager.

stringDescription
CNSA_1_0This security mode indicates the implementation meets NSA Commercial National Security Algorithm Suite 1.0 requirements. This mode requires FIPS 140-2 compliance.
CNSA_2_0This security mode indicates the implementation meets NSA Commercial National Security Algorithm Suite 2.0 requirements. This mode requires FIPS 140-3 compliance.
DefaultThis security mode indicates the implementation is in a vendor-specific default security state that does not match any other value.
FIPS_140_2This security mode indicates the implementation complies with FIPS 140-2.
FIPS_140_3This security mode indicates the implementation complies with FIPS 140-3.
OEMThis security mode indicates the implementation is in an OEM-specific security state.
SuiteBThis 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"
}