saltstack/salt

# -*- coding: utf-8 -*-
'''
Grains for iSCSI Qualified Names (IQN).

.. versionadded:: 2018.3.0

To enable these grains set `iscsi_grains: True`.

.. code-block:: yaml

    iscsi_grains: True
'''
# Import Python libs
from __future__ import absolute_import, print_function, unicode_literals

import errno
import logging

# Import Salt libs
import salt.modules.cmdmod
import salt.utils.files
import salt.utils.path
import salt.utils.platform

__virtualname__ = 'iscsi'

# Get logging started
log = logging.getLogger(__name__)


def __virtual__():
    if __opts__.get('iscsi_grains', False) is False:
        return False
    else:
        return __virtualname__


def iscsi_iqn():
    '''
    Return iSCSI IQN
    '''
    grains = {}
    grains['iscsi_iqn'] = False
    if salt.utils.platform.is_linux():
        grains['iscsi_iqn'] = _linux_iqn()
    elif salt.utils.platform.is_windows():
        grains['iscsi_iqn'] = _windows_iqn()
    elif salt.utils.platform.is_aix():
        grains['iscsi_iqn'] = _aix_iqn()
    return grains


def _linux_iqn():
    '''
    Return iSCSI IQN from a Linux host.
    '''
    ret = []

    initiator = '/etc/iscsi/initiatorname.iscsi'
    try:
        with salt.utils.files.fopen(initiator, 'r') as _iscsi:
            for line in _iscsi:
                line = line.strip()
                if line.startswith('InitiatorName='):
                    ret.append(line.split('=', 1)[1])
    except IOError as ex:
        if ex.errno != errno.ENOENT:
            log.debug("Error while accessing '%s': %s", initiator, ex)

    return ret


def _aix_iqn():
    '''
    Return iSCSI IQN from an AIX host.
    '''
    ret = []

    aix_cmd = 'lsattr -E -l iscsi0 | grep initiator_name'

    aix_ret = salt.modules.cmdmod.run(aix_cmd)
    if aix_ret[0].isalpha():
        try:
            ret.append(aix_ret.split()[1].rstrip())
        except IndexError:
            pass
    return ret


def _windows_iqn():
    '''
    Return iSCSI IQN from a Windows host.
    '''
    ret = []

    wmic = salt.utils.path.which('wmic')

    if not wmic:
        return ret

    namespace = r'\\root\WMI'
    path = 'MSiSCSIInitiator_MethodClass'
    get = 'iSCSINodeName'

    cmd_ret = salt.modules.cmdmod.run_all(
        '{0} /namespace:{1} path {2} get {3} /format:table'
        ''.format(wmic, namespace, path, get))

    for line in cmd_ret['stdout'].splitlines():
        if line.startswith('iqn.'):
            line = line.rstrip()
            ret.append(line.rstrip())

    return ret