Tokens

Tokens are predefined BMC Release Lifecycle Management (RLM) variables that are used during the deployment processes. Tokens are also used in notification templates. Tokens display the state of the system and help you make the deployment process more agile and flexible. During the deployment process, the token property name is replaced by its value.

The following tables list the RLM tokens by category.

Link tokens

Token	Description	Applies to
VL_LINK_CHRONO_HTML	Link to the chronology listing for a particular channel	Configuration
VL_LINK_DEPLOYMENT	Link to the results page for a deployment	Content, environment
VL_LINK_DEPLOYMENT_HTML	HTML version of VL_LINK_DEPLOYMENT	Content, environment
VL_LINK_DEPLOYMENTS	Link to the deployments results page	Content, environment, configuration, provisioning, signoff
VL_LINK_DEPLOYMENTS_HTML	HTML version of VL_LINK_DEPLOYMENTS	Content, environment, configuration, provisioning, signoff
VL_LINK_PROCESS	URL to the process that sent the email, which provides a link to the System tab	Content, environment
VL_LINK_PROCESS_HTML	HTML version of VL_LINK_PROCESS	Content, environment
VL_LINK_SIGNOFF	Link to the signoff page, which prompts the operator to enter a comment and optionally to accept or reject a deployment	Signoff
VL_LINK_SIGNOFF_HTML	HTML version of VL_LINK_SIGNOFF	Signoff
VL_LINK_TASK_ATTENTION	Link to the restart page, which prompts the operator to enter a comment, and optionally to restart a deployment	Content, environment
VL_LINK_TASK_ATTENTION_HTML	HTML version of VL_LINK_TASK_ATTENTION	Content, environment

Channel provisioning tokens

Token	Description
VL_BRIDGE_HOST	Physical host name of the channel server
VL_CHANNEL	Channel on which the configuration process is running
VL_CONFIG_PROCESS_TYPE	Allows actions to distinguish if the Config process being executed is one of the Sync, Drift, or Check process type
VL_INPUT_DATA	Path to the file containing list of configuration data to be set by config set action

Content-handling tokens

Token	Description
VL_ACTION	Action, either Deploy or Remove
VL_ACTION_NAME	Name of the action being executed during an Invoke Action task
VL_ACTIVITY_ID	ID of Activity being executed
VL_ARTIFACT_NAME	Name of the artifact that triggered the process being executed
VL_BRIDGE_HOST	Physical host name of the channel server
VL_CONTAINER	Package to which the instance belongs Deprecated; replaced by VL_PACKAGE
VL_CONTAINER_TYPE	Used by several actions to determine where content has been placed on target system. It must be a path
VL_CONTENT_NAME	Short version of the content that triggered the handling process
VL_CONTENT_PATH	Path to the piece of content that triggered the handling process
VL_ENVIRONMENT	Environment being deployed into
VL_INSTANCE	Package instance
VL_PACK	Pack that is associated with the target channels channel template
VL_PACK_ID	Pack ID of channel type that is current being deployed
VL_PACK_NAME	Pack that the action being executed is being pulled from
VL_PACKAGE	Package to which the instance belongs
VL_POST_PATH	Automatically generated path to place files to be copied into RLM during a reference get action
VL_PROCESS_ID	ID of current execution process
VL_PROCESS_TYPE	Type of process that is being executed
VL_REPOSITORY	Name of repository currently being deployed
VL_SOLID_NAME	Name of the reference

Environment tokens

Token	Description
VL_CHANNEL	Label of the channel on which the deployment process is running
VL_CHANNEL_ID	Channel ID where process is being executed
VL_CHANNEL_REV_ID	Revision ID where process is being executed
VL_CHANNEL_TEMPLATE	Name of the Channel Template of the Channel where process is being executed
VL_CHANNEL_TYPE_ID	ID of the Channel Type where process is being executed
VL_CONTAINER	Package to which the instance belongs Deprecated; replaced by VL_PACKAGE
VL_DELIVERY	Either ENVIRONMENT_PRE or ENVIRONMENT_POST, identifying the context in which the process is being called
VL_DELIVERY_ID	Delivery ID of current process
VL_DELIVERY_TYPE	Delivery type of current process
VL_DELIVERABLE_ID	ID of deliverable being deployed by current process
VL_DEPLOYMENT_ID	ID of current deployment
VL_ENVIRONMENT	Environment Name containing the channel that is currently being deployed
VL_ENVIRONMENT_ID	Environment ID containing the channel that is currently being deployed
VL_INSTANCE	Instance name of current deployment process
VL_PACKAGE	Package to which the instance belongs

General tokens

Token	Description
VL_BASE_URL	System setting to define tje base URL of RLM
VL_DEBUG	Optional property to enable verbose debugging of the dispatcher/bridge
VL_EVALUATE_SETS	When echoed to standard out, enables evaluation of data
VL_IGNORE_SETS	When echoed to standard out, disables evaluation of data
VL_PHASE_ID	Phase ID of current process
VL_TASK_ID	ID of currently executing task
VL_USER_ID	ID of dispatch user executing task
VL_USER_NAME	Name of dispatch user executing task

Virtual machine (VM) tokens

Token	Description
VL_VM_BRIDGE	Name of the name of the VM Hypervisor server
VL_VM_OPERATION	Used by the VM actions to determine what to do in certain situations
VL_REMOTE_PLATFORM	ID of the target server remote platform executing the process

Signoff tokens

Token	Description
VL_ACTION	Either the Deploy or Remove action
VL_CONTAINER	Package to which the instance belongs Deprecated; replaced by VL_PACKAGE
VL_DELIVERY	Always VALIDATING, indicating that the deployment is waiting for signoff before proceeding
VL_ENVIRONMENT	Environment to which this signoff applies
VL_INSTANCE	Package instance
VL_PACKAGE	Package instance being deployed or removed

Tokens

Related topics

Comments