Runbook scripts reside on and are executed from the management server (MSA)<\/a>.<\/p>\n\n\n\n
Steps to Execute Runbook Scripts<\/h3>\n\n\n\n\n- Log in to the MSA and create a scripts <\/em>folder under vme2<\/kbd><\/strong> (\/var\/lib\/vme2\/<\/kbd>).<\/li>\n\n\n\n
- Upload a pre-script and\/or post-script to the scripts <\/em>folder.<\/li>\n\n\n\n
- Make the uploaded scripts executable (Use the chmod +x<\/kbd><\/strong> option).<\/li>\n\n\n\n
- In the JetStream DR UI (Create Runbook Group <\/em>workflow) indicate the locations of the scripts and any parameters necessary to run the scripts.<\/li>\n<\/ul>\n\n\n\n
![\"\"](\"https:\/\/jetstreamsoft.com\/portal\/wp-content\/uploads\/2023\/06\/runbook-script.png\")
<\/figure>\n\n\n\nScript execution details can be reviewed from the MSA tasks logs.<\/p>\n\n\n\n
Script Configuration Example<\/h3>\n\n\n\nCopy scripts to MSA scripts folder<\/h5>\n\n\n\n
[root@fs074-msa3 scripts]# ls -lrh
total 12K
-rw-r--r--. 1 root root 5.9K Mar 24 15:36 pre-script.py
-rw-r--r--. 1 root root 4.0K Mar 24 10:16 post-script.py<\/code><\/p>\n\n\n\nMake scripts executable<\/h5>\n\n\n\n
[root@fs074-msa3 scripts]# chmod +x \/var\/lib\/vme2\/scripts\/*<\/code><\/p>\n\n\n\nVerify executable status of scripts<\/h5>\n\n\n\n
[root@fs074-msa3 scripts]# ls -lrh
total 12K
-rwxr-xr-x. 1 root root 5.9K Mar 24 15:36 pre-script.py
-rwxr-xr-x. 1 root root 4.0K Mar 24 10:16 post-script.py<\/code><\/p>\n\n\n\nTest Script<\/h3>\n\n\n\n
A sample test script is available from JetStream Software for evaluation purposes and can be used per the following guidelines:<\/p>\n\n\n\n
\n- Collect the sample script from the JetStream Software support team.
<\/li>\n\n\n\n - The script is written in Python and requires Python pyVmomi<\/strong> <\/em>SDK module version (8.0.0.1.2) to be installed on the MSA or manually updated.\n
\n- The script will not run correctly if the pyVmomi version is lower than (8.0.0.1.2).\n
\n- To check the version of pyVmomi currently installed, run the command:
pip3 show pyvmom<\/kbd><\/strong>i<\/strong><\/code><\/li>\n\n\n\n- If the version is incorrect, upgrade the module using the command:
pip3 install -U pyvmomi<\/kbd><\/strong>
\u00a0<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n\n\n\n- After placing the script in the correct folder and making it executable, run the help <\/strong>command to view its required parameters:
python3 post-script.py -help<\/kbd><\/strong>
\u00a0<\/li>\n\n\n\n- The script can be also be tested manually by executing the following syntax:
Python3 post-script.py -vi VCHOSTNAME -vu VCUSER -vp VCPASSWD -cl CLUSTERNAME -l VMSLIST -vmu VMUSER -vmp VMPASSWD -vmpc VMPROCESS<\/kbd><\/strong><\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"Changes can be made to Guest VMs after recovery by executing pre-scripts and post-scripts as part of runbook execution. Run-book scripts are custom scripts written in Python (.py) that can be created and applied by the user based upon their own specific requirements. Steps to Execute Runbook Scripts Script Configuration Example Copy scripts to MSA […]<\/p>\n","protected":false},"author":1,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"nf_dc_page":"","footnotes":""},"ht-kb-category":[245],"ht-kb-tag":[214],"class_list":["post-2571","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-how-to","ht_kb_tag-vmprotection"],"_links":{"self":[{"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/ht-kb\/2571","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/comments?post=2571"}],"version-history":[{"count":1,"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/ht-kb\/2571\/revisions"}],"predecessor-version":[{"id":5620,"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/ht-kb\/2571\/revisions\/5620"}],"wp:attachment":[{"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/media?parent=2571"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/ht-kb-category?post=2571"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/ht-kb-tag?post=2571"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
<\/figure>\n\n\n\nScript execution details can be reviewed from the MSA tasks logs.<\/p>\n\n\n\n
Script Configuration Example<\/h3>\n\n\n\nCopy scripts to MSA scripts folder<\/h5>\n\n\n\n
A sample test script is available from JetStream Software for evaluation purposes and can be used per the following guidelines:<\/p>\n\n\n\n Changes can be made to Guest VMs after recovery by executing pre-scripts and post-scripts as part of runbook execution. Run-book scripts are custom scripts written in Python (.py) that can be created and applied by the user based upon their own specific requirements. Steps to Execute Runbook Scripts Script Configuration Example Copy scripts to MSA […]<\/p>\n","protected":false},"author":1,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"nf_dc_page":"","footnotes":""},"ht-kb-category":[245],"ht-kb-tag":[214],"class_list":["post-2571","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-how-to","ht_kb_tag-vmprotection"],"_links":{"self":[{"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/ht-kb\/2571","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/comments?post=2571"}],"version-history":[{"count":1,"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/ht-kb\/2571\/revisions"}],"predecessor-version":[{"id":5620,"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/ht-kb\/2571\/revisions\/5620"}],"wp:attachment":[{"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/media?parent=2571"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/ht-kb-category?post=2571"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/jetstreamsoft.com\/portal\/wp-json\/wp\/v2\/ht-kb-tag?post=2571"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}[root@fs074-msa3 scripts]# ls -lrh
total 12K
-rw-r--r--. 1 root root 5.9K Mar 24 15:36 pre-script.py
-rw-r--r--. 1 root root 4.0K Mar 24 10:16 post-script.py<\/code><\/p>\n\n\n\nMake scripts executable<\/h5>\n\n\n\n
[root@fs074-msa3 scripts]# chmod +x \/var\/lib\/vme2\/scripts\/*<\/code><\/p>\n\n\n\nVerify executable status of scripts<\/h5>\n\n\n\n
[root@fs074-msa3 scripts]# ls -lrh
total 12K
-rwxr-xr-x. 1 root root 5.9K Mar 24 15:36 pre-script.py
-rwxr-xr-x. 1 root root 4.0K Mar 24 10:16 post-script.py<\/code><\/p>\n\n\n\nTest Script<\/h3>\n\n\n\n
\n
<\/li>\n\n\n\n\n
\n
pip3 show pyvmom<\/kbd><\/strong>i<\/strong><\/code><\/li>\n\n\n\n
pip3 install -U pyvmomi<\/kbd><\/strong>
\u00a0<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n\n\n\n
python3 post-script.py -help<\/kbd><\/strong>
\u00a0<\/li>\n\n\n\n
Python3 post-script.py -vi VCHOSTNAME -vu VCUSER -vp VCPASSWD -cl CLUSTERNAME -l VMSLIST -vmu VMUSER -vmp VMPASSWD -vmpc VMPROCESS<\/kbd><\/strong><\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"