1.4.7 swcfmg_job (Job Information Management Command)

Description

This command lists, displays details of, executes actions for, and deletes job information managed by Systemwalker Software Configuration Manager.

Synopsis

[Windows]

swcfmg_job.exe
{ -list [-file <Job info file>] [-e <Character encoding>] [-type <Job type>] [-status <Status>] [-owner <User ID>] [-tenant <Tenant ID>] [-startdate <Start date>] [-enddate <End date>] [-targettype <Target type>] [-target <Target>] |
-get -id <Job ID> [-getstatus] [-file <Output file path>] |
-select -id <Job ID> -action <Action> |
-delete -id <Job ID> }

[Linux]

swcfmg_job
{ -list [-file <Job info file>] [-e <Character encoding>] [-type <Job type>] [-status <Status>] [-owner <User ID>] [-tenant <Tenant ID>] [-startdate <Start date>] [-enddate <End date>] [-targettype <Target type>] [-target <Target>] |
-get -id <Job ID> [-getstatus] [-file <Output file path>] |
-select -id <Job ID> -action <Action> |
-delete -id <Job ID> }

Options

-list [-file <job info file>] [-e<char encoding>]

Outputs job information in CSV format.

Refer to "2.4.3 Job Information File" for information on the output file.

If -file <job info file> is omitted, the information is output to the standard output for this command.

If the specified file does not exist, a new file will be created. If the file exists, the existing file will be overwritten.

If the file cannot be output because of an error, either a new file will not be created or, if an existing file was to be overwritten, the existing file will be kept as it is, without being overwritten.

In the "-e" option, specify the character encoding for the output file. The following character encoding can be specified:

UTF-8

If this option is omitted, the character encoding of the execution environment of this command will be used.

By specifying the options below, you can filter the job information to be output. If you do not specify any option, all job information will be output.

[-type <job type>]

Specify the job type of the job to be output. The following job types can be specified:

patchapplication: Patch application
patchdistribution: Patch distribution
parametersetting: Parameter setting
scriptexecution: Script execution
configurationchange : Configuration modification

[-status <status>]

Specify the status of the job to be output. The following statuses can be specified:

running: Running
completed: Completed
selecting_abnormal: Selecting (abnormal)
completed_abnormal: Completed (abnormal)
waiting: Waiting
canceled: Canceled

[-owner <user ID>]: Specify the administrator of the job to be output.

[-tenant <Tenant ID>]: Specify the tenant to which the administrator of the job to be output belongs.

[-startdate <start date>]

Use the following format to specify the start date of the job to be output:

- YYYY-MM-DD

[-enddate <end date>]

Use the following format to specify the end date of the job to be output:

- YYYY-MM-DD

[-targettype <target type>][-target <target>]

Specify the target of the job to be output. The job target of patch application, patch deployment, parameter settings, script execution, and configuration modification is a server. Specify the target type in -targettype, and specify the target of the job to be output in -target. The following values can be specified as the target type:

ipaddress: IP address
server-id : Server ID

If the target type is omitted, the string specified using -target will be searched from all target types. If -target is omitted, the command obtains only jobs for which the target type specified in -targettype is defined.

-get -id <job ID> [-getstatus] [-file <output file>]

Detailed information or the status of the job specified by the job ID is output in XML format. If the "-getstatus" option is omitted, detailed information about the job is output in XML format (refer to "2.4.4 Job Details File" for details). If the "-getstatus" option is specified, the status of the job is output.

If "-file <output file>" is omitted, the information is output to the standard output for this command.

If the specified file does not exist, a new file will be created. If the file exists, the existing file will be overwritten.

-select -id <job ID> -action <action>

The action is executed for the job specified by the job ID.

In -action, specify the action to be executed. The following actions can be specified:

retry: Retry
retryall: Retry all
cancel: Cancel
continue: Continue

-delete -id <job ID>

The job specified by the job ID is deleted. Information about a job deleted using this option can no longer be obtained using list display or detailed information. Jobs with one of the following statuses can be deleted:

completed: Completed
completed_abnormal: Completed (abnormal)
canceled: Canceled

Return value

Return value	Meaning
0	The command has terminated normally.
10	A parameter error has occurred.
20	The specified I/O path is incorrect.
30	The specified character encoding is incorrect.
70	The specified job ID does not exist.
71	The specified action does not exist.
72	The specified job cannot be deleted.
100	Systemwalker Software Configuration Manager is not running.
102	You do not have the privileges required to execute this command.
105	Database connection has failed.
106	Acquisition of detailed information about the job failed.
110	A write error has occurred.
200	Setup has not been performed.
255	A system error has occurred.

Command location

Admin server

[Windows]

<Systemwalker Software Configuration Manager installation directory>\SWCFMGM\bin

[Linux]

/opt/FJSVcfmgm/bin

Privilege required/execution environment

[Windows]

