callout

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

create

Use callout-create from the command line to create a new callout.

Command-line syntax

clm callout-create [-h] [--waitfor TIME_OUT_SECONDS] --calloutname NAME --callouttype NAME|id:<GUID>
[--calloutweight NUMBER] [--notify] [--attr ATTRIBUTE_NAME=VALUE [ATTRIBUTE_NAME=VALUE ...]]

Use callout_create in the API to create a new callout. This command returns a Callout Python object with the same attributes and relationships.

API syntax

obj = callout_create(gcac, callout_name=None, callout_type=None, callout_weight=None, notification=False, work_flow_name=None)

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

Command-line argument	API parameter	Description	Required?
--calloutname	callout_name	Name of the callout.	Yes
--callouttype	callout_type	Name or GUID of the callout type.	Yes
--calloutweight	callout_weight	Numerical weight to assign to the new callout.
--notify	notification	Indicates that this is a notification callout, so the provided operation will not fail even if the callout malfunctions. This parameter does not need a value.
--attr	work_flow_name	Value for each access attribute defined for the callout type
--waitfor		Time in seconds to wait for response from the server, otherwise return running task details.
	gcac	GenericCloudAPIClient instance/user authentication.

delete

Use callout-delete from the command line to delete the specified callout.

Command-line syntax

clm callout-delete [-h] [--waitfor TIME_OUT_SECONDS] --callout NAME|id:<GUID>

Use callout_delete in the API to delete the specified callout. This command returns a callout object with the same attributes and relationships.

API syntax

Obj = callout_delete(gcac, callout=None):
Obj.guid # returns the GUID

Command-line argument	API parameter	Description	Required?
--callout	callout	Name or GUID of the callout type.	Yes
--waitfor		Time in seconds to wait for response from the server, otherwise return running task details.

list

Use callout-list from the command line to list available callouts.

Command-line syntax

clm callout-list [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]]
[--filter FIELD_NAME=VALUE [FIELD_NAME=VALUE ...]]

Use callout_list to list available callouts using the API. This command returns a list of Callout API objects with the same attributes and relationships.

API syntax

obj = callout_list(gcac, filters=None)

obj[n].guid returns the GUID
obj[n].name returns the name
...

Command-line argument	API parameter	Description
-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	filters	Filter the output according to the specified criteria.
	gcac	GenericCloudAPIClient instance/user authentication.

map-to

Use callout-map-to from the command line to map object model operations to a callout.

Command-line syntax

clm callout-map-to [-h] [--waitfor TIME_OUT_SECONDS] --callout NAME|id:<GUID>
[--callouttype NAME|id:<GUID>] [--preoperation PROVIDER_DEFINITION_NAME|
id:<GUID>.OM_CLASS_NAME.OM_OPERATION_NAME] [--postoperation PROVIDER_DEFINITION_NAME|
id:<GUID>.OM_CLASS_NAME.OM_OPERATION_NAME]

Use callout_map in the API to map object model operations to a callout. This command affects a Callout API object.

API syntax

obj = callout_map(gcac, callout=None, calloutType=None, preOperation=None, postOperation=None)

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

Command-line argument	API parameter	Description	Required?
--callout	callout	Name or GUID of the callout.	Yes
--preoperation	preOperation	The operation before which this callout will be invoked.	Yes
--postoperation	postOperation	The operation after which this callout will be invoked.	Yes
--callouttype	calloutType	Name or GUID of the callout type.
--waitfor		Time in seconds to wait for a response from the server, otherwise return running task details.
	gcac	GenericCloudAPIClient instance/user authentication.

unmap-to

Use callout-unmap-to from the command line to unmap object model operations from a callout.

Command-line syntax

clm callout-unmap-to [-h] [--waitfor TIME_OUT_SECONDS] --callout NAME|id:<GUID>
[--callouttype NAME|id:<GUID>] [--preoperation PROVIDER_DEFINITION_NAME|
id:<GUID>.OM_CLASS_NAME.OM_OPERATION_NAME] [--postoperation PROVIDER_DEFINITION_NAME|
id:<GUID>.OM_CLASS_NAME.OM_OPERATION_NAME]

Use callout_unmap in the API to unmap object model operations from a callout. This command affects a Callout API object.

API syntax

obj = callout_unmap(gcac, callout=None, calloutType=None, preOperation=None, postOperation=None)

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

Command-line argument	API parameter	Description	Required?
--callout	callout	Name or GUID of the callout.	Yes
--preoperation	preOperation	Operation for which mapping with the callout is removed	Yes
--postoperation	postOperation	Operation for which mapping with the callout is removed	Yes
--callouttype	calloutType	Name or GUID of the callout type.
--waitfor		Time in seconds to wait for a response from the server, otherwise return running task details.
	gcac	GenericCloudAPIClient instance/user authentication.

callout

create

delete

list

Use callout-list from the command line to list available callouts.

map-to

unmap-to

Related topic

Related topic on BMC Communities

On this page