Virtual Server Management module utility workflows for BMC BladeLogic
The Utilities folder contains workflows grouped by environment. This section describes the Virtual Server Management workflows in the BladeLogic folder:
Add Target Servers workflow
This workflow adds target servers to the execution task.
Add Target Servers workflow inputs
Input | Description | Required |
|---|---|---|
etkey | Specifies the handle to the execution task that you want to update | Yes |
server names | Specifies a comma-separated list of the target server names | Yes |
timeout | Specifies the timeout in milliseconds for BMC BladeLogic connection details | No |
user role | Specifies the user role for BMC BladeLogic connection details | No |
Add Target Servers workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
job run id | Returns the handle to the updated execution task |
Check Host Alive workflow description, inputs, and outputs
This workflow verifies whether the BMC BladeLogic agent is running on the host.
Check Host Alive workflow inputs
Input | Description | Required |
|---|---|---|
connection details | Specifies the BMC BladeLogic connection details needed to verify whether the agent on the specified computer (or host) is running | No |
count | Specifies the number of times to check for the agent information | Yes |
host name | Specifies the host on which the agent check is to be performed | Yes |
Check Host Alive workflow outputs
Output | Description |
|---|---|
available | Indicates whether the specified computer is running |
Create Device Boot Image workflow
This workflow sets a boot image of the device.
Create Device Boot Image workflow inputs
Input | Description | Required |
|---|---|---|
mac address | Specifies the MAC address of the device whose boot image you want to set | Yes |
boot image id | Specifies the ID of the boot image that you want to set | Yes |
timeout | Specifies the timeout in milliseconds for BMC BladeLogic connection details Note This parameter is used only by BMC BladeLogic. | No |
user role | Specifies the user role for BMC BladeLogic connection details Note This parameter is used only by BMC BladeLogic. | No |
Create Device Boot Image workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
Create Job Approval workflow
This workflow creates an approval request.
Note
You can add a returned approval ID to a job that requires approval.
Create Job Approval workflow inputs
Input | Description | Required |
|---|---|---|
risk level | Sets the risk level to one of the following integers: | Yes |
impact id | Sets the impact ID to one of the following integers: | Yes |
comments | Specifies any text that you want to appear in the change summary | Conditional; if approval type is set to 5 (Existing Approval), this parameter is optional (you can leave it empty) |
change type | Sets the change type to one of the following integers: | Yes |
approval type | Sets the approval type to one of the following integers: | Yes |
task id | Specifies the task ID from the change management system | Conditional; required only if approval type is set to 5 (Existing Approval) |
change id | Specifies the change ID from the change management system | Conditional; required only if approval type is set to 5 (Existing Approval) |
timeout | Specifies the timeout in milliseconds for BMC BladeLogic connection details | No |
user role | Specifies the user role for BMC BladeLogic connection details | No |
Create Job Approval workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
approval id | Returns the approval ID |
Create Post Install Batch Job workflow
This workflow sets the postinstallation Batch Job for a system package. The Batch Job runs after the provisioning process finishes.
Create Post Install Batch Job workflow inputs
Input | Description | Required |
|---|---|---|
spkey | Specifies the DBKey associated with the system package | Yes |
bjobkey | Specifies the DBKey associated with the batch job | Yes |
timeout | Specifies the timeout in milliseconds for BMC BladeLogic connection details | No |
user role | Specifies the user role for BMC BladeLogic connection details | No |
Create Post Install Batch Job workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
DBKey | Returns the DBKey |
Create Provisioning Input File workflow
This workflow creates a file of an XML type.
Create Provisioning Input File workflow inputs
Input | Description | Required |
|---|---|---|
adapter name | Specifies the file adapter name | No |
file name | Specifies the name of the file | Yes |
xml doc name | Specifies the name of the XML file | Yes |
Create Provisioning Input File workflow output
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
Create VM XML Input workflow
This workflow creates an XML input file used during the provisioning of a VM.
Create VM XML Input workflow inputs
Input | Description | Required |
|---|---|---|
file adapter name | Specifies the file adapter name | No |
srm id | Specifies the service request management (SRM) request ID | Yes |
change id | Specifies the ITSM change ID corresponding to the SRM ID | Yes |
task id | Specifies the ITSM task ID corresponding to the change ID | Yes |
file repository | Specifies the fully qualified folder path in which the VM template parameter file is created | Yes |
job folder ID | Specifies the BladeLogic folder ID where the VM creation job is created | Yes |
job name | Specifies the job name to be added to configuration file | Yes |
vm details | Contains details received from the SRM request | Yes |
ao hostname | Specifies the host name or IP address of the server housing the BMC Atrium Orchestrator configuration distribution peer (CDP) | Yes |
Create VM XML Input workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
bl file name | Provides the BMC BladeLogic file name |
file name | Provides the created file name; the file name format is a concatenation of the file repository, srmid, and timestamp |
Create VM from a Template workflow
This workflow creates a VM from a template.
Create VM from a Template workflow inputs
Input | Description | Required |
|---|---|---|
file adapter name | Specifies the file adapter name | No |
srm id | Specifies the service request management (SRM) request ID | Yes |
change id | Specifies the ITSM change ID corresponding to the SRM ID | Yes |
task id | Specifies the ITSM task ID corresponding to the change ID | Yes |
job folder ID | Specifies the BMC BladeLogic folder ID where the VM creation job is created | Yes |
job name | Specifies the job name to be added to configuration file | Yes |
vm details | Contains details received from the SRM request | Yes |
timeout | Specifies the timeout in milliseconds for BMC BladeLogic connection details | No |
user role | Specifies the user role for BMC BladeLogic connection details | No |
Create VM from a Template workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
file maintenance success status | Indicates whether the workflow finished successfully |
file maintenance status message | Provides a process-specific explanation for the value of file maintenance success status |
Create VM with Approval workflow
This workflow provisions a device that is currently in the imported state.
Note
The input file URL should be a valid java.net.URL pointing to a text file conforming to the java.util.Properties format.
Create VM with Approval workflow inputs
Input | Description | Required |
|---|---|---|
system package id | Specifies the ID of the system package | Yes |
mac address | Specifies the MAC address of the device to be provisioned | Yes |
acl template id | Specifies the ACL template to apply to the server to be added to Configuration Manager | Yes |
props file url | Specifies the URL to the input file containing device properties | Yes |
timeout | Specifies the timeout in milliseconds for BMC BladeLogic connection details | No |
user role | Specifies the user role for BMC BladeLogic connection details | No |
Create VM with Approval workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
bl file name | Provides the BMC BladeLogic file name |
DBKey | Returns the DBKey |
Create VM with Template XML Input workflow
This workflow creates an XML input file that is used during the provisioning of a VM from a template.
Create VM with Template XML Input workflow inputs
Input | Description | Required |
|---|---|---|
file adapter name | Specifies the file adapter name | No |
srm id | Specifies the service request management (SRM) request ID | Yes |
change id | Specifies the ITSM change ID corresponding to the SRM ID | Yes |
task id | Specifies the ITSM task ID corresponding to the change ID | Yes |
file repository | Specifies the fully qualified folder path in which the VM template parameter file is created | Yes |
job folder ID | Specifies the BMC BladeLogic folder ID where the VM creation job is created | Yes |
job name | Specifies the job name to be added to configuration file | Yes |
vm details | Contains details received from the SRM request | Yes |
ao hostname | Specifies the host name or IP address of the server housing the BMC Atrium Orchestrator CDP | Yes |
Create VM with Template XML Input workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
bl file name | Provides the BMC BladeLogic file name |
file name | Provides the created file name, which is a concatenation of the file repository, srmid, and timestamp |
Create VM workflow
This workflow creates a virtual machine.
Create VM workflow inputs
Input | Description | Required |
|---|---|---|
file adapter name | Specifies the file adapter name | No |
srm id | Specifies the service request management (SRM) request ID | Yes |
change id | Specifies the ITSM change ID corresponding to the SRM ID | Yes |
task id | Specifies the ITSM task ID corresponding to the change ID | Yes |
job folder ID | Specifies the BMC BladeLogic folder ID where the VM creation job is created | Yes |
job name | Specifies the job name to be added to configuration file | Yes |
vm details | Contains details received from the SRM request | Yes |
timeout | Specifies the timeout in milliseconds for BMC BladeLogic connection details | No |
user role | Specifies the user role for BMC BladeLogic connection details | No |
Create VM workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
file maintenance success status | Indicates whether the workflow finished successfully |
file maintenance status message | Provides a process-specific explanation for the value of file maintenance success status |
Delete VM workflow
This workflow removes a VM, if the VM is in a powered-off state.
Delete VM workflow inputs
Input | Description | Required |
|---|---|---|
vm name | Specifies the name of the virtual server | Yes |
virtual center | Specifies the virtual center on which the VM is hosted | No |
timeout | Specifies the timeout in milliseconds for BMC BladeLogic connection details | No |
user role | Specifies the user role for BMC BladeLogic connection details | No |
Delete VM workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
File Maintenance workflow
This workflow deletes a file.
File Maintenance workflow inputs
Input | Description | Required |
|---|---|---|
file adapter name | Specifies the file adapter name | No |
file name | Specifies the name of the file to delete | No |
File Maintenance workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
Get MAC Address for VM workflow
This workflow retrieves the MAC address for a specified VM.
Get MAC Address for VM workflow inputs
Input | Description | Required |
|---|---|---|
vm name | Specifies the name of the virtual server | Yes |
timeout | Specifies the timeout in milliseconds for BMC BladeLogic connection details | No |
user role | Specifies the user role for BMC BladeLogic connection details | No |
Get MAC Address for VM workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
macAddress | Provides the returned MAC address of the virtual server |
Get System Details workflow
This workflow retrieves system details such as operating system type, CPU, memory, and disk space used.
Get System Details workflow inputs
Input | Description | Required |
|---|---|---|
connection details | Specifies the BMC BladeLogic connection details | No |
host name | Specifies the host from which the system details are to be retrieved | Yes |
delay | Specifies the number of times to check for the agent information | No |
Get System Details workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
cpu speed | Provides the CPU speed in MHz |
system size memory | Provides the memory size in MB |
system size | Provides the total disk space |
system size cpu | Provides the number of CPUs |
os type | Provides the operating system type of the VM |
disk used | Provides the total disk space used |
Get VM Power Status workflow
This workflow retrieves the power status of a VM.
Get VM Power Status workflow inputs
Input | Description | Required |
|---|---|---|
vm name | Specifies the name of the virtual server | Yes |
timeout | Specifies the timeout in milliseconds for BMC BladeLogic connection details | No |
user role | Specifies the user role for BMC BladeLogic connection details | No |
virtual guest key | Specifies the unique key for each virtual guest or VM maintained by BMC BladeLogic | No |
Get VM Power Status workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
powerStatus | Returns the power status of the VM |
virtual guest key | Provides a unique key for each virtual guest or VM maintained by BMC BladeLogic |
Get Virtual Machines by Server Name workflow
This workflow retrieves a list of VMs hosted by a specified server.
Get Virtual Machines by Server Name workflow inputs
Input | Description | Required |
|---|---|---|
server name | Specifies the name of the server | Yes |
timeout | Specifies the timeout in milliseconds for BMC BladeLogic connection details | No |
user role | Specifies the user role for BMC BladeLogic connection details | No |
Get Virtual Machines by Server Name workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
vm list | Lists the VMs on the specified server |
Get Virtual Server Property Value workflow
This workflow retrieves a property value for a virtual server.
Get Virtual Server Property Value workflow inputs
Input | Description | Required |
|---|---|---|
server name | Specifies the name of the virtual server | Yes |
property name | Specifies the name of the property whose value is to be extracted | Yes |
timeout | Specifies the timeout in milliseconds for BMC BladeLogic connection details | No |
user role | Specifies the user role for BMC BladeLogic connection details | No |
Get Virtual Server Property Value workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
property value | Returns the property value |
Start VM workflow
This workflow starts a VM.
Start VM workflow inputs
Input | Description | Required |
|---|---|---|
vm name | Specifies the name of the virtual server | Yes |
timeout | Specifies the timeout in milliseconds for BMC BladeLogic connection details | No |
user role | Specifies the user role for BMC BladeLogic connection details | No |
Start VM workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
power status | Provides the power state of the VM |
Stop VM workflow
This workflow stops a VM and changes the VM power status to Stopped.
Stop VM workflow inputs
Input | Description | Required |
|---|---|---|
vm name | Specifies the name of the virtual server | Yes |
timeout | Specifies the timeout in milliseconds for BMC BladeLogic connection details | No |
user role | Specifies the user role for BMC BladeLogic connection details | No |
Stop VM workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
power status | Provides the power state of the VM |
Update VM Property workflow
This workflow updates the property value of a VM instance.
Update VM Property workflow inputs
Input | Description | Required |
|---|---|---|
vm name | Specifies the name of the virtual server | Yes |
attribute value | Specifies the value of the property that is updated | Yes |
property name | Specifies the property to be updated | Yes |
timeout | Specifies the timeout in milliseconds for BMC BladeLogic connection details | No |
user role | Specifies the user role for BMC BladeLogic connection details | No |
Update VM Property workflow outputs
Output | Description |
|---|---|
success status | Indicates whether the workflow finished successfully |
status message | Provides a workflow-specific explanation for the value of success status |
Comments
Log in or register to comment.