Administrator privileges are required. Execute as an administrator.
This command can be executed on the admin server.
This command can be executed at the same time as other commands.

[Linux]

System administrator (superuser) privileges are required.
This command can be executed on the admin server.
This command can be executed at the same time as other commands.

Notes

Common notes

Execute this command while Systemwalker Software Configuration Manager is running.

Notes on list display

If no job information is registered, only header information is output.
#job-id,job-name,job-type,status,owner,tenant,start-date,end-date,target-type,target

Notes on executing actions

The executable actions can be checked from the job details file obtained using the "-get" option.
Execute actions as a job administrator.

Notes on deletion

When a job is deleted, the scripts registered when the job was requested are also deleted.

Example

List
[Windows]
swcfmg_job.exe -list -file C:\work\joblist.csv
[Linux]
swcfmg_job -list -file /tmp/joblist.csv
Details
[Windows]
swcfmg_job.exe -get -id 000000001 -file C:\work\jobinfo.xml
[Linux]
swcfmg_job -get -id 000000001 -file /tmp/jobinfo.xml
Action execution
[Windows]
swcfmg_job.exe -select -id 000000001 -action retry
[Linux]
swcfmg_job -select -id 000000001 -action retry
Deletion
[Windows]
swcfmg_job.exe -delete -id 000000001
[Linux]
swcfmg_job -delete -id 000000001

Execution results/output format

List

Standard output

#job-id,job-name,job-type,status,owner,tenant,start-date,end-date,target-type,target
000000001,patchdistributionrequest_000000001_developmentserver1(kaihatsu1),patchdistribution, completed,user001,tenantA,2013-08-28 22:06:25,2013-08-28 22:15:50,server-id(ipaddress),0I6M73PAH@Direct(192.168.1.1)
000000002,patchapplicationrequest_000000001_developmentserver2(kaihatsu2),patchapplication,running,user002,tenantA,2013-08-28 22:15:45,,server-id(ipaddress),GYLDF7MHM@Direct(192.168.1.2)

File output

CFMGC30251 The job information management command has completed normally.

Note that the following header information is output as the first line of the CSV file that is output:

#job-id,job-name,job-type,status,owner,tenant,start-date,end-date,target-type,target

Details

Standard output (when the "-getstatus" option is omitted)

<?xml version="1.0" encoding="UTF-8"?>
<job>
<jobName>patchapplicationrequest_000000001_developmentserver(kaihatsu1)</jobName>
  <jobId>000000001</jobId>
  <jobType>patchapplication</jobType>
  <jobStatus>running</jobStatus>
  <jobOwner>user001</jobOwner>
  <jobTenant>tenantA</jobTenant>
  <jobStartDate>2013-08-28 22:05:50</jobStartDate>
  <jobEndDate />
  <jobTargetType>ipaddress</jobTargetType>
  <jobTarget>192.168.1.1</jobTarget>
  <processes>
    <process>
      <processName>acceptance</processName>
      <processOrder>1</processOrder>
      <processType>acceptance</processType>
      <processParameters />
    </process>
    <process>
      <processName>server operation check</processName>
      <processOrder>2</processOrder>
      <processType>checkServer</processType>
      <processParameters>
        <serverName>development server</serverName>
        <serverId>0I6M73PAH@Direct</serverId>
        <ipaddress>192.168.1.1</ipaddress>
        <monitorTime>0</monitorTime>
      </processParameters>
    </process>
    <process>
      <processName>patchapplication</processName>
      <processOrder>3</processOrder>
      <processType>patchApplication</processType>
      <processParameters>
        <serverName>developmentserver</serverName>
        <serverId>0I6M73PAH@Direct</serverId>
        <ipaddress>192.168.1.1</ipaddress>
        <windowsUpdates>
          <windowsUpdate>
            <patchId>KB2079403</patchId>
            <requiredLevel>required</requiredLevel>
            <patchType>patchprogramforsecurityproblem</patchType>
            <updateId>2864e0a9-1733-4c55-804f-a13982cd4d75</updateId>
          </windowsUpdate>
        </windowsUpdates>
      </processParameters>
    </process>
  </processes>
  <results>
    <result>
      <processName>acceptance</processName >
      <processOrder>1</processOrder>
      <processType>acceptance</processType>
      <processExecutor>user001</processExecutor>
      <processStatus>succeeded</processStatus>
      <processStartDate>2013-08-28 22:05:50</processStartDate>
      <processEndDate>2013-08-28 22:09:23</processEndDate>
      <messages>
        <message>
          <messageId>CFMGP10000</messageId>
          <messageText>Acceptance processing has completed normally.</messageText>
          <errorType>INFO</ErrorType>
          <messageParameters />
        </message>
      </messages>
    </result>
  </results>
</job>

Standard output (when the "-getstatus" option is specified)

running

File output

CFMGC30251 The job information management command has completed normally.