White Papers
Table Of Contents
- 1 Scope
- 2 Normative References
- 3 Terms and Definitions
- 4 Symbols and Abbreviated Terms
- 5 Synopsis
- 6 Description
- 7 Implementation Description
- 8 Methods
- Table 29 – DCIM_FCService.SetAttribute() Method: Return Code Values
- The SetAttributes() method is used to set or change the values of a group of attributes.
- Table 32 – DCIM_FCService.SetAttributes() Method: Return Code Values
- The CreateTargetedConfigJob() method is used to apply the pending values created by the SetAttribute and SetAttributes methods. The successful execution of this method creates a job for application of pending attribute values.
- CreateTargetedConfigJob method supports the following optional input parameters
- 1. RebootJobType: When provided in the input parameters, creates a specific reboot job to “PowerCycle”, “Graceful Reboot without forced shutdown”, or “Graceful Reboot with forced shutdown”. This parameter only creates the RebootJob and does not schedu...
- 2. ScheduledStartTime: When provided in the input parameters, schedules the “configuration job” and the optional “reboot job” at the specified start time. A special value of “TIME_NOW” schedules the job(s) immediately.
- 3. UntilTime: This parameter has a dependency on “ScheduledStartTime”, together “ScheduledStartTime” and “UntilTime” define a time window for scheduling the job(s). Once scheduled, jobs will be executed within the time window.
- If CreateTargetedConfigJob method is executed without the three optional parameters discussed above, then configuration job is created but not scheduled. However, this configuration job can be scheduled later using the DCIM_JobService.SetupJobQueue ()...
- Table 35 – DCIM_FCService.CreateTargetedConfigJob() Method: Return Code Values
- Table 38 – DCIM_FCService.DeletePendingConfiguration() Method: Return Code Values
- 9 Use Cases
- 10 CIM Elements
- 11 Privilege and License Requirement
32 Version 1.0.0
Table 29 – DCIM_FCService.SetAttribute( ) Method: Return Code Values
587
Value
Description
0
Completed with no error
2
Failed
Table 30 – DCIM_FCService.SetAttribute( ) Method: Parameters
588
Qualifiers
Name
Type
Description/Values
IN, REQ
Target
String
FQDD of the FC
IN, REQ
AttributeName
String
Shall contain the AttributeName property value for the
attribute to be modified.
IN, REQ
AttributeValue[]
String
Shall contain the desired attribute value.
If the value is valid, the CurrentValue or PendingValue
property of the specified attribute will be modified.
OUT
SetResult
String
Returns:
"Set CurrentValue property" when the attributes
current value is set.
“Set PendingValue” when the attributes pending
value is set.
OUT
RebootRequired
String
Returns:
“Yes” if reboot is required,
“No” if reboot is not required.
OUT
MessageID
String
Error MessageID
OUT
Message
String
Error Message
OUT
MessageArguments[]
String
Error MessageArguments
Table 31 – DCIM_FCService.SetAttribute( ) Method: Standard Messages
589
MessageID (OUT parameter)
Message
MessageArguments[]
FC001
The command was successful
FC002
Resource allocation failure
FC003
Missing required parameter
FC004
Invalid parameter value for
<parameter name>
Parameter
FC005
Mismatch in AttributeName and
AttributeValue count
FC006
Configuration job already created,
cannot set attribute on specified
target until existing job is completed
or is cancelled
FC007
Configuration job already created,
cannot create another config job on
specified target until existing job is
completed or is cancelled
FC008
No pending data is present to create
a Configuration job
FC009
Lifecycle Controller is currently in
use.
FC010
Lifecycle Controller is not enabled,
cannot create Configuration job.