Merge pull request #149 from ansible-hmc-org/dev-collection

v1.12.0 content

Author: naveenkandakur

.github/workflows/doc-publish.yaml

@@ -21,28 +21,27 @@ jobs:
 
     name: generate documenation source files
     steps:
-      - name: checkout repository
-        uses: actions/checkout@v4
-      - name: setup python
-        uses: actions/setup-python@v5.0.0
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: install document generation requirements
-        run: |
-          python -m pip install --upgrade pip
-          python -m pip install ansible
-          python -m pip install ansible-doc-extractor
-          python -m pip install sphinx
-          python -m pip install sphinx_rtd_theme
-          python -m pip install --upgrade myst-parser
-      - name: run document generator script
-        run: |
-          bash devops/bin/gen_doc.sh
-      - uses: actions/upload-artifact@v3
-        with:
-          name: hmc-doc-artifact
-          path: ./docs/build
-
+    - name: checkout repository
+      uses: actions/checkout@v4
+    - name: setup python
+      uses: actions/setup-python@v5.0.0
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: install document generation requirements
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install ansible
+        python -m pip install ansible-doc-extractor
+        python -m pip install sphinx
+        python -m pip install sphinx_rtd_theme
+        python -m pip install --upgrade myst-parser
+    - name: run document generator script
+      run: |
+        bash devops/bin/gen_doc.sh
+    - uses: actions/upload-artifact@v4
+      with:
+        name: hmc-doc-artifact
+        path: ./docs/build
   deploy-doc:
     runs-on: ubuntu-22.04
     needs: gen-doc
@@ -54,7 +53,7 @@ jobs:
       pages: write
 
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: hmc-doc-artifact
           path: .
@@ -63,10 +62,10 @@ jobs:
           # User need to set this secret on github actions
           token: ${{ secrets.TOKEN_PAM }}
           enablement: true
-      - uses: actions/upload-pages-artifact@v1
+      - uses: actions/upload-pages-artifact@v3
         with:
           path: .
       - id: deployment
-        uses: actions/deploy-pages@v3
+        uses: actions/deploy-pages@v4
         with:
           token: ${{ secrets.TOKEN_PAM }}

.github/workflows/unit-tests.yaml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        python-version: ['3.7']
+        python-version: ['3.7', '3.10', '3.11']
 
     name: running unit tests with python ${{ matrix.python-version }}
     steps:

CHANGELOG.rst

@@ -285,3 +285,22 @@ Notes
 
 .. _GitHub v1.11.0:
    https://github.com/IBM/ansible-power-hmc/releases/download/v1.11.0/ibm-power_hmc-1.11.0.tar.gz
