White Papers

Version 1.3.1 53
8.3 DCIM_NICService.CreateTargetedConfigJob()
878
The CreateTargetedConfigJob( ) method is used to apply the pending values created by the SetAttribute
879
and SetAttributes methods. The successful execution of this method creates a job for application of
880
pending attribute values.
881
CreateTargetedConfigJob method supports the following optional input parameters
882
1. RebootJobType: When provided in the input parameters, creates a specific reboot job to
883
“PowerCycle”, “Graceful Reboot without forced shutdown”, or “Graceful Reboot with forced shutdown”.
884
This parameter only creates the RebootJob and does not schedule it.
885
2. ScheduledStartTime: When provided in the input parameters, schedules the “configuration job” and the
886
optional “reboot job” at the specified start time. A special value of “TIME_NOW” schedules the job(s)
887
immediately.
888
3. UntilTime: This parameter has a dependency on “ScheduledStartTime”, together “ScheduledStartTime” and
889
“UntilTime” define a time window for scheduling the job(s). Once scheduled, jobs will be executed within the
890
time window.
891
If CreateTargetedConfigJob method is executed without the three optional parameters discussed above, then
892
configuration job is created but not scheduled. However, this configuration job can be scheduled later using the
893
DCIM_JobService.SetupJobQueue () method from the “Job Control Profile”. DCIM_JobService.SetupJobQueue ()
894
can be executed to schedule several configuration jobs including the reboot job. Refer to “Job Control Profile” for
895
more details.
896
Return code values for the CreateTargetedConfigJob( ) method are specified in Table 62, and parameters
897
are specified in Table 63.
898
Subsequent calls to CreateTargetedConfigJob after the first CreateTargetedConfigJob will result in error
899
until the first job is completed.
900
Table 62 – DCIM_NICService.CreateTargetedConfigJob( ) Method: Return Code Values
901
Value
Description
2
Failed
4096
1
Job Created
1
Table 63 – DCIM_NICService.CreateTargetedConfigJob( ) Method: Parameters
902
Qualifiers
Name
Type
Description/Values
IN, REQ
Target
String
FQDD of the NIC
IN
RebootJobType
Uint16
Shall contain the requested reboot type:
 1 - PowerCycle
 2 - Graceful Reboot without forced
shutdown
 3 - Graceful Reboot with forced
shutdown.
IN
ScheduledStartTime
String
Start time for the job execution in format:
yyyymmddhhmmss.
The string "TIME_NOW" means immediate.
IN
UntilTime
String
End time for the job execution in format:
yyyymmddhhmmss. :
If this parameter is not NULL, then
ScheduledStartTime parameter shall also be
specified.