This section lists the default workflows available in Workflow Hub for VMware Bare Metal Automation (BMA). These workflows are tested with VMware Telco Cloud Automation (TCA) 3.1. Infrastructure Automation workflows and BMA workflows are supported from the TCA 3.1 release onwards.
Parent Workflows
BMA Host imaging
Name | Id |
---|---|
BMA Host Imaging | bma-host-imaging |
This workflow can be used to perform Host imaging via TCA WorkdlowHub using VMware Bare Metal Automation.
ESXi host imaging and PhotonOS host imaging are the supported usecases.
Parameters | Description |
---|---|
bma | BMA IP |
worker_group | BMA Worker Group name |
workflow_bundle_name | Workflow Bundle name - Path of Workflow Eg:
|
workflow_name | Workflow name |
authentication | Authentication to access BMA instance and APIs authorization - "Its a fixed value as supported by BMA Platform" username - BMA Username password - Password to access the BMA scope - BMA API privileges |
host_imaging | This section encapsulates all the attributes to be passed onto BMA for imaging |
network_config | The network configuration. The supported values are dhcp and static.
|
custom_tag | Name to uniquely identify the Custom ISO Image name that is created for each host. This must be unique for every host presented. This parameter is not required to be presented if network_config is set to dhcp. Every block in the servers array section of the customer input specification must contain a custom_tag attribute and have a unique name assigned as value. |
global tag | Name to uniquely identify the global Custom ISO Image name that is created. This must be unique for every workflow (batch of hosts) presented. This parameter is not required to be presented if network_config is set to static. |
network_device_name | Specifies either the MAC address of the network card or the device name, in the form vmnicNN. For example, vmnic0. This option refers to the uplink device for the virtual switch. |
host_fqdn | Assign this attribute with complete FQDN of the host. |
vlanid | An ID String. (1-4094). This is the VLAN ID number. |
host_root_password | The password configured to access the host presented in the customer input specification after the imaging operation. You can access the host through SSH using this password. |
servers | It has the details of iDRAC/IMPI details and the details of the host with network configuration. It contains ipmi_ip, ipmi_username, ipmi_password as the mandatory fields. It also contains raid_level attribute which is configured on the iDRAC/IPMI which is optional. |
secret_key | Secret key used to decrypt password fields |
iso_image_info | This includes the VMware ISO image details about the location of the ISO image. This includes:
|
smtp_server_info | This section includes the:
|
locusId | Site identifier of the customer in TCSA context (Optional) |
market | Market name of the customer in TCSA context (Optional) |
model | Vendor model name in TCSA context (Optional) |
region | Region of the customer in TCSA context (Optional) |
vendor | Vendor name in TCSA context (Optional) |
url | TCSA Kafka URL with port number in TCSA context (Optional) |
BMA Host Imaging |
---|
{ "bma":"<ip address of BMA>", "worker_group":"<name of BMA worker group>", "workflow_bundle_name":"<name of the BMA workflow bundle>", "workflow_name":"<name of the BMA workflow>", "authentication":{ "authorization":"<basic authentication to access BMA>", "username":"<bma username>", "password":"<bma password>", "scope":"read+write+execute" }, "host_imaging":{ "network_config":"<value of network configuration either dhcp or static>", "host_root_password":"<host root password>", "network_device_name":"<name of network device>", "global_tag":"<name of global ISO image>", "vlanid":0, "servers":[ { "ipmi_ip":"<ip address of bare metal server>", "ipmi_username":"<username of bare metal server>", "ipmi_password":"<password of bare metal server>", "raid_level":0 }, { "ipmi_ip":"<ip address of bare metal server>", "ipmi_username":"<username of bare metal server>", "ipmi_password":"<password of bare metal server>", "raid_level":1 } ], "secret_key":"<secret key used to decrypt password fields>", "iso_image_info":{ "server_ip":"<ip address of web server>", "image_location":"<ip address of web server>", "image_url_scheme":"<URL scheme of web server>", "image_url_path":"<ISO image URL short path>", "image_name":"<ISO image name>", "username":"<username of web server>", "password":"<password of web server>", "os_type":"<type of operating system to be installed>" }, "smtp_server_info":{ "server_ip":"<ip address of SMTP server>", "port":"<port number of SMTP server>", "sender_address":"<email address of sender>", "recipient_mail_addresses":[ "<email addresses of recipients>" ], "username":"<username of the SMTP server - optional>", "password":"<password of the SMTP server - optional>" } }, "locusId":"<site identifier of the customer - optional>", "market":"<market name of the customer - optional>", "model":"<vendor model name - optional>", "region":"<region of the customer - optional>", "vendor":"<vendor name - optional>", "url":"<TCSA Kafka URL with port number - optional>" } |
BMA Server Information Collection
Name | Id |
---|---|
Collect Server Information | collect-server-information |
Parameters | Description |
---|---|
authentication | Authentication to access BMA instance and APIs authorization - "Its a fixed value as supported by BMA Platform" username - BMA Username password - Password to access the BMA scope - BMA API privileges |
bma | BMA IP |
iso_image_info | This has web server details where the server information records will be stored. This includes:
|
locusId | Site identifier of the customer in TCSA context (Optional) |
market | Market name of the customer in TCSA context (Optional) |
model | Vendor model name in TCSA context (Optional) |
region | Region of the customer in TCSA context (Optional) |
secret_key | Secret key used to decrypt password fields |
server_info_collection | This section encapsulates all the attributes to be passed onto BMA for server information collection |
servers | It has the details of iDRAC/IMPI details. It contains ipmi_ip, ipmi_username, ipmi_password as the mandatory fields |
smtp_server_info | This section includes the:
|
url | TCSA Kafka URL with port number in TCSA context (Optional) |
vendor | Vendor name in TCSA context (Optional) |
worker_group | BMA Worker Group name |
workflow_bundle_name | Workflow Bundle name - Path of Workflow Eg:
|
workflow_name | Workflow name |
{ "bma":"<ip address of BMA>", "worker_group":"<name of BMA worker group>", "workflow_bundle_name":"<name of the BMA workflow bundle>", "workflow_name":"<name of the BMA workflow>", "authentication":{ "authorization":"<basic authentication to access BMA>", "username":"<bma username>", "password":"<bma password>", "scope":"read+write+execute" }, "server_info_collection":{ "servers":[ { "ipmi_ip":"<ip address of bare metal server>", "ipmi_username":"<username of bare metal server>", "ipmi_password":"<password of bare metal server>" }, { "ipmi_ip":"<ip address of bare metal server>", "ipmi_username":"<username of bare metal server>", "ipmi_password":"<password of bare metal server>" } ], "secret_key":"<secret key used to decrypt password fields>", "iso_image_info":{ "server_ip":"<ip address of web server>", "username":"<username of web server>", "password":"<password of web server>" }, "smtp_server_info":{ "server_ip":"<ip address of SMTP server>", "port":"<port number of SMTP server>", "sender_address":"<email address of sender>", "recipient_mail_addresses":[ "<email addresses of recipients>" ], "username":"<username of the SMTP server - optional>", "password":"<password of the SMTP server - optional>" } }, "locusId":"<site identifier of the customer - optional>", "market":"<market name of the customer - optional>", "model":"<vendor model name - optional>", "region":"<region of the customer - optional>", "vendor":"<vendor name - optional>", "url":"<TCSA Kafka URL with port number - optional>" } |
BMA Firmware Update
Name | Id |
---|---|
BMA Firmware Update | bma-firmware-update |
Parameters | Description |
---|---|
bma | BMA IP |
worker_group | BMA Worker Group name |
workflow_bundle_name | Workflow Bundle name - Path of Workflow Eg:
|
workflow_name | Workflow name |
authentication | Authentication to access BMA instance and APIs authorization - "Its a fixed value as supported by BMA Platform" username - BMA Username password - Password to access the BMA scope - BMA API privileges |
firmware_update | This section encapsulates all the attributes to be passed onto BMA for firmware update |
system_images_location | URL - HTTP/HTTPS location of the Firmware images on the Web server |
servers | It has the details of iDRAC/IMPI details. It contains ipmi_ip, ipmi_username, ipmi_password, images as the mandatory fields |
secret_key | Secret key used to decrypt password fields |
smtp_server_info | This section includes the:
|
locusId | Site identifier of the customer in TCSA context (Optional) |
market | Market name of the customer in TCSA context (Optional) |
model | Vendor model name in TCSA context (Optional) |
region | Region of the customer in TCSA context (Optional) |
vendor | Vendor name in TCSA context (Optional) |
url | TCSA Kafka URL with port number in TCSA context (Optional) |
{ "bma":"<ip address of BMA>", "worker_group":"<name of BMA worker group>", "workflow_bundle_name":"<name of the BMA workflow bundle>", "workflow_name":"<name of the BMA workflow>", "authentication":{ "authorization":"<basic authentication to access BMA>", "username":"<bma username>", "password":"<bma password>", "scope":"read+write+execute" }, "firmware_update":{ "system_images_location":"<URL - HTTP/HTTPS location of the Firmware images on the Web server>", "servers":[ { "ipmi_ip":"<ip address of bare metal server>", "ipmi_username":"<username of bare metal server>", "ipmi_password":"<password of bare metal server>", "images":"<array of names of firmware images>" }, { "ipmi_ip":"<ip address of bare metal server>", "ipmi_username":"<username of bare metal server>", "ipmi_password":"<password of bare metal server>", "images":"<array of names of firmware images>" } ], "secret_key":"<secret key used to decrypt password fields>", "smtp_server_info":{ "server_ip":"<ip address of SMTP server>", "port":"<port number of SMTP server>", "sender_address":"<email address of sender>", "recipient_mail_addresses":[ "<email addresses of recipients>" ], "username":"<username of the SMTP server - optional>", "password":"<password of the SMTP server - optional>" } }, "locusId":"<site identifier of the customer - optional>", "market":"<market name of the customer - optional>", "model":"<vendor model name - optional>", "region":"<region of the customer - optional>", "vendor":"<vendor name - optional>", "url":"<TCSA Kafka URL with port number - optional>" } |