Skip to Content
Information
Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

task

This topic describes the verbs, command-line arguments, and API parameters available for the task noun in the BMC Cloud Lifecycle Management SDK.

result

Use task-result from the command line to return the result of the specified completed task.

Command-line syntax
clm task-result [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]] --taskid GUID

Use task_result in the API to return the result of the specified completed task. This command returns a CloudClass Python object with the same attributes and relationships.

API syntax
obj = task_result(gcac, task_guid=None)

obj.guid # returns the GUID
obj.name # returns the name
...

Command-line argument

API parameter

Description

Required?

--taskid
task_guid

GUID of the task.

Yes

-l

 

List all fields. This parameter does not need a value.

 

-u

 

List only GUIDs. This parameter does not need a value.

 

-n

 

List only names. This parameter does not need a value.

 

-s

 

List GUIDs, names, and status (if applicable). This parameter does not need a value.

 

-k

 

List the field names specified as the value for this parameter.

 

--filter

 

List the output that matches the specified filters.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

status

Use task-status from the command line to return the status of a task.

Command-line syntax
clm task-status [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]] --taskid GUID

Use task_status in the API to return the status of a task. This command returns a Task Python object with the same attributes and relationships.

API syntax
obj = task_status(gcac, task_guid=None)

obj.guid # returns the GUID
obj.name # returns the name
...

Command-line argument

API parameter

Description

Required?

--taskid
task_guid

GUID of the task.

Yes

-l

 

List all fields. This parameter does not need a value.

 

-u

 

List only GUIDs. This parameter does not need a value.

 

-n

 

List only names. This parameter does not need a value.

 

-s

 

List GUIDs, names, and status (if applicable). This parameter does not need a value.

 

-k

 

List the field names specified as the value for this parameter.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Cloud Lifecycle Management 4.1