+
+Version 1.12.0
+-------------
+Notes
+  * hmc_update_upgrade: Support for HMC upgrade through ibmwebsite(IBM Fixcentral website) and listing available upgrade images (Issue: #103)
+  * vios_alt_root_vg: Support for copying the root vg content to alternate disk and clean up existing alternate disk
+  * powervm_dlpar: Support for idempotency across all actions (Issues: #135 , #111)
+  * powervm_lpar_instance: Support for configuring advanced VNIC settings in lpar creation (Issue: #147)
+  * powervm_inventory: Fix for password reveal issue in warning message (Issue: #148)
+
+  Availability
+    * `Galaxy v1.12.0`_
+    * `GitHub v1.12.0`_
+
+.. _Galaxy v1.12.0:
+   https://galaxy.ansible.com/download/ibm-power_hmc-1.12.0.tar.gz
+
+.. _GitHub v1.12.0:
+   https://github.com/IBM/ansible-power-hmc/releases/download/v1.12.0/ibm-power_hmc-1.12.0.tar.gz

docs/source/release_notes.rst

@@ -285,3 +285,22 @@ Notes
 
 .. _GitHub v1.11.0:
    https://github.com/IBM/ansible-power-hmc/releases/download/v1.11.0/ibm-power_hmc-1.11.0.tar.gz
+
+Version 1.12.0
+-------------
+Notes
+  * hmc_update_upgrade: Support for HMC upgrade through ibmwebsite(IBM Fixcentral website) and listing available upgrade images (Issue: #103)
+  * vios_alt_root_vg: Support for copying the root vg content to alternate disk and clean up existing alternate disk
+  * powervm_dlpar: Support for idempotency across all actions (Issues: #135 , #111)
+  * powervm_lpar_instance: Support for configuring advanced VNIC settings in lpar creation (Issue: #147)
+  * powervm_inventory: Fix for password reveal issue in warning message (Issue: #148)
+
+  Availability
+    * `Galaxy v1.12.0`_
+    * `GitHub v1.12.0`_
+
+.. _Galaxy v1.12.0:
+   https://galaxy.ansible.com/download/ibm-power_hmc-1.12.0.tar.gz
+
+.. _GitHub v1.12.0:
+   https://github.com/IBM/ansible-power-hmc/releases/download/v1.12.0/ibm-power_hmc-1.12.0.tar.gz

galaxy.yml

@@ -7,7 +7,7 @@ namespace: ibm
 name: power_hmc
 
 # The version of the collection. Must be compatible with semantic versioning
-version: 1.11.0
+version: 1.12.0
 
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection

plugins/inventory/powervm_inventory.py

@@ -523,7 +523,7 @@ def get_lpars_by_system(self):
                     reraise(HmcError, "Error logging off HMC REST Service: %s" % error_msg, traceback)
             except Exception as error:
                 error_msg = parse_error_response(error)
-                msg = ("Unable to connect to HMC host %s: %s" % (hmc_host, error_msg))
+                msg = ("Unable to connect to HMC host %s: %s" % (hmc_host['hmc'], error_msg))
                 display.warning(msg=msg)
                 logger.debug(msg)
                 continue

plugins/module_utils/hmc_command_stack.py

@@ -45,6 +45,7 @@ class HmcCommandStack():
                'LSSYSCONN': 'lssysconn',
                'LSHMCLDAP': 'lshmcldap',
                'CHHMCLDAP': 'chhmcldap',
+               'LSUPGFILES': 'lsupgfiles',
                'LSUPDHMC': 'lsupdhmc',
                'MKVTERM': 'mkvterm',
                'RMVTERM': 'rmvterm',
@@ -130,14 +131,17 @@ class HmcCommandStack():
                    'GETUPGFILES': {'-R': {'FTP': ' -r ftp ',
                                           'SFTP': ' -r sftp ',
                                           'NFS': ' -r nfs ',
-                                          'DISK': ' -r disk '},
+                                          'DISK': ' -r disk ',
+                                          'IBMWEBSITE': ' -r ibmwebsite'},
                                    '-H': ' -h ',
                                    '-D': ' -d ',
                                    '-U': ' -u ',
                                    '--PASSWD': ' --passwd ',
                                    '-K': ' -k ',
                                    '-L': ' -l ',
-                                   '-O': ' -o '},
+                                   '-O': ' -o ',
+                                   '--PTF': ' --ptf'},
+                   'LSUPGFILES': {'-R': {'IBMWEBSITE': ' -r ibmwebsite '}},
                    'LSUPDHMC': {'-T': {'IBMWEBSITE': ' -t ibmwebsite '}},
                    'UPDHMC': {'-T': {'DISK': ' -t disk ',
                                      'DVD': ' -t dvd ',
@@ -347,7 +351,8 @@ class HmcCommandStack():
                    'VIOSVRCMD': {'-M': ' -m ',
                                  '-P': ' -p ',
                                  '-C': ' -c ',
-                                 '--ID': ' --id '},
+                                 '--ID': ' --id ',
+                                 '--ADMIN': ' --admin '},
                    'MKAUTHKEYS': {'-G': ' -g ',
                                   '--IP': ' --ip ',
                                   '-U': ' -u ',
@@ -422,9 +427,9 @@ class HmcCommandStack():
                                  'BINDDN': ' --binddn',
                                  'HMCAUTHNAMEATTRIBUTE': ' --hmcauthnameattribute',
                                  'STARTTLS': {'0': ' --starttls 0',
-                                              '1': '--starttls 1'},
-                                 'AUTH': {'LDAP': '--auth ldap',
-                                          'KERBEROS': '--auth kerberos'},
+                                              '1': ' --starttls 1'},
+                                 'AUTH': {'LDAP': ' --auth ldap',
+                                          'KERBEROS': ' --auth kerberos'},
                                  'TIMELIMIT': ' --timelimit',
                                  'BINDTIMELIMIT': ' --bindtimelimit',
                                  'LOGINATTRIBUTE': ' --loginattribute',
@@ -433,8 +438,8 @@ class HmcCommandStack():
                                  'SEARCHFILTER': ' --searchfilter',
                                  'SCOPE': {'ONE': ' --scope one',
                                            'SUB': ' --scope sub'},
-                                 'REFERRALS': {'1': '--referrals 1',
-                                               '0': '--referrals 0'},
+                                 'REFERRALS': {'1': ' --referrals 1',
+                                               '0': ' --referrals 0'},
                                  'HMCGROUPS': ' --hmcgroups',
                                  'AUTHSEARCH': {'BASE': ' --authsearch base',
                                                 'NONE': ' --authsearch none'},

plugins/module_utils/hmc_constants.py

@@ -1,3 +1,7 @@
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
 class HmcConstants():
     MTMS_pattern = r'^\d{4}-[A-Z\d]{3}\*[A-Z\d]{7}$'
     USER_AUTHORITY_ERR = "HSCL350B The user does not have the appropriate authority"

plugins/module_utils/hmc_resource.py

@@ -145,6 +145,15 @@ def hmcShutdown(self, numOfMin='now', reboot=False):
         if numOfMin != 'now':
             time.sleep(int(numOfMin) * 60)
 
+    def listUpgradeFiles(self, locationType, configDict=None):
+        hmcCmd = self.CMD['LSUPGFILES'] + \
+            self.OPT['LSUPGFILES']['-R'][locationType.upper()]
+
+        result = self.hmcconn.execute(hmcCmd)
+        if 'No results were found.' in result:
+            return 'No upgrade files available'
+        return self.cmdClass.parseMultiLineCSV(result)
+
     def getHMCUpgradeFiles(self, serverType, configDict=None):
         hmcCmd = self.CMD['GETUPGFILES'] + \
             self.OPT['GETUPGFILES']['-R'][serverType.upper()] + \
@@ -572,11 +581,15 @@ def getPartitionRefcode(self, system_name, name):
 
         return res
 
-    def runCommandOnVIOS(self, system_name, name, cmd):
+    def runCommandOnVIOS(self, system_name, name, cmd, flag=None):
         viosvrcmd = self.CMD['VIOSVRCMD'] +\
             self.OPT['VIOSVRCMD']['-M'] + system_name +\
-            self.OPT['VIOSVRCMD']['-P'] + name +\
-            self.OPT['VIOSVRCMD']['-C'] + '"' + cmd + '"'
+            self.OPT['VIOSVRCMD']['-P'] + name
+        if flag is True:
+            viosvrcmd += self.OPT['VIOSVRCMD']['--ADMIN']
+        viosvrcmd += self.OPT['VIOSVRCMD']['-C'] + '"' + cmd + '"'
+        if flag is not None:
+            return self.hmcconn.execute(viosvrcmd)
         self.hmcconn.execute(viosvrcmd)
 
     def authenticateHMCs(self, remote_hmc, username=None, passwd=None, test=False):
@@ -643,7 +656,7 @@ def createViosBk(self, configDict=None, enable=False, modify_type=None):
         output = ""
         for each in optional:
             if configDict.get(each) is not None:
-                opt.append(f"{each}={configDict[each]}")
+                opt.append("{}={}".format(each, configDict[each]))
         output = ','.join(opt)
         viosbk_cmd = self.CMD['MKVIOSBK'] + \
             self.OPT['MKVIOSBK']['-T'] + configDict['types'] + \