\n\n .. versionadded:: 2015.8.0\n '''\n profile = __opts__['profiles'].get(kwargs['profile'], {})\n if not profile:\n return {'Error': 'The requested profile was not found'}\n\n # Make sure the profile belongs to ec2\n provider = profile.get('provider', '0:0')\n comps = provider.split(':')\n if len(comps) < 2 or comps[1] != 'ec2':\n return {'Error': 'The requested profile does not belong to EC2'}\n\n image_id = profile.get('image', None)\n image_dict = show_image({'image': image_id}, 'function')\n image_info = image_dict[0]\n\n # Find out what platform it is\n if image_info.get('imageOwnerAlias', '') == 'amazon':\n if image_info.get('platform', '') == 'windows':\n image_description = image_info.get('description', '')\n if 'sql' in image_description.lower():\n if 'web' in image_description.lower():\n name = 'mswinsqlweb'\n else:\n name = 'mswinsql'\n else:\n name = 'mswin'\n elif image_info.get('imageLocation', '').strip().startswith('amazon/suse'):\n name = 'sles'\n else:\n name = 'linux'\n elif image_info.get('imageOwnerId', '') == '309956199498':\n name = 'rhel'\n else:\n name = 'linux'\n\n pricefile = os.path.join(\n __opts__['cachedir'], 'ec2-pricing-{0}.p'.format(name)\n )\n\n if not os.path.isfile(pricefile):\n update_pricing({'type': name}, 'function')\n\n with salt.utils.files.fopen(pricefile, 'r') as fhi:\n ec2_price = salt.utils.stringutils.to_unicode(\n salt.utils.msgpack.load(fhi))\n\n region = get_location(profile)\n size = profile.get('size', None)\n if size is None:\n return {'Error': 'The requested profile does not contain a size'}\n\n try:\n raw = ec2_price[region][size]\n except KeyError:\n return {'Error': 'The size ({0}) in the requested profile does not have '\n 'a price associated with it for the {1} region'.format(size, region)}\n\n ret = {}\n if kwargs.get('raw', False):\n ret['_raw'] = raw\n\n ret['per_hour'] = 0\n for col in raw.get('valueColumns', []):\n ret['per_hour'] += decimal.Decimal(col['prices'].get('USD', 0))\n\n ret['per_hour'] = decimal.Decimal(ret['per_hour'])\n ret['per_day'] = ret['per_hour'] * 24\n ret['per_week'] = ret['per_day'] * 7\n ret['per_month'] = ret['per_day'] * 30\n ret['per_year'] = ret['per_week'] * 52\n\n return {profile['profile']: ret}\n\n\ndef ssm_create_association(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Associates the specified SSM document with the specified instance\n\n http://docs.aws.amazon.com/ssm/latest/APIReference/API_CreateAssociation.html\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a ssm_create_association ec2-instance-name ssm_document=ssm-document-name\n '''\n\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The ssm_create_association action must be called with '\n '-a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'ssm_document' not in kwargs:\n log.error('A ssm_document is required.')\n return False\n\n params = {'Action': 'CreateAssociation',\n 'InstanceId': instance_id,\n 'Name': kwargs['ssm_document']}\n\n result = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n product='ssm',\n opts=__opts__,\n sigver='4')\n log.info(result)\n return result\n\n\ndef ssm_describe_association(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Describes the associations for the specified SSM document or instance.\n\n http://docs.aws.amazon.com/ssm/latest/APIReference/API_DescribeAssociation.html\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a ssm_describe_association ec2-instance-name ssm_document=ssm-document-name\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The ssm_describe_association action must be called with '\n '-a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'ssm_document' not in kwargs:\n log.error('A ssm_document is required.')\n return False\n\n params = {'Action': 'DescribeAssociation',\n 'InstanceId': instance_id,\n 'Name': kwargs['ssm_document']}\n\n result = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n product='ssm',\n opts=__opts__,\n sigver='4')\n log.info(result)\n return result\n"}}},{"rowIdx":353,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/cloud/clouds/ec2.py"},"func_name":{"kind":"string","value":"get_console_output"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def get_console_output(\n name=None,\n location=None,\n instance_id=None,\n call=None,\n kwargs=None,\n ):\n '''\n Show the console output from the instance.\n\n By default, returns decoded data, not the Base64-encoded data that is\n actually returned from the EC2 API.\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The get_console_output action must be called with '\n '-a or --action.'\n )\n\n if location is None:\n location = get_location()\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if kwargs is None:\n kwargs = {}\n\n if instance_id is None:\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n params = {'Action': 'GetConsoleOutput',\n 'InstanceId': instance_id}\n\n ret = {}\n data = aws.query(params,\n return_root=True,\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for item in data:\n if next(six.iterkeys(item)) == 'output':\n ret['output_decoded'] = binascii.a2b_base64(next(six.itervalues(item)))\n else:\n ret[next(six.iterkeys(item))] = next(six.itervalues(item))\n\n return ret"},"func_documentation_string":{"kind":"string","value":"Show the console output from the instance.\n\n By default, returns decoded data, not the Base64-encoded data that is\n actually returned from the EC2 API."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4798-L4848"},"called_functions":{"kind":"list like","value":["def iterkeys(d, **kw):\n return d.iterkeys(**kw)\n","def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_comps[0]\n return provider\n","def query(params=None, setname=None, requesturl=None, location=None,\n return_url=False, return_root=False, opts=None, provider=None,\n endpoint=None, product='ec2', sigver='2'):\n '''\n Perform a query against AWS services using Signature Version 2 Signing\n Process. This is documented at:\n\n http://docs.aws.amazon.com/general/latest/gr/signature-version-2.html\n\n Regions and endpoints are documented at:\n\n http://docs.aws.amazon.com/general/latest/gr/rande.html\n\n Default ``product`` is ``ec2``. Valid ``product`` names are:\n\n .. code-block: yaml\n\n - autoscaling (Auto Scaling)\n - cloudformation (CloudFormation)\n - ec2 (Elastic Compute Cloud)\n - elasticache (ElastiCache)\n - elasticbeanstalk (Elastic BeanStalk)\n - elasticloadbalancing (Elastic Load Balancing)\n - elasticmapreduce (Elastic MapReduce)\n - iam (Identity and Access Management)\n - importexport (Import/Export)\n - monitoring (CloudWatch)\n - rds (Relational Database Service)\n - simpledb (SimpleDB)\n - sns (Simple Notification Service)\n - sqs (Simple Queue Service)\n '''\n if params is None:\n params = {}\n\n if opts is None:\n opts = {}\n\n function = opts.get('function', (None, product))\n providers = opts.get('providers', {})\n\n if provider is None:\n prov_dict = providers.get(function[1], {}).get(product, {})\n if prov_dict:\n driver = list(list(prov_dict.keys()))[0]\n provider = providers.get(driver, product)\n else:\n prov_dict = providers.get(provider, {}).get(product, {})\n\n service_url = prov_dict.get('service_url', 'amazonaws.com')\n\n if not location:\n location = get_location(opts, prov_dict)\n\n if endpoint is None:\n if not requesturl:\n endpoint = prov_dict.get(\n 'endpoint',\n '{0}.{1}.{2}'.format(product, location, service_url)\n )\n\n requesturl = 'https://{0}/'.format(endpoint)\n else:\n endpoint = urlparse(requesturl).netloc\n if endpoint == '':\n endpoint_err = ('Could not find a valid endpoint in the '\n 'requesturl: {0}. Looking for something '\n 'like https://some.aws.endpoint/?args').format(\n requesturl\n )\n log.error(endpoint_err)\n if return_url is True:\n return {'error': endpoint_err}, requesturl\n return {'error': endpoint_err}\n\n log.debug('Using AWS endpoint: %s', endpoint)\n method = 'GET'\n\n aws_api_version = prov_dict.get(\n 'aws_api_version', prov_dict.get(\n '{0}_api_version'.format(product),\n DEFAULT_AWS_API_VERSION\n )\n )\n\n # Fallback to ec2's id & key if none is found, for this component\n if not prov_dict.get('id', None):\n prov_dict['id'] = providers.get(provider, {}).get('ec2', {}).get('id', {})\n prov_dict['key'] = providers.get(provider, {}).get('ec2', {}).get('key', {})\n\n if sigver == '4':\n headers, requesturl = sig4(\n method, endpoint, params, prov_dict, aws_api_version, location, product, requesturl=requesturl\n )\n params_with_headers = {}\n else:\n params_with_headers = sig2(\n method, endpoint, params, prov_dict, aws_api_version\n )\n headers = {}\n\n attempts = 0\n while attempts < AWS_MAX_RETRIES:\n log.debug('AWS Request: %s', requesturl)\n log.trace('AWS Request Parameters: %s', params_with_headers)\n try:\n result = requests.get(requesturl, headers=headers, params=params_with_headers)\n log.debug('AWS Response Status Code: %s', result.status_code)\n log.trace(\n 'AWS Response Text: %s',\n result.text\n )\n result.raise_for_status()\n break\n except requests.exceptions.HTTPError as exc:\n root = ET.fromstring(exc.response.content)\n data = xml.to_dict(root)\n\n # check to see if we should retry the query\n err_code = data.get('Errors', {}).get('Error', {}).get('Code', '')\n if attempts < AWS_MAX_RETRIES and err_code and err_code in AWS_RETRY_CODES:\n attempts += 1\n log.error(\n 'AWS Response Status Code and Error: [%s %s] %s; '\n 'Attempts remaining: %s',\n exc.response.status_code, exc, data, attempts\n )\n sleep_exponential_backoff(attempts)\n continue\n\n log.error(\n 'AWS Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n else:\n log.error(\n 'AWS Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n\n root = ET.fromstring(result.text)\n items = root[1]\n if return_root is True:\n items = root\n\n if setname:\n if sys.version_info < (2, 7):\n children_len = len(root.getchildren())\n else:\n children_len = len(root)\n\n for item in range(0, children_len):\n comps = root[item].tag.split('}')\n if comps[1] == setname:\n items = root[item]\n\n ret = []\n for item in items:\n ret.append(xml.to_dict(item))\n\n if return_url is True:\n return ret, requesturl\n\n return ret\n","def get_location(vm_=None):\n '''\n Return the EC2 region to use, in this order:\n - CLI parameter\n - VM parameter\n - Cloud profile setting\n '''\n return __opts__.get(\n 'location',\n config.get_cloud_config_value(\n 'location',\n vm_ or get_configured_provider(),\n __opts__,\n default=DEFAULT_LOCATION,\n search_global=False\n )\n )\n","def _get_node(name=None, instance_id=None, location=None):\n if location is None:\n location = get_location()\n\n params = {'Action': 'DescribeInstances'}\n\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if instance_id:\n params['InstanceId.1'] = instance_id\n else:\n params['Filter.1.Name'] = 'tag:Name'\n params['Filter.1.Value.1'] = name\n\n log.trace(params)\n\n provider = get_provider()\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n try:\n instances = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n instance_info = _extract_instance_info(instances).values()\n return next(iter(instance_info))\n except IndexError:\n attempts += 1\n log.debug(\n 'Failed to get the data for node \\'%s\\'. Remaining '\n 'attempts: %s', instance_id or name, attempts\n )\n aws.sleep_exponential_backoff(attempts)\n return {}\n"],"string":"[\n \"def iterkeys(d, **kw):\\n return d.iterkeys(**kw)\\n\",\n \"def get_provider(vm_=None):\\n '''\\n Extract the provider name from vm\\n '''\\n if vm_ is None:\\n provider = __active_provider_name__ or 'ec2'\\n else:\\n provider = vm_.get('provider', 'ec2')\\n\\n if ':' in provider:\\n prov_comps = provider.split(':')\\n provider = prov_comps[0]\\n return provider\\n\",\n \"def query(params=None, setname=None, requesturl=None, location=None,\\n return_url=False, return_root=False, opts=None, provider=None,\\n endpoint=None, product='ec2', sigver='2'):\\n '''\\n Perform a query against AWS services using Signature Version 2 Signing\\n Process. This is documented at:\\n\\n http://docs.aws.amazon.com/general/latest/gr/signature-version-2.html\\n\\n Regions and endpoints are documented at:\\n\\n http://docs.aws.amazon.com/general/latest/gr/rande.html\\n\\n Default ``product`` is ``ec2``. Valid ``product`` names are:\\n\\n .. code-block: yaml\\n\\n - autoscaling (Auto Scaling)\\n - cloudformation (CloudFormation)\\n - ec2 (Elastic Compute Cloud)\\n - elasticache (ElastiCache)\\n - elasticbeanstalk (Elastic BeanStalk)\\n - elasticloadbalancing (Elastic Load Balancing)\\n - elasticmapreduce (Elastic MapReduce)\\n - iam (Identity and Access Management)\\n - importexport (Import/Export)\\n - monitoring (CloudWatch)\\n - rds (Relational Database Service)\\n - simpledb (SimpleDB)\\n - sns (Simple Notification Service)\\n - sqs (Simple Queue Service)\\n '''\\n if params is None:\\n params = {}\\n\\n if opts is None:\\n opts = {}\\n\\n function = opts.get('function', (None, product))\\n providers = opts.get('providers', {})\\n\\n if provider is None:\\n prov_dict = providers.get(function[1], {}).get(product, {})\\n if prov_dict:\\n driver = list(list(prov_dict.keys()))[0]\\n provider = providers.get(driver, product)\\n else:\\n prov_dict = providers.get(provider, {}).get(product, {})\\n\\n service_url = prov_dict.get('service_url', 'amazonaws.com')\\n\\n if not location:\\n location = get_location(opts, prov_dict)\\n\\n if endpoint is None:\\n if not requesturl:\\n endpoint = prov_dict.get(\\n 'endpoint',\\n '{0}.{1}.{2}'.format(product, location, service_url)\\n )\\n\\n requesturl = 'https://{0}/'.format(endpoint)\\n else:\\n endpoint = urlparse(requesturl).netloc\\n if endpoint == '':\\n endpoint_err = ('Could not find a valid endpoint in the '\\n 'requesturl: {0}. Looking for something '\\n 'like https://some.aws.endpoint/?args').format(\\n requesturl\\n )\\n log.error(endpoint_err)\\n if return_url is True:\\n return {'error': endpoint_err}, requesturl\\n return {'error': endpoint_err}\\n\\n log.debug('Using AWS endpoint: %s', endpoint)\\n method = 'GET'\\n\\n aws_api_version = prov_dict.get(\\n 'aws_api_version', prov_dict.get(\\n '{0}_api_version'.format(product),\\n DEFAULT_AWS_API_VERSION\\n )\\n )\\n\\n # Fallback to ec2's id & key if none is found, for this component\\n if not prov_dict.get('id', None):\\n prov_dict['id'] = providers.get(provider, {}).get('ec2', {}).get('id', {})\\n prov_dict['key'] = providers.get(provider, {}).get('ec2', {}).get('key', {})\\n\\n if sigver == '4':\\n headers, requesturl = sig4(\\n method, endpoint, params, prov_dict, aws_api_version, location, product, requesturl=requesturl\\n )\\n params_with_headers = {}\\n else:\\n params_with_headers = sig2(\\n method, endpoint, params, prov_dict, aws_api_version\\n )\\n headers = {}\\n\\n attempts = 0\\n while attempts < AWS_MAX_RETRIES:\\n log.debug('AWS Request: %s', requesturl)\\n log.trace('AWS Request Parameters: %s', params_with_headers)\\n try:\\n result = requests.get(requesturl, headers=headers, params=params_with_headers)\\n log.debug('AWS Response Status Code: %s', result.status_code)\\n log.trace(\\n 'AWS Response Text: %s',\\n result.text\\n )\\n result.raise_for_status()\\n break\\n except requests.exceptions.HTTPError as exc:\\n root = ET.fromstring(exc.response.content)\\n data = xml.to_dict(root)\\n\\n # check to see if we should retry the query\\n err_code = data.get('Errors', {}).get('Error', {}).get('Code', '')\\n if attempts < AWS_MAX_RETRIES and err_code and err_code in AWS_RETRY_CODES:\\n attempts += 1\\n log.error(\\n 'AWS Response Status Code and Error: [%s %s] %s; '\\n 'Attempts remaining: %s',\\n exc.response.status_code, exc, data, attempts\\n )\\n sleep_exponential_backoff(attempts)\\n continue\\n\\n log.error(\\n 'AWS Response Status Code and Error: [%s %s] %s',\\n exc.response.status_code, exc, data\\n )\\n if return_url is True:\\n return {'error': data}, requesturl\\n return {'error': data}\\n else:\\n log.error(\\n 'AWS Response Status Code and Error: [%s %s] %s',\\n exc.response.status_code, exc, data\\n )\\n if return_url is True:\\n return {'error': data}, requesturl\\n return {'error': data}\\n\\n root = ET.fromstring(result.text)\\n items = root[1]\\n if return_root is True:\\n items = root\\n\\n if setname:\\n if sys.version_info < (2, 7):\\n children_len = len(root.getchildren())\\n else:\\n children_len = len(root)\\n\\n for item in range(0, children_len):\\n comps = root[item].tag.split('}')\\n if comps[1] == setname:\\n items = root[item]\\n\\n ret = []\\n for item in items:\\n ret.append(xml.to_dict(item))\\n\\n if return_url is True:\\n return ret, requesturl\\n\\n return ret\\n\",\n \"def get_location(vm_=None):\\n '''\\n Return the EC2 region to use, in this order:\\n - CLI parameter\\n - VM parameter\\n - Cloud profile setting\\n '''\\n return __opts__.get(\\n 'location',\\n config.get_cloud_config_value(\\n 'location',\\n vm_ or get_configured_provider(),\\n __opts__,\\n default=DEFAULT_LOCATION,\\n search_global=False\\n )\\n )\\n\",\n \"def _get_node(name=None, instance_id=None, location=None):\\n if location is None:\\n location = get_location()\\n\\n params = {'Action': 'DescribeInstances'}\\n\\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\\n instance_id = name\\n\\n if instance_id:\\n params['InstanceId.1'] = instance_id\\n else:\\n params['Filter.1.Name'] = 'tag:Name'\\n params['Filter.1.Value.1'] = name\\n\\n log.trace(params)\\n\\n provider = get_provider()\\n\\n attempts = 0\\n while attempts < aws.AWS_MAX_RETRIES:\\n try:\\n instances = aws.query(params,\\n location=location,\\n provider=provider,\\n opts=__opts__,\\n sigver='4')\\n instance_info = _extract_instance_info(instances).values()\\n return next(iter(instance_info))\\n except IndexError:\\n attempts += 1\\n log.debug(\\n 'Failed to get the data for node \\\\'%s\\\\'. Remaining '\\n 'attempts: %s', instance_id or name, attempts\\n )\\n aws.sleep_exponential_backoff(attempts)\\n return {}\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nThe EC2 Cloud Module\n====================\n\nThe EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.\n\nTo use the EC2 cloud module, set up the cloud configuration at\n ``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:\n\n.. code-block:: yaml\n\n my-ec2-config:\n # EC2 API credentials: Access Key ID and Secret Access Key.\n # Alternatively, to use IAM Instance Role credentials available via\n # EC2 metadata set both id and key to 'use-instance-role-credentials'\n id: GKTADJGHEIQSXMKKRBJ08H\n key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs\n\n # If 'role_arn' is specified the above credentials are used to\n # to assume to the role. By default, role_arn is set to None.\n role_arn: arn:aws:iam::012345678910:role/SomeRoleName\n\n # The ssh keyname to use\n keyname: default\n # The amazon security group\n securitygroup: ssh_open\n # The location of the private key which corresponds to the keyname\n private_key: /root/default.pem\n\n # Be default, service_url is set to amazonaws.com. If you are using this\n # driver for something other than Amazon EC2, change it here:\n service_url: amazonaws.com\n\n # The endpoint that is ultimately used is usually formed using the region\n # and the service_url. If you would like to override that entirely, you\n # can explicitly define the endpoint:\n endpoint: myendpoint.example.com:1138/services/Cloud\n\n # SSH Gateways can be used with this provider. Gateways can be used\n # when a salt-master is not on the same private network as the instance\n # that is being deployed.\n\n # Defaults to None\n # Required\n ssh_gateway: gateway.example.com\n\n # Defaults to port 22\n # Optional\n ssh_gateway_port: 22\n\n # Defaults to root\n # Optional\n ssh_gateway_username: root\n\n # Default to nc -q0 %h %p\n # Optional\n ssh_gateway_command: \"-W %h:%p\"\n\n # One authentication method is required. If both\n # are specified, Private key wins.\n\n # Private key defaults to None\n ssh_gateway_private_key: /path/to/key.pem\n\n # Password defaults to None\n ssh_gateway_password: ExamplePasswordHere\n\n driver: ec2\n\n # Pass userdata to the instance to be created\n userdata_file: /etc/salt/my-userdata-file\n\n # Instance termination protection setting\n # Default is disabled\n termination_protection: False\n\n:depends: requests\n'''\n# pylint: disable=invalid-name,function-redefined\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport os\nimport sys\nimport stat\nimport time\nimport uuid\nimport pprint\nimport logging\n\n# Import libs for talking to the EC2 API\nimport hmac\nimport hashlib\nimport binascii\nimport datetime\nimport base64\nimport re\nimport decimal\n\n# Import Salt Libs\nimport salt.utils.cloud\nimport salt.utils.compat\nimport salt.utils.files\nimport salt.utils.hashutils\nimport salt.utils.json\nimport salt.utils.msgpack\nimport salt.utils.stringutils\nimport salt.utils.yaml\nfrom salt._compat import ElementTree as ET\nimport salt.utils.http as http\nimport salt.utils.aws as aws\nimport salt.config as config\nfrom salt.exceptions import (\n SaltCloudException,\n SaltCloudSystemExit,\n SaltCloudConfigError,\n SaltCloudExecutionTimeout,\n SaltCloudExecutionFailure\n)\n\n# pylint: disable=import-error,no-name-in-module,redefined-builtin\nfrom salt.ext import six\nfrom salt.ext.six.moves import map, range, zip\nfrom salt.ext.six.moves.urllib.parse import urlparse as _urlparse, urlencode as _urlencode\n\n# Import 3rd-Party Libs\n# Try to import PyCrypto, which may not be installed on a RAET-based system\ntry:\n from M2Crypto import RSA\n HAS_M2 = True\nexcept ImportError:\n HAS_M2 = False\n\ntry:\n import Crypto\n # PKCS1_v1_5 was added in PyCrypto 2.5\n from Crypto.Cipher import PKCS1_v1_5 # pylint: disable=E0611\n from Crypto.Hash import SHA # pylint: disable=E0611,W0611\n HAS_PYCRYPTO = True\nexcept ImportError:\n HAS_PYCRYPTO = False\n\ntry:\n import requests\n HAS_REQUESTS = True\nexcept ImportError:\n HAS_REQUESTS = False\n# pylint: enable=import-error,no-name-in-module,redefined-builtin\n\n# Get logging started\nlog = logging.getLogger(__name__)\n\n\nEC2_LOCATIONS = {\n 'ap-northeast-1': 'ec2_ap_northeast',\n 'ap-northeast-2': 'ec2_ap_northeast_2',\n 'ap-southeast-1': 'ec2_ap_southeast',\n 'ap-southeast-2': 'ec2_ap_southeast_2',\n 'eu-west-1': 'ec2_eu_west',\n 'eu-central-1': 'ec2_eu_central',\n 'sa-east-1': 'ec2_sa_east',\n 'us-east-1': 'ec2_us_east',\n 'us-gov-west-1': 'ec2_us_gov_west_1',\n 'us-west-1': 'ec2_us_west',\n 'us-west-2': 'ec2_us_west_oregon',\n}\nDEFAULT_LOCATION = 'us-east-1'\n\nDEFAULT_EC2_API_VERSION = '2014-10-01'\n\nEC2_RETRY_CODES = [\n 'RequestLimitExceeded',\n 'InsufficientInstanceCapacity',\n 'InternalError',\n 'Unavailable',\n 'InsufficientAddressCapacity',\n 'InsufficientReservedInstanceCapacity',\n]\n\nJS_COMMENT_RE = re.compile(r'/\\*.*?\\*/', re.S)\n\n__virtualname__ = 'ec2'\n\n\n# Only load in this module if the EC2 configurations are in place\ndef __virtual__():\n '''\n Set up the libcloud functions and check for EC2 configurations\n '''\n if get_configured_provider() is False:\n return False\n\n if get_dependencies() is False:\n return False\n\n return __virtualname__\n\n\ndef get_configured_provider():\n '''\n Return the first configured instance.\n '''\n return config.is_provider_configured(\n __opts__,\n __active_provider_name__ or __virtualname__,\n ('id', 'key')\n )\n\n\ndef get_dependencies():\n '''\n Warn if dependencies aren't met.\n '''\n deps = {\n 'requests': HAS_REQUESTS,\n 'pycrypto or m2crypto': HAS_M2 or HAS_PYCRYPTO\n }\n return config.check_driver_dependencies(\n __virtualname__,\n deps\n )\n\n\ndef _xml_to_dict(xmltree):\n '''\n Convert an XML tree into a dict\n '''\n if sys.version_info < (2, 7):\n children_len = len(xmltree.getchildren())\n else:\n children_len = len(xmltree)\n\n if children_len < 1:\n name = xmltree.tag\n if '}' in name:\n comps = name.split('}')\n name = comps[1]\n return {name: xmltree.text}\n\n xmldict = {}\n for item in xmltree:\n name = item.tag\n if '}' in name:\n comps = name.split('}')\n name = comps[1]\n if name not in xmldict:\n if sys.version_info < (2, 7):\n children_len = len(item.getchildren())\n else:\n children_len = len(item)\n\n if children_len > 0:\n xmldict[name] = _xml_to_dict(item)\n else:\n xmldict[name] = item.text\n else:\n if not isinstance(xmldict[name], list):\n tempvar = xmldict[name]\n xmldict[name] = []\n xmldict[name].append(tempvar)\n xmldict[name].append(_xml_to_dict(item))\n return xmldict\n\n\ndef optimize_providers(providers):\n '''\n Return an optimized list of providers.\n\n We want to reduce the duplication of querying\n the same region.\n\n If a provider is using the same credentials for the same region\n the same data will be returned for each provider, thus causing\n un-wanted duplicate data and API calls to EC2.\n\n '''\n tmp_providers = {}\n optimized_providers = {}\n\n for name, data in six.iteritems(providers):\n if 'location' not in data:\n data['location'] = DEFAULT_LOCATION\n\n if data['location'] not in tmp_providers:\n tmp_providers[data['location']] = {}\n\n creds = (data['id'], data['key'])\n if creds not in tmp_providers[data['location']]:\n tmp_providers[data['location']][creds] = {'name': name,\n 'data': data,\n }\n\n for location, tmp_data in six.iteritems(tmp_providers):\n for creds, data in six.iteritems(tmp_data):\n _id, _key = creds\n _name = data['name']\n _data = data['data']\n if _name not in optimized_providers:\n optimized_providers[_name] = _data\n\n return optimized_providers\n\n\ndef sign(key, msg):\n return hmac.new(key, msg.encode('utf-8'), hashlib.sha256).digest()\n\n\ndef query(params=None, setname=None, requesturl=None, location=None,\n return_url=False, return_root=False):\n\n provider = get_configured_provider()\n service_url = provider.get('service_url', 'amazonaws.com')\n\n # Retrieve access credentials from meta-data, or use provided\n access_key_id, secret_access_key, token = aws.creds(provider)\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n params_with_headers = params.copy()\n timestamp = datetime.datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%SZ')\n\n if not location:\n location = get_location()\n\n if not requesturl:\n endpoint = provider.get(\n 'endpoint',\n 'ec2.{0}.{1}'.format(location, service_url)\n )\n\n requesturl = 'https://{0}/'.format(endpoint)\n endpoint = _urlparse(requesturl).netloc\n endpoint_path = _urlparse(requesturl).path\n else:\n endpoint = _urlparse(requesturl).netloc\n endpoint_path = _urlparse(requesturl).path\n if endpoint == '':\n endpoint_err = (\n 'Could not find a valid endpoint in the '\n 'requesturl: {0}. Looking for something '\n 'like https://some.ec2.endpoint/?args').format(requesturl)\n log.error(endpoint_err)\n if return_url is True:\n return {'error': endpoint_err}, requesturl\n return {'error': endpoint_err}\n\n log.debug('Using EC2 endpoint: %s', endpoint)\n # AWS v4 signature\n\n method = 'GET'\n region = location\n service = 'ec2'\n canonical_uri = _urlparse(requesturl).path\n host = endpoint.strip()\n\n # Create a date for headers and the credential string\n t = datetime.datetime.utcnow()\n amz_date = t.strftime('%Y%m%dT%H%M%SZ') # Format date as YYYYMMDD'T'HHMMSS'Z'\n datestamp = t.strftime('%Y%m%d') # Date w/o time, used in credential scope\n\n canonical_headers = 'host:' + host + '\\n' + 'x-amz-date:' + amz_date + '\\n'\n signed_headers = 'host;x-amz-date'\n\n payload_hash = salt.utils.hashutils.sha256_digest('')\n\n ec2_api_version = provider.get(\n 'ec2_api_version',\n DEFAULT_EC2_API_VERSION\n )\n\n params_with_headers['Version'] = ec2_api_version\n\n keys = sorted(list(params_with_headers))\n values = map(params_with_headers.get, keys)\n querystring = _urlencode(list(zip(keys, values)))\n querystring = querystring.replace('+', '%20')\n\n canonical_request = method + '\\n' + canonical_uri + '\\n' + \\\n querystring + '\\n' + canonical_headers + '\\n' + \\\n signed_headers + '\\n' + payload_hash\n\n algorithm = 'AWS4-HMAC-SHA256'\n credential_scope = datestamp + '/' + region + '/' + service + '/' + 'aws4_request'\n\n string_to_sign = algorithm + '\\n' + amz_date + '\\n' + \\\n credential_scope + '\\n' + \\\n salt.utils.hashutils.sha256_digest(canonical_request)\n\n kDate = sign(('AWS4' + provider['key']).encode('utf-8'), datestamp)\n kRegion = sign(kDate, region)\n kService = sign(kRegion, service)\n signing_key = sign(kService, 'aws4_request')\n\n signature = hmac.new(signing_key, (string_to_sign).encode('utf-8'),\n hashlib.sha256).hexdigest()\n\n authorization_header = algorithm + ' ' + 'Credential=' + \\\n provider['id'] + '/' + credential_scope + \\\n ', ' + 'SignedHeaders=' + signed_headers + \\\n ', ' + 'Signature=' + signature\n headers = {'x-amz-date': amz_date, 'Authorization': authorization_header}\n\n log.debug('EC2 Request: %s', requesturl)\n log.trace('EC2 Request Parameters: %s', params_with_headers)\n try:\n result = requests.get(requesturl, headers=headers, params=params_with_headers)\n log.debug(\n 'EC2 Response Status Code: %s',\n # result.getcode()\n result.status_code\n )\n log.trace('EC2 Response Text: %s', result.text)\n result.raise_for_status()\n break\n except requests.exceptions.HTTPError as exc:\n root = ET.fromstring(exc.response.content)\n data = _xml_to_dict(root)\n\n # check to see if we should retry the query\n err_code = data.get('Errors', {}).get('Error', {}).get('Code', '')\n if err_code and err_code in EC2_RETRY_CODES:\n attempts += 1\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s; '\n 'Attempts remaining: %s',\n exc.response.status_code, exc, data, attempts\n )\n aws.sleep_exponential_backoff(attempts)\n continue\n\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n else:\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n\n response = result.text\n\n root = ET.fromstring(response)\n items = root[1]\n if return_root is True:\n items = root\n\n if setname:\n if sys.version_info < (2, 7):\n children_len = len(root.getchildren())\n else:\n children_len = len(root)\n\n for item in range(0, children_len):\n comps = root[item].tag.split('}')\n if comps[1] == setname:\n items = root[item]\n\n ret = []\n for item in items:\n ret.append(_xml_to_dict(item))\n\n if return_url is True:\n return ret, requesturl\n\n return ret\n\n\ndef _wait_for_spot_instance(update_callback,\n update_args=None,\n update_kwargs=None,\n timeout=10 * 60,\n interval=30,\n interval_multiplier=1,\n max_failures=10):\n '''\n Helper function that waits for a spot instance request to become active\n for a specific maximum amount of time.\n\n :param update_callback: callback function which queries the cloud provider\n for spot instance request. It must return None if\n the required data, running instance included, is\n not available yet.\n :param update_args: Arguments to pass to update_callback\n :param update_kwargs: Keyword arguments to pass to update_callback\n :param timeout: The maximum amount of time(in seconds) to wait for the IP\n address.\n :param interval: The looping interval, i.e., the amount of time to sleep\n before the next iteration.\n :param interval_multiplier: Increase the interval by this multiplier after\n each request; helps with throttling\n :param max_failures: If update_callback returns ``False`` it's considered\n query failure. This value is the amount of failures\n accepted before giving up.\n :returns: The update_callback returned data\n :raises: SaltCloudExecutionTimeout\n\n '''\n if update_args is None:\n update_args = ()\n if update_kwargs is None:\n update_kwargs = {}\n\n duration = timeout\n while True:\n log.debug(\n 'Waiting for spot instance reservation. Giving up in '\n '00:%02d:%02d', int(timeout // 60), int(timeout % 60)\n )\n data = update_callback(*update_args, **update_kwargs)\n if data is False:\n log.debug(\n 'update_callback has returned False which is considered a '\n 'failure. Remaining Failures: %s', max_failures\n )\n max_failures -= 1\n if max_failures <= 0:\n raise SaltCloudExecutionFailure(\n 'Too many failures occurred while waiting for '\n 'the spot instance reservation to become active.'\n )\n elif data is not None:\n return data\n\n if timeout < 0:\n raise SaltCloudExecutionTimeout(\n 'Unable to get an active spot instance request for '\n '00:{0:02d}:{1:02d}'.format(\n int(duration // 60),\n int(duration % 60)\n )\n )\n time.sleep(interval)\n timeout -= interval\n\n if interval_multiplier > 1:\n interval *= interval_multiplier\n if interval > timeout:\n interval = timeout + 1\n log.info('Interval multiplier in effect; interval is '\n 'now %ss', interval)\n\n\ndef avail_sizes(call=None):\n '''\n Return a dict of all available VM sizes on the cloud provider with\n relevant data. Latest version can be found at:\n\n http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_sizes function must be called with '\n '-f or --function, or with the --list-sizes option'\n )\n\n sizes = {\n 'Cluster Compute': {\n 'cc2.8xlarge': {\n 'id': 'cc2.8xlarge',\n 'cores': '16 (2 x Intel Xeon E5-2670, eight-core with '\n 'hyperthread)',\n 'disk': '3360 GiB (4 x 840 GiB)',\n 'ram': '60.5 GiB'\n },\n 'cc1.4xlarge': {\n 'id': 'cc1.4xlarge',\n 'cores': '8 (2 x Intel Xeon X5570, quad-core with '\n 'hyperthread)',\n 'disk': '1690 GiB (2 x 840 GiB)',\n 'ram': '22.5 GiB'\n },\n },\n 'Cluster CPU': {\n 'cg1.4xlarge': {\n 'id': 'cg1.4xlarge',\n 'cores': '8 (2 x Intel Xeon X5570, quad-core with '\n 'hyperthread), plus 2 NVIDIA Tesla M2050 GPUs',\n 'disk': '1680 GiB (2 x 840 GiB)',\n 'ram': '22.5 GiB'\n },\n },\n 'Compute Optimized': {\n 'c4.large': {\n 'id': 'c4.large',\n 'cores': '2',\n 'disk': 'EBS - 500 Mbps',\n 'ram': '3.75 GiB'\n },\n 'c4.xlarge': {\n 'id': 'c4.xlarge',\n 'cores': '4',\n 'disk': 'EBS - 750 Mbps',\n 'ram': '7.5 GiB'\n },\n 'c4.2xlarge': {\n 'id': 'c4.2xlarge',\n 'cores': '8',\n 'disk': 'EBS - 1000 Mbps',\n 'ram': '15 GiB'\n },\n 'c4.4xlarge': {\n 'id': 'c4.4xlarge',\n 'cores': '16',\n 'disk': 'EBS - 2000 Mbps',\n 'ram': '30 GiB'\n },\n 'c4.8xlarge': {\n 'id': 'c4.8xlarge',\n 'cores': '36',\n 'disk': 'EBS - 4000 Mbps',\n 'ram': '60 GiB'\n },\n 'c3.large': {\n 'id': 'c3.large',\n 'cores': '2',\n 'disk': '32 GiB (2 x 16 GiB SSD)',\n 'ram': '3.75 GiB'\n },\n 'c3.xlarge': {\n 'id': 'c3.xlarge',\n 'cores': '4',\n 'disk': '80 GiB (2 x 40 GiB SSD)',\n 'ram': '7.5 GiB'\n },\n 'c3.2xlarge': {\n 'id': 'c3.2xlarge',\n 'cores': '8',\n 'disk': '160 GiB (2 x 80 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'c3.4xlarge': {\n 'id': 'c3.4xlarge',\n 'cores': '16',\n 'disk': '320 GiB (2 x 160 GiB SSD)',\n 'ram': '30 GiB'\n },\n 'c3.8xlarge': {\n 'id': 'c3.8xlarge',\n 'cores': '32',\n 'disk': '640 GiB (2 x 320 GiB SSD)',\n 'ram': '60 GiB'\n }\n },\n 'Dense Storage': {\n 'd2.xlarge': {\n 'id': 'd2.xlarge',\n 'cores': '4',\n 'disk': '6 TiB (3 x 2 TiB hard disk drives)',\n 'ram': '30.5 GiB'\n },\n 'd2.2xlarge': {\n 'id': 'd2.2xlarge',\n 'cores': '8',\n 'disk': '12 TiB (6 x 2 TiB hard disk drives)',\n 'ram': '61 GiB'\n },\n 'd2.4xlarge': {\n 'id': 'd2.4xlarge',\n 'cores': '16',\n 'disk': '24 TiB (12 x 2 TiB hard disk drives)',\n 'ram': '122 GiB'\n },\n 'd2.8xlarge': {\n 'id': 'd2.8xlarge',\n 'cores': '36',\n 'disk': '24 TiB (24 x 2 TiB hard disk drives)',\n 'ram': '244 GiB'\n },\n },\n 'GPU': {\n 'g2.2xlarge': {\n 'id': 'g2.2xlarge',\n 'cores': '8',\n 'disk': '60 GiB (1 x 60 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'g2.8xlarge': {\n 'id': 'g2.8xlarge',\n 'cores': '32',\n 'disk': '240 GiB (2 x 120 GiB SSD)',\n 'ram': '60 GiB'\n },\n },\n 'GPU Compute': {\n 'p2.xlarge': {\n 'id': 'p2.xlarge',\n 'cores': '4',\n 'disk': 'EBS',\n 'ram': '61 GiB'\n },\n 'p2.8xlarge': {\n 'id': 'p2.8xlarge',\n 'cores': '32',\n 'disk': 'EBS',\n 'ram': '488 GiB'\n },\n 'p2.16xlarge': {\n 'id': 'p2.16xlarge',\n 'cores': '64',\n 'disk': 'EBS',\n 'ram': '732 GiB'\n },\n },\n 'High I/O': {\n 'i2.xlarge': {\n 'id': 'i2.xlarge',\n 'cores': '4',\n 'disk': 'SSD (1 x 800 GiB)',\n 'ram': '30.5 GiB'\n },\n 'i2.2xlarge': {\n 'id': 'i2.2xlarge',\n 'cores': '8',\n 'disk': 'SSD (2 x 800 GiB)',\n 'ram': '61 GiB'\n },\n 'i2.4xlarge': {\n 'id': 'i2.4xlarge',\n 'cores': '16',\n 'disk': 'SSD (4 x 800 GiB)',\n 'ram': '122 GiB'\n },\n 'i2.8xlarge': {\n 'id': 'i2.8xlarge',\n 'cores': '32',\n 'disk': 'SSD (8 x 800 GiB)',\n 'ram': '244 GiB'\n }\n },\n 'High Memory': {\n 'x1.16xlarge': {\n 'id': 'x1.16xlarge',\n 'cores': '64 (with 5.45 ECUs each)',\n 'disk': '1920 GiB (1 x 1920 GiB)',\n 'ram': '976 GiB'\n },\n 'x1.32xlarge': {\n 'id': 'x1.32xlarge',\n 'cores': '128 (with 2.73 ECUs each)',\n 'disk': '3840 GiB (2 x 1920 GiB)',\n 'ram': '1952 GiB'\n },\n 'r4.large': {\n 'id': 'r4.large',\n 'cores': '2 (with 3.45 ECUs each)',\n 'disk': 'EBS',\n 'ram': '15.25 GiB'\n },\n 'r4.xlarge': {\n 'id': 'r4.xlarge',\n 'cores': '4 (with 3.35 ECUs each)',\n 'disk': 'EBS',\n 'ram': '30.5 GiB'\n },\n 'r4.2xlarge': {\n 'id': 'r4.2xlarge',\n 'cores': '8 (with 3.35 ECUs each)',\n 'disk': 'EBS',\n 'ram': '61 GiB'\n },\n 'r4.4xlarge': {\n 'id': 'r4.4xlarge',\n 'cores': '16 (with 3.3 ECUs each)',\n 'disk': 'EBS',\n 'ram': '122 GiB'\n },\n 'r4.8xlarge': {\n 'id': 'r4.8xlarge',\n 'cores': '32 (with 3.1 ECUs each)',\n 'disk': 'EBS',\n 'ram': '244 GiB'\n },\n 'r4.16xlarge': {\n 'id': 'r4.16xlarge',\n 'cores': '64 (with 3.05 ECUs each)',\n 'disk': 'EBS',\n 'ram': '488 GiB'\n },\n 'r3.large': {\n 'id': 'r3.large',\n 'cores': '2 (with 3.25 ECUs each)',\n 'disk': '32 GiB (1 x 32 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'r3.xlarge': {\n 'id': 'r3.xlarge',\n 'cores': '4 (with 3.25 ECUs each)',\n 'disk': '80 GiB (1 x 80 GiB SSD)',\n 'ram': '30.5 GiB'\n },\n 'r3.2xlarge': {\n 'id': 'r3.2xlarge',\n 'cores': '8 (with 3.25 ECUs each)',\n 'disk': '160 GiB (1 x 160 GiB SSD)',\n 'ram': '61 GiB'\n },\n 'r3.4xlarge': {\n 'id': 'r3.4xlarge',\n 'cores': '16 (with 3.25 ECUs each)',\n 'disk': '320 GiB (1 x 320 GiB SSD)',\n 'ram': '122 GiB'\n },\n 'r3.8xlarge': {\n 'id': 'r3.8xlarge',\n 'cores': '32 (with 3.25 ECUs each)',\n 'disk': '640 GiB (2 x 320 GiB SSD)',\n 'ram': '244 GiB'\n }\n },\n 'High-Memory Cluster': {\n 'cr1.8xlarge': {\n 'id': 'cr1.8xlarge',\n 'cores': '16 (2 x Intel Xeon E5-2670, eight-core)',\n 'disk': '240 GiB (2 x 120 GiB SSD)',\n 'ram': '244 GiB'\n },\n },\n 'High Storage': {\n 'hs1.8xlarge': {\n 'id': 'hs1.8xlarge',\n 'cores': '16 (8 cores + 8 hyperthreads)',\n 'disk': '48 TiB (24 x 2 TiB hard disk drives)',\n 'ram': '117 GiB'\n },\n },\n 'General Purpose': {\n 't2.nano': {\n 'id': 't2.nano',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '512 MiB'\n },\n 't2.micro': {\n 'id': 't2.micro',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '1 GiB'\n },\n 't2.small': {\n 'id': 't2.small',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '2 GiB'\n },\n 't2.medium': {\n 'id': 't2.medium',\n 'cores': '2',\n 'disk': 'EBS',\n 'ram': '4 GiB'\n },\n 't2.large': {\n 'id': 't2.large',\n 'cores': '2',\n 'disk': 'EBS',\n 'ram': '8 GiB'\n },\n 't2.xlarge': {\n 'id': 't2.xlarge',\n 'cores': '4',\n 'disk': 'EBS',\n 'ram': '16 GiB'\n },\n 't2.2xlarge': {\n 'id': 't2.2xlarge',\n 'cores': '8',\n 'disk': 'EBS',\n 'ram': '32 GiB'\n },\n 'm4.large': {\n 'id': 'm4.large',\n 'cores': '2',\n 'disk': 'EBS - 450 Mbps',\n 'ram': '8 GiB'\n },\n 'm4.xlarge': {\n 'id': 'm4.xlarge',\n 'cores': '4',\n 'disk': 'EBS - 750 Mbps',\n 'ram': '16 GiB'\n },\n 'm4.2xlarge': {\n 'id': 'm4.2xlarge',\n 'cores': '8',\n 'disk': 'EBS - 1000 Mbps',\n 'ram': '32 GiB'\n },\n 'm4.4xlarge': {\n 'id': 'm4.4xlarge',\n 'cores': '16',\n 'disk': 'EBS - 2000 Mbps',\n 'ram': '64 GiB'\n },\n 'm4.10xlarge': {\n 'id': 'm4.10xlarge',\n 'cores': '40',\n 'disk': 'EBS - 4000 Mbps',\n 'ram': '160 GiB'\n },\n 'm4.16xlarge': {\n 'id': 'm4.16xlarge',\n 'cores': '64',\n 'disk': 'EBS - 10000 Mbps',\n 'ram': '256 GiB'\n },\n 'm3.medium': {\n 'id': 'm3.medium',\n 'cores': '1',\n 'disk': 'SSD (1 x 4)',\n 'ram': '3.75 GiB'\n },\n 'm3.large': {\n 'id': 'm3.large',\n 'cores': '2',\n 'disk': 'SSD (1 x 32)',\n 'ram': '7.5 GiB'\n },\n 'm3.xlarge': {\n 'id': 'm3.xlarge',\n 'cores': '4',\n 'disk': 'SSD (2 x 40)',\n 'ram': '15 GiB'\n },\n 'm3.2xlarge': {\n 'id': 'm3.2xlarge',\n 'cores': '8',\n 'disk': 'SSD (2 x 80)',\n 'ram': '30 GiB'\n },\n }\n }\n return sizes\n\n\ndef avail_images(kwargs=None, call=None):\n '''\n Return a dict of all available VM images on the cloud provider.\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_images function must be called with '\n '-f or --function, or with the --list-images option'\n )\n\n if not isinstance(kwargs, dict):\n kwargs = {}\n\n if 'owner' in kwargs:\n owner = kwargs['owner']\n else:\n provider = get_configured_provider()\n\n owner = config.get_cloud_config_value(\n 'owner', provider, __opts__, default='amazon'\n )\n\n ret = {}\n params = {'Action': 'DescribeImages',\n 'Owner': owner}\n images = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for image in images:\n ret[image['imageId']] = image\n return ret\n\n\ndef script(vm_):\n '''\n Return the script deployment object\n '''\n return salt.utils.cloud.os_script(\n config.get_cloud_config_value('script', vm_, __opts__),\n vm_,\n __opts__,\n salt.utils.cloud.salt_config_to_yaml(\n salt.utils.cloud.minion_config(__opts__, vm_)\n )\n )\n\n\ndef keyname(vm_):\n '''\n Return the keyname\n '''\n return config.get_cloud_config_value(\n 'keyname', vm_, __opts__, search_global=False\n )\n\n\ndef securitygroup(vm_):\n '''\n Return the security group\n '''\n return config.get_cloud_config_value(\n 'securitygroup', vm_, __opts__, search_global=False\n )\n\n\ndef iam_profile(vm_):\n '''\n Return the IAM profile.\n\n The IAM instance profile to associate with the instances.\n This is either the Amazon Resource Name (ARN) of the instance profile\n or the name of the role.\n\n Type: String\n\n Default: None\n\n Required: No\n\n Example: arn:aws:iam::111111111111:instance-profile/s3access\n\n Example: s3access\n\n '''\n return config.get_cloud_config_value(\n 'iam_profile', vm_, __opts__, search_global=False\n )\n\n\ndef ssh_interface(vm_):\n '''\n Return the ssh_interface type to connect to. Either 'public_ips' (default)\n or 'private_ips'.\n '''\n ret = config.get_cloud_config_value(\n 'ssh_interface', vm_, __opts__, default='public_ips',\n search_global=False\n )\n if ret not in ('public_ips', 'private_ips'):\n log.warning(\n 'Invalid ssh_interface: %s. '\n 'Allowed options are (\"public_ips\", \"private_ips\"). '\n 'Defaulting to \"public_ips\".', ret\n )\n ret = 'public_ips'\n return ret\n\n\ndef get_ssh_gateway_config(vm_):\n '''\n Return the ssh_gateway configuration.\n '''\n ssh_gateway = config.get_cloud_config_value(\n 'ssh_gateway', vm_, __opts__, default=None,\n search_global=False\n )\n\n # Check to see if a SSH Gateway will be used.\n if not isinstance(ssh_gateway, six.string_types):\n return None\n\n # Create dictionary of configuration items\n\n # ssh_gateway\n ssh_gateway_config = {'ssh_gateway': ssh_gateway}\n\n # ssh_gateway_port\n ssh_gateway_config['ssh_gateway_port'] = config.get_cloud_config_value(\n 'ssh_gateway_port', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_username\n ssh_gateway_config['ssh_gateway_user'] = config.get_cloud_config_value(\n 'ssh_gateway_username', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_private_key\n ssh_gateway_config['ssh_gateway_key'] = config.get_cloud_config_value(\n 'ssh_gateway_private_key', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_password\n ssh_gateway_config['ssh_gateway_password'] = config.get_cloud_config_value(\n 'ssh_gateway_password', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_command\n ssh_gateway_config['ssh_gateway_command'] = config.get_cloud_config_value(\n 'ssh_gateway_command', vm_, __opts__, default=None,\n search_global=False\n )\n\n # Check if private key exists\n key_filename = ssh_gateway_config['ssh_gateway_key']\n if key_filename is not None and not os.path.isfile(key_filename):\n raise SaltCloudConfigError(\n 'The defined ssh_gateway_private_key \\'{0}\\' does not exist'\n .format(key_filename)\n )\n elif (\n key_filename is None and\n not ssh_gateway_config['ssh_gateway_password']\n ):\n raise SaltCloudConfigError(\n 'No authentication method. Please define: '\n ' ssh_gateway_password or ssh_gateway_private_key'\n )\n\n return ssh_gateway_config\n\n\ndef get_location(vm_=None):\n '''\n Return the EC2 region to use, in this order:\n - CLI parameter\n - VM parameter\n - Cloud profile setting\n '''\n return __opts__.get(\n 'location',\n config.get_cloud_config_value(\n 'location',\n vm_ or get_configured_provider(),\n __opts__,\n default=DEFAULT_LOCATION,\n search_global=False\n )\n )\n\n\ndef avail_locations(call=None):\n '''\n List all available locations\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_locations function must be called with '\n '-f or --function, or with the --list-locations option'\n )\n\n ret = {}\n\n params = {'Action': 'DescribeRegions'}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for region in result:\n ret[region['regionName']] = {\n 'name': region['regionName'],\n 'endpoint': region['regionEndpoint'],\n }\n\n return ret\n\n\ndef get_availability_zone(vm_):\n '''\n Return the availability zone to use\n '''\n avz = config.get_cloud_config_value(\n 'availability_zone', vm_, __opts__, search_global=False\n )\n\n if avz is None:\n return None\n\n zones = _list_availability_zones(vm_)\n\n # Validate user-specified AZ\n if avz not in zones:\n raise SaltCloudException(\n 'The specified availability zone isn\\'t valid in this region: '\n '{0}\\n'.format(\n avz\n )\n )\n\n # check specified AZ is available\n elif zones[avz] != 'available':\n raise SaltCloudException(\n 'The specified availability zone isn\\'t currently available: '\n '{0}\\n'.format(\n avz\n )\n )\n\n return avz\n\n\ndef get_tenancy(vm_):\n '''\n Returns the Tenancy to use.\n\n Can be \"dedicated\" or \"default\". Cannot be present for spot instances.\n '''\n return config.get_cloud_config_value(\n 'tenancy', vm_, __opts__, search_global=False\n )\n\n\ndef get_imageid(vm_):\n '''\n Returns the ImageId to use\n '''\n image = config.get_cloud_config_value(\n 'image', vm_, __opts__, search_global=False\n )\n if image.startswith('ami-'):\n return image\n # a poor man's cache\n if not hasattr(get_imageid, 'images'):\n get_imageid.images = {}\n elif image in get_imageid.images:\n return get_imageid.images[image]\n params = {'Action': 'DescribeImages',\n 'Filter.0.Name': 'name',\n 'Filter.0.Value.0': image}\n # Query AWS, sort by 'creationDate' and get the last imageId\n _t = lambda x: datetime.datetime.strptime(x['creationDate'], '%Y-%m-%dT%H:%M:%S.%fZ')\n image_id = sorted(aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'),\n lambda i, j: salt.utils.compat.cmp(_t(i), _t(j))\n )[-1]['imageId']\n get_imageid.images[image] = image_id\n return image_id\n\n\ndef _get_subnetname_id(subnetname):\n '''\n Returns the SubnetId of a SubnetName to use\n '''\n params = {'Action': 'DescribeSubnets'}\n for subnet in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n tags = subnet.get('tagSet', {}).get('item', {})\n if not isinstance(tags, list):\n tags = [tags]\n for tag in tags:\n if tag['key'] == 'Name' and tag['value'] == subnetname:\n log.debug(\n 'AWS Subnet ID of %s is %s',\n subnetname, subnet['subnetId']\n )\n return subnet['subnetId']\n return None\n\n\ndef get_subnetid(vm_):\n '''\n Returns the SubnetId to use\n '''\n subnetid = config.get_cloud_config_value(\n 'subnetid', vm_, __opts__, search_global=False\n )\n if subnetid:\n return subnetid\n\n subnetname = config.get_cloud_config_value(\n 'subnetname', vm_, __opts__, search_global=False\n )\n if subnetname:\n return _get_subnetname_id(subnetname)\n return None\n\n\ndef _get_securitygroupname_id(securitygroupname_list):\n '''\n Returns the SecurityGroupId of a SecurityGroupName to use\n '''\n securitygroupid_set = set()\n if not isinstance(securitygroupname_list, list):\n securitygroupname_list = [securitygroupname_list]\n params = {'Action': 'DescribeSecurityGroups'}\n for sg in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n if sg['groupName'] in securitygroupname_list:\n log.debug(\n 'AWS SecurityGroup ID of %s is %s',\n sg['groupName'], sg['groupId']\n )\n securitygroupid_set.add(sg['groupId'])\n return list(securitygroupid_set)\n\n\ndef securitygroupid(vm_):\n '''\n Returns the SecurityGroupId\n '''\n securitygroupid_set = set()\n securitygroupid_list = config.get_cloud_config_value(\n 'securitygroupid',\n vm_,\n __opts__,\n search_global=False\n )\n # If the list is None, then the set will remain empty\n # If the list is already a set then calling 'set' on it is a no-op\n # If the list is a string, then calling 'set' generates a one-element set\n # If the list is anything else, stacktrace\n if securitygroupid_list:\n securitygroupid_set = securitygroupid_set.union(set(securitygroupid_list))\n\n securitygroupname_list = config.get_cloud_config_value(\n 'securitygroupname', vm_, __opts__, search_global=False\n )\n if securitygroupname_list:\n if not isinstance(securitygroupname_list, list):\n securitygroupname_list = [securitygroupname_list]\n params = {'Action': 'DescribeSecurityGroups'}\n for sg in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n if sg['groupName'] in securitygroupname_list:\n log.debug(\n 'AWS SecurityGroup ID of %s is %s',\n sg['groupName'], sg['groupId']\n )\n securitygroupid_set.add(sg['groupId'])\n return list(securitygroupid_set)\n\n\ndef get_placementgroup(vm_):\n '''\n Returns the PlacementGroup to use\n '''\n return config.get_cloud_config_value(\n 'placementgroup', vm_, __opts__, search_global=False\n )\n\n\ndef get_spot_config(vm_):\n '''\n Returns the spot instance configuration for the provided vm\n '''\n return config.get_cloud_config_value(\n 'spot_config', vm_, __opts__, search_global=False\n )\n\n\ndef get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_comps[0]\n return provider\n\n\ndef _list_availability_zones(vm_=None):\n '''\n List all availability zones in the current region\n '''\n ret = {}\n\n params = {'Action': 'DescribeAvailabilityZones',\n 'Filter.0.Name': 'region-name',\n 'Filter.0.Value.0': get_location(vm_)}\n result = aws.query(params,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for zone in result:\n ret[zone['zoneName']] = zone['zoneState']\n\n return ret\n\n\ndef block_device_mappings(vm_):\n '''\n Return the block device mapping:\n\n .. code-block:: python\n\n [{'DeviceName': '/dev/sdb', 'VirtualName': 'ephemeral0'},\n {'DeviceName': '/dev/sdc', 'VirtualName': 'ephemeral1'}]\n '''\n return config.get_cloud_config_value(\n 'block_device_mappings', vm_, __opts__, search_global=True\n )\n\n\ndef _request_eip(interface, vm_):\n '''\n Request and return Elastic IP\n '''\n params = {'Action': 'AllocateAddress'}\n params['Domain'] = interface.setdefault('domain', 'vpc')\n eips = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n for eip in eips:\n if 'allocationId' in eip:\n return eip['allocationId']\n return None\n\n\ndef _create_eni_if_necessary(interface, vm_):\n '''\n Create an Elastic Interface if necessary and return a Network Interface Specification\n '''\n if 'NetworkInterfaceId' in interface and interface['NetworkInterfaceId'] is not None:\n return {'DeviceIndex': interface['DeviceIndex'],\n 'NetworkInterfaceId': interface['NetworkInterfaceId']}\n\n params = {'Action': 'DescribeSubnets'}\n subnet_query = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if 'SecurityGroupId' not in interface and 'securitygroupname' in interface:\n interface['SecurityGroupId'] = _get_securitygroupname_id(interface['securitygroupname'])\n if 'SubnetId' not in interface and 'subnetname' in interface:\n interface['SubnetId'] = _get_subnetname_id(interface['subnetname'])\n\n subnet_id = _get_subnet_id_for_interface(subnet_query, interface)\n if not subnet_id:\n raise SaltCloudConfigError(\n 'No such subnet <{0}>'.format(interface.get('SubnetId'))\n )\n params = {'SubnetId': subnet_id}\n\n for k in 'Description', 'PrivateIpAddress', 'SecondaryPrivateIpAddressCount':\n if k in interface:\n params[k] = interface[k]\n\n for k in 'PrivateIpAddresses', 'SecurityGroupId':\n if k in interface:\n params.update(_param_from_config(k, interface[k]))\n\n if 'AssociatePublicIpAddress' in interface:\n # Associating a public address in a VPC only works when the interface is not\n # created beforehand, but as a part of the machine creation request.\n for k in ('DeviceIndex', 'AssociatePublicIpAddress', 'NetworkInterfaceId'):\n if k in interface:\n params[k] = interface[k]\n params['DeleteOnTermination'] = interface.get('delete_interface_on_terminate', True)\n return params\n\n params['Action'] = 'CreateNetworkInterface'\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n eni_desc = result[1]\n if not eni_desc or not eni_desc.get('networkInterfaceId'):\n raise SaltCloudException('Failed to create interface: {0}'.format(result))\n\n eni_id = eni_desc.get('networkInterfaceId')\n log.debug(\n 'Created network interface %s inst %s',\n eni_id, interface['DeviceIndex']\n )\n\n associate_public_ip = interface.get('AssociatePublicIpAddress', False)\n if isinstance(associate_public_ip, six.string_types):\n # Assume id of EIP as value\n _associate_eip_with_interface(eni_id, associate_public_ip, vm_=vm_)\n\n if interface.get('associate_eip'):\n _associate_eip_with_interface(eni_id, interface.get('associate_eip'), vm_=vm_)\n elif interface.get('allocate_new_eip'):\n _new_eip = _request_eip(interface, vm_)\n _associate_eip_with_interface(eni_id, _new_eip, vm_=vm_)\n elif interface.get('allocate_new_eips'):\n addr_list = _list_interface_private_addrs(eni_desc)\n eip_list = []\n for idx, addr in enumerate(addr_list):\n eip_list.append(_request_eip(interface, vm_))\n for idx, addr in enumerate(addr_list):\n _associate_eip_with_interface(eni_id, eip_list[idx], addr, vm_=vm_)\n\n if 'Name' in interface:\n tag_params = {'Action': 'CreateTags',\n 'ResourceId.0': eni_id,\n 'Tag.0.Key': 'Name',\n 'Tag.0.Value': interface['Name']}\n tag_response = aws.query(tag_params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in tag_response:\n log.error('Failed to set name of interface {0}')\n\n return {'DeviceIndex': interface['DeviceIndex'],\n 'NetworkInterfaceId': eni_id}\n\n\ndef _get_subnet_id_for_interface(subnet_query, interface):\n for subnet_query_result in subnet_query:\n if 'item' in subnet_query_result:\n if isinstance(subnet_query_result['item'], dict):\n subnet_id = _get_subnet_from_subnet_query(subnet_query_result['item'],\n interface)\n if subnet_id is not None:\n return subnet_id\n\n else:\n for subnet in subnet_query_result['item']:\n subnet_id = _get_subnet_from_subnet_query(subnet, interface)\n if subnet_id is not None:\n return subnet_id\n\n\ndef _get_subnet_from_subnet_query(subnet_query, interface):\n if 'subnetId' in subnet_query:\n if interface.get('SubnetId'):\n if subnet_query['subnetId'] == interface['SubnetId']:\n return subnet_query['subnetId']\n else:\n return subnet_query['subnetId']\n\n\ndef _list_interface_private_addrs(eni_desc):\n '''\n Returns a list of all of the private IP addresses attached to a\n network interface. The 'primary' address will be listed first.\n '''\n primary = eni_desc.get('privateIpAddress')\n if not primary:\n return None\n\n addresses = [primary]\n\n lst = eni_desc.get('privateIpAddressesSet', {}).get('item', [])\n if not isinstance(lst, list):\n return addresses\n\n for entry in lst:\n if entry.get('primary') == 'true':\n continue\n if entry.get('privateIpAddress'):\n addresses.append(entry.get('privateIpAddress'))\n\n return addresses\n\n\ndef _modify_eni_properties(eni_id, properties=None, vm_=None):\n '''\n Change properties of the interface\n with id eni_id to the values in properties dict\n '''\n if not isinstance(properties, dict):\n raise SaltCloudException(\n 'ENI properties must be a dictionary'\n )\n\n params = {'Action': 'ModifyNetworkInterfaceAttribute',\n 'NetworkInterfaceId': eni_id}\n for k, v in six.iteritems(properties):\n params[k] = v\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if isinstance(result, dict) and result.get('error'):\n raise SaltCloudException(\n 'Could not change interface <{0}> attributes <\\'{1}\\'>'.format(\n eni_id, properties\n )\n )\n else:\n return result\n\n\ndef _associate_eip_with_interface(eni_id, eip_id, private_ip=None, vm_=None):\n '''\n Accept the id of a network interface, and the id of an elastic ip\n address, and associate the two of them, such that traffic sent to the\n elastic ip address will be forwarded (NATted) to this network interface.\n\n Optionally specify the private (10.x.x.x) IP address that traffic should\n be NATted to - useful if you have multiple IP addresses assigned to an\n interface.\n '''\n params = {'Action': 'AssociateAddress',\n 'NetworkInterfaceId': eni_id,\n 'AllocationId': eip_id}\n\n if private_ip:\n params['PrivateIpAddress'] = private_ip\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if not result[2].get('associationId'):\n raise SaltCloudException(\n 'Could not associate elastic ip address '\n '<{0}> with network interface <{1}>'.format(\n eip_id, eni_id\n )\n )\n\n log.debug(\n 'Associated ElasticIP address %s with interface %s',\n eip_id, eni_id\n )\n\n return result[2].get('associationId')\n\n\ndef _update_enis(interfaces, instance, vm_=None):\n config_enis = {}\n instance_enis = []\n for interface in interfaces:\n if 'DeviceIndex' in interface:\n if interface['DeviceIndex'] in config_enis:\n log.error(\n 'Duplicate DeviceIndex in profile. Cannot update ENIs.'\n )\n return None\n config_enis[six.text_type(interface['DeviceIndex'])] = interface\n query_enis = instance[0]['instancesSet']['item']['networkInterfaceSet']['item']\n if isinstance(query_enis, list):\n for query_eni in query_enis:\n instance_enis.append((query_eni['networkInterfaceId'], query_eni['attachment']))\n else:\n instance_enis.append((query_enis['networkInterfaceId'], query_enis['attachment']))\n\n for eni_id, eni_data in instance_enis:\n delete_on_terminate = True\n if 'DeleteOnTermination' in config_enis[eni_data['deviceIndex']]:\n delete_on_terminate = config_enis[eni_data['deviceIndex']]['DeleteOnTermination']\n elif 'delete_interface_on_terminate' in config_enis[eni_data['deviceIndex']]:\n delete_on_terminate = config_enis[eni_data['deviceIndex']]['delete_interface_on_terminate']\n\n params_attachment = {'Attachment.AttachmentId': eni_data['attachmentId'],\n 'Attachment.DeleteOnTermination': delete_on_terminate}\n set_eni_attachment_attributes = _modify_eni_properties(eni_id, params_attachment, vm_=vm_)\n\n if 'SourceDestCheck' in config_enis[eni_data['deviceIndex']]:\n params_sourcedest = {'SourceDestCheck.Value': config_enis[eni_data['deviceIndex']]['SourceDestCheck']}\n set_eni_sourcedest_property = _modify_eni_properties(eni_id, params_sourcedest, vm_=vm_)\n\n return None\n\n\ndef _param_from_config(key, data):\n '''\n Return EC2 API parameters based on the given config data.\n\n Examples:\n 1. List of dictionaries\n >>> data = [\n ... {'DeviceIndex': 0, 'SubnetId': 'subid0',\n ... 'AssociatePublicIpAddress': True},\n ... {'DeviceIndex': 1,\n ... 'SubnetId': 'subid1',\n ... 'PrivateIpAddress': '192.168.1.128'}\n ... ]\n >>> _param_from_config('NetworkInterface', data)\n ... {'NetworkInterface.0.SubnetId': 'subid0',\n ... 'NetworkInterface.0.DeviceIndex': 0,\n ... 'NetworkInterface.1.SubnetId': 'subid1',\n ... 'NetworkInterface.1.PrivateIpAddress': '192.168.1.128',\n ... 'NetworkInterface.0.AssociatePublicIpAddress': 'true',\n ... 'NetworkInterface.1.DeviceIndex': 1}\n\n 2. List of nested dictionaries\n >>> data = [\n ... {'DeviceName': '/dev/sdf',\n ... 'Ebs': {\n ... 'SnapshotId': 'dummy0',\n ... 'VolumeSize': 200,\n ... 'VolumeType': 'standard'}},\n ... {'DeviceName': '/dev/sdg',\n ... 'Ebs': {\n ... 'SnapshotId': 'dummy1',\n ... 'VolumeSize': 100,\n ... 'VolumeType': 'standard'}}\n ... ]\n >>> _param_from_config('BlockDeviceMapping', data)\n ... {'BlockDeviceMapping.0.Ebs.VolumeType': 'standard',\n ... 'BlockDeviceMapping.1.Ebs.SnapshotId': 'dummy1',\n ... 'BlockDeviceMapping.0.Ebs.VolumeSize': 200,\n ... 'BlockDeviceMapping.0.Ebs.SnapshotId': 'dummy0',\n ... 'BlockDeviceMapping.1.Ebs.VolumeType': 'standard',\n ... 'BlockDeviceMapping.1.DeviceName': '/dev/sdg',\n ... 'BlockDeviceMapping.1.Ebs.VolumeSize': 100,\n ... 'BlockDeviceMapping.0.DeviceName': '/dev/sdf'}\n\n 3. Dictionary of dictionaries\n >>> data = { 'Arn': 'dummyarn', 'Name': 'Tester' }\n >>> _param_from_config('IamInstanceProfile', data)\n {'IamInstanceProfile.Arn': 'dummyarn', 'IamInstanceProfile.Name': 'Tester'}\n\n '''\n\n param = {}\n\n if isinstance(data, dict):\n for k, v in six.iteritems(data):\n param.update(_param_from_config('{0}.{1}'.format(key, k), v))\n\n elif isinstance(data, list) or isinstance(data, tuple):\n for idx, conf_item in enumerate(data):\n prefix = '{0}.{1}'.format(key, idx)\n param.update(_param_from_config(prefix, conf_item))\n\n else:\n if isinstance(data, bool):\n # convert boolean True/False to 'true'/'false'\n param.update({key: six.text_type(data).lower()})\n else:\n param.update({key: data})\n\n return param\n\n\ndef request_instance(vm_=None, call=None):\n '''\n Put together all of the information necessary to request an instance on EC2,\n and then fire off the request the instance.\n\n Returns data about the instance\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The request_instance action must be called with -a or --action.'\n )\n\n location = vm_.get('location', get_location(vm_))\n\n # do we launch a regular vm or a spot instance?\n # see http://goo.gl/hYZ13f for more information on EC2 API\n spot_config = get_spot_config(vm_)\n if spot_config is not None:\n if 'spot_price' not in spot_config:\n raise SaltCloudSystemExit(\n 'Spot instance config for {0} requires a spot_price '\n 'attribute.'.format(vm_['name'])\n )\n\n params = {'Action': 'RequestSpotInstances',\n 'InstanceCount': '1',\n 'Type': spot_config['type']\n if 'type' in spot_config else 'one-time',\n 'SpotPrice': spot_config['spot_price']}\n\n # All of the necessary launch parameters for a VM when using\n # spot instances are the same except for the prefix below\n # being tacked on.\n spot_prefix = 'LaunchSpecification.'\n\n # regular EC2 instance\n else:\n # WARNING! EXPERIMENTAL!\n # This allows more than one instance to be spun up in a single call.\n # The first instance will be called by the name provided, but all other\n # instances will be nameless (or more specifically, they will use the\n # InstanceId as the name). This interface is expected to change, so\n # use at your own risk.\n min_instance = config.get_cloud_config_value(\n 'min_instance', vm_, __opts__, search_global=False, default=1\n )\n max_instance = config.get_cloud_config_value(\n 'max_instance', vm_, __opts__, search_global=False, default=1\n )\n params = {'Action': 'RunInstances',\n 'MinCount': min_instance,\n 'MaxCount': max_instance}\n\n # Normal instances should have no prefix.\n spot_prefix = ''\n\n image_id = get_imageid(vm_)\n params[spot_prefix + 'ImageId'] = image_id\n\n userdata = None\n userdata_file = config.get_cloud_config_value(\n 'userdata_file', vm_, __opts__, search_global=False, default=None\n )\n if userdata_file is None:\n userdata = config.get_cloud_config_value(\n 'userdata', vm_, __opts__, search_global=False, default=None\n )\n else:\n log.trace('userdata_file: %s', userdata_file)\n if os.path.exists(userdata_file):\n with salt.utils.files.fopen(userdata_file, 'r') as fh_:\n userdata = salt.utils.stringutils.to_unicode(fh_.read())\n\n userdata = salt.utils.cloud.userdata_template(__opts__, vm_, userdata)\n\n if userdata is not None:\n try:\n params[spot_prefix + 'UserData'] = base64.b64encode(\n salt.utils.stringutils.to_bytes(userdata)\n )\n except Exception as exc:\n log.exception('Failed to encode userdata: %s', exc)\n\n vm_size = config.get_cloud_config_value(\n 'size', vm_, __opts__, search_global=False\n )\n params[spot_prefix + 'InstanceType'] = vm_size\n\n ex_keyname = keyname(vm_)\n if ex_keyname:\n params[spot_prefix + 'KeyName'] = ex_keyname\n\n ex_securitygroup = securitygroup(vm_)\n if ex_securitygroup:\n if not isinstance(ex_securitygroup, list):\n params[spot_prefix + 'SecurityGroup.1'] = ex_securitygroup\n else:\n for counter, sg_ in enumerate(ex_securitygroup):\n params[spot_prefix + 'SecurityGroup.{0}'.format(counter)] = sg_\n\n ex_iam_profile = iam_profile(vm_)\n if ex_iam_profile:\n try:\n if ex_iam_profile.startswith('arn:aws:iam:'):\n params[\n spot_prefix + 'IamInstanceProfile.Arn'\n ] = ex_iam_profile\n else:\n params[\n spot_prefix + 'IamInstanceProfile.Name'\n ] = ex_iam_profile\n except AttributeError:\n raise SaltCloudConfigError(\n '\\'iam_profile\\' should be a string value.'\n )\n\n az_ = get_availability_zone(vm_)\n if az_ is not None:\n params[spot_prefix + 'Placement.AvailabilityZone'] = az_\n\n tenancy_ = get_tenancy(vm_)\n if tenancy_ is not None:\n if spot_config is not None:\n raise SaltCloudConfigError(\n 'Spot instance config for {0} does not support '\n 'specifying tenancy.'.format(vm_['name'])\n )\n params['Placement.Tenancy'] = tenancy_\n\n subnetid_ = get_subnetid(vm_)\n if subnetid_ is not None:\n params[spot_prefix + 'SubnetId'] = subnetid_\n\n ex_securitygroupid = securitygroupid(vm_)\n if ex_securitygroupid:\n if not isinstance(ex_securitygroupid, list):\n params[spot_prefix + 'SecurityGroupId.1'] = ex_securitygroupid\n else:\n for counter, sg_ in enumerate(ex_securitygroupid):\n params[\n spot_prefix + 'SecurityGroupId.{0}'.format(counter)\n ] = sg_\n\n placementgroup_ = get_placementgroup(vm_)\n if placementgroup_ is not None:\n params[spot_prefix + 'Placement.GroupName'] = placementgroup_\n\n blockdevicemappings_holder = block_device_mappings(vm_)\n if blockdevicemappings_holder:\n for _bd in blockdevicemappings_holder:\n if 'tag' in _bd:\n _bd.pop('tag')\n\n ex_blockdevicemappings = blockdevicemappings_holder\n if ex_blockdevicemappings:\n params.update(_param_from_config(spot_prefix + 'BlockDeviceMapping',\n ex_blockdevicemappings))\n\n network_interfaces = config.get_cloud_config_value(\n 'network_interfaces',\n vm_,\n __opts__,\n search_global=False\n )\n\n if network_interfaces:\n eni_devices = []\n for interface in network_interfaces:\n log.debug('Create network interface: %s', interface)\n _new_eni = _create_eni_if_necessary(interface, vm_)\n eni_devices.append(_new_eni)\n params.update(_param_from_config(spot_prefix + 'NetworkInterface',\n eni_devices))\n\n set_ebs_optimized = config.get_cloud_config_value(\n 'ebs_optimized', vm_, __opts__, search_global=False\n )\n\n if set_ebs_optimized is not None:\n if not isinstance(set_ebs_optimized, bool):\n raise SaltCloudConfigError(\n '\\'ebs_optimized\\' should be a boolean value.'\n )\n params[spot_prefix + 'EbsOptimized'] = set_ebs_optimized\n\n set_del_root_vol_on_destroy = config.get_cloud_config_value(\n 'del_root_vol_on_destroy', vm_, __opts__, search_global=False\n )\n\n set_termination_protection = config.get_cloud_config_value(\n 'termination_protection', vm_, __opts__, search_global=False\n )\n\n if set_termination_protection is not None:\n if not isinstance(set_termination_protection, bool):\n raise SaltCloudConfigError(\n '\\'termination_protection\\' should be a boolean value.'\n )\n params.update(_param_from_config(spot_prefix + 'DisableApiTermination',\n set_termination_protection))\n\n if set_del_root_vol_on_destroy and not isinstance(set_del_root_vol_on_destroy, bool):\n raise SaltCloudConfigError(\n '\\'del_root_vol_on_destroy\\' should be a boolean value.'\n )\n\n vm_['set_del_root_vol_on_destroy'] = set_del_root_vol_on_destroy\n\n if set_del_root_vol_on_destroy:\n # first make sure to look up the root device name\n # as Ubuntu and CentOS (and most likely other OSs)\n # use different device identifiers\n\n log.info('Attempting to look up root device name for image id %s on '\n 'VM %s', image_id, vm_['name'])\n\n rd_params = {\n 'Action': 'DescribeImages',\n 'ImageId.1': image_id\n }\n try:\n rd_data = aws.query(rd_params,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in rd_data:\n return rd_data['error']\n log.debug('EC2 Response: \\'%s\\'', rd_data)\n except Exception as exc:\n log.error(\n 'Error getting root device name for image id %s for '\n 'VM %s: \\n%s', image_id, vm_['name'], exc,\n # Show the traceback if the debug logging level is enabled\n exc_info_on_loglevel=logging.DEBUG\n )\n raise\n\n # make sure we have a response\n if not rd_data:\n err_msg = 'There was an error querying EC2 for the root device ' \\\n 'of image id {0}. Empty response.'.format(image_id)\n raise SaltCloudSystemExit(err_msg)\n\n # pull the root device name from the result and use it when\n # launching the new VM\n rd_name = None\n rd_type = None\n if 'blockDeviceMapping' in rd_data[0]:\n # Some ami instances do not have a root volume. Ignore such cases\n if rd_data[0]['blockDeviceMapping'] is not None:\n item = rd_data[0]['blockDeviceMapping']['item']\n if isinstance(item, list):\n item = item[0]\n rd_name = item['deviceName']\n # Grab the volume type\n rd_type = item['ebs'].get('volumeType', None)\n\n log.info('Found root device name: %s', rd_name)\n\n if rd_name is not None:\n if ex_blockdevicemappings:\n dev_list = [\n dev['DeviceName'] for dev in ex_blockdevicemappings\n ]\n else:\n dev_list = []\n\n if rd_name in dev_list:\n # Device already listed, just grab the index\n dev_index = dev_list.index(rd_name)\n else:\n dev_index = len(dev_list)\n # Add the device name in since it wasn't already there\n params[\n '{0}BlockDeviceMapping.{1}.DeviceName'.format(\n spot_prefix, dev_index\n )\n ] = rd_name\n\n # Set the termination value\n termination_key = '{0}BlockDeviceMapping.{1}.Ebs.DeleteOnTermination'.format(spot_prefix, dev_index)\n params[termination_key] = six.text_type(set_del_root_vol_on_destroy).lower()\n\n # Use default volume type if not specified\n if ex_blockdevicemappings and dev_index < len(ex_blockdevicemappings) and \\\n 'Ebs.VolumeType' not in ex_blockdevicemappings[dev_index]:\n type_key = '{0}BlockDeviceMapping.{1}.Ebs.VolumeType'.format(spot_prefix, dev_index)\n params[type_key] = rd_type\n\n set_del_all_vols_on_destroy = config.get_cloud_config_value(\n 'del_all_vols_on_destroy', vm_, __opts__, search_global=False, default=False\n )\n\n if set_del_all_vols_on_destroy and not isinstance(set_del_all_vols_on_destroy, bool):\n raise SaltCloudConfigError(\n '\\'del_all_vols_on_destroy\\' should be a boolean value.'\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'requesting instance',\n 'salt/cloud/{0}/requesting'.format(vm_['name']),\n args={\n 'kwargs': __utils__['cloud.filter_event'](\n 'requesting', params, list(params)\n ),\n 'location': location,\n },\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n provider = get_provider(vm_)\n\n try:\n data = aws.query(params,\n 'instancesSet',\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if 'error' in data:\n return data['error']\n except Exception as exc:\n log.error(\n 'Error creating %s on EC2 when trying to run the initial '\n 'deployment: \\n%s', vm_['name'], exc,\n # Show the traceback if the debug logging level is enabled\n exc_info_on_loglevel=logging.DEBUG\n )\n raise\n\n # if we're using spot instances, we need to wait for the spot request\n # to become active before we continue\n if spot_config:\n sir_id = data[0]['spotInstanceRequestId']\n\n vm_['spotRequestId'] = sir_id\n\n def __query_spot_instance_request(sir_id, location):\n params = {'Action': 'DescribeSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if not data:\n log.error(\n 'There was an error while querying EC2. Empty response'\n )\n # Trigger a failure in the wait for spot instance method\n return False\n\n if isinstance(data, dict) and 'error' in data:\n log.warning('There was an error in the query. %s', data['error'])\n # Trigger a failure in the wait for spot instance method\n return False\n\n log.debug('Returned query data: %s', data)\n\n state = data[0].get('state')\n\n if state == 'active':\n return data\n\n if state == 'open':\n # Still waiting for an active state\n log.info('Spot instance status: %s', data[0]['status']['message'])\n return None\n\n if state in ['cancelled', 'failed', 'closed']:\n # Request will never be active, fail\n log.error('Spot instance request resulted in state \\'{0}\\'. '\n 'Nothing else we can do here.')\n return False\n\n __utils__['cloud.fire_event'](\n 'event',\n 'waiting for spot instance',\n 'salt/cloud/{0}/waiting_for_spot'.format(vm_['name']),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n try:\n data = _wait_for_spot_instance(\n __query_spot_instance_request,\n update_args=(sir_id, location),\n timeout=config.get_cloud_config_value(\n 'wait_for_spot_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_spot_interval', vm_, __opts__, default=30),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_spot_interval_multiplier',\n vm_,\n __opts__,\n default=1),\n max_failures=config.get_cloud_config_value(\n 'wait_for_spot_max_failures',\n vm_,\n __opts__,\n default=10),\n )\n log.debug('wait_for_spot_instance data %s', data)\n\n except (SaltCloudExecutionTimeout, SaltCloudExecutionFailure) as exc:\n try:\n # Cancel the existing spot instance request\n params = {'Action': 'CancelSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n\n log.debug('Canceled spot instance request %s. Data '\n 'returned: %s', sir_id, data)\n\n except SaltCloudSystemExit:\n pass\n finally:\n raise SaltCloudSystemExit(six.text_type(exc))\n\n return data, vm_\n\n\ndef query_instance(vm_=None, call=None):\n '''\n Query an instance upon creation from the EC2 API\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The query_instance action must be called with -a or --action.'\n )\n\n instance_id = vm_['instance_id']\n location = vm_.get('location', get_location(vm_))\n __utils__['cloud.fire_event'](\n 'event',\n 'querying instance',\n 'salt/cloud/{0}/querying'.format(vm_['name']),\n args={'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n log.debug('The new VM instance_id is %s', instance_id)\n\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n\n provider = get_provider(vm_)\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n data, requesturl = aws.query(params, # pylint: disable=unbalanced-tuple-unpacking\n location=location,\n provider=provider,\n opts=__opts__,\n return_url=True,\n sigver='4')\n log.debug('The query returned: %s', data)\n\n if isinstance(data, dict) and 'error' in data:\n log.warning(\n 'There was an error in the query. %s attempts '\n 'remaining: %s', attempts, data['error']\n )\n elif isinstance(data, list) and not data:\n log.warning(\n 'Query returned an empty list. %s attempts '\n 'remaining.', attempts\n )\n else:\n break\n\n aws.sleep_exponential_backoff(attempts)\n attempts += 1\n continue\n else:\n raise SaltCloudSystemExit(\n 'An error occurred while creating VM: {0}'.format(data['error'])\n )\n\n def __query_ip_address(params, url): # pylint: disable=W0613\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if not data:\n log.error(\n 'There was an error while querying EC2. Empty response'\n )\n # Trigger a failure in the wait for IP function\n return False\n\n if isinstance(data, dict) and 'error' in data:\n log.warning('There was an error in the query. %s', data['error'])\n # Trigger a failure in the wait for IP function\n return False\n\n log.debug('Returned query data: %s', data)\n\n if ssh_interface(vm_) == 'public_ips':\n if 'ipAddress' in data[0]['instancesSet']['item']:\n return data\n else:\n log.error(\n 'Public IP not detected.'\n )\n\n if ssh_interface(vm_) == 'private_ips':\n if 'privateIpAddress' in data[0]['instancesSet']['item']:\n return data\n else:\n log.error(\n 'Private IP not detected.'\n )\n\n try:\n data = salt.utils.cloud.wait_for_ip(\n __query_ip_address,\n update_args=(params, requesturl),\n timeout=config.get_cloud_config_value(\n 'wait_for_ip_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_ip_interval', vm_, __opts__, default=10),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_ip_interval_multiplier', vm_, __opts__, default=1),\n )\n except (SaltCloudExecutionTimeout, SaltCloudExecutionFailure) as exc:\n try:\n # It might be already up, let's destroy it!\n destroy(vm_['name'])\n except SaltCloudSystemExit:\n pass\n finally:\n raise SaltCloudSystemExit(six.text_type(exc))\n\n if 'reactor' in vm_ and vm_['reactor'] is True:\n __utils__['cloud.fire_event'](\n 'event',\n 'instance queried',\n 'salt/cloud/{0}/query_reactor'.format(vm_['name']),\n args={'data': data},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n return data\n\n\ndef wait_for_instance(\n vm_=None,\n data=None,\n ip_address=None,\n display_ssh_output=True,\n call=None,\n ):\n '''\n Wait for an instance upon creation from the EC2 API, to become available\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The wait_for_instance action must be called with -a or --action.'\n )\n\n if vm_ is None:\n vm_ = {}\n\n if data is None:\n data = {}\n\n ssh_gateway_config = vm_.get(\n 'gateway', get_ssh_gateway_config(vm_)\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'waiting for ssh',\n 'salt/cloud/{0}/waiting_for_ssh'.format(vm_['name']),\n args={'ip_address': ip_address},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n ssh_connect_timeout = config.get_cloud_config_value(\n 'ssh_connect_timeout', vm_, __opts__, 900 # 15 minutes\n )\n ssh_port = config.get_cloud_config_value(\n 'ssh_port', vm_, __opts__, 22\n )\n\n if config.get_cloud_config_value('win_installer', vm_, __opts__):\n username = config.get_cloud_config_value(\n 'win_username', vm_, __opts__, default='Administrator'\n )\n win_passwd = config.get_cloud_config_value(\n 'win_password', vm_, __opts__, default=''\n )\n win_deploy_auth_retries = config.get_cloud_config_value(\n 'win_deploy_auth_retries', vm_, __opts__, default=10\n )\n win_deploy_auth_retry_delay = config.get_cloud_config_value(\n 'win_deploy_auth_retry_delay', vm_, __opts__, default=1\n )\n use_winrm = config.get_cloud_config_value(\n 'use_winrm', vm_, __opts__, default=False\n )\n winrm_verify_ssl = config.get_cloud_config_value(\n 'winrm_verify_ssl', vm_, __opts__, default=True\n )\n\n if win_passwd and win_passwd == 'auto':\n log.debug('Waiting for auto-generated Windows EC2 password')\n while True:\n password_data = get_password_data(\n name=vm_['name'],\n kwargs={\n 'key_file': vm_['private_key'],\n },\n call='action',\n )\n win_passwd = password_data.get('password', None)\n if win_passwd is None:\n log.debug(password_data)\n # This wait is so high, because the password is unlikely to\n # be generated for at least 4 minutes\n time.sleep(60)\n else:\n logging_data = password_data\n\n logging_data['password'] = 'XXX-REDACTED-XXX'\n logging_data['passwordData'] = 'XXX-REDACTED-XXX'\n log.debug(logging_data)\n\n vm_['win_password'] = win_passwd\n break\n\n # SMB used whether psexec or winrm\n if not salt.utils.cloud.wait_for_port(ip_address,\n port=445,\n timeout=ssh_connect_timeout):\n raise SaltCloudSystemExit(\n 'Failed to connect to remote windows host'\n )\n\n # If not using winrm keep same psexec behavior\n if not use_winrm:\n\n log.debug('Trying to authenticate via SMB using psexec')\n\n if not salt.utils.cloud.validate_windows_cred(ip_address,\n username,\n win_passwd,\n retries=win_deploy_auth_retries,\n retry_delay=win_deploy_auth_retry_delay):\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote windows host (smb)'\n )\n\n # If using winrm\n else:\n\n # Default HTTPS port can be changed in cloud configuration\n winrm_port = config.get_cloud_config_value(\n 'winrm_port', vm_, __opts__, default=5986\n )\n\n # Wait for winrm port to be available\n if not salt.utils.cloud.wait_for_port(ip_address,\n port=winrm_port,\n timeout=ssh_connect_timeout):\n raise SaltCloudSystemExit(\n 'Failed to connect to remote windows host (winrm)'\n )\n\n log.debug('Trying to authenticate via Winrm using pywinrm')\n\n if not salt.utils.cloud.wait_for_winrm(ip_address,\n winrm_port,\n username,\n win_passwd,\n timeout=ssh_connect_timeout,\n verify=winrm_verify_ssl):\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote windows host'\n )\n\n elif salt.utils.cloud.wait_for_port(ip_address,\n port=ssh_port,\n timeout=ssh_connect_timeout,\n gateway=ssh_gateway_config\n ):\n # If a known_hosts_file is configured, this instance will not be\n # accessible until it has a host key. Since this is provided on\n # supported instances by cloud-init, and viewable to us only from the\n # console output (which may take several minutes to become available,\n # we have some more waiting to do here.\n known_hosts_file = config.get_cloud_config_value(\n 'known_hosts_file', vm_, __opts__, default=None\n )\n if known_hosts_file:\n console = {}\n while 'output_decoded' not in console:\n console = get_console_output(\n instance_id=vm_['instance_id'],\n call='action',\n location=get_location(vm_)\n )\n pprint.pprint(console)\n time.sleep(5)\n output = salt.utils.stringutils.to_unicode(console['output_decoded'])\n comps = output.split('-----BEGIN SSH HOST KEY KEYS-----')\n if len(comps) < 2:\n # Fail; there are no host keys\n return False\n\n comps = comps[1].split('-----END SSH HOST KEY KEYS-----')\n keys = ''\n for line in comps[0].splitlines():\n if not line:\n continue\n keys += '\\n{0} {1}'.format(ip_address, line)\n\n with salt.utils.files.fopen(known_hosts_file, 'a') as fp_:\n fp_.write(salt.utils.stringutils.to_str(keys))\n fp_.close()\n\n for user in vm_['usernames']:\n if salt.utils.cloud.wait_for_passwd(\n host=ip_address,\n port=ssh_port,\n username=user,\n ssh_timeout=config.get_cloud_config_value(\n 'wait_for_passwd_timeout', vm_, __opts__, default=1 * 60\n ),\n key_filename=vm_['key_filename'],\n display_ssh_output=display_ssh_output,\n gateway=ssh_gateway_config,\n maxtries=config.get_cloud_config_value(\n 'wait_for_passwd_maxtries', vm_, __opts__, default=15\n ),\n known_hosts_file=config.get_cloud_config_value(\n 'known_hosts_file', vm_, __opts__,\n default='/dev/null'\n ),\n ):\n __opts__['ssh_username'] = user\n vm_['ssh_username'] = user\n break\n else:\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote ssh'\n )\n else:\n raise SaltCloudSystemExit(\n 'Failed to connect to remote ssh'\n )\n\n if 'reactor' in vm_ and vm_['reactor'] is True:\n __utils__['cloud.fire_event'](\n 'event',\n 'ssh is available',\n 'salt/cloud/{0}/ssh_ready_reactor'.format(vm_['name']),\n args={'ip_address': ip_address},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n return vm_\n\n\ndef _validate_key_path_and_mode(key_filename):\n if key_filename is None:\n raise SaltCloudSystemExit(\n 'The required \\'private_key\\' configuration setting is missing from the '\n '\\'ec2\\' driver.'\n )\n\n if not os.path.exists(key_filename):\n raise SaltCloudSystemExit(\n 'The EC2 key file \\'{0}\\' does not exist.\\n'.format(\n key_filename\n )\n )\n\n key_mode = stat.S_IMODE(os.stat(key_filename).st_mode)\n if key_mode not in (0o400, 0o600):\n raise SaltCloudSystemExit(\n 'The EC2 key file \\'{0}\\' needs to be set to mode 0400 or 0600.\\n'.format(\n key_filename\n )\n )\n\n return True\n\n\ndef create(vm_=None, call=None):\n '''\n Create a single VM from a data dict\n '''\n if call:\n raise SaltCloudSystemExit(\n 'You cannot create an instance with -a or -f.'\n )\n\n try:\n # Check for required profile parameters before sending any API calls.\n if vm_['profile'] and config.is_profile_configured(__opts__,\n __active_provider_name__ or 'ec2',\n vm_['profile'],\n vm_=vm_) is False:\n return False\n except AttributeError:\n pass\n\n # Check for private_key and keyfile name for bootstrapping new instances\n deploy = config.get_cloud_config_value(\n 'deploy', vm_, __opts__, default=True\n )\n win_password = config.get_cloud_config_value(\n 'win_password', vm_, __opts__, default=''\n )\n key_filename = config.get_cloud_config_value(\n 'private_key', vm_, __opts__, search_global=False, default=None\n )\n if deploy:\n # The private_key and keyname settings are only needed for bootstrapping\n # new instances when deploy is True\n _validate_key_path_and_mode(key_filename)\n\n __utils__['cloud.fire_event'](\n 'event',\n 'starting create',\n 'salt/cloud/{0}/creating'.format(vm_['name']),\n args=__utils__['cloud.filter_event']('creating', vm_, ['name', 'profile', 'provider', 'driver']),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n __utils__['cloud.cachedir_index_add'](\n vm_['name'], vm_['profile'], 'ec2', vm_['driver']\n )\n\n vm_['key_filename'] = key_filename\n # wait_for_instance requires private_key\n vm_['private_key'] = key_filename\n\n # Get SSH Gateway config early to verify the private_key,\n # if used, exists or not. We don't want to deploy an instance\n # and not be able to access it via the gateway.\n vm_['gateway'] = get_ssh_gateway_config(vm_)\n\n location = get_location(vm_)\n vm_['location'] = location\n\n log.info('Creating Cloud VM %s in %s', vm_['name'], location)\n vm_['usernames'] = salt.utils.cloud.ssh_usernames(\n vm_,\n __opts__,\n default_users=(\n 'ec2-user', # Amazon Linux, Fedora, RHEL; FreeBSD\n 'centos', # CentOS AMIs from AWS Marketplace\n 'ubuntu', # Ubuntu\n 'admin', # Debian GNU/Linux\n 'bitnami', # BitNami AMIs\n 'root' # Last resort, default user on RHEL 5, SUSE\n )\n )\n\n if 'instance_id' in vm_:\n # This was probably created via another process, and doesn't have\n # things like salt keys created yet, so let's create them now.\n if 'pub_key' not in vm_ and 'priv_key' not in vm_:\n log.debug('Generating minion keys for \\'%s\\'', vm_['name'])\n vm_['priv_key'], vm_['pub_key'] = salt.utils.cloud.gen_keys(\n salt.config.get_cloud_config_value(\n 'keysize',\n vm_,\n __opts__\n )\n )\n else:\n # Put together all of the information required to request the instance,\n # and then fire off the request for it\n if keyname(vm_) is None:\n raise SaltCloudSystemExit(\n 'The required \\'keyname\\' configuration setting is missing from the '\n '\\'ec2\\' driver.'\n )\n\n data, vm_ = request_instance(vm_, location)\n\n # If data is a str, it's an error\n if isinstance(data, six.string_types):\n log.error('Error requesting instance: %s', data)\n return {}\n\n # Pull the instance ID, valid for both spot and normal instances\n\n # Multiple instances may have been spun up, get all their IDs\n vm_['instance_id_list'] = []\n for instance in data:\n vm_['instance_id_list'].append(instance['instanceId'])\n\n vm_['instance_id'] = vm_['instance_id_list'].pop()\n if vm_['instance_id_list']:\n # Multiple instances were spun up, get one now, and queue the rest\n queue_instances(vm_['instance_id_list'])\n\n # Wait for vital information, such as IP addresses, to be available\n # for the new instance\n data = query_instance(vm_)\n\n # Now that the instance is available, tag it appropriately. Should\n # mitigate race conditions with tags\n tags = config.get_cloud_config_value('tag',\n vm_,\n __opts__,\n {},\n search_global=False)\n if not isinstance(tags, dict):\n raise SaltCloudConfigError(\n '\\'tag\\' should be a dict.'\n )\n\n for value in six.itervalues(tags):\n if not isinstance(value, six.string_types):\n raise SaltCloudConfigError(\n '\\'tag\\' values must be strings. Try quoting the values. '\n 'e.g. \"2013-09-19T20:09:46Z\".'\n )\n\n tags['Name'] = vm_['name']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/{0}/tagging'.format(vm_['name']),\n args={'tags': tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n salt.utils.cloud.wait_for_fun(\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=tags,\n instance_id=vm_['instance_id'],\n call='action',\n location=location\n )\n\n # Once instance tags are set, tag the spot request if configured\n if 'spot_config' in vm_ and 'tag' in vm_['spot_config']:\n\n if not isinstance(vm_['spot_config']['tag'], dict):\n raise SaltCloudConfigError(\n '\\'tag\\' should be a dict.'\n )\n\n for value in six.itervalues(vm_['spot_config']['tag']):\n if not isinstance(value, str):\n raise SaltCloudConfigError(\n '\\'tag\\' values must be strings. Try quoting the values. '\n 'e.g. \"2013-09-19T20:09:46Z\".'\n )\n\n spot_request_tags = {}\n\n if 'spotRequestId' not in vm_:\n raise SaltCloudConfigError('Failed to find spotRequestId')\n\n sir_id = vm_['spotRequestId']\n\n spot_request_tags['Name'] = vm_['name']\n\n for k, v in six.iteritems(vm_['spot_config']['tag']):\n spot_request_tags[k] = v\n\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/spot_request_{0}/tagging'.format(sir_id),\n args={'tags': spot_request_tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n salt.utils.cloud.wait_for_fun(\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=spot_request_tags,\n instance_id=sir_id,\n call='action',\n location=location\n )\n\n network_interfaces = config.get_cloud_config_value(\n 'network_interfaces',\n vm_,\n __opts__,\n search_global=False\n )\n\n if network_interfaces:\n _update_enis(network_interfaces, data, vm_)\n\n # At this point, the node is created and tagged, and now needs to be\n # bootstrapped, once the necessary port is available.\n log.info('Created node %s', vm_['name'])\n\n instance = data[0]['instancesSet']['item']\n\n # Wait for the necessary port to become available to bootstrap\n if ssh_interface(vm_) == 'private_ips':\n ip_address = instance['privateIpAddress']\n log.info('Salt node data. Private_ip: %s', ip_address)\n else:\n ip_address = instance['ipAddress']\n log.info('Salt node data. Public_ip: %s', ip_address)\n vm_['ssh_host'] = ip_address\n\n if salt.utils.cloud.get_salt_interface(vm_, __opts__) == 'private_ips':\n salt_ip_address = instance['privateIpAddress']\n log.info('Salt interface set to: %s', salt_ip_address)\n else:\n salt_ip_address = instance['ipAddress']\n log.debug('Salt interface set to: %s', salt_ip_address)\n vm_['salt_host'] = salt_ip_address\n\n if deploy:\n display_ssh_output = config.get_cloud_config_value(\n 'display_ssh_output', vm_, __opts__, default=True\n )\n\n vm_ = wait_for_instance(\n vm_, data, ip_address, display_ssh_output\n )\n\n # The instance is booted and accessible, let's Salt it!\n ret = instance.copy()\n\n # Get ANY defined volumes settings, merging data, in the following order\n # 1. VM config\n # 2. Profile config\n # 3. Global configuration\n volumes = config.get_cloud_config_value(\n 'volumes', vm_, __opts__, search_global=True\n )\n if volumes:\n __utils__['cloud.fire_event'](\n 'event',\n 'attaching volumes',\n 'salt/cloud/{0}/attaching_volumes'.format(vm_['name']),\n args={'volumes': volumes},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n log.info('Create and attach volumes to node %s', vm_['name'])\n created = create_attach_volumes(\n vm_['name'],\n {\n 'volumes': volumes,\n 'zone': ret['placement']['availabilityZone'],\n 'instance_id': ret['instanceId'],\n 'del_all_vols_on_destroy': vm_.get('del_all_vols_on_destroy', False)\n },\n call='action'\n )\n ret['Attached Volumes'] = created\n\n # Associate instance with a ssm document, if present\n ssm_document = config.get_cloud_config_value(\n 'ssm_document', vm_, __opts__, None, search_global=False\n )\n if ssm_document:\n log.debug('Associating with ssm document: %s', ssm_document)\n assoc = ssm_create_association(\n vm_['name'],\n {'ssm_document': ssm_document},\n instance_id=vm_['instance_id'],\n call='action'\n )\n if isinstance(assoc, dict) and assoc.get('error', None):\n log.error(\n 'Failed to associate instance %s with ssm document %s',\n vm_['instance_id'], ssm_document\n )\n return {}\n\n for key, value in six.iteritems(__utils__['cloud.bootstrap'](vm_, __opts__)):\n ret.setdefault(key, value)\n\n log.info('Created Cloud VM \\'%s\\'', vm_['name'])\n log.debug(\n '\\'%s\\' VM creation details:\\n%s',\n vm_['name'], pprint.pformat(instance)\n )\n\n event_data = {\n 'name': vm_['name'],\n 'profile': vm_['profile'],\n 'provider': vm_['driver'],\n 'instance_id': vm_['instance_id'],\n }\n if volumes:\n event_data['volumes'] = volumes\n if ssm_document:\n event_data['ssm_document'] = ssm_document\n\n __utils__['cloud.fire_event'](\n 'event',\n 'created instance',\n 'salt/cloud/{0}/created'.format(vm_['name']),\n args=__utils__['cloud.filter_event']('created', event_data, list(event_data)),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n # Ensure that the latest node data is returned\n node = _get_node(instance_id=vm_['instance_id'])\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n ret.update(node)\n\n # Add any block device tags specified\n ex_blockdevicetags = {}\n blockdevicemappings_holder = block_device_mappings(vm_)\n if blockdevicemappings_holder:\n for _bd in blockdevicemappings_holder:\n if 'tag' in _bd:\n ex_blockdevicetags[_bd['DeviceName']] = _bd['tag']\n\n block_device_volume_id_map = {}\n\n if ex_blockdevicetags:\n for _device, _map in six.iteritems(ret['blockDeviceMapping']):\n bd_items = []\n if isinstance(_map, dict):\n bd_items.append(_map)\n else:\n for mapitem in _map:\n bd_items.append(mapitem)\n\n for blockitem in bd_items:\n if blockitem['deviceName'] in ex_blockdevicetags and 'Name' not in ex_blockdevicetags[blockitem['deviceName']]:\n ex_blockdevicetags[blockitem['deviceName']]['Name'] = vm_['name']\n if blockitem['deviceName'] in ex_blockdevicetags:\n block_device_volume_id_map[blockitem[ret['rootDeviceType']]['volumeId']] = ex_blockdevicetags[blockitem['deviceName']]\n\n if block_device_volume_id_map:\n\n for volid, tags in six.iteritems(block_device_volume_id_map):\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/block_volume_{0}/tagging'.format(str(volid)),\n args={'tags': tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n __utils__['cloud.wait_for_fun'](\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=tags,\n resource_id=volid,\n call='action',\n location=location\n )\n\n return ret\n\n\ndef queue_instances(instances):\n '''\n Queue a set of instances to be provisioned later. Expects a list.\n\n Currently this only queries node data, and then places it in the cloud\n cache (if configured). If the salt-cloud-reactor is being used, these\n instances will be automatically provisioned using that.\n\n For more information about the salt-cloud-reactor, see:\n\n https://github.com/saltstack-formulas/salt-cloud-reactor\n '''\n for instance_id in instances:\n node = _get_node(instance_id=instance_id)\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n\n\ndef create_attach_volumes(name, kwargs, call=None, wait_to_finish=True):\n '''\n Create and attach volumes to created node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The create_attach_volumes action must be called with '\n '-a or --action.'\n )\n\n if 'instance_id' not in kwargs:\n kwargs['instance_id'] = _get_node(name)['instanceId']\n\n if isinstance(kwargs['volumes'], six.string_types):\n volumes = salt.utils.yaml.safe_load(kwargs['volumes'])\n else:\n volumes = kwargs['volumes']\n\n ret = []\n for volume in volumes:\n created = False\n volume_name = '{0} on {1}'.format(volume['device'], name)\n\n volume_dict = {\n 'volume_name': volume_name,\n 'zone': kwargs['zone']\n }\n if 'volume_id' in volume:\n volume_dict['volume_id'] = volume['volume_id']\n elif 'snapshot' in volume:\n volume_dict['snapshot'] = volume['snapshot']\n elif 'size' in volume:\n volume_dict['size'] = volume['size']\n else:\n raise SaltCloudConfigError(\n 'Cannot create volume. Please define one of \\'volume_id\\', '\n '\\'snapshot\\', or \\'size\\''\n )\n\n if 'tags' in volume:\n volume_dict['tags'] = volume['tags']\n if 'type' in volume:\n volume_dict['type'] = volume['type']\n if 'iops' in volume:\n volume_dict['iops'] = volume['iops']\n if 'encrypted' in volume:\n volume_dict['encrypted'] = volume['encrypted']\n if 'kmskeyid' in volume:\n volume_dict['kmskeyid'] = volume['kmskeyid']\n\n if 'volume_id' not in volume_dict:\n created_volume = create_volume(volume_dict, call='function', wait_to_finish=wait_to_finish)\n created = True\n if 'volumeId' in created_volume:\n volume_dict['volume_id'] = created_volume['volumeId']\n\n attach = attach_volume(\n name,\n {'volume_id': volume_dict['volume_id'],\n 'device': volume['device']},\n instance_id=kwargs['instance_id'],\n call='action'\n )\n\n # Update the delvol parameter for this volume\n delvols_on_destroy = kwargs.get('del_all_vols_on_destroy', None)\n\n if attach and created and delvols_on_destroy is not None:\n _toggle_delvol(instance_id=kwargs['instance_id'],\n device=volume['device'],\n value=delvols_on_destroy)\n\n if attach:\n msg = (\n '{0} attached to {1} (aka {2}) as device {3}'.format(\n volume_dict['volume_id'],\n kwargs['instance_id'],\n name,\n volume['device']\n )\n )\n log.info(msg)\n ret.append(msg)\n return ret\n\n\ndef stop(name, call=None):\n '''\n Stop a node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The stop action must be called with -a or --action.'\n )\n\n log.info('Stopping node %s', name)\n\n instance_id = _get_node(name)['instanceId']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'stopping instance',\n 'salt/cloud/{0}/stopping'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n params = {'Action': 'StopInstances',\n 'InstanceId.1': instance_id}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n return result\n\n\ndef start(name, call=None):\n '''\n Start a node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The start action must be called with -a or --action.'\n )\n\n log.info('Starting node %s', name)\n\n instance_id = _get_node(name)['instanceId']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'starting instance',\n 'salt/cloud/{0}/starting'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n params = {'Action': 'StartInstances',\n 'InstanceId.1': instance_id}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n return result\n\n\ndef set_tags(name=None,\n tags=None,\n call=None,\n location=None,\n instance_id=None,\n resource_id=None,\n kwargs=None): # pylint: disable=W0613\n '''\n Set tags for a resource. Normally a VM name or instance_id is passed in,\n but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a set_tags mymachine tag1=somestuff tag2='Other stuff'\n salt-cloud -a set_tags resource_id=vol-3267ab32 tag=somestuff\n '''\n if kwargs is None:\n kwargs = {}\n\n if location is None:\n location = get_location()\n\n if instance_id is None:\n if 'resource_id' in kwargs:\n resource_id = kwargs['resource_id']\n del kwargs['resource_id']\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n if resource_id is None:\n if instance_id is None:\n instance_id = _get_node(name=name, instance_id=None, location=location)['instanceId']\n else:\n instance_id = resource_id\n\n # This second check is a safety, in case the above still failed to produce\n # a usable ID\n if instance_id is None:\n return {\n 'Error': 'A valid instance_id or resource_id was not specified.'\n }\n\n params = {'Action': 'CreateTags',\n 'ResourceId.1': instance_id}\n\n log.debug('Tags to set for %s: %s', name, tags)\n\n if kwargs and not tags:\n tags = kwargs\n\n for idx, (tag_k, tag_v) in enumerate(six.iteritems(tags)):\n params['Tag.{0}.Key'.format(idx)] = tag_k\n params['Tag.{0}.Value'.format(idx)] = tag_v\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n aws.query(params,\n setname='tagSet',\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n settags = get_tags(\n instance_id=instance_id, call='action', location=location\n )\n\n log.debug('Setting the tags returned: %s', settags)\n\n failed_to_set_tags = False\n for tag in settags:\n if tag['key'] not in tags:\n # We were not setting this tag\n continue\n\n if tag.get('value') is None and tags.get(tag['key']) == '':\n # This is a correctly set tag with no value\n continue\n\n if six.text_type(tags.get(tag['key'])) != six.text_type(tag['value']):\n # Not set to the proper value!?\n log.debug(\n 'Setting the tag %s returned %s instead of %s',\n tag['key'], tags.get(tag['key']), tag['value']\n )\n failed_to_set_tags = True\n break\n\n if failed_to_set_tags:\n log.warning('Failed to set tags. Remaining attempts %s', attempts)\n attempts += 1\n aws.sleep_exponential_backoff(attempts)\n continue\n\n return settags\n\n raise SaltCloudSystemExit(\n 'Failed to set tags on {0}!'.format(name)\n )\n\n\ndef get_tags(name=None,\n instance_id=None,\n call=None,\n location=None,\n kwargs=None,\n resource_id=None): # pylint: disable=W0613\n '''\n Retrieve tags for a resource. Normally a VM name or instance_id is passed\n in, but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a get_tags mymachine\n salt-cloud -a get_tags resource_id=vol-3267ab32\n '''\n if location is None:\n location = get_location()\n\n if instance_id is None:\n if resource_id is None:\n if name:\n instance_id = _get_node(name)['instanceId']\n elif 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n elif 'resource_id' in kwargs:\n instance_id = kwargs['resource_id']\n else:\n instance_id = resource_id\n\n params = {'Action': 'DescribeTags',\n 'Filter.1.Name': 'resource-id',\n 'Filter.1.Value': instance_id}\n\n return aws.query(params,\n setname='tagSet',\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n\ndef del_tags(name=None,\n kwargs=None,\n call=None,\n instance_id=None,\n resource_id=None): # pylint: disable=W0613\n '''\n Delete tags for a resource. Normally a VM name or instance_id is passed in,\n but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a del_tags mymachine tags=mytag,\n salt-cloud -a del_tags mymachine tags=tag1,tag2,tag3\n salt-cloud -a del_tags resource_id=vol-3267ab32 tags=tag1,tag2,tag3\n '''\n if kwargs is None:\n kwargs = {}\n\n if 'tags' not in kwargs:\n raise SaltCloudSystemExit(\n 'A tag or tags must be specified using tags=list,of,tags'\n )\n\n if not name and 'resource_id' in kwargs:\n instance_id = kwargs['resource_id']\n del kwargs['resource_id']\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n params = {'Action': 'DeleteTags',\n 'ResourceId.1': instance_id}\n\n for idx, tag in enumerate(kwargs['tags'].split(',')):\n params['Tag.{0}.Key'.format(idx)] = tag\n\n aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if resource_id:\n return get_tags(resource_id=resource_id)\n else:\n return get_tags(instance_id=instance_id)\n\n\ndef rename(name, kwargs, call=None):\n '''\n Properly rename a node. Pass in the new name as \"new name\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a rename mymachine newname=yourmachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The rename action must be called with -a or --action.'\n )\n\n log.info('Renaming %s to %s', name, kwargs['newname'])\n\n set_tags(name, {'Name': kwargs['newname']}, call='action')\n\n salt.utils.cloud.rename_key(\n __opts__['pki_dir'], name, kwargs['newname']\n )\n\n\ndef destroy(name, call=None):\n '''\n Destroy a node. Will check termination protection and warn if enabled.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud --destroy mymachine\n '''\n if call == 'function':\n raise SaltCloudSystemExit(\n 'The destroy action must be called with -d, --destroy, '\n '-a or --action.'\n )\n\n node_metadata = _get_node(name)\n instance_id = node_metadata['instanceId']\n sir_id = node_metadata.get('spotInstanceRequestId')\n protected = show_term_protect(\n name=name,\n instance_id=instance_id,\n call='action',\n quiet=True\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'destroying instance',\n 'salt/cloud/{0}/destroying'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n if protected == 'true':\n raise SaltCloudSystemExit(\n 'This instance has been protected from being destroyed. '\n 'Use the following command to disable protection:\\n\\n'\n 'salt-cloud -a disable_term_protect {0}'.format(\n name\n )\n )\n\n ret = {}\n\n # Default behavior is to rename EC2 VMs when destroyed\n # via salt-cloud, unless explicitly set to False.\n rename_on_destroy = config.get_cloud_config_value('rename_on_destroy',\n get_configured_provider(),\n __opts__,\n search_global=False)\n if rename_on_destroy is not False:\n newname = '{0}-DEL{1}'.format(name, uuid.uuid4().hex)\n rename(name, kwargs={'newname': newname}, call='action')\n log.info(\n 'Machine will be identified as %s until it has been '\n 'cleaned up.', newname\n )\n ret['newname'] = newname\n\n params = {'Action': 'TerminateInstances',\n 'InstanceId.1': instance_id}\n\n location = get_location()\n provider = get_provider()\n result = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n\n log.info(result)\n ret.update(result[0])\n\n # If this instance is part of a spot instance request, we\n # need to cancel it as well\n if sir_id is not None:\n params = {'Action': 'CancelSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n result = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n ret['spotInstance'] = result[0]\n\n __utils__['cloud.fire_event'](\n 'event',\n 'destroyed instance',\n 'salt/cloud/{0}/destroyed'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n __utils__['cloud.cachedir_index_del'](name)\n\n if __opts__.get('update_cachedir', False) is True:\n __utils__['cloud.delete_minion_cachedir'](name, __active_provider_name__.split(':')[0], __opts__)\n\n return ret\n\n\ndef reboot(name, call=None):\n '''\n Reboot a node.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a reboot mymachine\n '''\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'RebootInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if result == []:\n log.info('Complete')\n\n return {'Reboot': 'Complete'}\n\n\ndef show_image(kwargs, call=None):\n '''\n Show the details from EC2 concerning an AMI\n '''\n if call != 'function':\n raise SaltCloudSystemExit(\n 'The show_image action must be called with -f or --function.'\n )\n\n params = {'ImageId.1': kwargs['image'],\n 'Action': 'DescribeImages'}\n result = aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n log.info(result)\n\n return result\n\n\ndef show_instance(name=None, instance_id=None, call=None, kwargs=None):\n '''\n Show the details from EC2 concerning an AMI.\n\n Can be called as an action (which requires a name):\n\n .. code-block:: bash\n\n salt-cloud -a show_instance myinstance\n\n ...or as a function (which requires either a name or instance_id):\n\n .. code-block:: bash\n\n salt-cloud -f show_instance my-ec2 name=myinstance\n salt-cloud -f show_instance my-ec2 instance_id=i-d34db33f\n '''\n if not name and call == 'action':\n raise SaltCloudSystemExit(\n 'The show_instance action requires a name.'\n )\n\n if call == 'function':\n name = kwargs.get('name', None)\n instance_id = kwargs.get('instance_id', None)\n\n if not name and not instance_id:\n raise SaltCloudSystemExit(\n 'The show_instance function requires '\n 'either a name or an instance_id'\n )\n\n node = _get_node(name=name, instance_id=instance_id)\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n return node\n\n\ndef _get_node(name=None, instance_id=None, location=None):\n if location is None:\n location = get_location()\n\n params = {'Action': 'DescribeInstances'}\n\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if instance_id:\n params['InstanceId.1'] = instance_id\n else:\n params['Filter.1.Name'] = 'tag:Name'\n params['Filter.1.Value.1'] = name\n\n log.trace(params)\n\n provider = get_provider()\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n try:\n instances = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n instance_info = _extract_instance_info(instances).values()\n return next(iter(instance_info))\n except IndexError:\n attempts += 1\n log.debug(\n 'Failed to get the data for node \\'%s\\'. Remaining '\n 'attempts: %s', instance_id or name, attempts\n )\n aws.sleep_exponential_backoff(attempts)\n return {}\n\n\ndef list_nodes_full(location=None, call=None):\n '''\n Return a list of the VMs that are on the provider\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes_full function must be called with -f '\n 'or --function.'\n )\n\n return _list_nodes_full(location or get_location())\n\n\ndef _extract_name_tag(item):\n if 'tagSet' in item and item['tagSet'] is not None:\n tagset = item['tagSet']\n if isinstance(tagset['item'], list):\n for tag in tagset['item']:\n if tag['key'] == 'Name':\n return tag['value']\n return item['instanceId']\n return item['tagSet']['item']['value']\n return item['instanceId']\n\n\ndef _extract_instance_info(instances):\n '''\n Given an instance query, return a dict of all instance data\n '''\n ret = {}\n for instance in instances:\n # items could be type dict or list (for stopped EC2 instances)\n if isinstance(instance['instancesSet']['item'], list):\n for item in instance['instancesSet']['item']:\n name = _extract_name_tag(item)\n ret[name] = item\n ret[name]['name'] = name\n ret[name].update(\n dict(\n id=item['instanceId'],\n image=item['imageId'],\n size=item['instanceType'],\n state=item['instanceState']['name'],\n private_ips=item.get('privateIpAddress', []),\n public_ips=item.get('ipAddress', [])\n )\n )\n else:\n item = instance['instancesSet']['item']\n name = _extract_name_tag(item)\n ret[name] = item\n ret[name]['name'] = name\n ret[name].update(\n dict(\n id=item['instanceId'],\n image=item['imageId'],\n size=item['instanceType'],\n state=item['instanceState']['name'],\n private_ips=item.get('privateIpAddress', []),\n public_ips=item.get('ipAddress', [])\n )\n )\n\n return ret\n\n\ndef _list_nodes_full(location=None):\n '''\n Return a list of the VMs that in this location\n '''\n provider = __active_provider_name__ or 'ec2'\n if ':' in provider:\n comps = provider.split(':')\n provider = comps[0]\n\n params = {'Action': 'DescribeInstances'}\n instances = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if 'error' in instances:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n instances['error']['Errors']['Error']['Message']\n )\n )\n\n ret = _extract_instance_info(instances)\n\n __utils__['cloud.cache_node_list'](ret, provider, __opts__)\n return ret\n\n\ndef list_nodes_min(location=None, call=None):\n '''\n Return a list of the VMs that are on the provider. Only a list of VM names,\n and their state, is returned. This is the minimum amount of information\n needed to check for existing VMs.\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes_min function must be called with -f or --function.'\n )\n\n ret = {}\n params = {'Action': 'DescribeInstances'}\n instances = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in instances:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n instances['error']['Errors']['Error']['Message']\n )\n )\n\n for instance in instances:\n if isinstance(instance['instancesSet']['item'], list):\n items = instance['instancesSet']['item']\n else:\n items = [instance['instancesSet']['item']]\n\n for item in items:\n state = item['instanceState']['name']\n name = _extract_name_tag(item)\n id = item['instanceId']\n ret[name] = {'state': state, 'id': id}\n return ret\n\n\ndef list_nodes(call=None):\n '''\n Return a list of the VMs that are on the provider\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes function must be called with -f or --function.'\n )\n\n ret = {}\n nodes = list_nodes_full(get_location())\n if 'error' in nodes:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n nodes['error']['Errors']['Error']['Message']\n )\n )\n for node in nodes:\n ret[node] = {\n 'id': nodes[node]['id'],\n 'image': nodes[node]['image'],\n 'name': nodes[node]['name'],\n 'size': nodes[node]['size'],\n 'state': nodes[node]['state'],\n 'private_ips': nodes[node]['private_ips'],\n 'public_ips': nodes[node]['public_ips'],\n }\n return ret\n\n\ndef list_nodes_select(call=None):\n '''\n Return a list of the VMs that are on the provider, with select fields\n '''\n return salt.utils.cloud.list_nodes_select(\n list_nodes_full(get_location()), __opts__['query.selection'], call,\n )\n\n\ndef show_term_protect(name=None, instance_id=None, call=None, quiet=False):\n '''\n Show the details from EC2 concerning an instance's termination protection state\n\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_term_protect action must be called with -a or --action.'\n )\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'DescribeInstanceAttribute',\n 'InstanceId': instance_id,\n 'Attribute': 'disableApiTermination'}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n disable_protect = False\n for item in result:\n if 'value' in item:\n disable_protect = item['value']\n break\n\n log.log(\n logging.DEBUG if quiet is True else logging.INFO,\n 'Termination Protection is %s for %s',\n disable_protect == 'true' and 'enabled' or 'disabled', name\n )\n\n return disable_protect\n\n\ndef show_detailed_monitoring(name=None, instance_id=None, call=None, quiet=False):\n '''\n Show the details from EC2 regarding cloudwatch detailed monitoring.\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_detailed_monitoring action must be called with -a or --action.'\n )\n location = get_location()\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if not name and not instance_id:\n raise SaltCloudSystemExit(\n 'The show_detailed_monitoring action must be provided with a name or instance\\\n ID'\n )\n matched = _get_node(name=name, instance_id=instance_id, location=location)\n log.log(\n logging.DEBUG if quiet is True else logging.INFO,\n 'Detailed Monitoring is %s for %s', matched['monitoring'], name\n )\n return matched['monitoring']\n\n\ndef _toggle_term_protect(name, value):\n '''\n Enable or Disable termination protection on a node\n\n '''\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'ModifyInstanceAttribute',\n 'InstanceId': instance_id,\n 'DisableApiTermination.Value': value}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_term_protect(name=name, instance_id=instance_id, call='action')\n\n\ndef enable_term_protect(name, call=None):\n '''\n Enable termination protection on a node\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a enable_term_protect mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n return _toggle_term_protect(name, 'true')\n\n\ndef disable_term_protect(name, call=None):\n '''\n Disable termination protection on a node\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a disable_term_protect mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n return _toggle_term_protect(name, 'false')\n\n\ndef disable_detailed_monitoring(name, call=None):\n '''\n Enable/disable detailed monitoring on a node\n\n CLI Example:\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'UnmonitorInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_detailed_monitoring(name=name, instance_id=instance_id, call='action')\n\n\ndef enable_detailed_monitoring(name, call=None):\n '''\n Enable/disable detailed monitoring on a node\n\n CLI Example:\n\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'MonitorInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_detailed_monitoring(name=name, instance_id=instance_id, call='action')\n\n\ndef show_delvol_on_destroy(name, kwargs=None, call=None):\n '''\n Do not delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a show_delvol_on_destroy mymachine\n '''\n\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_delvol_on_destroy action must be called '\n 'with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n instance_id = kwargs.get('instance_id', None)\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n if instance_id is None:\n instance_id = _get_node(name)['instanceId']\n\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n\n data = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n blockmap = data[0]['instancesSet']['item']['blockDeviceMapping']\n\n if not isinstance(blockmap['item'], list):\n blockmap['item'] = [blockmap['item']]\n\n items = []\n\n for idx, item in enumerate(blockmap['item']):\n device_name = item['deviceName']\n\n if device is not None and device != device_name:\n continue\n\n if volume_id is not None and volume_id != item['ebs']['volumeId']:\n continue\n\n info = {\n 'device_name': device_name,\n 'volume_id': item['ebs']['volumeId'],\n 'deleteOnTermination': item['ebs']['deleteOnTermination']\n }\n\n items.append(info)\n\n return items\n\n\ndef keepvol_on_destroy(name, kwargs=None, call=None):\n '''\n Do not delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a keepvol_on_destroy mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The keepvol_on_destroy action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n return _toggle_delvol(name=name, device=device,\n volume_id=volume_id, value='false')\n\n\ndef delvol_on_destroy(name, kwargs=None, call=None):\n '''\n Delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a delvol_on_destroy mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The delvol_on_destroy action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n return _toggle_delvol(name=name, device=device,\n volume_id=volume_id, value='true')\n\n\ndef _toggle_delvol(name=None, instance_id=None, device=None, volume_id=None,\n value=None, requesturl=None):\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if requesturl:\n data = aws.query(requesturl=requesturl,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n else:\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n data, requesturl = aws.query(params, # pylint: disable=unbalanced-tuple-unpacking\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n blockmap = data[0]['instancesSet']['item']['blockDeviceMapping']\n\n params = {'Action': 'ModifyInstanceAttribute',\n 'InstanceId': instance_id}\n\n if not isinstance(blockmap['item'], list):\n blockmap['item'] = [blockmap['item']]\n\n for idx, item in enumerate(blockmap['item']):\n device_name = item['deviceName']\n\n if device is not None and device != device_name:\n continue\n if volume_id is not None and volume_id != item['ebs']['volumeId']:\n continue\n\n params['BlockDeviceMapping.{0}.DeviceName'.format(idx)] = device_name\n params['BlockDeviceMapping.{0}.Ebs.DeleteOnTermination'.format(idx)] = value\n\n aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n kwargs = {'instance_id': instance_id,\n 'device': device,\n 'volume_id': volume_id}\n return show_delvol_on_destroy(name, kwargs, call='action')\n\n\ndef register_image(kwargs=None, call=None):\n '''\n Create an ami from a snapshot\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -f register_image my-ec2-config ami_name=my_ami description=\"my description\"\n root_device_name=/dev/xvda snapshot_id=snap-xxxxxxxx\n '''\n\n if call != 'function':\n log.error(\n 'The create_volume function must be called with -f or --function.'\n )\n return False\n\n if 'ami_name' not in kwargs:\n log.error('ami_name must be specified to register an image.')\n return False\n\n block_device_mapping = kwargs.get('block_device_mapping', None)\n if not block_device_mapping:\n if 'snapshot_id' not in kwargs:\n log.error('snapshot_id or block_device_mapping must be specified to register an image.')\n return False\n if 'root_device_name' not in kwargs:\n log.error('root_device_name or block_device_mapping must be specified to register an image.')\n return False\n block_device_mapping = [{\n 'DeviceName': kwargs['root_device_name'],\n 'Ebs': {\n 'VolumeType': kwargs.get('volume_type', 'gp2'),\n 'SnapshotId': kwargs['snapshot_id'],\n }\n }]\n\n if not isinstance(block_device_mapping, list):\n block_device_mapping = [block_device_mapping]\n\n params = {'Action': 'RegisterImage',\n 'Name': kwargs['ami_name']}\n\n params.update(_param_from_config('BlockDeviceMapping', block_device_mapping))\n\n if 'root_device_name' in kwargs:\n params['RootDeviceName'] = kwargs['root_device_name']\n\n if 'description' in kwargs:\n params['Description'] = kwargs['description']\n\n if 'virtualization_type' in kwargs:\n params['VirtualizationType'] = kwargs['virtualization_type']\n\n if 'architecture' in kwargs:\n params['Architecture'] = kwargs['architecture']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n r_data = {}\n for d in data[0]:\n for k, v in d.items():\n r_data[k] = v\n\n return r_data\n\n\ndef volume_create(**kwargs):\n '''\n Wrapper around create_volume.\n Here just to ensure the compatibility with the cloud module.\n '''\n return create_volume(kwargs, 'function')\n\n\ndef create_volume(kwargs=None, call=None, wait_to_finish=False):\n '''\n Create a volume.\n\n zone\n The availability zone used to create the volume. Required. String.\n\n size\n The size of the volume, in GiBs. Defaults to ``10``. Integer.\n\n snapshot\n The snapshot-id from which to create the volume. Integer.\n\n type\n The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned\n IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for\n Magnetic volumes. String.\n\n iops\n The number of I/O operations per second (IOPS) to provision for the volume,\n with a maximum ratio of 50 IOPS/GiB. Only valid for Provisioned IOPS SSD\n volumes. Integer.\n\n This option will only be set if ``type`` is also specified as ``io1``.\n\n encrypted\n Specifies whether the volume will be encrypted. Boolean.\n\n If ``snapshot`` is also given in the list of kwargs, then this value is ignored\n since volumes that are created from encrypted snapshots are also automatically\n encrypted.\n\n tags\n The tags to apply to the volume during creation. Dictionary.\n\n call\n The ``create_volume`` function must be called with ``-f`` or ``--function``.\n String.\n\n wait_to_finish\n Whether or not to wait for the volume to be available. Boolean. Defaults to\n ``False``.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f create_volume my-ec2-config zone=us-east-1b\n salt-cloud -f create_volume my-ec2-config zone=us-east-1b tags='{\"tag1\": \"val1\", \"tag2\", \"val2\"}'\n '''\n if call != 'function':\n log.error(\n 'The create_volume function must be called with -f or --function.'\n )\n return False\n\n if 'zone' not in kwargs:\n log.error('An availability zone must be specified to create a volume.')\n return False\n\n if 'size' not in kwargs and 'snapshot' not in kwargs:\n # This number represents GiB\n kwargs['size'] = '10'\n\n params = {'Action': 'CreateVolume',\n 'AvailabilityZone': kwargs['zone']}\n\n if 'size' in kwargs:\n params['Size'] = kwargs['size']\n\n if 'snapshot' in kwargs:\n params['SnapshotId'] = kwargs['snapshot']\n\n if 'type' in kwargs:\n params['VolumeType'] = kwargs['type']\n\n if 'iops' in kwargs and kwargs.get('type', 'standard') == 'io1':\n params['Iops'] = kwargs['iops']\n\n # You can't set `encrypted` if you pass a snapshot\n if 'encrypted' in kwargs and 'snapshot' not in kwargs:\n params['Encrypted'] = kwargs['encrypted']\n if 'kmskeyid' in kwargs:\n params['KmsKeyId'] = kwargs['kmskeyid']\n if 'kmskeyid' in kwargs and 'encrypted' not in kwargs:\n log.error(\n 'If a KMS Key ID is specified, encryption must be enabled'\n )\n return False\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n r_data = {}\n for d in data[0]:\n for k, v in six.iteritems(d):\n r_data[k] = v\n volume_id = r_data['volumeId']\n\n # Allow tags to be set upon creation\n if 'tags' in kwargs:\n if isinstance(kwargs['tags'], six.string_types):\n tags = salt.utils.yaml.safe_load(kwargs['tags'])\n else:\n tags = kwargs['tags']\n\n if isinstance(tags, dict):\n new_tags = set_tags(tags=tags,\n resource_id=volume_id,\n call='action',\n location=get_location())\n r_data['tags'] = new_tags\n\n # Waits till volume is available\n if wait_to_finish:\n salt.utils.cloud.run_func_until_ret_arg(fun=describe_volumes,\n kwargs={'volume_id': volume_id},\n fun_call=call,\n argument_being_watched='status',\n required_argument_response='available')\n\n return r_data\n\n\ndef __attach_vol_to_instance(params, kws, instance_id):\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if data[0]:\n log.warning(\n 'Error attaching volume %s to instance %s. Retrying!',\n kws['volume_id'], instance_id\n )\n return False\n\n return data\n\n\ndef attach_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Attach a volume to an instance\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The attach_volume action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n if 'device' not in kwargs:\n log.error('A device is required (ex. /dev/sdb1).')\n return False\n\n params = {'Action': 'AttachVolume',\n 'VolumeId': kwargs['volume_id'],\n 'InstanceId': instance_id,\n 'Device': kwargs['device']}\n\n log.debug(params)\n\n vm_ = get_configured_provider()\n\n data = salt.utils.cloud.wait_for_ip(\n __attach_vol_to_instance,\n update_args=(params, kwargs, instance_id),\n timeout=config.get_cloud_config_value(\n 'wait_for_ip_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_ip_interval', vm_, __opts__, default=10),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_ip_interval_multiplier', vm_, __opts__, default=1),\n )\n\n return data\n\n\ndef show_volume(kwargs=None, call=None):\n '''\n Wrapper around describe_volumes.\n Here just to keep functionality.\n Might be depreciated later.\n '''\n if not kwargs:\n kwargs = {}\n\n return describe_volumes(kwargs, call)\n\n\ndef detach_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Detach a volume from an instance\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The detach_volume action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n params = {'Action': 'DetachVolume',\n 'VolumeId': kwargs['volume_id']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef delete_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Delete a volume\n '''\n if not kwargs:\n kwargs = {}\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n params = {'Action': 'DeleteVolume',\n 'VolumeId': kwargs['volume_id']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef volume_list(**kwargs):\n '''\n Wrapper around describe_volumes.\n Here just to ensure the compatibility with the cloud module.\n '''\n return describe_volumes(kwargs, 'function')\n\n\ndef describe_volumes(kwargs=None, call=None):\n '''\n Describe a volume (or volumes)\n\n volume_id\n One or more volume IDs. Multiple IDs must be separated by \",\".\n\n TODO: Add all of the filters.\n '''\n if call != 'function':\n log.error(\n 'The describe_volumes function must be called with -f '\n 'or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n params = {'Action': 'DescribeVolumes'}\n\n if 'volume_id' in kwargs:\n volume_id = kwargs['volume_id'].split(',')\n for volume_index, volume_id in enumerate(volume_id):\n params['VolumeId.{0}'.format(volume_index)] = volume_id\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef create_keypair(kwargs=None, call=None):\n '''\n Create an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The create_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'CreateKeyPair',\n 'KeyName': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n keys = [x for x in data[0] if 'requestId' not in x]\n\n return (keys, data[1])\n\n\ndef import_keypair(kwargs=None, call=None):\n '''\n Import an SSH public key.\n\n .. versionadded:: 2015.8.3\n '''\n if call != 'function':\n log.error(\n 'The import_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n if 'file' not in kwargs:\n log.error('A public key file is required.')\n return False\n\n params = {'Action': 'ImportKeyPair',\n 'KeyName': kwargs['keyname']}\n\n public_key_file = kwargs['file']\n\n if os.path.exists(public_key_file):\n with salt.utils.files.fopen(public_key_file, 'r') as fh_:\n public_key = salt.utils.stringutils.to_unicode(fh_.read())\n\n if public_key is not None:\n params['PublicKeyMaterial'] = base64.b64encode(public_key)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef show_keypair(kwargs=None, call=None):\n '''\n Show the details of an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The show_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'DescribeKeyPairs',\n 'KeyName.1': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef delete_keypair(kwargs=None, call=None):\n '''\n Delete an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The delete_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'DeleteKeyPair',\n 'KeyName': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef create_snapshot(kwargs=None, call=None, wait_to_finish=False):\n '''\n Create a snapshot.\n\n volume_id\n The ID of the Volume from which to create a snapshot.\n\n description\n The optional description of the snapshot.\n\n CLI Exampe:\n\n .. code-block:: bash\n\n salt-cloud -f create_snapshot my-ec2-config volume_id=vol-351d8826\n salt-cloud -f create_snapshot my-ec2-config volume_id=vol-351d8826 \\\\\n description=\"My Snapshot Description\"\n '''\n if call != 'function':\n raise SaltCloudSystemExit(\n 'The create_snapshot function must be called with -f '\n 'or --function.'\n )\n\n if kwargs is None:\n kwargs = {}\n\n volume_id = kwargs.get('volume_id', None)\n description = kwargs.get('description', '')\n\n if volume_id is None:\n raise SaltCloudSystemExit(\n 'A volume_id must be specified to create a snapshot.'\n )\n\n params = {'Action': 'CreateSnapshot',\n 'VolumeId': volume_id,\n 'Description': description}\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')[0]\n\n r_data = {}\n for d in data:\n for k, v in six.iteritems(d):\n r_data[k] = v\n\n if 'snapshotId' in r_data:\n snapshot_id = r_data['snapshotId']\n\n # Waits till volume is available\n if wait_to_finish:\n salt.utils.cloud.run_func_until_ret_arg(fun=describe_snapshots,\n kwargs={'snapshot_id': snapshot_id},\n fun_call=call,\n argument_being_watched='status',\n required_argument_response='completed')\n\n return r_data\n\n\ndef delete_snapshot(kwargs=None, call=None):\n '''\n Delete a snapshot\n '''\n if call != 'function':\n log.error(\n 'The delete_snapshot function must be called with -f '\n 'or --function.'\n )\n return False\n\n if 'snapshot_id' not in kwargs:\n log.error('A snapshot_id must be specified to delete a snapshot.')\n return False\n\n params = {'Action': 'DeleteSnapshot'}\n\n if 'snapshot_id' in kwargs:\n params['SnapshotId'] = kwargs['snapshot_id']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef copy_snapshot(kwargs=None, call=None):\n '''\n Copy a snapshot\n '''\n if call != 'function':\n log.error(\n 'The copy_snapshot function must be called with -f or --function.'\n )\n return False\n\n if 'source_region' not in kwargs:\n log.error('A source_region must be specified to copy a snapshot.')\n return False\n\n if 'source_snapshot_id' not in kwargs:\n log.error('A source_snapshot_id must be specified to copy a snapshot.')\n return False\n\n if 'description' not in kwargs:\n kwargs['description'] = ''\n\n params = {'Action': 'CopySnapshot'}\n\n if 'source_region' in kwargs:\n params['SourceRegion'] = kwargs['source_region']\n\n if 'source_snapshot_id' in kwargs:\n params['SourceSnapshotId'] = kwargs['source_snapshot_id']\n\n if 'description' in kwargs:\n params['Description'] = kwargs['description']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef describe_snapshots(kwargs=None, call=None):\n '''\n Describe a snapshot (or snapshots)\n\n snapshot_id\n One or more snapshot IDs. Multiple IDs must be separated by \",\".\n\n owner\n Return the snapshots owned by the specified owner. Valid values\n include: self, amazon, <AWS Account ID>. Multiple values must be\n separated by \",\".\n\n restorable_by\n One or more AWS accounts IDs that can create volumes from the snapshot.\n Multiple aws account IDs must be separated by \",\".\n\n TODO: Add all of the filters.\n '''\n if call != 'function':\n log.error(\n 'The describe_snapshot function must be called with -f '\n 'or --function.'\n )\n return False\n\n params = {'Action': 'DescribeSnapshots'}\n\n # The AWS correct way is to use non-plurals like snapshot_id INSTEAD of snapshot_ids.\n if 'snapshot_ids' in kwargs:\n kwargs['snapshot_id'] = kwargs['snapshot_ids']\n\n if 'snapshot_id' in kwargs:\n snapshot_ids = kwargs['snapshot_id'].split(',')\n for snapshot_index, snapshot_id in enumerate(snapshot_ids):\n params['SnapshotId.{0}'.format(snapshot_index)] = snapshot_id\n\n if 'owner' in kwargs:\n owners = kwargs['owner'].split(',')\n for owner_index, owner in enumerate(owners):\n params['Owner.{0}'.format(owner_index)] = owner\n\n if 'restorable_by' in kwargs:\n restorable_bys = kwargs['restorable_by'].split(',')\n for restorable_by_index, restorable_by in enumerate(restorable_bys):\n params[\n 'RestorableBy.{0}'.format(restorable_by_index)\n ] = restorable_by\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\n\ndef get_password_data(\n name=None,\n kwargs=None,\n instance_id=None,\n call=None,\n ):\n '''\n Return password data for a Windows instance.\n\n By default only the encrypted password data will be returned. However, if a\n key_file is passed in, then a decrypted password will also be returned.\n\n Note that the key_file references the private key that was used to generate\n the keypair associated with this instance. This private key will _not_ be\n transmitted to Amazon; it is only used internally inside of Salt Cloud to\n decrypt data _after_ it has been received from Amazon.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a get_password_data mymachine\n salt-cloud -a get_password_data mymachine key_file=/root/ec2key.pem\n\n Note: PKCS1_v1_5 was added in PyCrypto 2.5\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The get_password_data action must be called with '\n '-a or --action.'\n )\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if kwargs is None:\n kwargs = {}\n\n if instance_id is None:\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n params = {'Action': 'GetPasswordData',\n 'InstanceId': instance_id}\n\n ret = {}\n data = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for item in data:\n ret[next(six.iterkeys(item))] = next(six.itervalues(item))\n\n if not HAS_M2 and not HAS_PYCRYPTO:\n return ret\n\n if 'key' not in kwargs:\n if 'key_file' in kwargs:\n with salt.utils.files.fopen(kwargs['key_file'], 'r') as kf_:\n kwargs['key'] = salt.utils.stringutils.to_unicode(kf_.read())\n\n if 'key' in kwargs:\n pwdata = ret.get('passwordData', None)\n if pwdata is not None:\n rsa_key = kwargs['key']\n pwdata = base64.b64decode(pwdata)\n if HAS_M2:\n key = RSA.load_key_string(rsa_key.encode('ascii'))\n password = key.private_decrypt(pwdata, RSA.pkcs1_padding)\n else:\n dsize = Crypto.Hash.SHA.digest_size\n sentinel = Crypto.Random.new().read(15 + dsize)\n key_obj = Crypto.PublicKey.RSA.importKey(rsa_key)\n key_obj = PKCS1_v1_5.new(key_obj)\n password = key_obj.decrypt(pwdata, sentinel)\n ret['password'] = salt.utils.stringutils.to_unicode(password)\n\n return ret\n\n\ndef update_pricing(kwargs=None, call=None):\n '''\n Download most recent pricing information from AWS and convert to a local\n JSON file.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f update_pricing my-ec2-config\n salt-cloud -f update_pricing my-ec2-config type=linux\n\n .. versionadded:: 2015.8.0\n '''\n sources = {\n 'linux': 'https://a0.awsstatic.com/pricing/1/ec2/linux-od.min.js',\n 'rhel': 'https://a0.awsstatic.com/pricing/1/ec2/rhel-od.min.js',\n 'sles': 'https://a0.awsstatic.com/pricing/1/ec2/sles-od.min.js',\n 'mswin': 'https://a0.awsstatic.com/pricing/1/ec2/mswin-od.min.js',\n 'mswinsql': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQL-od.min.js',\n 'mswinsqlweb': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQLWeb-od.min.js',\n }\n\n if kwargs is None:\n kwargs = {}\n\n if 'type' not in kwargs:\n for source in sources:\n _parse_pricing(sources[source], source)\n else:\n _parse_pricing(sources[kwargs['type']], kwargs['type'])\n\n\ndef _parse_pricing(url, name):\n '''\n Download and parse an individual pricing file from AWS\n\n .. versionadded:: 2015.8.0\n '''\n price_js = http.query(url, text=True)\n\n items = []\n current_item = ''\n\n price_js = re.sub(JS_COMMENT_RE, '', price_js['text'])\n price_js = price_js.strip().rstrip(');').lstrip('callback(')\n for keyword in (\n 'vers',\n 'config',\n 'rate',\n 'valueColumns',\n 'currencies',\n 'instanceTypes',\n 'type',\n 'ECU',\n 'storageGB',\n 'name',\n 'vCPU',\n 'memoryGiB',\n 'storageGiB',\n 'USD',\n ):\n price_js = price_js.replace(keyword, '\"{0}\"'.format(keyword))\n\n for keyword in ('region', 'price', 'size'):\n price_js = price_js.replace(keyword, '\"{0}\"'.format(keyword))\n price_js = price_js.replace('\"{0}\"s'.format(keyword), '\"{0}s\"'.format(keyword))\n\n price_js = price_js.replace('\"\"', '\"')\n\n # Turn the data into something that's easier/faster to process\n regions = {}\n price_json = salt.utils.json.loads(price_js)\n for region in price_json['config']['regions']:\n sizes = {}\n for itype in region['instanceTypes']:\n for size in itype['sizes']:\n sizes[size['size']] = size\n regions[region['region']] = sizes\n\n outfile = os.path.join(\n __opts__['cachedir'], 'ec2-pricing-{0}.p'.format(name)\n )\n with salt.utils.files.fopen(outfile, 'w') as fho:\n salt.utils.msgpack.dump(regions, fho)\n\n return True\n\n\ndef show_pricing(kwargs=None, call=None):\n '''\n Show pricing for a particular profile. This is only an estimate, based on\n unofficial pricing sources.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f show_pricing my-ec2-config profile=my-profile\n\n If pricing sources have not been cached, they will be downloaded. Once they\n have been cached, they will not be updated automatically. To manually update\n all prices, use the following command:\n\n .. code-block:: bash\n\n salt-cloud -f update_pricing <provider>\n\n .. versionadded:: 2015.8.0\n '''\n profile = __opts__['profiles'].get(kwargs['profile'], {})\n if not profile:\n return {'Error': 'The requested profile was not found'}\n\n # Make sure the profile belongs to ec2\n provider = profile.get('provider', '0:0')\n comps = provider.split(':')\n if len(comps) < 2 or comps[1] != 'ec2':\n return {'Error': 'The requested profile does not belong to EC2'}\n\n image_id = profile.get('image', None)\n image_dict = show_image({'image': image_id}, 'function')\n image_info = image_dict[0]\n\n # Find out what platform it is\n if image_info.get('imageOwnerAlias', '') == 'amazon':\n if image_info.get('platform', '') == 'windows':\n image_description = image_info.get('description', '')\n if 'sql' in image_description.lower():\n if 'web' in image_description.lower():\n name = 'mswinsqlweb'\n else:\n name = 'mswinsql'\n else:\n name = 'mswin'\n elif image_info.get('imageLocation', '').strip().startswith('amazon/suse'):\n name = 'sles'\n else:\n name = 'linux'\n elif image_info.get('imageOwnerId', '') == '309956199498':\n name = 'rhel'\n else:\n name = 'linux'\n\n pricefile = os.path.join(\n __opts__['cachedir'], 'ec2-pricing-{0}.p'.format(name)\n )\n\n if not os.path.isfile(pricefile):\n update_pricing({'type': name}, 'function')\n\n with salt.utils.files.fopen(pricefile, 'r') as fhi:\n ec2_price = salt.utils.stringutils.to_unicode(\n salt.utils.msgpack.load(fhi))\n\n region = get_location(profile)\n size = profile.get('size', None)\n if size is None:\n return {'Error': 'The requested profile does not contain a size'}\n\n try:\n raw = ec2_price[region][size]\n except KeyError:\n return {'Error': 'The size ({0}) in the requested profile does not have '\n 'a price associated with it for the {1} region'.format(size, region)}\n\n ret = {}\n if kwargs.get('raw', False):\n ret['_raw'] = raw\n\n ret['per_hour'] = 0\n for col in raw.get('valueColumns', []):\n ret['per_hour'] += decimal.Decimal(col['prices'].get('USD', 0))\n\n ret['per_hour'] = decimal.Decimal(ret['per_hour'])\n ret['per_day'] = ret['per_hour'] * 24\n ret['per_week'] = ret['per_day'] * 7\n ret['per_month'] = ret['per_day'] * 30\n ret['per_year'] = ret['per_week'] * 52\n\n return {profile['profile']: ret}\n\n\ndef ssm_create_association(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Associates the specified SSM document with the specified instance\n\n http://docs.aws.amazon.com/ssm/latest/APIReference/API_CreateAssociation.html\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a ssm_create_association ec2-instance-name ssm_document=ssm-document-name\n '''\n\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The ssm_create_association action must be called with '\n '-a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'ssm_document' not in kwargs:\n log.error('A ssm_document is required.')\n return False\n\n params = {'Action': 'CreateAssociation',\n 'InstanceId': instance_id,\n 'Name': kwargs['ssm_document']}\n\n result = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n product='ssm',\n opts=__opts__,\n sigver='4')\n log.info(result)\n return result\n\n\ndef ssm_describe_association(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Describes the associations for the specified SSM document or instance.\n\n http://docs.aws.amazon.com/ssm/latest/APIReference/API_DescribeAssociation.html\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a ssm_describe_association ec2-instance-name ssm_document=ssm-document-name\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The ssm_describe_association action must be called with '\n '-a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'ssm_document' not in kwargs:\n log.error('A ssm_document is required.')\n return False\n\n params = {'Action': 'DescribeAssociation',\n 'InstanceId': instance_id,\n 'Name': kwargs['ssm_document']}\n\n result = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n product='ssm',\n opts=__opts__,\n sigver='4')\n log.info(result)\n return result\n"}}},{"rowIdx":354,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/cloud/clouds/ec2.py"},"func_name":{"kind":"string","value":"get_password_data"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def get_password_data(\n name=None,\n kwargs=None,\n instance_id=None,\n call=None,\n ):\n '''\n Return password data for a Windows instance.\n\n By default only the encrypted password data will be returned. However, if a\n key_file is passed in, then a decrypted password will also be returned.\n\n Note that the key_file references the private key that was used to generate\n the keypair associated with this instance. This private key will _not_ be\n transmitted to Amazon; it is only used internally inside of Salt Cloud to\n decrypt data _after_ it has been received from Amazon.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a get_password_data mymachine\n salt-cloud -a get_password_data mymachine key_file=/root/ec2key.pem\n\n Note: PKCS1_v1_5 was added in PyCrypto 2.5\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The get_password_data action must be called with '\n '-a or --action.'\n )\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if kwargs is None:\n kwargs = {}\n\n if instance_id is None:\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n params = {'Action': 'GetPasswordData',\n 'InstanceId': instance_id}\n\n ret = {}\n data = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for item in data:\n ret[next(six.iterkeys(item))] = next(six.itervalues(item))\n\n if not HAS_M2 and not HAS_PYCRYPTO:\n return ret\n\n if 'key' not in kwargs:\n if 'key_file' in kwargs:\n with salt.utils.files.fopen(kwargs['key_file'], 'r') as kf_:\n kwargs['key'] = salt.utils.stringutils.to_unicode(kf_.read())\n\n if 'key' in kwargs:\n pwdata = ret.get('passwordData', None)\n if pwdata is not None:\n rsa_key = kwargs['key']\n pwdata = base64.b64decode(pwdata)\n if HAS_M2:\n key = RSA.load_key_string(rsa_key.encode('ascii'))\n password = key.private_decrypt(pwdata, RSA.pkcs1_padding)\n else:\n dsize = Crypto.Hash.SHA.digest_size\n sentinel = Crypto.Random.new().read(15 + dsize)\n key_obj = Crypto.PublicKey.RSA.importKey(rsa_key)\n key_obj = PKCS1_v1_5.new(key_obj)\n password = key_obj.decrypt(pwdata, sentinel)\n ret['password'] = salt.utils.stringutils.to_unicode(password)\n\n return ret"},"func_documentation_string":{"kind":"string","value":"Return password data for a Windows instance.\n\n By default only the encrypted password data will be returned. However, if a\n key_file is passed in, then a decrypted password will also be returned.\n\n Note that the key_file references the private key that was used to generate\n the keypair associated with this instance. This private key will _not_ be\n transmitted to Amazon; it is only used internally inside of Salt Cloud to\n decrypt data _after_ it has been received from Amazon.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a get_password_data mymachine\n salt-cloud -a get_password_data mymachine key_file=/root/ec2key.pem\n\n Note: PKCS1_v1_5 was added in PyCrypto 2.5"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4851-L4932"},"called_functions":{"kind":"list like","value":["def iterkeys(d, **kw):\n return d.iterkeys(**kw)\n","def itervalues(d, **kw):\n return d.itervalues(**kw)\n","def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_comps[0]\n return provider\n","def fopen(*args, **kwargs):\n '''\n Wrapper around open() built-in to set CLOEXEC on the fd.\n\n This flag specifies that the file descriptor should be closed when an exec\n function is invoked;\n\n When a file descriptor is allocated (as with open or dup), this bit is\n initially cleared on the new file descriptor, meaning that descriptor will\n survive into the new program after exec.\n\n NB! We still have small race condition between open and fcntl.\n '''\n if six.PY3:\n try:\n # Don't permit stdin/stdout/stderr to be opened. The boolean False\n # and True are treated by Python 3's open() as file descriptors 0\n # and 1, respectively.\n if args[0] in (0, 1, 2):\n raise TypeError(\n '{0} is not a permitted file descriptor'.format(args[0])\n )\n except IndexError:\n pass\n binary = None\n # ensure 'binary' mode is always used on Windows in Python 2\n if ((six.PY2 and salt.utils.platform.is_windows() and 'binary' not in kwargs) or\n kwargs.pop('binary', False)):\n if len(args) > 1:\n args = list(args)\n if 'b' not in args[1]:\n args[1] = args[1].replace('t', 'b')\n if 'b' not in args[1]:\n args[1] += 'b'\n elif kwargs.get('mode'):\n if 'b' not in kwargs['mode']:\n kwargs['mode'] = kwargs['mode'].replace('t', 'b')\n if 'b' not in kwargs['mode']:\n kwargs['mode'] += 'b'\n else:\n # the default is to read\n kwargs['mode'] = 'rb'\n elif six.PY3 and 'encoding' not in kwargs:\n # In Python 3, if text mode is used and the encoding\n # is not specified, set the encoding to 'utf-8'.\n binary = False\n if len(args) > 1:\n args = list(args)\n if 'b' in args[1]:\n binary = True\n if kwargs.get('mode', None):\n if 'b' in kwargs['mode']:\n binary = True\n if not binary:\n kwargs['encoding'] = __salt_system_encoding__\n\n if six.PY3 and not binary and not kwargs.get('newline', None):\n kwargs['newline'] = ''\n\n f_handle = open(*args, **kwargs) # pylint: disable=resource-leakage\n\n if is_fcntl_available():\n # modify the file descriptor on systems with fcntl\n # unix and unix-like systems only\n try:\n FD_CLOEXEC = fcntl.FD_CLOEXEC # pylint: disable=C0103\n except AttributeError:\n FD_CLOEXEC = 1 # pylint: disable=C0103\n old_flags = fcntl.fcntl(f_handle.fileno(), fcntl.F_GETFD)\n fcntl.fcntl(f_handle.fileno(), fcntl.F_SETFD, old_flags | FD_CLOEXEC)\n\n return f_handle\n","def to_unicode(s, encoding=None, errors='strict', normalize=False):\n '''\n Given str or unicode, return unicode (str for python 3)\n '''\n def _normalize(s):\n return unicodedata.normalize('NFC', s) if normalize else s\n\n if encoding is None:\n # Try utf-8 first, and fall back to detected encoding\n encoding = ('utf-8', __salt_system_encoding__)\n if not isinstance(encoding, (tuple, list)):\n encoding = (encoding,)\n\n if not encoding:\n raise ValueError('encoding cannot be empty')\n\n exc = None\n if six.PY3:\n if isinstance(s, str):\n return _normalize(s)\n elif isinstance(s, (bytes, bytearray)):\n return _normalize(to_str(s, encoding, errors))\n raise TypeError('expected str, bytes, or bytearray')\n else:\n # This needs to be str and not six.string_types, since if the string is\n # already a unicode type, it does not need to be decoded (and doing so\n # will raise an exception).\n if isinstance(s, unicode): # pylint: disable=incompatible-py3-code,undefined-variable\n return _normalize(s)\n elif isinstance(s, (str, bytearray)):\n for enc in encoding:\n try:\n return _normalize(s.decode(enc, errors))\n except UnicodeDecodeError as err:\n exc = err\n continue\n # The only way we get this far is if a UnicodeDecodeError was\n # raised, otherwise we would have already returned (or raised some\n # other exception).\n raise exc # pylint: disable=raising-bad-type\n raise TypeError('expected str or bytearray')\n","def query(params=None, setname=None, requesturl=None, location=None,\n return_url=False, return_root=False, opts=None, provider=None,\n endpoint=None, product='ec2', sigver='2'):\n '''\n Perform a query against AWS services using Signature Version 2 Signing\n Process. This is documented at:\n\n http://docs.aws.amazon.com/general/latest/gr/signature-version-2.html\n\n Regions and endpoints are documented at:\n\n http://docs.aws.amazon.com/general/latest/gr/rande.html\n\n Default ``product`` is ``ec2``. Valid ``product`` names are:\n\n .. code-block: yaml\n\n - autoscaling (Auto Scaling)\n - cloudformation (CloudFormation)\n - ec2 (Elastic Compute Cloud)\n - elasticache (ElastiCache)\n - elasticbeanstalk (Elastic BeanStalk)\n - elasticloadbalancing (Elastic Load Balancing)\n - elasticmapreduce (Elastic MapReduce)\n - iam (Identity and Access Management)\n - importexport (Import/Export)\n - monitoring (CloudWatch)\n - rds (Relational Database Service)\n - simpledb (SimpleDB)\n - sns (Simple Notification Service)\n - sqs (Simple Queue Service)\n '''\n if params is None:\n params = {}\n\n if opts is None:\n opts = {}\n\n function = opts.get('function', (None, product))\n providers = opts.get('providers', {})\n\n if provider is None:\n prov_dict = providers.get(function[1], {}).get(product, {})\n if prov_dict:\n driver = list(list(prov_dict.keys()))[0]\n provider = providers.get(driver, product)\n else:\n prov_dict = providers.get(provider, {}).get(product, {})\n\n service_url = prov_dict.get('service_url', 'amazonaws.com')\n\n if not location:\n location = get_location(opts, prov_dict)\n\n if endpoint is None:\n if not requesturl:\n endpoint = prov_dict.get(\n 'endpoint',\n '{0}.{1}.{2}'.format(product, location, service_url)\n )\n\n requesturl = 'https://{0}/'.format(endpoint)\n else:\n endpoint = urlparse(requesturl).netloc\n if endpoint == '':\n endpoint_err = ('Could not find a valid endpoint in the '\n 'requesturl: {0}. Looking for something '\n 'like https://some.aws.endpoint/?args').format(\n requesturl\n )\n log.error(endpoint_err)\n if return_url is True:\n return {'error': endpoint_err}, requesturl\n return {'error': endpoint_err}\n\n log.debug('Using AWS endpoint: %s', endpoint)\n method = 'GET'\n\n aws_api_version = prov_dict.get(\n 'aws_api_version', prov_dict.get(\n '{0}_api_version'.format(product),\n DEFAULT_AWS_API_VERSION\n )\n )\n\n # Fallback to ec2's id & key if none is found, for this component\n if not prov_dict.get('id', None):\n prov_dict['id'] = providers.get(provider, {}).get('ec2', {}).get('id', {})\n prov_dict['key'] = providers.get(provider, {}).get('ec2', {}).get('key', {})\n\n if sigver == '4':\n headers, requesturl = sig4(\n method, endpoint, params, prov_dict, aws_api_version, location, product, requesturl=requesturl\n )\n params_with_headers = {}\n else:\n params_with_headers = sig2(\n method, endpoint, params, prov_dict, aws_api_version\n )\n headers = {}\n\n attempts = 0\n while attempts < AWS_MAX_RETRIES:\n log.debug('AWS Request: %s', requesturl)\n log.trace('AWS Request Parameters: %s', params_with_headers)\n try:\n result = requests.get(requesturl, headers=headers, params=params_with_headers)\n log.debug('AWS Response Status Code: %s', result.status_code)\n log.trace(\n 'AWS Response Text: %s',\n result.text\n )\n result.raise_for_status()\n break\n except requests.exceptions.HTTPError as exc:\n root = ET.fromstring(exc.response.content)\n data = xml.to_dict(root)\n\n # check to see if we should retry the query\n err_code = data.get('Errors', {}).get('Error', {}).get('Code', '')\n if attempts < AWS_MAX_RETRIES and err_code and err_code in AWS_RETRY_CODES:\n attempts += 1\n log.error(\n 'AWS Response Status Code and Error: [%s %s] %s; '\n 'Attempts remaining: %s',\n exc.response.status_code, exc, data, attempts\n )\n sleep_exponential_backoff(attempts)\n continue\n\n log.error(\n 'AWS Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n else:\n log.error(\n 'AWS Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n\n root = ET.fromstring(result.text)\n items = root[1]\n if return_root is True:\n items = root\n\n if setname:\n if sys.version_info < (2, 7):\n children_len = len(root.getchildren())\n else:\n children_len = len(root)\n\n for item in range(0, children_len):\n comps = root[item].tag.split('}')\n if comps[1] == setname:\n items = root[item]\n\n ret = []\n for item in items:\n ret.append(xml.to_dict(item))\n\n if return_url is True:\n return ret, requesturl\n\n return ret\n","def get_location(vm_=None):\n '''\n Return the EC2 region to use, in this order:\n - CLI parameter\n - VM parameter\n - Cloud profile setting\n '''\n return __opts__.get(\n 'location',\n config.get_cloud_config_value(\n 'location',\n vm_ or get_configured_provider(),\n __opts__,\n default=DEFAULT_LOCATION,\n search_global=False\n )\n )\n","def _get_node(name=None, instance_id=None, location=None):\n if location is None:\n location = get_location()\n\n params = {'Action': 'DescribeInstances'}\n\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if instance_id:\n params['InstanceId.1'] = instance_id\n else:\n params['Filter.1.Name'] = 'tag:Name'\n params['Filter.1.Value.1'] = name\n\n log.trace(params)\n\n provider = get_provider()\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n try:\n instances = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n instance_info = _extract_instance_info(instances).values()\n return next(iter(instance_info))\n except IndexError:\n attempts += 1\n log.debug(\n 'Failed to get the data for node \\'%s\\'. Remaining '\n 'attempts: %s', instance_id or name, attempts\n )\n aws.sleep_exponential_backoff(attempts)\n return {}\n"],"string":"[\n \"def iterkeys(d, **kw):\\n return d.iterkeys(**kw)\\n\",\n \"def itervalues(d, **kw):\\n return d.itervalues(**kw)\\n\",\n \"def get_provider(vm_=None):\\n '''\\n Extract the provider name from vm\\n '''\\n if vm_ is None:\\n provider = __active_provider_name__ or 'ec2'\\n else:\\n provider = vm_.get('provider', 'ec2')\\n\\n if ':' in provider:\\n prov_comps = provider.split(':')\\n provider = prov_comps[0]\\n return provider\\n\",\n \"def fopen(*args, **kwargs):\\n '''\\n Wrapper around open() built-in to set CLOEXEC on the fd.\\n\\n This flag specifies that the file descriptor should be closed when an exec\\n function is invoked;\\n\\n When a file descriptor is allocated (as with open or dup), this bit is\\n initially cleared on the new file descriptor, meaning that descriptor will\\n survive into the new program after exec.\\n\\n NB! We still have small race condition between open and fcntl.\\n '''\\n if six.PY3:\\n try:\\n # Don't permit stdin/stdout/stderr to be opened. The boolean False\\n # and True are treated by Python 3's open() as file descriptors 0\\n # and 1, respectively.\\n if args[0] in (0, 1, 2):\\n raise TypeError(\\n '{0} is not a permitted file descriptor'.format(args[0])\\n )\\n except IndexError:\\n pass\\n binary = None\\n # ensure 'binary' mode is always used on Windows in Python 2\\n if ((six.PY2 and salt.utils.platform.is_windows() and 'binary' not in kwargs) or\\n kwargs.pop('binary', False)):\\n if len(args) > 1:\\n args = list(args)\\n if 'b' not in args[1]:\\n args[1] = args[1].replace('t', 'b')\\n if 'b' not in args[1]:\\n args[1] += 'b'\\n elif kwargs.get('mode'):\\n if 'b' not in kwargs['mode']:\\n kwargs['mode'] = kwargs['mode'].replace('t', 'b')\\n if 'b' not in kwargs['mode']:\\n kwargs['mode'] += 'b'\\n else:\\n # the default is to read\\n kwargs['mode'] = 'rb'\\n elif six.PY3 and 'encoding' not in kwargs:\\n # In Python 3, if text mode is used and the encoding\\n # is not specified, set the encoding to 'utf-8'.\\n binary = False\\n if len(args) > 1:\\n args = list(args)\\n if 'b' in args[1]:\\n binary = True\\n if kwargs.get('mode', None):\\n if 'b' in kwargs['mode']:\\n binary = True\\n if not binary:\\n kwargs['encoding'] = __salt_system_encoding__\\n\\n if six.PY3 and not binary and not kwargs.get('newline', None):\\n kwargs['newline'] = ''\\n\\n f_handle = open(*args, **kwargs) # pylint: disable=resource-leakage\\n\\n if is_fcntl_available():\\n # modify the file descriptor on systems with fcntl\\n # unix and unix-like systems only\\n try:\\n FD_CLOEXEC = fcntl.FD_CLOEXEC # pylint: disable=C0103\\n except AttributeError:\\n FD_CLOEXEC = 1 # pylint: disable=C0103\\n old_flags = fcntl.fcntl(f_handle.fileno(), fcntl.F_GETFD)\\n fcntl.fcntl(f_handle.fileno(), fcntl.F_SETFD, old_flags | FD_CLOEXEC)\\n\\n return f_handle\\n\",\n \"def to_unicode(s, encoding=None, errors='strict', normalize=False):\\n '''\\n Given str or unicode, return unicode (str for python 3)\\n '''\\n def _normalize(s):\\n return unicodedata.normalize('NFC', s) if normalize else s\\n\\n if encoding is None:\\n # Try utf-8 first, and fall back to detected encoding\\n encoding = ('utf-8', __salt_system_encoding__)\\n if not isinstance(encoding, (tuple, list)):\\n encoding = (encoding,)\\n\\n if not encoding:\\n raise ValueError('encoding cannot be empty')\\n\\n exc = None\\n if six.PY3:\\n if isinstance(s, str):\\n return _normalize(s)\\n elif isinstance(s, (bytes, bytearray)):\\n return _normalize(to_str(s, encoding, errors))\\n raise TypeError('expected str, bytes, or bytearray')\\n else:\\n # This needs to be str and not six.string_types, since if the string is\\n # already a unicode type, it does not need to be decoded (and doing so\\n # will raise an exception).\\n if isinstance(s, unicode): # pylint: disable=incompatible-py3-code,undefined-variable\\n return _normalize(s)\\n elif isinstance(s, (str, bytearray)):\\n for enc in encoding:\\n try:\\n return _normalize(s.decode(enc, errors))\\n except UnicodeDecodeError as err:\\n exc = err\\n continue\\n # The only way we get this far is if a UnicodeDecodeError was\\n # raised, otherwise we would have already returned (or raised some\\n # other exception).\\n raise exc # pylint: disable=raising-bad-type\\n raise TypeError('expected str or bytearray')\\n\",\n \"def query(params=None, setname=None, requesturl=None, location=None,\\n return_url=False, return_root=False, opts=None, provider=None,\\n endpoint=None, product='ec2', sigver='2'):\\n '''\\n Perform a query against AWS services using Signature Version 2 Signing\\n Process. This is documented at:\\n\\n http://docs.aws.amazon.com/general/latest/gr/signature-version-2.html\\n\\n Regions and endpoints are documented at:\\n\\n http://docs.aws.amazon.com/general/latest/gr/rande.html\\n\\n Default ``product`` is ``ec2``. Valid ``product`` names are:\\n\\n .. code-block: yaml\\n\\n - autoscaling (Auto Scaling)\\n - cloudformation (CloudFormation)\\n - ec2 (Elastic Compute Cloud)\\n - elasticache (ElastiCache)\\n - elasticbeanstalk (Elastic BeanStalk)\\n - elasticloadbalancing (Elastic Load Balancing)\\n - elasticmapreduce (Elastic MapReduce)\\n - iam (Identity and Access Management)\\n - importexport (Import/Export)\\n - monitoring (CloudWatch)\\n - rds (Relational Database Service)\\n - simpledb (SimpleDB)\\n - sns (Simple Notification Service)\\n - sqs (Simple Queue Service)\\n '''\\n if params is None:\\n params = {}\\n\\n if opts is None:\\n opts = {}\\n\\n function = opts.get('function', (None, product))\\n providers = opts.get('providers', {})\\n\\n if provider is None:\\n prov_dict = providers.get(function[1], {}).get(product, {})\\n if prov_dict:\\n driver = list(list(prov_dict.keys()))[0]\\n provider = providers.get(driver, product)\\n else:\\n prov_dict = providers.get(provider, {}).get(product, {})\\n\\n service_url = prov_dict.get('service_url', 'amazonaws.com')\\n\\n if not location:\\n location = get_location(opts, prov_dict)\\n\\n if endpoint is None:\\n if not requesturl:\\n endpoint = prov_dict.get(\\n 'endpoint',\\n '{0}.{1}.{2}'.format(product, location, service_url)\\n )\\n\\n requesturl = 'https://{0}/'.format(endpoint)\\n else:\\n endpoint = urlparse(requesturl).netloc\\n if endpoint == '':\\n endpoint_err = ('Could not find a valid endpoint in the '\\n 'requesturl: {0}. Looking for something '\\n 'like https://some.aws.endpoint/?args').format(\\n requesturl\\n )\\n log.error(endpoint_err)\\n if return_url is True:\\n return {'error': endpoint_err}, requesturl\\n return {'error': endpoint_err}\\n\\n log.debug('Using AWS endpoint: %s', endpoint)\\n method = 'GET'\\n\\n aws_api_version = prov_dict.get(\\n 'aws_api_version', prov_dict.get(\\n '{0}_api_version'.format(product),\\n DEFAULT_AWS_API_VERSION\\n )\\n )\\n\\n # Fallback to ec2's id & key if none is found, for this component\\n if not prov_dict.get('id', None):\\n prov_dict['id'] = providers.get(provider, {}).get('ec2', {}).get('id', {})\\n prov_dict['key'] = providers.get(provider, {}).get('ec2', {}).get('key', {})\\n\\n if sigver == '4':\\n headers, requesturl = sig4(\\n method, endpoint, params, prov_dict, aws_api_version, location, product, requesturl=requesturl\\n )\\n params_with_headers = {}\\n else:\\n params_with_headers = sig2(\\n method, endpoint, params, prov_dict, aws_api_version\\n )\\n headers = {}\\n\\n attempts = 0\\n while attempts < AWS_MAX_RETRIES:\\n log.debug('AWS Request: %s', requesturl)\\n log.trace('AWS Request Parameters: %s', params_with_headers)\\n try:\\n result = requests.get(requesturl, headers=headers, params=params_with_headers)\\n log.debug('AWS Response Status Code: %s', result.status_code)\\n log.trace(\\n 'AWS Response Text: %s',\\n result.text\\n )\\n result.raise_for_status()\\n break\\n except requests.exceptions.HTTPError as exc:\\n root = ET.fromstring(exc.response.content)\\n data = xml.to_dict(root)\\n\\n # check to see if we should retry the query\\n err_code = data.get('Errors', {}).get('Error', {}).get('Code', '')\\n if attempts < AWS_MAX_RETRIES and err_code and err_code in AWS_RETRY_CODES:\\n attempts += 1\\n log.error(\\n 'AWS Response Status Code and Error: [%s %s] %s; '\\n 'Attempts remaining: %s',\\n exc.response.status_code, exc, data, attempts\\n )\\n sleep_exponential_backoff(attempts)\\n continue\\n\\n log.error(\\n 'AWS Response Status Code and Error: [%s %s] %s',\\n exc.response.status_code, exc, data\\n )\\n if return_url is True:\\n return {'error': data}, requesturl\\n return {'error': data}\\n else:\\n log.error(\\n 'AWS Response Status Code and Error: [%s %s] %s',\\n exc.response.status_code, exc, data\\n )\\n if return_url is True:\\n return {'error': data}, requesturl\\n return {'error': data}\\n\\n root = ET.fromstring(result.text)\\n items = root[1]\\n if return_root is True:\\n items = root\\n\\n if setname:\\n if sys.version_info < (2, 7):\\n children_len = len(root.getchildren())\\n else:\\n children_len = len(root)\\n\\n for item in range(0, children_len):\\n comps = root[item].tag.split('}')\\n if comps[1] == setname:\\n items = root[item]\\n\\n ret = []\\n for item in items:\\n ret.append(xml.to_dict(item))\\n\\n if return_url is True:\\n return ret, requesturl\\n\\n return ret\\n\",\n \"def get_location(vm_=None):\\n '''\\n Return the EC2 region to use, in this order:\\n - CLI parameter\\n - VM parameter\\n - Cloud profile setting\\n '''\\n return __opts__.get(\\n 'location',\\n config.get_cloud_config_value(\\n 'location',\\n vm_ or get_configured_provider(),\\n __opts__,\\n default=DEFAULT_LOCATION,\\n search_global=False\\n )\\n )\\n\",\n \"def _get_node(name=None, instance_id=None, location=None):\\n if location is None:\\n location = get_location()\\n\\n params = {'Action': 'DescribeInstances'}\\n\\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\\n instance_id = name\\n\\n if instance_id:\\n params['InstanceId.1'] = instance_id\\n else:\\n params['Filter.1.Name'] = 'tag:Name'\\n params['Filter.1.Value.1'] = name\\n\\n log.trace(params)\\n\\n provider = get_provider()\\n\\n attempts = 0\\n while attempts < aws.AWS_MAX_RETRIES:\\n try:\\n instances = aws.query(params,\\n location=location,\\n provider=provider,\\n opts=__opts__,\\n sigver='4')\\n instance_info = _extract_instance_info(instances).values()\\n return next(iter(instance_info))\\n except IndexError:\\n attempts += 1\\n log.debug(\\n 'Failed to get the data for node \\\\'%s\\\\'. Remaining '\\n 'attempts: %s', instance_id or name, attempts\\n )\\n aws.sleep_exponential_backoff(attempts)\\n return {}\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nThe EC2 Cloud Module\n====================\n\nThe EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.\n\nTo use the EC2 cloud module, set up the cloud configuration at\n ``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:\n\n.. code-block:: yaml\n\n my-ec2-config:\n # EC2 API credentials: Access Key ID and Secret Access Key.\n # Alternatively, to use IAM Instance Role credentials available via\n # EC2 metadata set both id and key to 'use-instance-role-credentials'\n id: GKTADJGHEIQSXMKKRBJ08H\n key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs\n\n # If 'role_arn' is specified the above credentials are used to\n # to assume to the role. By default, role_arn is set to None.\n role_arn: arn:aws:iam::012345678910:role/SomeRoleName\n\n # The ssh keyname to use\n keyname: default\n # The amazon security group\n securitygroup: ssh_open\n # The location of the private key which corresponds to the keyname\n private_key: /root/default.pem\n\n # Be default, service_url is set to amazonaws.com. If you are using this\n # driver for something other than Amazon EC2, change it here:\n service_url: amazonaws.com\n\n # The endpoint that is ultimately used is usually formed using the region\n # and the service_url. If you would like to override that entirely, you\n # can explicitly define the endpoint:\n endpoint: myendpoint.example.com:1138/services/Cloud\n\n # SSH Gateways can be used with this provider. Gateways can be used\n # when a salt-master is not on the same private network as the instance\n # that is being deployed.\n\n # Defaults to None\n # Required\n ssh_gateway: gateway.example.com\n\n # Defaults to port 22\n # Optional\n ssh_gateway_port: 22\n\n # Defaults to root\n # Optional\n ssh_gateway_username: root\n\n # Default to nc -q0 %h %p\n # Optional\n ssh_gateway_command: \"-W %h:%p\"\n\n # One authentication method is required. If both\n # are specified, Private key wins.\n\n # Private key defaults to None\n ssh_gateway_private_key: /path/to/key.pem\n\n # Password defaults to None\n ssh_gateway_password: ExamplePasswordHere\n\n driver: ec2\n\n # Pass userdata to the instance to be created\n userdata_file: /etc/salt/my-userdata-file\n\n # Instance termination protection setting\n # Default is disabled\n termination_protection: False\n\n:depends: requests\n'''\n# pylint: disable=invalid-name,function-redefined\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport os\nimport sys\nimport stat\nimport time\nimport uuid\nimport pprint\nimport logging\n\n# Import libs for talking to the EC2 API\nimport hmac\nimport hashlib\nimport binascii\nimport datetime\nimport base64\nimport re\nimport decimal\n\n# Import Salt Libs\nimport salt.utils.cloud\nimport salt.utils.compat\nimport salt.utils.files\nimport salt.utils.hashutils\nimport salt.utils.json\nimport salt.utils.msgpack\nimport salt.utils.stringutils\nimport salt.utils.yaml\nfrom salt._compat import ElementTree as ET\nimport salt.utils.http as http\nimport salt.utils.aws as aws\nimport salt.config as config\nfrom salt.exceptions import (\n SaltCloudException,\n SaltCloudSystemExit,\n SaltCloudConfigError,\n SaltCloudExecutionTimeout,\n SaltCloudExecutionFailure\n)\n\n# pylint: disable=import-error,no-name-in-module,redefined-builtin\nfrom salt.ext import six\nfrom salt.ext.six.moves import map, range, zip\nfrom salt.ext.six.moves.urllib.parse import urlparse as _urlparse, urlencode as _urlencode\n\n# Import 3rd-Party Libs\n# Try to import PyCrypto, which may not be installed on a RAET-based system\ntry:\n from M2Crypto import RSA\n HAS_M2 = True\nexcept ImportError:\n HAS_M2 = False\n\ntry:\n import Crypto\n # PKCS1_v1_5 was added in PyCrypto 2.5\n from Crypto.Cipher import PKCS1_v1_5 # pylint: disable=E0611\n from Crypto.Hash import SHA # pylint: disable=E0611,W0611\n HAS_PYCRYPTO = True\nexcept ImportError:\n HAS_PYCRYPTO = False\n\ntry:\n import requests\n HAS_REQUESTS = True\nexcept ImportError:\n HAS_REQUESTS = False\n# pylint: enable=import-error,no-name-in-module,redefined-builtin\n\n# Get logging started\nlog = logging.getLogger(__name__)\n\n\nEC2_LOCATIONS = {\n 'ap-northeast-1': 'ec2_ap_northeast',\n 'ap-northeast-2': 'ec2_ap_northeast_2',\n 'ap-southeast-1': 'ec2_ap_southeast',\n 'ap-southeast-2': 'ec2_ap_southeast_2',\n 'eu-west-1': 'ec2_eu_west',\n 'eu-central-1': 'ec2_eu_central',\n 'sa-east-1': 'ec2_sa_east',\n 'us-east-1': 'ec2_us_east',\n 'us-gov-west-1': 'ec2_us_gov_west_1',\n 'us-west-1': 'ec2_us_west',\n 'us-west-2': 'ec2_us_west_oregon',\n}\nDEFAULT_LOCATION = 'us-east-1'\n\nDEFAULT_EC2_API_VERSION = '2014-10-01'\n\nEC2_RETRY_CODES = [\n 'RequestLimitExceeded',\n 'InsufficientInstanceCapacity',\n 'InternalError',\n 'Unavailable',\n 'InsufficientAddressCapacity',\n 'InsufficientReservedInstanceCapacity',\n]\n\nJS_COMMENT_RE = re.compile(r'/\\*.*?\\*/', re.S)\n\n__virtualname__ = 'ec2'\n\n\n# Only load in this module if the EC2 configurations are in place\ndef __virtual__():\n '''\n Set up the libcloud functions and check for EC2 configurations\n '''\n if get_configured_provider() is False:\n return False\n\n if get_dependencies() is False:\n return False\n\n return __virtualname__\n\n\ndef get_configured_provider():\n '''\n Return the first configured instance.\n '''\n return config.is_provider_configured(\n __opts__,\n __active_provider_name__ or __virtualname__,\n ('id', 'key')\n )\n\n\ndef get_dependencies():\n '''\n Warn if dependencies aren't met.\n '''\n deps = {\n 'requests': HAS_REQUESTS,\n 'pycrypto or m2crypto': HAS_M2 or HAS_PYCRYPTO\n }\n return config.check_driver_dependencies(\n __virtualname__,\n deps\n )\n\n\ndef _xml_to_dict(xmltree):\n '''\n Convert an XML tree into a dict\n '''\n if sys.version_info < (2, 7):\n children_len = len(xmltree.getchildren())\n else:\n children_len = len(xmltree)\n\n if children_len < 1:\n name = xmltree.tag\n if '}' in name:\n comps = name.split('}')\n name = comps[1]\n return {name: xmltree.text}\n\n xmldict = {}\n for item in xmltree:\n name = item.tag\n if '}' in name:\n comps = name.split('}')\n name = comps[1]\n if name not in xmldict:\n if sys.version_info < (2, 7):\n children_len = len(item.getchildren())\n else:\n children_len = len(item)\n\n if children_len > 0:\n xmldict[name] = _xml_to_dict(item)\n else:\n xmldict[name] = item.text\n else:\n if not isinstance(xmldict[name], list):\n tempvar = xmldict[name]\n xmldict[name] = []\n xmldict[name].append(tempvar)\n xmldict[name].append(_xml_to_dict(item))\n return xmldict\n\n\ndef optimize_providers(providers):\n '''\n Return an optimized list of providers.\n\n We want to reduce the duplication of querying\n the same region.\n\n If a provider is using the same credentials for the same region\n the same data will be returned for each provider, thus causing\n un-wanted duplicate data and API calls to EC2.\n\n '''\n tmp_providers = {}\n optimized_providers = {}\n\n for name, data in six.iteritems(providers):\n if 'location' not in data:\n data['location'] = DEFAULT_LOCATION\n\n if data['location'] not in tmp_providers:\n tmp_providers[data['location']] = {}\n\n creds = (data['id'], data['key'])\n if creds not in tmp_providers[data['location']]:\n tmp_providers[data['location']][creds] = {'name': name,\n 'data': data,\n }\n\n for location, tmp_data in six.iteritems(tmp_providers):\n for creds, data in six.iteritems(tmp_data):\n _id, _key = creds\n _name = data['name']\n _data = data['data']\n if _name not in optimized_providers:\n optimized_providers[_name] = _data\n\n return optimized_providers\n\n\ndef sign(key, msg):\n return hmac.new(key, msg.encode('utf-8'), hashlib.sha256).digest()\n\n\ndef query(params=None, setname=None, requesturl=None, location=None,\n return_url=False, return_root=False):\n\n provider = get_configured_provider()\n service_url = provider.get('service_url', 'amazonaws.com')\n\n # Retrieve access credentials from meta-data, or use provided\n access_key_id, secret_access_key, token = aws.creds(provider)\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n params_with_headers = params.copy()\n timestamp = datetime.datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%SZ')\n\n if not location:\n location = get_location()\n\n if not requesturl:\n endpoint = provider.get(\n 'endpoint',\n 'ec2.{0}.{1}'.format(location, service_url)\n )\n\n requesturl = 'https://{0}/'.format(endpoint)\n endpoint = _urlparse(requesturl).netloc\n endpoint_path = _urlparse(requesturl).path\n else:\n endpoint = _urlparse(requesturl).netloc\n endpoint_path = _urlparse(requesturl).path\n if endpoint == '':\n endpoint_err = (\n 'Could not find a valid endpoint in the '\n 'requesturl: {0}. Looking for something '\n 'like https://some.ec2.endpoint/?args').format(requesturl)\n log.error(endpoint_err)\n if return_url is True:\n return {'error': endpoint_err}, requesturl\n return {'error': endpoint_err}\n\n log.debug('Using EC2 endpoint: %s', endpoint)\n # AWS v4 signature\n\n method = 'GET'\n region = location\n service = 'ec2'\n canonical_uri = _urlparse(requesturl).path\n host = endpoint.strip()\n\n # Create a date for headers and the credential string\n t = datetime.datetime.utcnow()\n amz_date = t.strftime('%Y%m%dT%H%M%SZ') # Format date as YYYYMMDD'T'HHMMSS'Z'\n datestamp = t.strftime('%Y%m%d') # Date w/o time, used in credential scope\n\n canonical_headers = 'host:' + host + '\\n' + 'x-amz-date:' + amz_date + '\\n'\n signed_headers = 'host;x-amz-date'\n\n payload_hash = salt.utils.hashutils.sha256_digest('')\n\n ec2_api_version = provider.get(\n 'ec2_api_version',\n DEFAULT_EC2_API_VERSION\n )\n\n params_with_headers['Version'] = ec2_api_version\n\n keys = sorted(list(params_with_headers))\n values = map(params_with_headers.get, keys)\n querystring = _urlencode(list(zip(keys, values)))\n querystring = querystring.replace('+', '%20')\n\n canonical_request = method + '\\n' + canonical_uri + '\\n' + \\\n querystring + '\\n' + canonical_headers + '\\n' + \\\n signed_headers + '\\n' + payload_hash\n\n algorithm = 'AWS4-HMAC-SHA256'\n credential_scope = datestamp + '/' + region + '/' + service + '/' + 'aws4_request'\n\n string_to_sign = algorithm + '\\n' + amz_date + '\\n' + \\\n credential_scope + '\\n' + \\\n salt.utils.hashutils.sha256_digest(canonical_request)\n\n kDate = sign(('AWS4' + provider['key']).encode('utf-8'), datestamp)\n kRegion = sign(kDate, region)\n kService = sign(kRegion, service)\n signing_key = sign(kService, 'aws4_request')\n\n signature = hmac.new(signing_key, (string_to_sign).encode('utf-8'),\n hashlib.sha256).hexdigest()\n\n authorization_header = algorithm + ' ' + 'Credential=' + \\\n provider['id'] + '/' + credential_scope + \\\n ', ' + 'SignedHeaders=' + signed_headers + \\\n ', ' + 'Signature=' + signature\n headers = {'x-amz-date': amz_date, 'Authorization': authorization_header}\n\n log.debug('EC2 Request: %s', requesturl)\n log.trace('EC2 Request Parameters: %s', params_with_headers)\n try:\n result = requests.get(requesturl, headers=headers, params=params_with_headers)\n log.debug(\n 'EC2 Response Status Code: %s',\n # result.getcode()\n result.status_code\n )\n log.trace('EC2 Response Text: %s', result.text)\n result.raise_for_status()\n break\n except requests.exceptions.HTTPError as exc:\n root = ET.fromstring(exc.response.content)\n data = _xml_to_dict(root)\n\n # check to see if we should retry the query\n err_code = data.get('Errors', {}).get('Error', {}).get('Code', '')\n if err_code and err_code in EC2_RETRY_CODES:\n attempts += 1\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s; '\n 'Attempts remaining: %s',\n exc.response.status_code, exc, data, attempts\n )\n aws.sleep_exponential_backoff(attempts)\n continue\n\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n else:\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n\n response = result.text\n\n root = ET.fromstring(response)\n items = root[1]\n if return_root is True:\n items = root\n\n if setname:\n if sys.version_info < (2, 7):\n children_len = len(root.getchildren())\n else:\n children_len = len(root)\n\n for item in range(0, children_len):\n comps = root[item].tag.split('}')\n if comps[1] == setname:\n items = root[item]\n\n ret = []\n for item in items:\n ret.append(_xml_to_dict(item))\n\n if return_url is True:\n return ret, requesturl\n\n return ret\n\n\ndef _wait_for_spot_instance(update_callback,\n update_args=None,\n update_kwargs=None,\n timeout=10 * 60,\n interval=30,\n interval_multiplier=1,\n max_failures=10):\n '''\n Helper function that waits for a spot instance request to become active\n for a specific maximum amount of time.\n\n :param update_callback: callback function which queries the cloud provider\n for spot instance request. It must return None if\n the required data, running instance included, is\n not available yet.\n :param update_args: Arguments to pass to update_callback\n :param update_kwargs: Keyword arguments to pass to update_callback\n :param timeout: The maximum amount of time(in seconds) to wait for the IP\n address.\n :param interval: The looping interval, i.e., the amount of time to sleep\n before the next iteration.\n :param interval_multiplier: Increase the interval by this multiplier after\n each request; helps with throttling\n :param max_failures: If update_callback returns ``False`` it's considered\n query failure. This value is the amount of failures\n accepted before giving up.\n :returns: The update_callback returned data\n :raises: SaltCloudExecutionTimeout\n\n '''\n if update_args is None:\n update_args = ()\n if update_kwargs is None:\n update_kwargs = {}\n\n duration = timeout\n while True:\n log.debug(\n 'Waiting for spot instance reservation. Giving up in '\n '00:%02d:%02d', int(timeout // 60), int(timeout % 60)\n )\n data = update_callback(*update_args, **update_kwargs)\n if data is False:\n log.debug(\n 'update_callback has returned False which is considered a '\n 'failure. Remaining Failures: %s', max_failures\n )\n max_failures -= 1\n if max_failures <= 0:\n raise SaltCloudExecutionFailure(\n 'Too many failures occurred while waiting for '\n 'the spot instance reservation to become active.'\n )\n elif data is not None:\n return data\n\n if timeout < 0:\n raise SaltCloudExecutionTimeout(\n 'Unable to get an active spot instance request for '\n '00:{0:02d}:{1:02d}'.format(\n int(duration // 60),\n int(duration % 60)\n )\n )\n time.sleep(interval)\n timeout -= interval\n\n if interval_multiplier > 1:\n interval *= interval_multiplier\n if interval > timeout:\n interval = timeout + 1\n log.info('Interval multiplier in effect; interval is '\n 'now %ss', interval)\n\n\ndef avail_sizes(call=None):\n '''\n Return a dict of all available VM sizes on the cloud provider with\n relevant data. Latest version can be found at:\n\n http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_sizes function must be called with '\n '-f or --function, or with the --list-sizes option'\n )\n\n sizes = {\n 'Cluster Compute': {\n 'cc2.8xlarge': {\n 'id': 'cc2.8xlarge',\n 'cores': '16 (2 x Intel Xeon E5-2670, eight-core with '\n 'hyperthread)',\n 'disk': '3360 GiB (4 x 840 GiB)',\n 'ram': '60.5 GiB'\n },\n 'cc1.4xlarge': {\n 'id': 'cc1.4xlarge',\n 'cores': '8 (2 x Intel Xeon X5570, quad-core with '\n 'hyperthread)',\n 'disk': '1690 GiB (2 x 840 GiB)',\n 'ram': '22.5 GiB'\n },\n },\n 'Cluster CPU': {\n 'cg1.4xlarge': {\n 'id': 'cg1.4xlarge',\n 'cores': '8 (2 x Intel Xeon X5570, quad-core with '\n 'hyperthread), plus 2 NVIDIA Tesla M2050 GPUs',\n 'disk': '1680 GiB (2 x 840 GiB)',\n 'ram': '22.5 GiB'\n },\n },\n 'Compute Optimized': {\n 'c4.large': {\n 'id': 'c4.large',\n 'cores': '2',\n 'disk': 'EBS - 500 Mbps',\n 'ram': '3.75 GiB'\n },\n 'c4.xlarge': {\n 'id': 'c4.xlarge',\n 'cores': '4',\n 'disk': 'EBS - 750 Mbps',\n 'ram': '7.5 GiB'\n },\n 'c4.2xlarge': {\n 'id': 'c4.2xlarge',\n 'cores': '8',\n 'disk': 'EBS - 1000 Mbps',\n 'ram': '15 GiB'\n },\n 'c4.4xlarge': {\n 'id': 'c4.4xlarge',\n 'cores': '16',\n 'disk': 'EBS - 2000 Mbps',\n 'ram': '30 GiB'\n },\n 'c4.8xlarge': {\n 'id': 'c4.8xlarge',\n 'cores': '36',\n 'disk': 'EBS - 4000 Mbps',\n 'ram': '60 GiB'\n },\n 'c3.large': {\n 'id': 'c3.large',\n 'cores': '2',\n 'disk': '32 GiB (2 x 16 GiB SSD)',\n 'ram': '3.75 GiB'\n },\n 'c3.xlarge': {\n 'id': 'c3.xlarge',\n 'cores': '4',\n 'disk': '80 GiB (2 x 40 GiB SSD)',\n 'ram': '7.5 GiB'\n },\n 'c3.2xlarge': {\n 'id': 'c3.2xlarge',\n 'cores': '8',\n 'disk': '160 GiB (2 x 80 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'c3.4xlarge': {\n 'id': 'c3.4xlarge',\n 'cores': '16',\n 'disk': '320 GiB (2 x 160 GiB SSD)',\n 'ram': '30 GiB'\n },\n 'c3.8xlarge': {\n 'id': 'c3.8xlarge',\n 'cores': '32',\n 'disk': '640 GiB (2 x 320 GiB SSD)',\n 'ram': '60 GiB'\n }\n },\n 'Dense Storage': {\n 'd2.xlarge': {\n 'id': 'd2.xlarge',\n 'cores': '4',\n 'disk': '6 TiB (3 x 2 TiB hard disk drives)',\n 'ram': '30.5 GiB'\n },\n 'd2.2xlarge': {\n 'id': 'd2.2xlarge',\n 'cores': '8',\n 'disk': '12 TiB (6 x 2 TiB hard disk drives)',\n 'ram': '61 GiB'\n },\n 'd2.4xlarge': {\n 'id': 'd2.4xlarge',\n 'cores': '16',\n 'disk': '24 TiB (12 x 2 TiB hard disk drives)',\n 'ram': '122 GiB'\n },\n 'd2.8xlarge': {\n 'id': 'd2.8xlarge',\n 'cores': '36',\n 'disk': '24 TiB (24 x 2 TiB hard disk drives)',\n 'ram': '244 GiB'\n },\n },\n 'GPU': {\n 'g2.2xlarge': {\n 'id': 'g2.2xlarge',\n 'cores': '8',\n 'disk': '60 GiB (1 x 60 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'g2.8xlarge': {\n 'id': 'g2.8xlarge',\n 'cores': '32',\n 'disk': '240 GiB (2 x 120 GiB SSD)',\n 'ram': '60 GiB'\n },\n },\n 'GPU Compute': {\n 'p2.xlarge': {\n 'id': 'p2.xlarge',\n 'cores': '4',\n 'disk': 'EBS',\n 'ram': '61 GiB'\n },\n 'p2.8xlarge': {\n 'id': 'p2.8xlarge',\n 'cores': '32',\n 'disk': 'EBS',\n 'ram': '488 GiB'\n },\n 'p2.16xlarge': {\n 'id': 'p2.16xlarge',\n 'cores': '64',\n 'disk': 'EBS',\n 'ram': '732 GiB'\n },\n },\n 'High I/O': {\n 'i2.xlarge': {\n 'id': 'i2.xlarge',\n 'cores': '4',\n 'disk': 'SSD (1 x 800 GiB)',\n 'ram': '30.5 GiB'\n },\n 'i2.2xlarge': {\n 'id': 'i2.2xlarge',\n 'cores': '8',\n 'disk': 'SSD (2 x 800 GiB)',\n 'ram': '61 GiB'\n },\n 'i2.4xlarge': {\n 'id': 'i2.4xlarge',\n 'cores': '16',\n 'disk': 'SSD (4 x 800 GiB)',\n 'ram': '122 GiB'\n },\n 'i2.8xlarge': {\n 'id': 'i2.8xlarge',\n 'cores': '32',\n 'disk': 'SSD (8 x 800 GiB)',\n 'ram': '244 GiB'\n }\n },\n 'High Memory': {\n 'x1.16xlarge': {\n 'id': 'x1.16xlarge',\n 'cores': '64 (with 5.45 ECUs each)',\n 'disk': '1920 GiB (1 x 1920 GiB)',\n 'ram': '976 GiB'\n },\n 'x1.32xlarge': {\n 'id': 'x1.32xlarge',\n 'cores': '128 (with 2.73 ECUs each)',\n 'disk': '3840 GiB (2 x 1920 GiB)',\n 'ram': '1952 GiB'\n },\n 'r4.large': {\n 'id': 'r4.large',\n 'cores': '2 (with 3.45 ECUs each)',\n 'disk': 'EBS',\n 'ram': '15.25 GiB'\n },\n 'r4.xlarge': {\n 'id': 'r4.xlarge',\n 'cores': '4 (with 3.35 ECUs each)',\n 'disk': 'EBS',\n 'ram': '30.5 GiB'\n },\n 'r4.2xlarge': {\n 'id': 'r4.2xlarge',\n 'cores': '8 (with 3.35 ECUs each)',\n 'disk': 'EBS',\n 'ram': '61 GiB'\n },\n 'r4.4xlarge': {\n 'id': 'r4.4xlarge',\n 'cores': '16 (with 3.3 ECUs each)',\n 'disk': 'EBS',\n 'ram': '122 GiB'\n },\n 'r4.8xlarge': {\n 'id': 'r4.8xlarge',\n 'cores': '32 (with 3.1 ECUs each)',\n 'disk': 'EBS',\n 'ram': '244 GiB'\n },\n 'r4.16xlarge': {\n 'id': 'r4.16xlarge',\n 'cores': '64 (with 3.05 ECUs each)',\n 'disk': 'EBS',\n 'ram': '488 GiB'\n },\n 'r3.large': {\n 'id': 'r3.large',\n 'cores': '2 (with 3.25 ECUs each)',\n 'disk': '32 GiB (1 x 32 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'r3.xlarge': {\n 'id': 'r3.xlarge',\n 'cores': '4 (with 3.25 ECUs each)',\n 'disk': '80 GiB (1 x 80 GiB SSD)',\n 'ram': '30.5 GiB'\n },\n 'r3.2xlarge': {\n 'id': 'r3.2xlarge',\n 'cores': '8 (with 3.25 ECUs each)',\n 'disk': '160 GiB (1 x 160 GiB SSD)',\n 'ram': '61 GiB'\n },\n 'r3.4xlarge': {\n 'id': 'r3.4xlarge',\n 'cores': '16 (with 3.25 ECUs each)',\n 'disk': '320 GiB (1 x 320 GiB SSD)',\n 'ram': '122 GiB'\n },\n 'r3.8xlarge': {\n 'id': 'r3.8xlarge',\n 'cores': '32 (with 3.25 ECUs each)',\n 'disk': '640 GiB (2 x 320 GiB SSD)',\n 'ram': '244 GiB'\n }\n },\n 'High-Memory Cluster': {\n 'cr1.8xlarge': {\n 'id': 'cr1.8xlarge',\n 'cores': '16 (2 x Intel Xeon E5-2670, eight-core)',\n 'disk': '240 GiB (2 x 120 GiB SSD)',\n 'ram': '244 GiB'\n },\n },\n 'High Storage': {\n 'hs1.8xlarge': {\n 'id': 'hs1.8xlarge',\n 'cores': '16 (8 cores + 8 hyperthreads)',\n 'disk': '48 TiB (24 x 2 TiB hard disk drives)',\n 'ram': '117 GiB'\n },\n },\n 'General Purpose': {\n 't2.nano': {\n 'id': 't2.nano',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '512 MiB'\n },\n 't2.micro': {\n 'id': 't2.micro',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '1 GiB'\n },\n 't2.small': {\n 'id': 't2.small',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '2 GiB'\n },\n 't2.medium': {\n 'id': 't2.medium',\n 'cores': '2',\n 'disk': 'EBS',\n 'ram': '4 GiB'\n },\n 't2.large': {\n 'id': 't2.large',\n 'cores': '2',\n 'disk': 'EBS',\n 'ram': '8 GiB'\n },\n 't2.xlarge': {\n 'id': 't2.xlarge',\n 'cores': '4',\n 'disk': 'EBS',\n 'ram': '16 GiB'\n },\n 't2.2xlarge': {\n 'id': 't2.2xlarge',\n 'cores': '8',\n 'disk': 'EBS',\n 'ram': '32 GiB'\n },\n 'm4.large': {\n 'id': 'm4.large',\n 'cores': '2',\n 'disk': 'EBS - 450 Mbps',\n 'ram': '8 GiB'\n },\n 'm4.xlarge': {\n 'id': 'm4.xlarge',\n 'cores': '4',\n 'disk': 'EBS - 750 Mbps',\n 'ram': '16 GiB'\n },\n 'm4.2xlarge': {\n 'id': 'm4.2xlarge',\n 'cores': '8',\n 'disk': 'EBS - 1000 Mbps',\n 'ram': '32 GiB'\n },\n 'm4.4xlarge': {\n 'id': 'm4.4xlarge',\n 'cores': '16',\n 'disk': 'EBS - 2000 Mbps',\n 'ram': '64 GiB'\n },\n 'm4.10xlarge': {\n 'id': 'm4.10xlarge',\n 'cores': '40',\n 'disk': 'EBS - 4000 Mbps',\n 'ram': '160 GiB'\n },\n 'm4.16xlarge': {\n 'id': 'm4.16xlarge',\n 'cores': '64',\n 'disk': 'EBS - 10000 Mbps',\n 'ram': '256 GiB'\n },\n 'm3.medium': {\n 'id': 'm3.medium',\n 'cores': '1',\n 'disk': 'SSD (1 x 4)',\n 'ram': '3.75 GiB'\n },\n 'm3.large': {\n 'id': 'm3.large',\n 'cores': '2',\n 'disk': 'SSD (1 x 32)',\n 'ram': '7.5 GiB'\n },\n 'm3.xlarge': {\n 'id': 'm3.xlarge',\n 'cores': '4',\n 'disk': 'SSD (2 x 40)',\n 'ram': '15 GiB'\n },\n 'm3.2xlarge': {\n 'id': 'm3.2xlarge',\n 'cores': '8',\n 'disk': 'SSD (2 x 80)',\n 'ram': '30 GiB'\n },\n }\n }\n return sizes\n\n\ndef avail_images(kwargs=None, call=None):\n '''\n Return a dict of all available VM images on the cloud provider.\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_images function must be called with '\n '-f or --function, or with the --list-images option'\n )\n\n if not isinstance(kwargs, dict):\n kwargs = {}\n\n if 'owner' in kwargs:\n owner = kwargs['owner']\n else:\n provider = get_configured_provider()\n\n owner = config.get_cloud_config_value(\n 'owner', provider, __opts__, default='amazon'\n )\n\n ret = {}\n params = {'Action': 'DescribeImages',\n 'Owner': owner}\n images = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for image in images:\n ret[image['imageId']] = image\n return ret\n\n\ndef script(vm_):\n '''\n Return the script deployment object\n '''\n return salt.utils.cloud.os_script(\n config.get_cloud_config_value('script', vm_, __opts__),\n vm_,\n __opts__,\n salt.utils.cloud.salt_config_to_yaml(\n salt.utils.cloud.minion_config(__opts__, vm_)\n )\n )\n\n\ndef keyname(vm_):\n '''\n Return the keyname\n '''\n return config.get_cloud_config_value(\n 'keyname', vm_, __opts__, search_global=False\n )\n\n\ndef securitygroup(vm_):\n '''\n Return the security group\n '''\n return config.get_cloud_config_value(\n 'securitygroup', vm_, __opts__, search_global=False\n )\n\n\ndef iam_profile(vm_):\n '''\n Return the IAM profile.\n\n The IAM instance profile to associate with the instances.\n This is either the Amazon Resource Name (ARN) of the instance profile\n or the name of the role.\n\n Type: String\n\n Default: None\n\n Required: No\n\n Example: arn:aws:iam::111111111111:instance-profile/s3access\n\n Example: s3access\n\n '''\n return config.get_cloud_config_value(\n 'iam_profile', vm_, __opts__, search_global=False\n )\n\n\ndef ssh_interface(vm_):\n '''\n Return the ssh_interface type to connect to. Either 'public_ips' (default)\n or 'private_ips'.\n '''\n ret = config.get_cloud_config_value(\n 'ssh_interface', vm_, __opts__, default='public_ips',\n search_global=False\n )\n if ret not in ('public_ips', 'private_ips'):\n log.warning(\n 'Invalid ssh_interface: %s. '\n 'Allowed options are (\"public_ips\", \"private_ips\"). '\n 'Defaulting to \"public_ips\".', ret\n )\n ret = 'public_ips'\n return ret\n\n\ndef get_ssh_gateway_config(vm_):\n '''\n Return the ssh_gateway configuration.\n '''\n ssh_gateway = config.get_cloud_config_value(\n 'ssh_gateway', vm_, __opts__, default=None,\n search_global=False\n )\n\n # Check to see if a SSH Gateway will be used.\n if not isinstance(ssh_gateway, six.string_types):\n return None\n\n # Create dictionary of configuration items\n\n # ssh_gateway\n ssh_gateway_config = {'ssh_gateway': ssh_gateway}\n\n # ssh_gateway_port\n ssh_gateway_config['ssh_gateway_port'] = config.get_cloud_config_value(\n 'ssh_gateway_port', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_username\n ssh_gateway_config['ssh_gateway_user'] = config.get_cloud_config_value(\n 'ssh_gateway_username', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_private_key\n ssh_gateway_config['ssh_gateway_key'] = config.get_cloud_config_value(\n 'ssh_gateway_private_key', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_password\n ssh_gateway_config['ssh_gateway_password'] = config.get_cloud_config_value(\n 'ssh_gateway_password', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_command\n ssh_gateway_config['ssh_gateway_command'] = config.get_cloud_config_value(\n 'ssh_gateway_command', vm_, __opts__, default=None,\n search_global=False\n )\n\n # Check if private key exists\n key_filename = ssh_gateway_config['ssh_gateway_key']\n if key_filename is not None and not os.path.isfile(key_filename):\n raise SaltCloudConfigError(\n 'The defined ssh_gateway_private_key \\'{0}\\' does not exist'\n .format(key_filename)\n )\n elif (\n key_filename is None and\n not ssh_gateway_config['ssh_gateway_password']\n ):\n raise SaltCloudConfigError(\n 'No authentication method. Please define: '\n ' ssh_gateway_password or ssh_gateway_private_key'\n )\n\n return ssh_gateway_config\n\n\ndef get_location(vm_=None):\n '''\n Return the EC2 region to use, in this order:\n - CLI parameter\n - VM parameter\n - Cloud profile setting\n '''\n return __opts__.get(\n 'location',\n config.get_cloud_config_value(\n 'location',\n vm_ or get_configured_provider(),\n __opts__,\n default=DEFAULT_LOCATION,\n search_global=False\n )\n )\n\n\ndef avail_locations(call=None):\n '''\n List all available locations\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_locations function must be called with '\n '-f or --function, or with the --list-locations option'\n )\n\n ret = {}\n\n params = {'Action': 'DescribeRegions'}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for region in result:\n ret[region['regionName']] = {\n 'name': region['regionName'],\n 'endpoint': region['regionEndpoint'],\n }\n\n return ret\n\n\ndef get_availability_zone(vm_):\n '''\n Return the availability zone to use\n '''\n avz = config.get_cloud_config_value(\n 'availability_zone', vm_, __opts__, search_global=False\n )\n\n if avz is None:\n return None\n\n zones = _list_availability_zones(vm_)\n\n # Validate user-specified AZ\n if avz not in zones:\n raise SaltCloudException(\n 'The specified availability zone isn\\'t valid in this region: '\n '{0}\\n'.format(\n avz\n )\n )\n\n # check specified AZ is available\n elif zones[avz] != 'available':\n raise SaltCloudException(\n 'The specified availability zone isn\\'t currently available: '\n '{0}\\n'.format(\n avz\n )\n )\n\n return avz\n\n\ndef get_tenancy(vm_):\n '''\n Returns the Tenancy to use.\n\n Can be \"dedicated\" or \"default\". Cannot be present for spot instances.\n '''\n return config.get_cloud_config_value(\n 'tenancy', vm_, __opts__, search_global=False\n )\n\n\ndef get_imageid(vm_):\n '''\n Returns the ImageId to use\n '''\n image = config.get_cloud_config_value(\n 'image', vm_, __opts__, search_global=False\n )\n if image.startswith('ami-'):\n return image\n # a poor man's cache\n if not hasattr(get_imageid, 'images'):\n get_imageid.images = {}\n elif image in get_imageid.images:\n return get_imageid.images[image]\n params = {'Action': 'DescribeImages',\n 'Filter.0.Name': 'name',\n 'Filter.0.Value.0': image}\n # Query AWS, sort by 'creationDate' and get the last imageId\n _t = lambda x: datetime.datetime.strptime(x['creationDate'], '%Y-%m-%dT%H:%M:%S.%fZ')\n image_id = sorted(aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'),\n lambda i, j: salt.utils.compat.cmp(_t(i), _t(j))\n )[-1]['imageId']\n get_imageid.images[image] = image_id\n return image_id\n\n\ndef _get_subnetname_id(subnetname):\n '''\n Returns the SubnetId of a SubnetName to use\n '''\n params = {'Action': 'DescribeSubnets'}\n for subnet in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n tags = subnet.get('tagSet', {}).get('item', {})\n if not isinstance(tags, list):\n tags = [tags]\n for tag in tags:\n if tag['key'] == 'Name' and tag['value'] == subnetname:\n log.debug(\n 'AWS Subnet ID of %s is %s',\n subnetname, subnet['subnetId']\n )\n return subnet['subnetId']\n return None\n\n\ndef get_subnetid(vm_):\n '''\n Returns the SubnetId to use\n '''\n subnetid = config.get_cloud_config_value(\n 'subnetid', vm_, __opts__, search_global=False\n )\n if subnetid:\n return subnetid\n\n subnetname = config.get_cloud_config_value(\n 'subnetname', vm_, __opts__, search_global=False\n )\n if subnetname:\n return _get_subnetname_id(subnetname)\n return None\n\n\ndef _get_securitygroupname_id(securitygroupname_list):\n '''\n Returns the SecurityGroupId of a SecurityGroupName to use\n '''\n securitygroupid_set = set()\n if not isinstance(securitygroupname_list, list):\n securitygroupname_list = [securitygroupname_list]\n params = {'Action': 'DescribeSecurityGroups'}\n for sg in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n if sg['groupName'] in securitygroupname_list:\n log.debug(\n 'AWS SecurityGroup ID of %s is %s',\n sg['groupName'], sg['groupId']\n )\n securitygroupid_set.add(sg['groupId'])\n return list(securitygroupid_set)\n\n\ndef securitygroupid(vm_):\n '''\n Returns the SecurityGroupId\n '''\n securitygroupid_set = set()\n securitygroupid_list = config.get_cloud_config_value(\n 'securitygroupid',\n vm_,\n __opts__,\n search_global=False\n )\n # If the list is None, then the set will remain empty\n # If the list is already a set then calling 'set' on it is a no-op\n # If the list is a string, then calling 'set' generates a one-element set\n # If the list is anything else, stacktrace\n if securitygroupid_list:\n securitygroupid_set = securitygroupid_set.union(set(securitygroupid_list))\n\n securitygroupname_list = config.get_cloud_config_value(\n 'securitygroupname', vm_, __opts__, search_global=False\n )\n if securitygroupname_list:\n if not isinstance(securitygroupname_list, list):\n securitygroupname_list = [securitygroupname_list]\n params = {'Action': 'DescribeSecurityGroups'}\n for sg in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n if sg['groupName'] in securitygroupname_list:\n log.debug(\n 'AWS SecurityGroup ID of %s is %s',\n sg['groupName'], sg['groupId']\n )\n securitygroupid_set.add(sg['groupId'])\n return list(securitygroupid_set)\n\n\ndef get_placementgroup(vm_):\n '''\n Returns the PlacementGroup to use\n '''\n return config.get_cloud_config_value(\n 'placementgroup', vm_, __opts__, search_global=False\n )\n\n\ndef get_spot_config(vm_):\n '''\n Returns the spot instance configuration for the provided vm\n '''\n return config.get_cloud_config_value(\n 'spot_config', vm_, __opts__, search_global=False\n )\n\n\ndef get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_comps[0]\n return provider\n\n\ndef _list_availability_zones(vm_=None):\n '''\n List all availability zones in the current region\n '''\n ret = {}\n\n params = {'Action': 'DescribeAvailabilityZones',\n 'Filter.0.Name': 'region-name',\n 'Filter.0.Value.0': get_location(vm_)}\n result = aws.query(params,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for zone in result:\n ret[zone['zoneName']] = zone['zoneState']\n\n return ret\n\n\ndef block_device_mappings(vm_):\n '''\n Return the block device mapping:\n\n .. code-block:: python\n\n [{'DeviceName': '/dev/sdb', 'VirtualName': 'ephemeral0'},\n {'DeviceName': '/dev/sdc', 'VirtualName': 'ephemeral1'}]\n '''\n return config.get_cloud_config_value(\n 'block_device_mappings', vm_, __opts__, search_global=True\n )\n\n\ndef _request_eip(interface, vm_):\n '''\n Request and return Elastic IP\n '''\n params = {'Action': 'AllocateAddress'}\n params['Domain'] = interface.setdefault('domain', 'vpc')\n eips = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n for eip in eips:\n if 'allocationId' in eip:\n return eip['allocationId']\n return None\n\n\ndef _create_eni_if_necessary(interface, vm_):\n '''\n Create an Elastic Interface if necessary and return a Network Interface Specification\n '''\n if 'NetworkInterfaceId' in interface and interface['NetworkInterfaceId'] is not None:\n return {'DeviceIndex': interface['DeviceIndex'],\n 'NetworkInterfaceId': interface['NetworkInterfaceId']}\n\n params = {'Action': 'DescribeSubnets'}\n subnet_query = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if 'SecurityGroupId' not in interface and 'securitygroupname' in interface:\n interface['SecurityGroupId'] = _get_securitygroupname_id(interface['securitygroupname'])\n if 'SubnetId' not in interface and 'subnetname' in interface:\n interface['SubnetId'] = _get_subnetname_id(interface['subnetname'])\n\n subnet_id = _get_subnet_id_for_interface(subnet_query, interface)\n if not subnet_id:\n raise SaltCloudConfigError(\n 'No such subnet <{0}>'.format(interface.get('SubnetId'))\n )\n params = {'SubnetId': subnet_id}\n\n for k in 'Description', 'PrivateIpAddress', 'SecondaryPrivateIpAddressCount':\n if k in interface:\n params[k] = interface[k]\n\n for k in 'PrivateIpAddresses', 'SecurityGroupId':\n if k in interface:\n params.update(_param_from_config(k, interface[k]))\n\n if 'AssociatePublicIpAddress' in interface:\n # Associating a public address in a VPC only works when the interface is not\n # created beforehand, but as a part of the machine creation request.\n for k in ('DeviceIndex', 'AssociatePublicIpAddress', 'NetworkInterfaceId'):\n if k in interface:\n params[k] = interface[k]\n params['DeleteOnTermination'] = interface.get('delete_interface_on_terminate', True)\n return params\n\n params['Action'] = 'CreateNetworkInterface'\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n eni_desc = result[1]\n if not eni_desc or not eni_desc.get('networkInterfaceId'):\n raise SaltCloudException('Failed to create interface: {0}'.format(result))\n\n eni_id = eni_desc.get('networkInterfaceId')\n log.debug(\n 'Created network interface %s inst %s',\n eni_id, interface['DeviceIndex']\n )\n\n associate_public_ip = interface.get('AssociatePublicIpAddress', False)\n if isinstance(associate_public_ip, six.string_types):\n # Assume id of EIP as value\n _associate_eip_with_interface(eni_id, associate_public_ip, vm_=vm_)\n\n if interface.get('associate_eip'):\n _associate_eip_with_interface(eni_id, interface.get('associate_eip'), vm_=vm_)\n elif interface.get('allocate_new_eip'):\n _new_eip = _request_eip(interface, vm_)\n _associate_eip_with_interface(eni_id, _new_eip, vm_=vm_)\n elif interface.get('allocate_new_eips'):\n addr_list = _list_interface_private_addrs(eni_desc)\n eip_list = []\n for idx, addr in enumerate(addr_list):\n eip_list.append(_request_eip(interface, vm_))\n for idx, addr in enumerate(addr_list):\n _associate_eip_with_interface(eni_id, eip_list[idx], addr, vm_=vm_)\n\n if 'Name' in interface:\n tag_params = {'Action': 'CreateTags',\n 'ResourceId.0': eni_id,\n 'Tag.0.Key': 'Name',\n 'Tag.0.Value': interface['Name']}\n tag_response = aws.query(tag_params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in tag_response:\n log.error('Failed to set name of interface {0}')\n\n return {'DeviceIndex': interface['DeviceIndex'],\n 'NetworkInterfaceId': eni_id}\n\n\ndef _get_subnet_id_for_interface(subnet_query, interface):\n for subnet_query_result in subnet_query:\n if 'item' in subnet_query_result:\n if isinstance(subnet_query_result['item'], dict):\n subnet_id = _get_subnet_from_subnet_query(subnet_query_result['item'],\n interface)\n if subnet_id is not None:\n return subnet_id\n\n else:\n for subnet in subnet_query_result['item']:\n subnet_id = _get_subnet_from_subnet_query(subnet, interface)\n if subnet_id is not None:\n return subnet_id\n\n\ndef _get_subnet_from_subnet_query(subnet_query, interface):\n if 'subnetId' in subnet_query:\n if interface.get('SubnetId'):\n if subnet_query['subnetId'] == interface['SubnetId']:\n return subnet_query['subnetId']\n else:\n return subnet_query['subnetId']\n\n\ndef _list_interface_private_addrs(eni_desc):\n '''\n Returns a list of all of the private IP addresses attached to a\n network interface. The 'primary' address will be listed first.\n '''\n primary = eni_desc.get('privateIpAddress')\n if not primary:\n return None\n\n addresses = [primary]\n\n lst = eni_desc.get('privateIpAddressesSet', {}).get('item', [])\n if not isinstance(lst, list):\n return addresses\n\n for entry in lst:\n if entry.get('primary') == 'true':\n continue\n if entry.get('privateIpAddress'):\n addresses.append(entry.get('privateIpAddress'))\n\n return addresses\n\n\ndef _modify_eni_properties(eni_id, properties=None, vm_=None):\n '''\n Change properties of the interface\n with id eni_id to the values in properties dict\n '''\n if not isinstance(properties, dict):\n raise SaltCloudException(\n 'ENI properties must be a dictionary'\n )\n\n params = {'Action': 'ModifyNetworkInterfaceAttribute',\n 'NetworkInterfaceId': eni_id}\n for k, v in six.iteritems(properties):\n params[k] = v\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if isinstance(result, dict) and result.get('error'):\n raise SaltCloudException(\n 'Could not change interface <{0}> attributes <\\'{1}\\'>'.format(\n eni_id, properties\n )\n )\n else:\n return result\n\n\ndef _associate_eip_with_interface(eni_id, eip_id, private_ip=None, vm_=None):\n '''\n Accept the id of a network interface, and the id of an elastic ip\n address, and associate the two of them, such that traffic sent to the\n elastic ip address will be forwarded (NATted) to this network interface.\n\n Optionally specify the private (10.x.x.x) IP address that traffic should\n be NATted to - useful if you have multiple IP addresses assigned to an\n interface.\n '''\n params = {'Action': 'AssociateAddress',\n 'NetworkInterfaceId': eni_id,\n 'AllocationId': eip_id}\n\n if private_ip:\n params['PrivateIpAddress'] = private_ip\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if not result[2].get('associationId'):\n raise SaltCloudException(\n 'Could not associate elastic ip address '\n '<{0}> with network interface <{1}>'.format(\n eip_id, eni_id\n )\n )\n\n log.debug(\n 'Associated ElasticIP address %s with interface %s',\n eip_id, eni_id\n )\n\n return result[2].get('associationId')\n\n\ndef _update_enis(interfaces, instance, vm_=None):\n config_enis = {}\n instance_enis = []\n for interface in interfaces:\n if 'DeviceIndex' in interface:\n if interface['DeviceIndex'] in config_enis:\n log.error(\n 'Duplicate DeviceIndex in profile. Cannot update ENIs.'\n )\n return None\n config_enis[six.text_type(interface['DeviceIndex'])] = interface\n query_enis = instance[0]['instancesSet']['item']['networkInterfaceSet']['item']\n if isinstance(query_enis, list):\n for query_eni in query_enis:\n instance_enis.append((query_eni['networkInterfaceId'], query_eni['attachment']))\n else:\n instance_enis.append((query_enis['networkInterfaceId'], query_enis['attachment']))\n\n for eni_id, eni_data in instance_enis:\n delete_on_terminate = True\n if 'DeleteOnTermination' in config_enis[eni_data['deviceIndex']]:\n delete_on_terminate = config_enis[eni_data['deviceIndex']]['DeleteOnTermination']\n elif 'delete_interface_on_terminate' in config_enis[eni_data['deviceIndex']]:\n delete_on_terminate = config_enis[eni_data['deviceIndex']]['delete_interface_on_terminate']\n\n params_attachment = {'Attachment.AttachmentId': eni_data['attachmentId'],\n 'Attachment.DeleteOnTermination': delete_on_terminate}\n set_eni_attachment_attributes = _modify_eni_properties(eni_id, params_attachment, vm_=vm_)\n\n if 'SourceDestCheck' in config_enis[eni_data['deviceIndex']]:\n params_sourcedest = {'SourceDestCheck.Value': config_enis[eni_data['deviceIndex']]['SourceDestCheck']}\n set_eni_sourcedest_property = _modify_eni_properties(eni_id, params_sourcedest, vm_=vm_)\n\n return None\n\n\ndef _param_from_config(key, data):\n '''\n Return EC2 API parameters based on the given config data.\n\n Examples:\n 1. List of dictionaries\n >>> data = [\n ... {'DeviceIndex': 0, 'SubnetId': 'subid0',\n ... 'AssociatePublicIpAddress': True},\n ... {'DeviceIndex': 1,\n ... 'SubnetId': 'subid1',\n ... 'PrivateIpAddress': '192.168.1.128'}\n ... ]\n >>> _param_from_config('NetworkInterface', data)\n ... {'NetworkInterface.0.SubnetId': 'subid0',\n ... 'NetworkInterface.0.DeviceIndex': 0,\n ... 'NetworkInterface.1.SubnetId': 'subid1',\n ... 'NetworkInterface.1.PrivateIpAddress': '192.168.1.128',\n ... 'NetworkInterface.0.AssociatePublicIpAddress': 'true',\n ... 'NetworkInterface.1.DeviceIndex': 1}\n\n 2. List of nested dictionaries\n >>> data = [\n ... {'DeviceName': '/dev/sdf',\n ... 'Ebs': {\n ... 'SnapshotId': 'dummy0',\n ... 'VolumeSize': 200,\n ... 'VolumeType': 'standard'}},\n ... {'DeviceName': '/dev/sdg',\n ... 'Ebs': {\n ... 'SnapshotId': 'dummy1',\n ... 'VolumeSize': 100,\n ... 'VolumeType': 'standard'}}\n ... ]\n >>> _param_from_config('BlockDeviceMapping', data)\n ... {'BlockDeviceMapping.0.Ebs.VolumeType': 'standard',\n ... 'BlockDeviceMapping.1.Ebs.SnapshotId': 'dummy1',\n ... 'BlockDeviceMapping.0.Ebs.VolumeSize': 200,\n ... 'BlockDeviceMapping.0.Ebs.SnapshotId': 'dummy0',\n ... 'BlockDeviceMapping.1.Ebs.VolumeType': 'standard',\n ... 'BlockDeviceMapping.1.DeviceName': '/dev/sdg',\n ... 'BlockDeviceMapping.1.Ebs.VolumeSize': 100,\n ... 'BlockDeviceMapping.0.DeviceName': '/dev/sdf'}\n\n 3. Dictionary of dictionaries\n >>> data = { 'Arn': 'dummyarn', 'Name': 'Tester' }\n >>> _param_from_config('IamInstanceProfile', data)\n {'IamInstanceProfile.Arn': 'dummyarn', 'IamInstanceProfile.Name': 'Tester'}\n\n '''\n\n param = {}\n\n if isinstance(data, dict):\n for k, v in six.iteritems(data):\n param.update(_param_from_config('{0}.{1}'.format(key, k), v))\n\n elif isinstance(data, list) or isinstance(data, tuple):\n for idx, conf_item in enumerate(data):\n prefix = '{0}.{1}'.format(key, idx)\n param.update(_param_from_config(prefix, conf_item))\n\n else:\n if isinstance(data, bool):\n # convert boolean True/False to 'true'/'false'\n param.update({key: six.text_type(data).lower()})\n else:\n param.update({key: data})\n\n return param\n\n\ndef request_instance(vm_=None, call=None):\n '''\n Put together all of the information necessary to request an instance on EC2,\n and then fire off the request the instance.\n\n Returns data about the instance\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The request_instance action must be called with -a or --action.'\n )\n\n location = vm_.get('location', get_location(vm_))\n\n # do we launch a regular vm or a spot instance?\n # see http://goo.gl/hYZ13f for more information on EC2 API\n spot_config = get_spot_config(vm_)\n if spot_config is not None:\n if 'spot_price' not in spot_config:\n raise SaltCloudSystemExit(\n 'Spot instance config for {0} requires a spot_price '\n 'attribute.'.format(vm_['name'])\n )\n\n params = {'Action': 'RequestSpotInstances',\n 'InstanceCount': '1',\n 'Type': spot_config['type']\n if 'type' in spot_config else 'one-time',\n 'SpotPrice': spot_config['spot_price']}\n\n # All of the necessary launch parameters for a VM when using\n # spot instances are the same except for the prefix below\n # being tacked on.\n spot_prefix = 'LaunchSpecification.'\n\n # regular EC2 instance\n else:\n # WARNING! EXPERIMENTAL!\n # This allows more than one instance to be spun up in a single call.\n # The first instance will be called by the name provided, but all other\n # instances will be nameless (or more specifically, they will use the\n # InstanceId as the name). This interface is expected to change, so\n # use at your own risk.\n min_instance = config.get_cloud_config_value(\n 'min_instance', vm_, __opts__, search_global=False, default=1\n )\n max_instance = config.get_cloud_config_value(\n 'max_instance', vm_, __opts__, search_global=False, default=1\n )\n params = {'Action': 'RunInstances',\n 'MinCount': min_instance,\n 'MaxCount': max_instance}\n\n # Normal instances should have no prefix.\n spot_prefix = ''\n\n image_id = get_imageid(vm_)\n params[spot_prefix + 'ImageId'] = image_id\n\n userdata = None\n userdata_file = config.get_cloud_config_value(\n 'userdata_file', vm_, __opts__, search_global=False, default=None\n )\n if userdata_file is None:\n userdata = config.get_cloud_config_value(\n 'userdata', vm_, __opts__, search_global=False, default=None\n )\n else:\n log.trace('userdata_file: %s', userdata_file)\n if os.path.exists(userdata_file):\n with salt.utils.files.fopen(userdata_file, 'r') as fh_:\n userdata = salt.utils.stringutils.to_unicode(fh_.read())\n\n userdata = salt.utils.cloud.userdata_template(__opts__, vm_, userdata)\n\n if userdata is not None:\n try:\n params[spot_prefix + 'UserData'] = base64.b64encode(\n salt.utils.stringutils.to_bytes(userdata)\n )\n except Exception as exc:\n log.exception('Failed to encode userdata: %s', exc)\n\n vm_size = config.get_cloud_config_value(\n 'size', vm_, __opts__, search_global=False\n )\n params[spot_prefix + 'InstanceType'] = vm_size\n\n ex_keyname = keyname(vm_)\n if ex_keyname:\n params[spot_prefix + 'KeyName'] = ex_keyname\n\n ex_securitygroup = securitygroup(vm_)\n if ex_securitygroup:\n if not isinstance(ex_securitygroup, list):\n params[spot_prefix + 'SecurityGroup.1'] = ex_securitygroup\n else:\n for counter, sg_ in enumerate(ex_securitygroup):\n params[spot_prefix + 'SecurityGroup.{0}'.format(counter)] = sg_\n\n ex_iam_profile = iam_profile(vm_)\n if ex_iam_profile:\n try:\n if ex_iam_profile.startswith('arn:aws:iam:'):\n params[\n spot_prefix + 'IamInstanceProfile.Arn'\n ] = ex_iam_profile\n else:\n params[\n spot_prefix + 'IamInstanceProfile.Name'\n ] = ex_iam_profile\n except AttributeError:\n raise SaltCloudConfigError(\n '\\'iam_profile\\' should be a string value.'\n )\n\n az_ = get_availability_zone(vm_)\n if az_ is not None:\n params[spot_prefix + 'Placement.AvailabilityZone'] = az_\n\n tenancy_ = get_tenancy(vm_)\n if tenancy_ is not None:\n if spot_config is not None:\n raise SaltCloudConfigError(\n 'Spot instance config for {0} does not support '\n 'specifying tenancy.'.format(vm_['name'])\n )\n params['Placement.Tenancy'] = tenancy_\n\n subnetid_ = get_subnetid(vm_)\n if subnetid_ is not None:\n params[spot_prefix + 'SubnetId'] = subnetid_\n\n ex_securitygroupid = securitygroupid(vm_)\n if ex_securitygroupid:\n if not isinstance(ex_securitygroupid, list):\n params[spot_prefix + 'SecurityGroupId.1'] = ex_securitygroupid\n else:\n for counter, sg_ in enumerate(ex_securitygroupid):\n params[\n spot_prefix + 'SecurityGroupId.{0}'.format(counter)\n ] = sg_\n\n placementgroup_ = get_placementgroup(vm_)\n if placementgroup_ is not None:\n params[spot_prefix + 'Placement.GroupName'] = placementgroup_\n\n blockdevicemappings_holder = block_device_mappings(vm_)\n if blockdevicemappings_holder:\n for _bd in blockdevicemappings_holder:\n if 'tag' in _bd:\n _bd.pop('tag')\n\n ex_blockdevicemappings = blockdevicemappings_holder\n if ex_blockdevicemappings:\n params.update(_param_from_config(spot_prefix + 'BlockDeviceMapping',\n ex_blockdevicemappings))\n\n network_interfaces = config.get_cloud_config_value(\n 'network_interfaces',\n vm_,\n __opts__,\n search_global=False\n )\n\n if network_interfaces:\n eni_devices = []\n for interface in network_interfaces:\n log.debug('Create network interface: %s', interface)\n _new_eni = _create_eni_if_necessary(interface, vm_)\n eni_devices.append(_new_eni)\n params.update(_param_from_config(spot_prefix + 'NetworkInterface',\n eni_devices))\n\n set_ebs_optimized = config.get_cloud_config_value(\n 'ebs_optimized', vm_, __opts__, search_global=False\n )\n\n if set_ebs_optimized is not None:\n if not isinstance(set_ebs_optimized, bool):\n raise SaltCloudConfigError(\n '\\'ebs_optimized\\' should be a boolean value.'\n )\n params[spot_prefix + 'EbsOptimized'] = set_ebs_optimized\n\n set_del_root_vol_on_destroy = config.get_cloud_config_value(\n 'del_root_vol_on_destroy', vm_, __opts__, search_global=False\n )\n\n set_termination_protection = config.get_cloud_config_value(\n 'termination_protection', vm_, __opts__, search_global=False\n )\n\n if set_termination_protection is not None:\n if not isinstance(set_termination_protection, bool):\n raise SaltCloudConfigError(\n '\\'termination_protection\\' should be a boolean value.'\n )\n params.update(_param_from_config(spot_prefix + 'DisableApiTermination',\n set_termination_protection))\n\n if set_del_root_vol_on_destroy and not isinstance(set_del_root_vol_on_destroy, bool):\n raise SaltCloudConfigError(\n '\\'del_root_vol_on_destroy\\' should be a boolean value.'\n )\n\n vm_['set_del_root_vol_on_destroy'] = set_del_root_vol_on_destroy\n\n if set_del_root_vol_on_destroy:\n # first make sure to look up the root device name\n # as Ubuntu and CentOS (and most likely other OSs)\n # use different device identifiers\n\n log.info('Attempting to look up root device name for image id %s on '\n 'VM %s', image_id, vm_['name'])\n\n rd_params = {\n 'Action': 'DescribeImages',\n 'ImageId.1': image_id\n }\n try:\n rd_data = aws.query(rd_params,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in rd_data:\n return rd_data['error']\n log.debug('EC2 Response: \\'%s\\'', rd_data)\n except Exception as exc:\n log.error(\n 'Error getting root device name for image id %s for '\n 'VM %s: \\n%s', image_id, vm_['name'], exc,\n # Show the traceback if the debug logging level is enabled\n exc_info_on_loglevel=logging.DEBUG\n )\n raise\n\n # make sure we have a response\n if not rd_data:\n err_msg = 'There was an error querying EC2 for the root device ' \\\n 'of image id {0}. Empty response.'.format(image_id)\n raise SaltCloudSystemExit(err_msg)\n\n # pull the root device name from the result and use it when\n # launching the new VM\n rd_name = None\n rd_type = None\n if 'blockDeviceMapping' in rd_data[0]:\n # Some ami instances do not have a root volume. Ignore such cases\n if rd_data[0]['blockDeviceMapping'] is not None:\n item = rd_data[0]['blockDeviceMapping']['item']\n if isinstance(item, list):\n item = item[0]\n rd_name = item['deviceName']\n # Grab the volume type\n rd_type = item['ebs'].get('volumeType', None)\n\n log.info('Found root device name: %s', rd_name)\n\n if rd_name is not None:\n if ex_blockdevicemappings:\n dev_list = [\n dev['DeviceName'] for dev in ex_blockdevicemappings\n ]\n else:\n dev_list = []\n\n if rd_name in dev_list:\n # Device already listed, just grab the index\n dev_index = dev_list.index(rd_name)\n else:\n dev_index = len(dev_list)\n # Add the device name in since it wasn't already there\n params[\n '{0}BlockDeviceMapping.{1}.DeviceName'.format(\n spot_prefix, dev_index\n )\n ] = rd_name\n\n # Set the termination value\n termination_key = '{0}BlockDeviceMapping.{1}.Ebs.DeleteOnTermination'.format(spot_prefix, dev_index)\n params[termination_key] = six.text_type(set_del_root_vol_on_destroy).lower()\n\n # Use default volume type if not specified\n if ex_blockdevicemappings and dev_index < len(ex_blockdevicemappings) and \\\n 'Ebs.VolumeType' not in ex_blockdevicemappings[dev_index]:\n type_key = '{0}BlockDeviceMapping.{1}.Ebs.VolumeType'.format(spot_prefix, dev_index)\n params[type_key] = rd_type\n\n set_del_all_vols_on_destroy = config.get_cloud_config_value(\n 'del_all_vols_on_destroy', vm_, __opts__, search_global=False, default=False\n )\n\n if set_del_all_vols_on_destroy and not isinstance(set_del_all_vols_on_destroy, bool):\n raise SaltCloudConfigError(\n '\\'del_all_vols_on_destroy\\' should be a boolean value.'\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'requesting instance',\n 'salt/cloud/{0}/requesting'.format(vm_['name']),\n args={\n 'kwargs': __utils__['cloud.filter_event'](\n 'requesting', params, list(params)\n ),\n 'location': location,\n },\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n provider = get_provider(vm_)\n\n try:\n data = aws.query(params,\n 'instancesSet',\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if 'error' in data:\n return data['error']\n except Exception as exc:\n log.error(\n 'Error creating %s on EC2 when trying to run the initial '\n 'deployment: \\n%s', vm_['name'], exc,\n # Show the traceback if the debug logging level is enabled\n exc_info_on_loglevel=logging.DEBUG\n )\n raise\n\n # if we're using spot instances, we need to wait for the spot request\n # to become active before we continue\n if spot_config:\n sir_id = data[0]['spotInstanceRequestId']\n\n vm_['spotRequestId'] = sir_id\n\n def __query_spot_instance_request(sir_id, location):\n params = {'Action': 'DescribeSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if not data:\n log.error(\n 'There was an error while querying EC2. Empty response'\n )\n # Trigger a failure in the wait for spot instance method\n return False\n\n if isinstance(data, dict) and 'error' in data:\n log.warning('There was an error in the query. %s', data['error'])\n # Trigger a failure in the wait for spot instance method\n return False\n\n log.debug('Returned query data: %s', data)\n\n state = data[0].get('state')\n\n if state == 'active':\n return data\n\n if state == 'open':\n # Still waiting for an active state\n log.info('Spot instance status: %s', data[0]['status']['message'])\n return None\n\n if state in ['cancelled', 'failed', 'closed']:\n # Request will never be active, fail\n log.error('Spot instance request resulted in state \\'{0}\\'. '\n 'Nothing else we can do here.')\n return False\n\n __utils__['cloud.fire_event'](\n 'event',\n 'waiting for spot instance',\n 'salt/cloud/{0}/waiting_for_spot'.format(vm_['name']),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n try:\n data = _wait_for_spot_instance(\n __query_spot_instance_request,\n update_args=(sir_id, location),\n timeout=config.get_cloud_config_value(\n 'wait_for_spot_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_spot_interval', vm_, __opts__, default=30),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_spot_interval_multiplier',\n vm_,\n __opts__,\n default=1),\n max_failures=config.get_cloud_config_value(\n 'wait_for_spot_max_failures',\n vm_,\n __opts__,\n default=10),\n )\n log.debug('wait_for_spot_instance data %s', data)\n\n except (SaltCloudExecutionTimeout, SaltCloudExecutionFailure) as exc:\n try:\n # Cancel the existing spot instance request\n params = {'Action': 'CancelSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n\n log.debug('Canceled spot instance request %s. Data '\n 'returned: %s', sir_id, data)\n\n except SaltCloudSystemExit:\n pass\n finally:\n raise SaltCloudSystemExit(six.text_type(exc))\n\n return data, vm_\n\n\ndef query_instance(vm_=None, call=None):\n '''\n Query an instance upon creation from the EC2 API\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The query_instance action must be called with -a or --action.'\n )\n\n instance_id = vm_['instance_id']\n location = vm_.get('location', get_location(vm_))\n __utils__['cloud.fire_event'](\n 'event',\n 'querying instance',\n 'salt/cloud/{0}/querying'.format(vm_['name']),\n args={'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n log.debug('The new VM instance_id is %s', instance_id)\n\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n\n provider = get_provider(vm_)\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n data, requesturl = aws.query(params, # pylint: disable=unbalanced-tuple-unpacking\n location=location,\n provider=provider,\n opts=__opts__,\n return_url=True,\n sigver='4')\n log.debug('The query returned: %s', data)\n\n if isinstance(data, dict) and 'error' in data:\n log.warning(\n 'There was an error in the query. %s attempts '\n 'remaining: %s', attempts, data['error']\n )\n elif isinstance(data, list) and not data:\n log.warning(\n 'Query returned an empty list. %s attempts '\n 'remaining.', attempts\n )\n else:\n break\n\n aws.sleep_exponential_backoff(attempts)\n attempts += 1\n continue\n else:\n raise SaltCloudSystemExit(\n 'An error occurred while creating VM: {0}'.format(data['error'])\n )\n\n def __query_ip_address(params, url): # pylint: disable=W0613\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if not data:\n log.error(\n 'There was an error while querying EC2. Empty response'\n )\n # Trigger a failure in the wait for IP function\n return False\n\n if isinstance(data, dict) and 'error' in data:\n log.warning('There was an error in the query. %s', data['error'])\n # Trigger a failure in the wait for IP function\n return False\n\n log.debug('Returned query data: %s', data)\n\n if ssh_interface(vm_) == 'public_ips':\n if 'ipAddress' in data[0]['instancesSet']['item']:\n return data\n else:\n log.error(\n 'Public IP not detected.'\n )\n\n if ssh_interface(vm_) == 'private_ips':\n if 'privateIpAddress' in data[0]['instancesSet']['item']:\n return data\n else:\n log.error(\n 'Private IP not detected.'\n )\n\n try:\n data = salt.utils.cloud.wait_for_ip(\n __query_ip_address,\n update_args=(params, requesturl),\n timeout=config.get_cloud_config_value(\n 'wait_for_ip_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_ip_interval', vm_, __opts__, default=10),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_ip_interval_multiplier', vm_, __opts__, default=1),\n )\n except (SaltCloudExecutionTimeout, SaltCloudExecutionFailure) as exc:\n try:\n # It might be already up, let's destroy it!\n destroy(vm_['name'])\n except SaltCloudSystemExit:\n pass\n finally:\n raise SaltCloudSystemExit(six.text_type(exc))\n\n if 'reactor' in vm_ and vm_['reactor'] is True:\n __utils__['cloud.fire_event'](\n 'event',\n 'instance queried',\n 'salt/cloud/{0}/query_reactor'.format(vm_['name']),\n args={'data': data},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n return data\n\n\ndef wait_for_instance(\n vm_=None,\n data=None,\n ip_address=None,\n display_ssh_output=True,\n call=None,\n ):\n '''\n Wait for an instance upon creation from the EC2 API, to become available\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The wait_for_instance action must be called with -a or --action.'\n )\n\n if vm_ is None:\n vm_ = {}\n\n if data is None:\n data = {}\n\n ssh_gateway_config = vm_.get(\n 'gateway', get_ssh_gateway_config(vm_)\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'waiting for ssh',\n 'salt/cloud/{0}/waiting_for_ssh'.format(vm_['name']),\n args={'ip_address': ip_address},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n ssh_connect_timeout = config.get_cloud_config_value(\n 'ssh_connect_timeout', vm_, __opts__, 900 # 15 minutes\n )\n ssh_port = config.get_cloud_config_value(\n 'ssh_port', vm_, __opts__, 22\n )\n\n if config.get_cloud_config_value('win_installer', vm_, __opts__):\n username = config.get_cloud_config_value(\n 'win_username', vm_, __opts__, default='Administrator'\n )\n win_passwd = config.get_cloud_config_value(\n 'win_password', vm_, __opts__, default=''\n )\n win_deploy_auth_retries = config.get_cloud_config_value(\n 'win_deploy_auth_retries', vm_, __opts__, default=10\n )\n win_deploy_auth_retry_delay = config.get_cloud_config_value(\n 'win_deploy_auth_retry_delay', vm_, __opts__, default=1\n )\n use_winrm = config.get_cloud_config_value(\n 'use_winrm', vm_, __opts__, default=False\n )\n winrm_verify_ssl = config.get_cloud_config_value(\n 'winrm_verify_ssl', vm_, __opts__, default=True\n )\n\n if win_passwd and win_passwd == 'auto':\n log.debug('Waiting for auto-generated Windows EC2 password')\n while True:\n password_data = get_password_data(\n name=vm_['name'],\n kwargs={\n 'key_file': vm_['private_key'],\n },\n call='action',\n )\n win_passwd = password_data.get('password', None)\n if win_passwd is None:\n log.debug(password_data)\n # This wait is so high, because the password is unlikely to\n # be generated for at least 4 minutes\n time.sleep(60)\n else:\n logging_data = password_data\n\n logging_data['password'] = 'XXX-REDACTED-XXX'\n logging_data['passwordData'] = 'XXX-REDACTED-XXX'\n log.debug(logging_data)\n\n vm_['win_password'] = win_passwd\n break\n\n # SMB used whether psexec or winrm\n if not salt.utils.cloud.wait_for_port(ip_address,\n port=445,\n timeout=ssh_connect_timeout):\n raise SaltCloudSystemExit(\n 'Failed to connect to remote windows host'\n )\n\n # If not using winrm keep same psexec behavior\n if not use_winrm:\n\n log.debug('Trying to authenticate via SMB using psexec')\n\n if not salt.utils.cloud.validate_windows_cred(ip_address,\n username,\n win_passwd,\n retries=win_deploy_auth_retries,\n retry_delay=win_deploy_auth_retry_delay):\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote windows host (smb)'\n )\n\n # If using winrm\n else:\n\n # Default HTTPS port can be changed in cloud configuration\n winrm_port = config.get_cloud_config_value(\n 'winrm_port', vm_, __opts__, default=5986\n )\n\n # Wait for winrm port to be available\n if not salt.utils.cloud.wait_for_port(ip_address,\n port=winrm_port,\n timeout=ssh_connect_timeout):\n raise SaltCloudSystemExit(\n 'Failed to connect to remote windows host (winrm)'\n )\n\n log.debug('Trying to authenticate via Winrm using pywinrm')\n\n if not salt.utils.cloud.wait_for_winrm(ip_address,\n winrm_port,\n username,\n win_passwd,\n timeout=ssh_connect_timeout,\n verify=winrm_verify_ssl):\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote windows host'\n )\n\n elif salt.utils.cloud.wait_for_port(ip_address,\n port=ssh_port,\n timeout=ssh_connect_timeout,\n gateway=ssh_gateway_config\n ):\n # If a known_hosts_file is configured, this instance will not be\n # accessible until it has a host key. Since this is provided on\n # supported instances by cloud-init, and viewable to us only from the\n # console output (which may take several minutes to become available,\n # we have some more waiting to do here.\n known_hosts_file = config.get_cloud_config_value(\n 'known_hosts_file', vm_, __opts__, default=None\n )\n if known_hosts_file:\n console = {}\n while 'output_decoded' not in console:\n console = get_console_output(\n instance_id=vm_['instance_id'],\n call='action',\n location=get_location(vm_)\n )\n pprint.pprint(console)\n time.sleep(5)\n output = salt.utils.stringutils.to_unicode(console['output_decoded'])\n comps = output.split('-----BEGIN SSH HOST KEY KEYS-----')\n if len(comps) < 2:\n # Fail; there are no host keys\n return False\n\n comps = comps[1].split('-----END SSH HOST KEY KEYS-----')\n keys = ''\n for line in comps[0].splitlines():\n if not line:\n continue\n keys += '\\n{0} {1}'.format(ip_address, line)\n\n with salt.utils.files.fopen(known_hosts_file, 'a') as fp_:\n fp_.write(salt.utils.stringutils.to_str(keys))\n fp_.close()\n\n for user in vm_['usernames']:\n if salt.utils.cloud.wait_for_passwd(\n host=ip_address,\n port=ssh_port,\n username=user,\n ssh_timeout=config.get_cloud_config_value(\n 'wait_for_passwd_timeout', vm_, __opts__, default=1 * 60\n ),\n key_filename=vm_['key_filename'],\n display_ssh_output=display_ssh_output,\n gateway=ssh_gateway_config,\n maxtries=config.get_cloud_config_value(\n 'wait_for_passwd_maxtries', vm_, __opts__, default=15\n ),\n known_hosts_file=config.get_cloud_config_value(\n 'known_hosts_file', vm_, __opts__,\n default='/dev/null'\n ),\n ):\n __opts__['ssh_username'] = user\n vm_['ssh_username'] = user\n break\n else:\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote ssh'\n )\n else:\n raise SaltCloudSystemExit(\n 'Failed to connect to remote ssh'\n )\n\n if 'reactor' in vm_ and vm_['reactor'] is True:\n __utils__['cloud.fire_event'](\n 'event',\n 'ssh is available',\n 'salt/cloud/{0}/ssh_ready_reactor'.format(vm_['name']),\n args={'ip_address': ip_address},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n return vm_\n\n\ndef _validate_key_path_and_mode(key_filename):\n if key_filename is None:\n raise SaltCloudSystemExit(\n 'The required \\'private_key\\' configuration setting is missing from the '\n '\\'ec2\\' driver.'\n )\n\n if not os.path.exists(key_filename):\n raise SaltCloudSystemExit(\n 'The EC2 key file \\'{0}\\' does not exist.\\n'.format(\n key_filename\n )\n )\n\n key_mode = stat.S_IMODE(os.stat(key_filename).st_mode)\n if key_mode not in (0o400, 0o600):\n raise SaltCloudSystemExit(\n 'The EC2 key file \\'{0}\\' needs to be set to mode 0400 or 0600.\\n'.format(\n key_filename\n )\n )\n\n return True\n\n\ndef create(vm_=None, call=None):\n '''\n Create a single VM from a data dict\n '''\n if call:\n raise SaltCloudSystemExit(\n 'You cannot create an instance with -a or -f.'\n )\n\n try:\n # Check for required profile parameters before sending any API calls.\n if vm_['profile'] and config.is_profile_configured(__opts__,\n __active_provider_name__ or 'ec2',\n vm_['profile'],\n vm_=vm_) is False:\n return False\n except AttributeError:\n pass\n\n # Check for private_key and keyfile name for bootstrapping new instances\n deploy = config.get_cloud_config_value(\n 'deploy', vm_, __opts__, default=True\n )\n win_password = config.get_cloud_config_value(\n 'win_password', vm_, __opts__, default=''\n )\n key_filename = config.get_cloud_config_value(\n 'private_key', vm_, __opts__, search_global=False, default=None\n )\n if deploy:\n # The private_key and keyname settings are only needed for bootstrapping\n # new instances when deploy is True\n _validate_key_path_and_mode(key_filename)\n\n __utils__['cloud.fire_event'](\n 'event',\n 'starting create',\n 'salt/cloud/{0}/creating'.format(vm_['name']),\n args=__utils__['cloud.filter_event']('creating', vm_, ['name', 'profile', 'provider', 'driver']),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n __utils__['cloud.cachedir_index_add'](\n vm_['name'], vm_['profile'], 'ec2', vm_['driver']\n )\n\n vm_['key_filename'] = key_filename\n # wait_for_instance requires private_key\n vm_['private_key'] = key_filename\n\n # Get SSH Gateway config early to verify the private_key,\n # if used, exists or not. We don't want to deploy an instance\n # and not be able to access it via the gateway.\n vm_['gateway'] = get_ssh_gateway_config(vm_)\n\n location = get_location(vm_)\n vm_['location'] = location\n\n log.info('Creating Cloud VM %s in %s', vm_['name'], location)\n vm_['usernames'] = salt.utils.cloud.ssh_usernames(\n vm_,\n __opts__,\n default_users=(\n 'ec2-user', # Amazon Linux, Fedora, RHEL; FreeBSD\n 'centos', # CentOS AMIs from AWS Marketplace\n 'ubuntu', # Ubuntu\n 'admin', # Debian GNU/Linux\n 'bitnami', # BitNami AMIs\n 'root' # Last resort, default user on RHEL 5, SUSE\n )\n )\n\n if 'instance_id' in vm_:\n # This was probably created via another process, and doesn't have\n # things like salt keys created yet, so let's create them now.\n if 'pub_key' not in vm_ and 'priv_key' not in vm_:\n log.debug('Generating minion keys for \\'%s\\'', vm_['name'])\n vm_['priv_key'], vm_['pub_key'] = salt.utils.cloud.gen_keys(\n salt.config.get_cloud_config_value(\n 'keysize',\n vm_,\n __opts__\n )\n )\n else:\n # Put together all of the information required to request the instance,\n # and then fire off the request for it\n if keyname(vm_) is None:\n raise SaltCloudSystemExit(\n 'The required \\'keyname\\' configuration setting is missing from the '\n '\\'ec2\\' driver.'\n )\n\n data, vm_ = request_instance(vm_, location)\n\n # If data is a str, it's an error\n if isinstance(data, six.string_types):\n log.error('Error requesting instance: %s', data)\n return {}\n\n # Pull the instance ID, valid for both spot and normal instances\n\n # Multiple instances may have been spun up, get all their IDs\n vm_['instance_id_list'] = []\n for instance in data:\n vm_['instance_id_list'].append(instance['instanceId'])\n\n vm_['instance_id'] = vm_['instance_id_list'].pop()\n if vm_['instance_id_list']:\n # Multiple instances were spun up, get one now, and queue the rest\n queue_instances(vm_['instance_id_list'])\n\n # Wait for vital information, such as IP addresses, to be available\n # for the new instance\n data = query_instance(vm_)\n\n # Now that the instance is available, tag it appropriately. Should\n # mitigate race conditions with tags\n tags = config.get_cloud_config_value('tag',\n vm_,\n __opts__,\n {},\n search_global=False)\n if not isinstance(tags, dict):\n raise SaltCloudConfigError(\n '\\'tag\\' should be a dict.'\n )\n\n for value in six.itervalues(tags):\n if not isinstance(value, six.string_types):\n raise SaltCloudConfigError(\n '\\'tag\\' values must be strings. Try quoting the values. '\n 'e.g. \"2013-09-19T20:09:46Z\".'\n )\n\n tags['Name'] = vm_['name']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/{0}/tagging'.format(vm_['name']),\n args={'tags': tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n salt.utils.cloud.wait_for_fun(\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=tags,\n instance_id=vm_['instance_id'],\n call='action',\n location=location\n )\n\n # Once instance tags are set, tag the spot request if configured\n if 'spot_config' in vm_ and 'tag' in vm_['spot_config']:\n\n if not isinstance(vm_['spot_config']['tag'], dict):\n raise SaltCloudConfigError(\n '\\'tag\\' should be a dict.'\n )\n\n for value in six.itervalues(vm_['spot_config']['tag']):\n if not isinstance(value, str):\n raise SaltCloudConfigError(\n '\\'tag\\' values must be strings. Try quoting the values. '\n 'e.g. \"2013-09-19T20:09:46Z\".'\n )\n\n spot_request_tags = {}\n\n if 'spotRequestId' not in vm_:\n raise SaltCloudConfigError('Failed to find spotRequestId')\n\n sir_id = vm_['spotRequestId']\n\n spot_request_tags['Name'] = vm_['name']\n\n for k, v in six.iteritems(vm_['spot_config']['tag']):\n spot_request_tags[k] = v\n\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/spot_request_{0}/tagging'.format(sir_id),\n args={'tags': spot_request_tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n salt.utils.cloud.wait_for_fun(\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=spot_request_tags,\n instance_id=sir_id,\n call='action',\n location=location\n )\n\n network_interfaces = config.get_cloud_config_value(\n 'network_interfaces',\n vm_,\n __opts__,\n search_global=False\n )\n\n if network_interfaces:\n _update_enis(network_interfaces, data, vm_)\n\n # At this point, the node is created and tagged, and now needs to be\n # bootstrapped, once the necessary port is available.\n log.info('Created node %s', vm_['name'])\n\n instance = data[0]['instancesSet']['item']\n\n # Wait for the necessary port to become available to bootstrap\n if ssh_interface(vm_) == 'private_ips':\n ip_address = instance['privateIpAddress']\n log.info('Salt node data. Private_ip: %s', ip_address)\n else:\n ip_address = instance['ipAddress']\n log.info('Salt node data. Public_ip: %s', ip_address)\n vm_['ssh_host'] = ip_address\n\n if salt.utils.cloud.get_salt_interface(vm_, __opts__) == 'private_ips':\n salt_ip_address = instance['privateIpAddress']\n log.info('Salt interface set to: %s', salt_ip_address)\n else:\n salt_ip_address = instance['ipAddress']\n log.debug('Salt interface set to: %s', salt_ip_address)\n vm_['salt_host'] = salt_ip_address\n\n if deploy:\n display_ssh_output = config.get_cloud_config_value(\n 'display_ssh_output', vm_, __opts__, default=True\n )\n\n vm_ = wait_for_instance(\n vm_, data, ip_address, display_ssh_output\n )\n\n # The instance is booted and accessible, let's Salt it!\n ret = instance.copy()\n\n # Get ANY defined volumes settings, merging data, in the following order\n # 1. VM config\n # 2. Profile config\n # 3. Global configuration\n volumes = config.get_cloud_config_value(\n 'volumes', vm_, __opts__, search_global=True\n )\n if volumes:\n __utils__['cloud.fire_event'](\n 'event',\n 'attaching volumes',\n 'salt/cloud/{0}/attaching_volumes'.format(vm_['name']),\n args={'volumes': volumes},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n log.info('Create and attach volumes to node %s', vm_['name'])\n created = create_attach_volumes(\n vm_['name'],\n {\n 'volumes': volumes,\n 'zone': ret['placement']['availabilityZone'],\n 'instance_id': ret['instanceId'],\n 'del_all_vols_on_destroy': vm_.get('del_all_vols_on_destroy', False)\n },\n call='action'\n )\n ret['Attached Volumes'] = created\n\n # Associate instance with a ssm document, if present\n ssm_document = config.get_cloud_config_value(\n 'ssm_document', vm_, __opts__, None, search_global=False\n )\n if ssm_document:\n log.debug('Associating with ssm document: %s', ssm_document)\n assoc = ssm_create_association(\n vm_['name'],\n {'ssm_document': ssm_document},\n instance_id=vm_['instance_id'],\n call='action'\n )\n if isinstance(assoc, dict) and assoc.get('error', None):\n log.error(\n 'Failed to associate instance %s with ssm document %s',\n vm_['instance_id'], ssm_document\n )\n return {}\n\n for key, value in six.iteritems(__utils__['cloud.bootstrap'](vm_, __opts__)):\n ret.setdefault(key, value)\n\n log.info('Created Cloud VM \\'%s\\'', vm_['name'])\n log.debug(\n '\\'%s\\' VM creation details:\\n%s',\n vm_['name'], pprint.pformat(instance)\n )\n\n event_data = {\n 'name': vm_['name'],\n 'profile': vm_['profile'],\n 'provider': vm_['driver'],\n 'instance_id': vm_['instance_id'],\n }\n if volumes:\n event_data['volumes'] = volumes\n if ssm_document:\n event_data['ssm_document'] = ssm_document\n\n __utils__['cloud.fire_event'](\n 'event',\n 'created instance',\n 'salt/cloud/{0}/created'.format(vm_['name']),\n args=__utils__['cloud.filter_event']('created', event_data, list(event_data)),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n # Ensure that the latest node data is returned\n node = _get_node(instance_id=vm_['instance_id'])\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n ret.update(node)\n\n # Add any block device tags specified\n ex_blockdevicetags = {}\n blockdevicemappings_holder = block_device_mappings(vm_)\n if blockdevicemappings_holder:\n for _bd in blockdevicemappings_holder:\n if 'tag' in _bd:\n ex_blockdevicetags[_bd['DeviceName']] = _bd['tag']\n\n block_device_volume_id_map = {}\n\n if ex_blockdevicetags:\n for _device, _map in six.iteritems(ret['blockDeviceMapping']):\n bd_items = []\n if isinstance(_map, dict):\n bd_items.append(_map)\n else:\n for mapitem in _map:\n bd_items.append(mapitem)\n\n for blockitem in bd_items:\n if blockitem['deviceName'] in ex_blockdevicetags and 'Name' not in ex_blockdevicetags[blockitem['deviceName']]:\n ex_blockdevicetags[blockitem['deviceName']]['Name'] = vm_['name']\n if blockitem['deviceName'] in ex_blockdevicetags:\n block_device_volume_id_map[blockitem[ret['rootDeviceType']]['volumeId']] = ex_blockdevicetags[blockitem['deviceName']]\n\n if block_device_volume_id_map:\n\n for volid, tags in six.iteritems(block_device_volume_id_map):\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/block_volume_{0}/tagging'.format(str(volid)),\n args={'tags': tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n __utils__['cloud.wait_for_fun'](\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=tags,\n resource_id=volid,\n call='action',\n location=location\n )\n\n return ret\n\n\ndef queue_instances(instances):\n '''\n Queue a set of instances to be provisioned later. Expects a list.\n\n Currently this only queries node data, and then places it in the cloud\n cache (if configured). If the salt-cloud-reactor is being used, these\n instances will be automatically provisioned using that.\n\n For more information about the salt-cloud-reactor, see:\n\n https://github.com/saltstack-formulas/salt-cloud-reactor\n '''\n for instance_id in instances:\n node = _get_node(instance_id=instance_id)\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n\n\ndef create_attach_volumes(name, kwargs, call=None, wait_to_finish=True):\n '''\n Create and attach volumes to created node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The create_attach_volumes action must be called with '\n '-a or --action.'\n )\n\n if 'instance_id' not in kwargs:\n kwargs['instance_id'] = _get_node(name)['instanceId']\n\n if isinstance(kwargs['volumes'], six.string_types):\n volumes = salt.utils.yaml.safe_load(kwargs['volumes'])\n else:\n volumes = kwargs['volumes']\n\n ret = []\n for volume in volumes:\n created = False\n volume_name = '{0} on {1}'.format(volume['device'], name)\n\n volume_dict = {\n 'volume_name': volume_name,\n 'zone': kwargs['zone']\n }\n if 'volume_id' in volume:\n volume_dict['volume_id'] = volume['volume_id']\n elif 'snapshot' in volume:\n volume_dict['snapshot'] = volume['snapshot']\n elif 'size' in volume:\n volume_dict['size'] = volume['size']\n else:\n raise SaltCloudConfigError(\n 'Cannot create volume. Please define one of \\'volume_id\\', '\n '\\'snapshot\\', or \\'size\\''\n )\n\n if 'tags' in volume:\n volume_dict['tags'] = volume['tags']\n if 'type' in volume:\n volume_dict['type'] = volume['type']\n if 'iops' in volume:\n volume_dict['iops'] = volume['iops']\n if 'encrypted' in volume:\n volume_dict['encrypted'] = volume['encrypted']\n if 'kmskeyid' in volume:\n volume_dict['kmskeyid'] = volume['kmskeyid']\n\n if 'volume_id' not in volume_dict:\n created_volume = create_volume(volume_dict, call='function', wait_to_finish=wait_to_finish)\n created = True\n if 'volumeId' in created_volume:\n volume_dict['volume_id'] = created_volume['volumeId']\n\n attach = attach_volume(\n name,\n {'volume_id': volume_dict['volume_id'],\n 'device': volume['device']},\n instance_id=kwargs['instance_id'],\n call='action'\n )\n\n # Update the delvol parameter for this volume\n delvols_on_destroy = kwargs.get('del_all_vols_on_destroy', None)\n\n if attach and created and delvols_on_destroy is not None:\n _toggle_delvol(instance_id=kwargs['instance_id'],\n device=volume['device'],\n value=delvols_on_destroy)\n\n if attach:\n msg = (\n '{0} attached to {1} (aka {2}) as device {3}'.format(\n volume_dict['volume_id'],\n kwargs['instance_id'],\n name,\n volume['device']\n )\n )\n log.info(msg)\n ret.append(msg)\n return ret\n\n\ndef stop(name, call=None):\n '''\n Stop a node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The stop action must be called with -a or --action.'\n )\n\n log.info('Stopping node %s', name)\n\n instance_id = _get_node(name)['instanceId']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'stopping instance',\n 'salt/cloud/{0}/stopping'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n params = {'Action': 'StopInstances',\n 'InstanceId.1': instance_id}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n return result\n\n\ndef start(name, call=None):\n '''\n Start a node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The start action must be called with -a or --action.'\n )\n\n log.info('Starting node %s', name)\n\n instance_id = _get_node(name)['instanceId']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'starting instance',\n 'salt/cloud/{0}/starting'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n params = {'Action': 'StartInstances',\n 'InstanceId.1': instance_id}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n return result\n\n\ndef set_tags(name=None,\n tags=None,\n call=None,\n location=None,\n instance_id=None,\n resource_id=None,\n kwargs=None): # pylint: disable=W0613\n '''\n Set tags for a resource. Normally a VM name or instance_id is passed in,\n but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a set_tags mymachine tag1=somestuff tag2='Other stuff'\n salt-cloud -a set_tags resource_id=vol-3267ab32 tag=somestuff\n '''\n if kwargs is None:\n kwargs = {}\n\n if location is None:\n location = get_location()\n\n if instance_id is None:\n if 'resource_id' in kwargs:\n resource_id = kwargs['resource_id']\n del kwargs['resource_id']\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n if resource_id is None:\n if instance_id is None:\n instance_id = _get_node(name=name, instance_id=None, location=location)['instanceId']\n else:\n instance_id = resource_id\n\n # This second check is a safety, in case the above still failed to produce\n # a usable ID\n if instance_id is None:\n return {\n 'Error': 'A valid instance_id or resource_id was not specified.'\n }\n\n params = {'Action': 'CreateTags',\n 'ResourceId.1': instance_id}\n\n log.debug('Tags to set for %s: %s', name, tags)\n\n if kwargs and not tags:\n tags = kwargs\n\n for idx, (tag_k, tag_v) in enumerate(six.iteritems(tags)):\n params['Tag.{0}.Key'.format(idx)] = tag_k\n params['Tag.{0}.Value'.format(idx)] = tag_v\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n aws.query(params,\n setname='tagSet',\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n settags = get_tags(\n instance_id=instance_id, call='action', location=location\n )\n\n log.debug('Setting the tags returned: %s', settags)\n\n failed_to_set_tags = False\n for tag in settags:\n if tag['key'] not in tags:\n # We were not setting this tag\n continue\n\n if tag.get('value') is None and tags.get(tag['key']) == '':\n # This is a correctly set tag with no value\n continue\n\n if six.text_type(tags.get(tag['key'])) != six.text_type(tag['value']):\n # Not set to the proper value!?\n log.debug(\n 'Setting the tag %s returned %s instead of %s',\n tag['key'], tags.get(tag['key']), tag['value']\n )\n failed_to_set_tags = True\n break\n\n if failed_to_set_tags:\n log.warning('Failed to set tags. Remaining attempts %s', attempts)\n attempts += 1\n aws.sleep_exponential_backoff(attempts)\n continue\n\n return settags\n\n raise SaltCloudSystemExit(\n 'Failed to set tags on {0}!'.format(name)\n )\n\n\ndef get_tags(name=None,\n instance_id=None,\n call=None,\n location=None,\n kwargs=None,\n resource_id=None): # pylint: disable=W0613\n '''\n Retrieve tags for a resource. Normally a VM name or instance_id is passed\n in, but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a get_tags mymachine\n salt-cloud -a get_tags resource_id=vol-3267ab32\n '''\n if location is None:\n location = get_location()\n\n if instance_id is None:\n if resource_id is None:\n if name:\n instance_id = _get_node(name)['instanceId']\n elif 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n elif 'resource_id' in kwargs:\n instance_id = kwargs['resource_id']\n else:\n instance_id = resource_id\n\n params = {'Action': 'DescribeTags',\n 'Filter.1.Name': 'resource-id',\n 'Filter.1.Value': instance_id}\n\n return aws.query(params,\n setname='tagSet',\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n\ndef del_tags(name=None,\n kwargs=None,\n call=None,\n instance_id=None,\n resource_id=None): # pylint: disable=W0613\n '''\n Delete tags for a resource. Normally a VM name or instance_id is passed in,\n but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a del_tags mymachine tags=mytag,\n salt-cloud -a del_tags mymachine tags=tag1,tag2,tag3\n salt-cloud -a del_tags resource_id=vol-3267ab32 tags=tag1,tag2,tag3\n '''\n if kwargs is None:\n kwargs = {}\n\n if 'tags' not in kwargs:\n raise SaltCloudSystemExit(\n 'A tag or tags must be specified using tags=list,of,tags'\n )\n\n if not name and 'resource_id' in kwargs:\n instance_id = kwargs['resource_id']\n del kwargs['resource_id']\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n params = {'Action': 'DeleteTags',\n 'ResourceId.1': instance_id}\n\n for idx, tag in enumerate(kwargs['tags'].split(',')):\n params['Tag.{0}.Key'.format(idx)] = tag\n\n aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if resource_id:\n return get_tags(resource_id=resource_id)\n else:\n return get_tags(instance_id=instance_id)\n\n\ndef rename(name, kwargs, call=None):\n '''\n Properly rename a node. Pass in the new name as \"new name\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a rename mymachine newname=yourmachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The rename action must be called with -a or --action.'\n )\n\n log.info('Renaming %s to %s', name, kwargs['newname'])\n\n set_tags(name, {'Name': kwargs['newname']}, call='action')\n\n salt.utils.cloud.rename_key(\n __opts__['pki_dir'], name, kwargs['newname']\n )\n\n\ndef destroy(name, call=None):\n '''\n Destroy a node. Will check termination protection and warn if enabled.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud --destroy mymachine\n '''\n if call == 'function':\n raise SaltCloudSystemExit(\n 'The destroy action must be called with -d, --destroy, '\n '-a or --action.'\n )\n\n node_metadata = _get_node(name)\n instance_id = node_metadata['instanceId']\n sir_id = node_metadata.get('spotInstanceRequestId')\n protected = show_term_protect(\n name=name,\n instance_id=instance_id,\n call='action',\n quiet=True\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'destroying instance',\n 'salt/cloud/{0}/destroying'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n if protected == 'true':\n raise SaltCloudSystemExit(\n 'This instance has been protected from being destroyed. '\n 'Use the following command to disable protection:\\n\\n'\n 'salt-cloud -a disable_term_protect {0}'.format(\n name\n )\n )\n\n ret = {}\n\n # Default behavior is to rename EC2 VMs when destroyed\n # via salt-cloud, unless explicitly set to False.\n rename_on_destroy = config.get_cloud_config_value('rename_on_destroy',\n get_configured_provider(),\n __opts__,\n search_global=False)\n if rename_on_destroy is not False:\n newname = '{0}-DEL{1}'.format(name, uuid.uuid4().hex)\n rename(name, kwargs={'newname': newname}, call='action')\n log.info(\n 'Machine will be identified as %s until it has been '\n 'cleaned up.', newname\n )\n ret['newname'] = newname\n\n params = {'Action': 'TerminateInstances',\n 'InstanceId.1': instance_id}\n\n location = get_location()\n provider = get_provider()\n result = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n\n log.info(result)\n ret.update(result[0])\n\n # If this instance is part of a spot instance request, we\n # need to cancel it as well\n if sir_id is not None:\n params = {'Action': 'CancelSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n result = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n ret['spotInstance'] = result[0]\n\n __utils__['cloud.fire_event'](\n 'event',\n 'destroyed instance',\n 'salt/cloud/{0}/destroyed'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n __utils__['cloud.cachedir_index_del'](name)\n\n if __opts__.get('update_cachedir', False) is True:\n __utils__['cloud.delete_minion_cachedir'](name, __active_provider_name__.split(':')[0], __opts__)\n\n return ret\n\n\ndef reboot(name, call=None):\n '''\n Reboot a node.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a reboot mymachine\n '''\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'RebootInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if result == []:\n log.info('Complete')\n\n return {'Reboot': 'Complete'}\n\n\ndef show_image(kwargs, call=None):\n '''\n Show the details from EC2 concerning an AMI\n '''\n if call != 'function':\n raise SaltCloudSystemExit(\n 'The show_image action must be called with -f or --function.'\n )\n\n params = {'ImageId.1': kwargs['image'],\n 'Action': 'DescribeImages'}\n result = aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n log.info(result)\n\n return result\n\n\ndef show_instance(name=None, instance_id=None, call=None, kwargs=None):\n '''\n Show the details from EC2 concerning an AMI.\n\n Can be called as an action (which requires a name):\n\n .. code-block:: bash\n\n salt-cloud -a show_instance myinstance\n\n ...or as a function (which requires either a name or instance_id):\n\n .. code-block:: bash\n\n salt-cloud -f show_instance my-ec2 name=myinstance\n salt-cloud -f show_instance my-ec2 instance_id=i-d34db33f\n '''\n if not name and call == 'action':\n raise SaltCloudSystemExit(\n 'The show_instance action requires a name.'\n )\n\n if call == 'function':\n name = kwargs.get('name', None)\n instance_id = kwargs.get('instance_id', None)\n\n if not name and not instance_id:\n raise SaltCloudSystemExit(\n 'The show_instance function requires '\n 'either a name or an instance_id'\n )\n\n node = _get_node(name=name, instance_id=instance_id)\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n return node\n\n\ndef _get_node(name=None, instance_id=None, location=None):\n if location is None:\n location = get_location()\n\n params = {'Action': 'DescribeInstances'}\n\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if instance_id:\n params['InstanceId.1'] = instance_id\n else:\n params['Filter.1.Name'] = 'tag:Name'\n params['Filter.1.Value.1'] = name\n\n log.trace(params)\n\n provider = get_provider()\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n try:\n instances = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n instance_info = _extract_instance_info(instances).values()\n return next(iter(instance_info))\n except IndexError:\n attempts += 1\n log.debug(\n 'Failed to get the data for node \\'%s\\'. Remaining '\n 'attempts: %s', instance_id or name, attempts\n )\n aws.sleep_exponential_backoff(attempts)\n return {}\n\n\ndef list_nodes_full(location=None, call=None):\n '''\n Return a list of the VMs that are on the provider\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes_full function must be called with -f '\n 'or --function.'\n )\n\n return _list_nodes_full(location or get_location())\n\n\ndef _extract_name_tag(item):\n if 'tagSet' in item and item['tagSet'] is not None:\n tagset = item['tagSet']\n if isinstance(tagset['item'], list):\n for tag in tagset['item']:\n if tag['key'] == 'Name':\n return tag['value']\n return item['instanceId']\n return item['tagSet']['item']['value']\n return item['instanceId']\n\n\ndef _extract_instance_info(instances):\n '''\n Given an instance query, return a dict of all instance data\n '''\n ret = {}\n for instance in instances:\n # items could be type dict or list (for stopped EC2 instances)\n if isinstance(instance['instancesSet']['item'], list):\n for item in instance['instancesSet']['item']:\n name = _extract_name_tag(item)\n ret[name] = item\n ret[name]['name'] = name\n ret[name].update(\n dict(\n id=item['instanceId'],\n image=item['imageId'],\n size=item['instanceType'],\n state=item['instanceState']['name'],\n private_ips=item.get('privateIpAddress', []),\n public_ips=item.get('ipAddress', [])\n )\n )\n else:\n item = instance['instancesSet']['item']\n name = _extract_name_tag(item)\n ret[name] = item\n ret[name]['name'] = name\n ret[name].update(\n dict(\n id=item['instanceId'],\n image=item['imageId'],\n size=item['instanceType'],\n state=item['instanceState']['name'],\n private_ips=item.get('privateIpAddress', []),\n public_ips=item.get('ipAddress', [])\n )\n )\n\n return ret\n\n\ndef _list_nodes_full(location=None):\n '''\n Return a list of the VMs that in this location\n '''\n provider = __active_provider_name__ or 'ec2'\n if ':' in provider:\n comps = provider.split(':')\n provider = comps[0]\n\n params = {'Action': 'DescribeInstances'}\n instances = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if 'error' in instances:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n instances['error']['Errors']['Error']['Message']\n )\n )\n\n ret = _extract_instance_info(instances)\n\n __utils__['cloud.cache_node_list'](ret, provider, __opts__)\n return ret\n\n\ndef list_nodes_min(location=None, call=None):\n '''\n Return a list of the VMs that are on the provider. Only a list of VM names,\n and their state, is returned. This is the minimum amount of information\n needed to check for existing VMs.\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes_min function must be called with -f or --function.'\n )\n\n ret = {}\n params = {'Action': 'DescribeInstances'}\n instances = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in instances:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n instances['error']['Errors']['Error']['Message']\n )\n )\n\n for instance in instances:\n if isinstance(instance['instancesSet']['item'], list):\n items = instance['instancesSet']['item']\n else:\n items = [instance['instancesSet']['item']]\n\n for item in items:\n state = item['instanceState']['name']\n name = _extract_name_tag(item)\n id = item['instanceId']\n ret[name] = {'state': state, 'id': id}\n return ret\n\n\ndef list_nodes(call=None):\n '''\n Return a list of the VMs that are on the provider\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes function must be called with -f or --function.'\n )\n\n ret = {}\n nodes = list_nodes_full(get_location())\n if 'error' in nodes:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n nodes['error']['Errors']['Error']['Message']\n )\n )\n for node in nodes:\n ret[node] = {\n 'id': nodes[node]['id'],\n 'image': nodes[node]['image'],\n 'name': nodes[node]['name'],\n 'size': nodes[node]['size'],\n 'state': nodes[node]['state'],\n 'private_ips': nodes[node]['private_ips'],\n 'public_ips': nodes[node]['public_ips'],\n }\n return ret\n\n\ndef list_nodes_select(call=None):\n '''\n Return a list of the VMs that are on the provider, with select fields\n '''\n return salt.utils.cloud.list_nodes_select(\n list_nodes_full(get_location()), __opts__['query.selection'], call,\n )\n\n\ndef show_term_protect(name=None, instance_id=None, call=None, quiet=False):\n '''\n Show the details from EC2 concerning an instance's termination protection state\n\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_term_protect action must be called with -a or --action.'\n )\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'DescribeInstanceAttribute',\n 'InstanceId': instance_id,\n 'Attribute': 'disableApiTermination'}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n disable_protect = False\n for item in result:\n if 'value' in item:\n disable_protect = item['value']\n break\n\n log.log(\n logging.DEBUG if quiet is True else logging.INFO,\n 'Termination Protection is %s for %s',\n disable_protect == 'true' and 'enabled' or 'disabled', name\n )\n\n return disable_protect\n\n\ndef show_detailed_monitoring(name=None, instance_id=None, call=None, quiet=False):\n '''\n Show the details from EC2 regarding cloudwatch detailed monitoring.\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_detailed_monitoring action must be called with -a or --action.'\n )\n location = get_location()\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if not name and not instance_id:\n raise SaltCloudSystemExit(\n 'The show_detailed_monitoring action must be provided with a name or instance\\\n ID'\n )\n matched = _get_node(name=name, instance_id=instance_id, location=location)\n log.log(\n logging.DEBUG if quiet is True else logging.INFO,\n 'Detailed Monitoring is %s for %s', matched['monitoring'], name\n )\n return matched['monitoring']\n\n\ndef _toggle_term_protect(name, value):\n '''\n Enable or Disable termination protection on a node\n\n '''\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'ModifyInstanceAttribute',\n 'InstanceId': instance_id,\n 'DisableApiTermination.Value': value}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_term_protect(name=name, instance_id=instance_id, call='action')\n\n\ndef enable_term_protect(name, call=None):\n '''\n Enable termination protection on a node\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a enable_term_protect mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n return _toggle_term_protect(name, 'true')\n\n\ndef disable_term_protect(name, call=None):\n '''\n Disable termination protection on a node\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a disable_term_protect mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n return _toggle_term_protect(name, 'false')\n\n\ndef disable_detailed_monitoring(name, call=None):\n '''\n Enable/disable detailed monitoring on a node\n\n CLI Example:\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'UnmonitorInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_detailed_monitoring(name=name, instance_id=instance_id, call='action')\n\n\ndef enable_detailed_monitoring(name, call=None):\n '''\n Enable/disable detailed monitoring on a node\n\n CLI Example:\n\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'MonitorInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_detailed_monitoring(name=name, instance_id=instance_id, call='action')\n\n\ndef show_delvol_on_destroy(name, kwargs=None, call=None):\n '''\n Do not delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a show_delvol_on_destroy mymachine\n '''\n\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_delvol_on_destroy action must be called '\n 'with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n instance_id = kwargs.get('instance_id', None)\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n if instance_id is None:\n instance_id = _get_node(name)['instanceId']\n\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n\n data = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n blockmap = data[0]['instancesSet']['item']['blockDeviceMapping']\n\n if not isinstance(blockmap['item'], list):\n blockmap['item'] = [blockmap['item']]\n\n items = []\n\n for idx, item in enumerate(blockmap['item']):\n device_name = item['deviceName']\n\n if device is not None and device != device_name:\n continue\n\n if volume_id is not None and volume_id != item['ebs']['volumeId']:\n continue\n\n info = {\n 'device_name': device_name,\n 'volume_id': item['ebs']['volumeId'],\n 'deleteOnTermination': item['ebs']['deleteOnTermination']\n }\n\n items.append(info)\n\n return items\n\n\ndef keepvol_on_destroy(name, kwargs=None, call=None):\n '''\n Do not delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a keepvol_on_destroy mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The keepvol_on_destroy action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n return _toggle_delvol(name=name, device=device,\n volume_id=volume_id, value='false')\n\n\ndef delvol_on_destroy(name, kwargs=None, call=None):\n '''\n Delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a delvol_on_destroy mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The delvol_on_destroy action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n return _toggle_delvol(name=name, device=device,\n volume_id=volume_id, value='true')\n\n\ndef _toggle_delvol(name=None, instance_id=None, device=None, volume_id=None,\n value=None, requesturl=None):\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if requesturl:\n data = aws.query(requesturl=requesturl,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n else:\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n data, requesturl = aws.query(params, # pylint: disable=unbalanced-tuple-unpacking\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n blockmap = data[0]['instancesSet']['item']['blockDeviceMapping']\n\n params = {'Action': 'ModifyInstanceAttribute',\n 'InstanceId': instance_id}\n\n if not isinstance(blockmap['item'], list):\n blockmap['item'] = [blockmap['item']]\n\n for idx, item in enumerate(blockmap['item']):\n device_name = item['deviceName']\n\n if device is not None and device != device_name:\n continue\n if volume_id is not None and volume_id != item['ebs']['volumeId']:\n continue\n\n params['BlockDeviceMapping.{0}.DeviceName'.format(idx)] = device_name\n params['BlockDeviceMapping.{0}.Ebs.DeleteOnTermination'.format(idx)] = value\n\n aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n kwargs = {'instance_id': instance_id,\n 'device': device,\n 'volume_id': volume_id}\n return show_delvol_on_destroy(name, kwargs, call='action')\n\n\ndef register_image(kwargs=None, call=None):\n '''\n Create an ami from a snapshot\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -f register_image my-ec2-config ami_name=my_ami description=\"my description\"\n root_device_name=/dev/xvda snapshot_id=snap-xxxxxxxx\n '''\n\n if call != 'function':\n log.error(\n 'The create_volume function must be called with -f or --function.'\n )\n return False\n\n if 'ami_name' not in kwargs:\n log.error('ami_name must be specified to register an image.')\n return False\n\n block_device_mapping = kwargs.get('block_device_mapping', None)\n if not block_device_mapping:\n if 'snapshot_id' not in kwargs:\n log.error('snapshot_id or block_device_mapping must be specified to register an image.')\n return False\n if 'root_device_name' not in kwargs:\n log.error('root_device_name or block_device_mapping must be specified to register an image.')\n return False\n block_device_mapping = [{\n 'DeviceName': kwargs['root_device_name'],\n 'Ebs': {\n 'VolumeType': kwargs.get('volume_type', 'gp2'),\n 'SnapshotId': kwargs['snapshot_id'],\n }\n }]\n\n if not isinstance(block_device_mapping, list):\n block_device_mapping = [block_device_mapping]\n\n params = {'Action': 'RegisterImage',\n 'Name': kwargs['ami_name']}\n\n params.update(_param_from_config('BlockDeviceMapping', block_device_mapping))\n\n if 'root_device_name' in kwargs:\n params['RootDeviceName'] = kwargs['root_device_name']\n\n if 'description' in kwargs:\n params['Description'] = kwargs['description']\n\n if 'virtualization_type' in kwargs:\n params['VirtualizationType'] = kwargs['virtualization_type']\n\n if 'architecture' in kwargs:\n params['Architecture'] = kwargs['architecture']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n r_data = {}\n for d in data[0]:\n for k, v in d.items():\n r_data[k] = v\n\n return r_data\n\n\ndef volume_create(**kwargs):\n '''\n Wrapper around create_volume.\n Here just to ensure the compatibility with the cloud module.\n '''\n return create_volume(kwargs, 'function')\n\n\ndef create_volume(kwargs=None, call=None, wait_to_finish=False):\n '''\n Create a volume.\n\n zone\n The availability zone used to create the volume. Required. String.\n\n size\n The size of the volume, in GiBs. Defaults to ``10``. Integer.\n\n snapshot\n The snapshot-id from which to create the volume. Integer.\n\n type\n The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned\n IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for\n Magnetic volumes. String.\n\n iops\n The number of I/O operations per second (IOPS) to provision for the volume,\n with a maximum ratio of 50 IOPS/GiB. Only valid for Provisioned IOPS SSD\n volumes. Integer.\n\n This option will only be set if ``type`` is also specified as ``io1``.\n\n encrypted\n Specifies whether the volume will be encrypted. Boolean.\n\n If ``snapshot`` is also given in the list of kwargs, then this value is ignored\n since volumes that are created from encrypted snapshots are also automatically\n encrypted.\n\n tags\n The tags to apply to the volume during creation. Dictionary.\n\n call\n The ``create_volume`` function must be called with ``-f`` or ``--function``.\n String.\n\n wait_to_finish\n Whether or not to wait for the volume to be available. Boolean. Defaults to\n ``False``.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f create_volume my-ec2-config zone=us-east-1b\n salt-cloud -f create_volume my-ec2-config zone=us-east-1b tags='{\"tag1\": \"val1\", \"tag2\", \"val2\"}'\n '''\n if call != 'function':\n log.error(\n 'The create_volume function must be called with -f or --function.'\n )\n return False\n\n if 'zone' not in kwargs:\n log.error('An availability zone must be specified to create a volume.')\n return False\n\n if 'size' not in kwargs and 'snapshot' not in kwargs:\n # This number represents GiB\n kwargs['size'] = '10'\n\n params = {'Action': 'CreateVolume',\n 'AvailabilityZone': kwargs['zone']}\n\n if 'size' in kwargs:\n params['Size'] = kwargs['size']\n\n if 'snapshot' in kwargs:\n params['SnapshotId'] = kwargs['snapshot']\n\n if 'type' in kwargs:\n params['VolumeType'] = kwargs['type']\n\n if 'iops' in kwargs and kwargs.get('type', 'standard') == 'io1':\n params['Iops'] = kwargs['iops']\n\n # You can't set `encrypted` if you pass a snapshot\n if 'encrypted' in kwargs and 'snapshot' not in kwargs:\n params['Encrypted'] = kwargs['encrypted']\n if 'kmskeyid' in kwargs:\n params['KmsKeyId'] = kwargs['kmskeyid']\n if 'kmskeyid' in kwargs and 'encrypted' not in kwargs:\n log.error(\n 'If a KMS Key ID is specified, encryption must be enabled'\n )\n return False\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n r_data = {}\n for d in data[0]:\n for k, v in six.iteritems(d):\n r_data[k] = v\n volume_id = r_data['volumeId']\n\n # Allow tags to be set upon creation\n if 'tags' in kwargs:\n if isinstance(kwargs['tags'], six.string_types):\n tags = salt.utils.yaml.safe_load(kwargs['tags'])\n else:\n tags = kwargs['tags']\n\n if isinstance(tags, dict):\n new_tags = set_tags(tags=tags,\n resource_id=volume_id,\n call='action',\n location=get_location())\n r_data['tags'] = new_tags\n\n # Waits till volume is available\n if wait_to_finish:\n salt.utils.cloud.run_func_until_ret_arg(fun=describe_volumes,\n kwargs={'volume_id': volume_id},\n fun_call=call,\n argument_being_watched='status',\n required_argument_response='available')\n\n return r_data\n\n\ndef __attach_vol_to_instance(params, kws, instance_id):\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if data[0]:\n log.warning(\n 'Error attaching volume %s to instance %s. Retrying!',\n kws['volume_id'], instance_id\n )\n return False\n\n return data\n\n\ndef attach_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Attach a volume to an instance\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The attach_volume action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n if 'device' not in kwargs:\n log.error('A device is required (ex. /dev/sdb1).')\n return False\n\n params = {'Action': 'AttachVolume',\n 'VolumeId': kwargs['volume_id'],\n 'InstanceId': instance_id,\n 'Device': kwargs['device']}\n\n log.debug(params)\n\n vm_ = get_configured_provider()\n\n data = salt.utils.cloud.wait_for_ip(\n __attach_vol_to_instance,\n update_args=(params, kwargs, instance_id),\n timeout=config.get_cloud_config_value(\n 'wait_for_ip_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_ip_interval', vm_, __opts__, default=10),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_ip_interval_multiplier', vm_, __opts__, default=1),\n )\n\n return data\n\n\ndef show_volume(kwargs=None, call=None):\n '''\n Wrapper around describe_volumes.\n Here just to keep functionality.\n Might be depreciated later.\n '''\n if not kwargs:\n kwargs = {}\n\n return describe_volumes(kwargs, call)\n\n\ndef detach_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Detach a volume from an instance\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The detach_volume action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n params = {'Action': 'DetachVolume',\n 'VolumeId': kwargs['volume_id']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef delete_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Delete a volume\n '''\n if not kwargs:\n kwargs = {}\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n params = {'Action': 'DeleteVolume',\n 'VolumeId': kwargs['volume_id']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef volume_list(**kwargs):\n '''\n Wrapper around describe_volumes.\n Here just to ensure the compatibility with the cloud module.\n '''\n return describe_volumes(kwargs, 'function')\n\n\ndef describe_volumes(kwargs=None, call=None):\n '''\n Describe a volume (or volumes)\n\n volume_id\n One or more volume IDs. Multiple IDs must be separated by \",\".\n\n TODO: Add all of the filters.\n '''\n if call != 'function':\n log.error(\n 'The describe_volumes function must be called with -f '\n 'or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n params = {'Action': 'DescribeVolumes'}\n\n if 'volume_id' in kwargs:\n volume_id = kwargs['volume_id'].split(',')\n for volume_index, volume_id in enumerate(volume_id):\n params['VolumeId.{0}'.format(volume_index)] = volume_id\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef create_keypair(kwargs=None, call=None):\n '''\n Create an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The create_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'CreateKeyPair',\n 'KeyName': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n keys = [x for x in data[0] if 'requestId' not in x]\n\n return (keys, data[1])\n\n\ndef import_keypair(kwargs=None, call=None):\n '''\n Import an SSH public key.\n\n .. versionadded:: 2015.8.3\n '''\n if call != 'function':\n log.error(\n 'The import_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n if 'file' not in kwargs:\n log.error('A public key file is required.')\n return False\n\n params = {'Action': 'ImportKeyPair',\n 'KeyName': kwargs['keyname']}\n\n public_key_file = kwargs['file']\n\n if os.path.exists(public_key_file):\n with salt.utils.files.fopen(public_key_file, 'r') as fh_:\n public_key = salt.utils.stringutils.to_unicode(fh_.read())\n\n if public_key is not None:\n params['PublicKeyMaterial'] = base64.b64encode(public_key)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef show_keypair(kwargs=None, call=None):\n '''\n Show the details of an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The show_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'DescribeKeyPairs',\n 'KeyName.1': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef delete_keypair(kwargs=None, call=None):\n '''\n Delete an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The delete_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'DeleteKeyPair',\n 'KeyName': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef create_snapshot(kwargs=None, call=None, wait_to_finish=False):\n '''\n Create a snapshot.\n\n volume_id\n The ID of the Volume from which to create a snapshot.\n\n description\n The optional description of the snapshot.\n\n CLI Exampe:\n\n .. code-block:: bash\n\n salt-cloud -f create_snapshot my-ec2-config volume_id=vol-351d8826\n salt-cloud -f create_snapshot my-ec2-config volume_id=vol-351d8826 \\\\\n description=\"My Snapshot Description\"\n '''\n if call != 'function':\n raise SaltCloudSystemExit(\n 'The create_snapshot function must be called with -f '\n 'or --function.'\n )\n\n if kwargs is None:\n kwargs = {}\n\n volume_id = kwargs.get('volume_id', None)\n description = kwargs.get('description', '')\n\n if volume_id is None:\n raise SaltCloudSystemExit(\n 'A volume_id must be specified to create a snapshot.'\n )\n\n params = {'Action': 'CreateSnapshot',\n 'VolumeId': volume_id,\n 'Description': description}\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')[0]\n\n r_data = {}\n for d in data:\n for k, v in six.iteritems(d):\n r_data[k] = v\n\n if 'snapshotId' in r_data:\n snapshot_id = r_data['snapshotId']\n\n # Waits till volume is available\n if wait_to_finish:\n salt.utils.cloud.run_func_until_ret_arg(fun=describe_snapshots,\n kwargs={'snapshot_id': snapshot_id},\n fun_call=call,\n argument_being_watched='status',\n required_argument_response='completed')\n\n return r_data\n\n\ndef delete_snapshot(kwargs=None, call=None):\n '''\n Delete a snapshot\n '''\n if call != 'function':\n log.error(\n 'The delete_snapshot function must be called with -f '\n 'or --function.'\n )\n return False\n\n if 'snapshot_id' not in kwargs:\n log.error('A snapshot_id must be specified to delete a snapshot.')\n return False\n\n params = {'Action': 'DeleteSnapshot'}\n\n if 'snapshot_id' in kwargs:\n params['SnapshotId'] = kwargs['snapshot_id']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef copy_snapshot(kwargs=None, call=None):\n '''\n Copy a snapshot\n '''\n if call != 'function':\n log.error(\n 'The copy_snapshot function must be called with -f or --function.'\n )\n return False\n\n if 'source_region' not in kwargs:\n log.error('A source_region must be specified to copy a snapshot.')\n return False\n\n if 'source_snapshot_id' not in kwargs:\n log.error('A source_snapshot_id must be specified to copy a snapshot.')\n return False\n\n if 'description' not in kwargs:\n kwargs['description'] = ''\n\n params = {'Action': 'CopySnapshot'}\n\n if 'source_region' in kwargs:\n params['SourceRegion'] = kwargs['source_region']\n\n if 'source_snapshot_id' in kwargs:\n params['SourceSnapshotId'] = kwargs['source_snapshot_id']\n\n if 'description' in kwargs:\n params['Description'] = kwargs['description']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef describe_snapshots(kwargs=None, call=None):\n '''\n Describe a snapshot (or snapshots)\n\n snapshot_id\n One or more snapshot IDs. Multiple IDs must be separated by \",\".\n\n owner\n Return the snapshots owned by the specified owner. Valid values\n include: self, amazon, <AWS Account ID>. Multiple values must be\n separated by \",\".\n\n restorable_by\n One or more AWS accounts IDs that can create volumes from the snapshot.\n Multiple aws account IDs must be separated by \",\".\n\n TODO: Add all of the filters.\n '''\n if call != 'function':\n log.error(\n 'The describe_snapshot function must be called with -f '\n 'or --function.'\n )\n return False\n\n params = {'Action': 'DescribeSnapshots'}\n\n # The AWS correct way is to use non-plurals like snapshot_id INSTEAD of snapshot_ids.\n if 'snapshot_ids' in kwargs:\n kwargs['snapshot_id'] = kwargs['snapshot_ids']\n\n if 'snapshot_id' in kwargs:\n snapshot_ids = kwargs['snapshot_id'].split(',')\n for snapshot_index, snapshot_id in enumerate(snapshot_ids):\n params['SnapshotId.{0}'.format(snapshot_index)] = snapshot_id\n\n if 'owner' in kwargs:\n owners = kwargs['owner'].split(',')\n for owner_index, owner in enumerate(owners):\n params['Owner.{0}'.format(owner_index)] = owner\n\n if 'restorable_by' in kwargs:\n restorable_bys = kwargs['restorable_by'].split(',')\n for restorable_by_index, restorable_by in enumerate(restorable_bys):\n params[\n 'RestorableBy.{0}'.format(restorable_by_index)\n ] = restorable_by\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef get_console_output(\n name=None,\n location=None,\n instance_id=None,\n call=None,\n kwargs=None,\n ):\n '''\n Show the console output from the instance.\n\n By default, returns decoded data, not the Base64-encoded data that is\n actually returned from the EC2 API.\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The get_console_output action must be called with '\n '-a or --action.'\n )\n\n if location is None:\n location = get_location()\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if kwargs is None:\n kwargs = {}\n\n if instance_id is None:\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n params = {'Action': 'GetConsoleOutput',\n 'InstanceId': instance_id}\n\n ret = {}\n data = aws.query(params,\n return_root=True,\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for item in data:\n if next(six.iterkeys(item)) == 'output':\n ret['output_decoded'] = binascii.a2b_base64(next(six.itervalues(item)))\n else:\n ret[next(six.iterkeys(item))] = next(six.itervalues(item))\n\n return ret\n\n\n\ndef update_pricing(kwargs=None, call=None):\n '''\n Download most recent pricing information from AWS and convert to a local\n JSON file.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f update_pricing my-ec2-config\n salt-cloud -f update_pricing my-ec2-config type=linux\n\n .. versionadded:: 2015.8.0\n '''\n sources = {\n 'linux': 'https://a0.awsstatic.com/pricing/1/ec2/linux-od.min.js',\n 'rhel': 'https://a0.awsstatic.com/pricing/1/ec2/rhel-od.min.js',\n 'sles': 'https://a0.awsstatic.com/pricing/1/ec2/sles-od.min.js',\n 'mswin': 'https://a0.awsstatic.com/pricing/1/ec2/mswin-od.min.js',\n 'mswinsql': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQL-od.min.js',\n 'mswinsqlweb': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQLWeb-od.min.js',\n }\n\n if kwargs is None:\n kwargs = {}\n\n if 'type' not in kwargs:\n for source in sources:\n _parse_pricing(sources[source], source)\n else:\n _parse_pricing(sources[kwargs['type']], kwargs['type'])\n\n\ndef _parse_pricing(url, name):\n '''\n Download and parse an individual pricing file from AWS\n\n .. versionadded:: 2015.8.0\n '''\n price_js = http.query(url, text=True)\n\n items = []\n current_item = ''\n\n price_js = re.sub(JS_COMMENT_RE, '', price_js['text'])\n price_js = price_js.strip().rstrip(');').lstrip('callback(')\n for keyword in (\n 'vers',\n 'config',\n 'rate',\n 'valueColumns',\n 'currencies',\n 'instanceTypes',\n 'type',\n 'ECU',\n 'storageGB',\n 'name',\n 'vCPU',\n 'memoryGiB',\n 'storageGiB',\n 'USD',\n ):\n price_js = price_js.replace(keyword, '\"{0}\"'.format(keyword))\n\n for keyword in ('region', 'price', 'size'):\n price_js = price_js.replace(keyword, '\"{0}\"'.format(keyword))\n price_js = price_js.replace('\"{0}\"s'.format(keyword), '\"{0}s\"'.format(keyword))\n\n price_js = price_js.replace('\"\"', '\"')\n\n # Turn the data into something that's easier/faster to process\n regions = {}\n price_json = salt.utils.json.loads(price_js)\n for region in price_json['config']['regions']:\n sizes = {}\n for itype in region['instanceTypes']:\n for size in itype['sizes']:\n sizes[size['size']] = size\n regions[region['region']] = sizes\n\n outfile = os.path.join(\n __opts__['cachedir'], 'ec2-pricing-{0}.p'.format(name)\n )\n with salt.utils.files.fopen(outfile, 'w') as fho:\n salt.utils.msgpack.dump(regions, fho)\n\n return True\n\n\ndef show_pricing(kwargs=None, call=None):\n '''\n Show pricing for a particular profile. This is only an estimate, based on\n unofficial pricing sources.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f show_pricing my-ec2-config profile=my-profile\n\n If pricing sources have not been cached, they will be downloaded. Once they\n have been cached, they will not be updated automatically. To manually update\n all prices, use the following command:\n\n .. code-block:: bash\n\n salt-cloud -f update_pricing <provider>\n\n .. versionadded:: 2015.8.0\n '''\n profile = __opts__['profiles'].get(kwargs['profile'], {})\n if not profile:\n return {'Error': 'The requested profile was not found'}\n\n # Make sure the profile belongs to ec2\n provider = profile.get('provider', '0:0')\n comps = provider.split(':')\n if len(comps) < 2 or comps[1] != 'ec2':\n return {'Error': 'The requested profile does not belong to EC2'}\n\n image_id = profile.get('image', None)\n image_dict = show_image({'image': image_id}, 'function')\n image_info = image_dict[0]\n\n # Find out what platform it is\n if image_info.get('imageOwnerAlias', '') == 'amazon':\n if image_info.get('platform', '') == 'windows':\n image_description = image_info.get('description', '')\n if 'sql' in image_description.lower():\n if 'web' in image_description.lower():\n name = 'mswinsqlweb'\n else:\n name = 'mswinsql'\n else:\n name = 'mswin'\n elif image_info.get('imageLocation', '').strip().startswith('amazon/suse'):\n name = 'sles'\n else:\n name = 'linux'\n elif image_info.get('imageOwnerId', '') == '309956199498':\n name = 'rhel'\n else:\n name = 'linux'\n\n pricefile = os.path.join(\n __opts__['cachedir'], 'ec2-pricing-{0}.p'.format(name)\n )\n\n if not os.path.isfile(pricefile):\n update_pricing({'type': name}, 'function')\n\n with salt.utils.files.fopen(pricefile, 'r') as fhi:\n ec2_price = salt.utils.stringutils.to_unicode(\n salt.utils.msgpack.load(fhi))\n\n region = get_location(profile)\n size = profile.get('size', None)\n if size is None:\n return {'Error': 'The requested profile does not contain a size'}\n\n try:\n raw = ec2_price[region][size]\n except KeyError:\n return {'Error': 'The size ({0}) in the requested profile does not have '\n 'a price associated with it for the {1} region'.format(size, region)}\n\n ret = {}\n if kwargs.get('raw', False):\n ret['_raw'] = raw\n\n ret['per_hour'] = 0\n for col in raw.get('valueColumns', []):\n ret['per_hour'] += decimal.Decimal(col['prices'].get('USD', 0))\n\n ret['per_hour'] = decimal.Decimal(ret['per_hour'])\n ret['per_day'] = ret['per_hour'] * 24\n ret['per_week'] = ret['per_day'] * 7\n ret['per_month'] = ret['per_day'] * 30\n ret['per_year'] = ret['per_week'] * 52\n\n return {profile['profile']: ret}\n\n\ndef ssm_create_association(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Associates the specified SSM document with the specified instance\n\n http://docs.aws.amazon.com/ssm/latest/APIReference/API_CreateAssociation.html\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a ssm_create_association ec2-instance-name ssm_document=ssm-document-name\n '''\n\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The ssm_create_association action must be called with '\n '-a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'ssm_document' not in kwargs:\n log.error('A ssm_document is required.')\n return False\n\n params = {'Action': 'CreateAssociation',\n 'InstanceId': instance_id,\n 'Name': kwargs['ssm_document']}\n\n result = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n product='ssm',\n opts=__opts__,\n sigver='4')\n log.info(result)\n return result\n\n\ndef ssm_describe_association(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Describes the associations for the specified SSM document or instance.\n\n http://docs.aws.amazon.com/ssm/latest/APIReference/API_DescribeAssociation.html\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a ssm_describe_association ec2-instance-name ssm_document=ssm-document-name\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The ssm_describe_association action must be called with '\n '-a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'ssm_document' not in kwargs:\n log.error('A ssm_document is required.')\n return False\n\n params = {'Action': 'DescribeAssociation',\n 'InstanceId': instance_id,\n 'Name': kwargs['ssm_document']}\n\n result = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n product='ssm',\n opts=__opts__,\n sigver='4')\n log.info(result)\n return result\n"}}},{"rowIdx":355,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/cloud/clouds/ec2.py"},"func_name":{"kind":"string","value":"update_pricing"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def update_pricing(kwargs=None, call=None):\n '''\n Download most recent pricing information from AWS and convert to a local\n JSON file.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f update_pricing my-ec2-config\n salt-cloud -f update_pricing my-ec2-config type=linux\n\n .. versionadded:: 2015.8.0\n '''\n sources = {\n 'linux': 'https://a0.awsstatic.com/pricing/1/ec2/linux-od.min.js',\n 'rhel': 'https://a0.awsstatic.com/pricing/1/ec2/rhel-od.min.js',\n 'sles': 'https://a0.awsstatic.com/pricing/1/ec2/sles-od.min.js',\n 'mswin': 'https://a0.awsstatic.com/pricing/1/ec2/mswin-od.min.js',\n 'mswinsql': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQL-od.min.js',\n 'mswinsqlweb': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQLWeb-od.min.js',\n }\n\n if kwargs is None:\n kwargs = {}\n\n if 'type' not in kwargs:\n for source in sources:\n _parse_pricing(sources[source], source)\n else:\n _parse_pricing(sources[kwargs['type']], kwargs['type'])"},"func_documentation_string":{"kind":"string","value":"Download most recent pricing information from AWS and convert to a local\n JSON file.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f update_pricing my-ec2-config\n salt-cloud -f update_pricing my-ec2-config type=linux\n\n .. versionadded:: 2015.8.0"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4935-L4965"},"called_functions":{"kind":"list like","value":["def _parse_pricing(url, name):\n '''\n Download and parse an individual pricing file from AWS\n\n .. versionadded:: 2015.8.0\n '''\n price_js = http.query(url, text=True)\n\n items = []\n current_item = ''\n\n price_js = re.sub(JS_COMMENT_RE, '', price_js['text'])\n price_js = price_js.strip().rstrip(');').lstrip('callback(')\n for keyword in (\n 'vers',\n 'config',\n 'rate',\n 'valueColumns',\n 'currencies',\n 'instanceTypes',\n 'type',\n 'ECU',\n 'storageGB',\n 'name',\n 'vCPU',\n 'memoryGiB',\n 'storageGiB',\n 'USD',\n ):\n price_js = price_js.replace(keyword, '\"{0}\"'.format(keyword))\n\n for keyword in ('region', 'price', 'size'):\n price_js = price_js.replace(keyword, '\"{0}\"'.format(keyword))\n price_js = price_js.replace('\"{0}\"s'.format(keyword), '\"{0}s\"'.format(keyword))\n\n price_js = price_js.replace('\"\"', '\"')\n\n # Turn the data into something that's easier/faster to process\n regions = {}\n price_json = salt.utils.json.loads(price_js)\n for region in price_json['config']['regions']:\n sizes = {}\n for itype in region['instanceTypes']:\n for size in itype['sizes']:\n sizes[size['size']] = size\n regions[region['region']] = sizes\n\n outfile = os.path.join(\n __opts__['cachedir'], 'ec2-pricing-{0}.p'.format(name)\n )\n with salt.utils.files.fopen(outfile, 'w') as fho:\n salt.utils.msgpack.dump(regions, fho)\n\n return True\n"],"string":"[\n \"def _parse_pricing(url, name):\\n '''\\n Download and parse an individual pricing file from AWS\\n\\n .. versionadded:: 2015.8.0\\n '''\\n price_js = http.query(url, text=True)\\n\\n items = []\\n current_item = ''\\n\\n price_js = re.sub(JS_COMMENT_RE, '', price_js['text'])\\n price_js = price_js.strip().rstrip(');').lstrip('callback(')\\n for keyword in (\\n 'vers',\\n 'config',\\n 'rate',\\n 'valueColumns',\\n 'currencies',\\n 'instanceTypes',\\n 'type',\\n 'ECU',\\n 'storageGB',\\n 'name',\\n 'vCPU',\\n 'memoryGiB',\\n 'storageGiB',\\n 'USD',\\n ):\\n price_js = price_js.replace(keyword, '\\\"{0}\\\"'.format(keyword))\\n\\n for keyword in ('region', 'price', 'size'):\\n price_js = price_js.replace(keyword, '\\\"{0}\\\"'.format(keyword))\\n price_js = price_js.replace('\\\"{0}\\\"s'.format(keyword), '\\\"{0}s\\\"'.format(keyword))\\n\\n price_js = price_js.replace('\\\"\\\"', '\\\"')\\n\\n # Turn the data into something that's easier/faster to process\\n regions = {}\\n price_json = salt.utils.json.loads(price_js)\\n for region in price_json['config']['regions']:\\n sizes = {}\\n for itype in region['instanceTypes']:\\n for size in itype['sizes']:\\n sizes[size['size']] = size\\n regions[region['region']] = sizes\\n\\n outfile = os.path.join(\\n __opts__['cachedir'], 'ec2-pricing-{0}.p'.format(name)\\n )\\n with salt.utils.files.fopen(outfile, 'w') as fho:\\n salt.utils.msgpack.dump(regions, fho)\\n\\n return True\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nThe EC2 Cloud Module\n====================\n\nThe EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.\n\nTo use the EC2 cloud module, set up the cloud configuration at\n ``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:\n\n.. code-block:: yaml\n\n my-ec2-config:\n # EC2 API credentials: Access Key ID and Secret Access Key.\n # Alternatively, to use IAM Instance Role credentials available via\n # EC2 metadata set both id and key to 'use-instance-role-credentials'\n id: GKTADJGHEIQSXMKKRBJ08H\n key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs\n\n # If 'role_arn' is specified the above credentials are used to\n # to assume to the role. By default, role_arn is set to None.\n role_arn: arn:aws:iam::012345678910:role/SomeRoleName\n\n # The ssh keyname to use\n keyname: default\n # The amazon security group\n securitygroup: ssh_open\n # The location of the private key which corresponds to the keyname\n private_key: /root/default.pem\n\n # Be default, service_url is set to amazonaws.com. If you are using this\n # driver for something other than Amazon EC2, change it here:\n service_url: amazonaws.com\n\n # The endpoint that is ultimately used is usually formed using the region\n # and the service_url. If you would like to override that entirely, you\n # can explicitly define the endpoint:\n endpoint: myendpoint.example.com:1138/services/Cloud\n\n # SSH Gateways can be used with this provider. Gateways can be used\n # when a salt-master is not on the same private network as the instance\n # that is being deployed.\n\n # Defaults to None\n # Required\n ssh_gateway: gateway.example.com\n\n # Defaults to port 22\n # Optional\n ssh_gateway_port: 22\n\n # Defaults to root\n # Optional\n ssh_gateway_username: root\n\n # Default to nc -q0 %h %p\n # Optional\n ssh_gateway_command: \"-W %h:%p\"\n\n # One authentication method is required. If both\n # are specified, Private key wins.\n\n # Private key defaults to None\n ssh_gateway_private_key: /path/to/key.pem\n\n # Password defaults to None\n ssh_gateway_password: ExamplePasswordHere\n\n driver: ec2\n\n # Pass userdata to the instance to be created\n userdata_file: /etc/salt/my-userdata-file\n\n # Instance termination protection setting\n # Default is disabled\n termination_protection: False\n\n:depends: requests\n'''\n# pylint: disable=invalid-name,function-redefined\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport os\nimport sys\nimport stat\nimport time\nimport uuid\nimport pprint\nimport logging\n\n# Import libs for talking to the EC2 API\nimport hmac\nimport hashlib\nimport binascii\nimport datetime\nimport base64\nimport re\nimport decimal\n\n# Import Salt Libs\nimport salt.utils.cloud\nimport salt.utils.compat\nimport salt.utils.files\nimport salt.utils.hashutils\nimport salt.utils.json\nimport salt.utils.msgpack\nimport salt.utils.stringutils\nimport salt.utils.yaml\nfrom salt._compat import ElementTree as ET\nimport salt.utils.http as http\nimport salt.utils.aws as aws\nimport salt.config as config\nfrom salt.exceptions import (\n SaltCloudException,\n SaltCloudSystemExit,\n SaltCloudConfigError,\n SaltCloudExecutionTimeout,\n SaltCloudExecutionFailure\n)\n\n# pylint: disable=import-error,no-name-in-module,redefined-builtin\nfrom salt.ext import six\nfrom salt.ext.six.moves import map, range, zip\nfrom salt.ext.six.moves.urllib.parse import urlparse as _urlparse, urlencode as _urlencode\n\n# Import 3rd-Party Libs\n# Try to import PyCrypto, which may not be installed on a RAET-based system\ntry:\n from M2Crypto import RSA\n HAS_M2 = True\nexcept ImportError:\n HAS_M2 = False\n\ntry:\n import Crypto\n # PKCS1_v1_5 was added in PyCrypto 2.5\n from Crypto.Cipher import PKCS1_v1_5 # pylint: disable=E0611\n from Crypto.Hash import SHA # pylint: disable=E0611,W0611\n HAS_PYCRYPTO = True\nexcept ImportError:\n HAS_PYCRYPTO = False\n\ntry:\n import requests\n HAS_REQUESTS = True\nexcept ImportError:\n HAS_REQUESTS = False\n# pylint: enable=import-error,no-name-in-module,redefined-builtin\n\n# Get logging started\nlog = logging.getLogger(__name__)\n\n\nEC2_LOCATIONS = {\n 'ap-northeast-1': 'ec2_ap_northeast',\n 'ap-northeast-2': 'ec2_ap_northeast_2',\n 'ap-southeast-1': 'ec2_ap_southeast',\n 'ap-southeast-2': 'ec2_ap_southeast_2',\n 'eu-west-1': 'ec2_eu_west',\n 'eu-central-1': 'ec2_eu_central',\n 'sa-east-1': 'ec2_sa_east',\n 'us-east-1': 'ec2_us_east',\n 'us-gov-west-1': 'ec2_us_gov_west_1',\n 'us-west-1': 'ec2_us_west',\n 'us-west-2': 'ec2_us_west_oregon',\n}\nDEFAULT_LOCATION = 'us-east-1'\n\nDEFAULT_EC2_API_VERSION = '2014-10-01'\n\nEC2_RETRY_CODES = [\n 'RequestLimitExceeded',\n 'InsufficientInstanceCapacity',\n 'InternalError',\n 'Unavailable',\n 'InsufficientAddressCapacity',\n 'InsufficientReservedInstanceCapacity',\n]\n\nJS_COMMENT_RE = re.compile(r'/\\*.*?\\*/', re.S)\n\n__virtualname__ = 'ec2'\n\n\n# Only load in this module if the EC2 configurations are in place\ndef __virtual__():\n '''\n Set up the libcloud functions and check for EC2 configurations\n '''\n if get_configured_provider() is False:\n return False\n\n if get_dependencies() is False:\n return False\n\n return __virtualname__\n\n\ndef get_configured_provider():\n '''\n Return the first configured instance.\n '''\n return config.is_provider_configured(\n __opts__,\n __active_provider_name__ or __virtualname__,\n ('id', 'key')\n )\n\n\ndef get_dependencies():\n '''\n Warn if dependencies aren't met.\n '''\n deps = {\n 'requests': HAS_REQUESTS,\n 'pycrypto or m2crypto': HAS_M2 or HAS_PYCRYPTO\n }\n return config.check_driver_dependencies(\n __virtualname__,\n deps\n )\n\n\ndef _xml_to_dict(xmltree):\n '''\n Convert an XML tree into a dict\n '''\n if sys.version_info < (2, 7):\n children_len = len(xmltree.getchildren())\n else:\n children_len = len(xmltree)\n\n if children_len < 1:\n name = xmltree.tag\n if '}' in name:\n comps = name.split('}')\n name = comps[1]\n return {name: xmltree.text}\n\n xmldict = {}\n for item in xmltree:\n name = item.tag\n if '}' in name:\n comps = name.split('}')\n name = comps[1]\n if name not in xmldict:\n if sys.version_info < (2, 7):\n children_len = len(item.getchildren())\n else:\n children_len = len(item)\n\n if children_len > 0:\n xmldict[name] = _xml_to_dict(item)\n else:\n xmldict[name] = item.text\n else:\n if not isinstance(xmldict[name], list):\n tempvar = xmldict[name]\n xmldict[name] = []\n xmldict[name].append(tempvar)\n xmldict[name].append(_xml_to_dict(item))\n return xmldict\n\n\ndef optimize_providers(providers):\n '''\n Return an optimized list of providers.\n\n We want to reduce the duplication of querying\n the same region.\n\n If a provider is using the same credentials for the same region\n the same data will be returned for each provider, thus causing\n un-wanted duplicate data and API calls to EC2.\n\n '''\n tmp_providers = {}\n optimized_providers = {}\n\n for name, data in six.iteritems(providers):\n if 'location' not in data:\n data['location'] = DEFAULT_LOCATION\n\n if data['location'] not in tmp_providers:\n tmp_providers[data['location']] = {}\n\n creds = (data['id'], data['key'])\n if creds not in tmp_providers[data['location']]:\n tmp_providers[data['location']][creds] = {'name': name,\n 'data': data,\n }\n\n for location, tmp_data in six.iteritems(tmp_providers):\n for creds, data in six.iteritems(tmp_data):\n _id, _key = creds\n _name = data['name']\n _data = data['data']\n if _name not in optimized_providers:\n optimized_providers[_name] = _data\n\n return optimized_providers\n\n\ndef sign(key, msg):\n return hmac.new(key, msg.encode('utf-8'), hashlib.sha256).digest()\n\n\ndef query(params=None, setname=None, requesturl=None, location=None,\n return_url=False, return_root=False):\n\n provider = get_configured_provider()\n service_url = provider.get('service_url', 'amazonaws.com')\n\n # Retrieve access credentials from meta-data, or use provided\n access_key_id, secret_access_key, token = aws.creds(provider)\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n params_with_headers = params.copy()\n timestamp = datetime.datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%SZ')\n\n if not location:\n location = get_location()\n\n if not requesturl:\n endpoint = provider.get(\n 'endpoint',\n 'ec2.{0}.{1}'.format(location, service_url)\n )\n\n requesturl = 'https://{0}/'.format(endpoint)\n endpoint = _urlparse(requesturl).netloc\n endpoint_path = _urlparse(requesturl).path\n else:\n endpoint = _urlparse(requesturl).netloc\n endpoint_path = _urlparse(requesturl).path\n if endpoint == '':\n endpoint_err = (\n 'Could not find a valid endpoint in the '\n 'requesturl: {0}. Looking for something '\n 'like https://some.ec2.endpoint/?args').format(requesturl)\n log.error(endpoint_err)\n if return_url is True:\n return {'error': endpoint_err}, requesturl\n return {'error': endpoint_err}\n\n log.debug('Using EC2 endpoint: %s', endpoint)\n # AWS v4 signature\n\n method = 'GET'\n region = location\n service = 'ec2'\n canonical_uri = _urlparse(requesturl).path\n host = endpoint.strip()\n\n # Create a date for headers and the credential string\n t = datetime.datetime.utcnow()\n amz_date = t.strftime('%Y%m%dT%H%M%SZ') # Format date as YYYYMMDD'T'HHMMSS'Z'\n datestamp = t.strftime('%Y%m%d') # Date w/o time, used in credential scope\n\n canonical_headers = 'host:' + host + '\\n' + 'x-amz-date:' + amz_date + '\\n'\n signed_headers = 'host;x-amz-date'\n\n payload_hash = salt.utils.hashutils.sha256_digest('')\n\n ec2_api_version = provider.get(\n 'ec2_api_version',\n DEFAULT_EC2_API_VERSION\n )\n\n params_with_headers['Version'] = ec2_api_version\n\n keys = sorted(list(params_with_headers))\n values = map(params_with_headers.get, keys)\n querystring = _urlencode(list(zip(keys, values)))\n querystring = querystring.replace('+', '%20')\n\n canonical_request = method + '\\n' + canonical_uri + '\\n' + \\\n querystring + '\\n' + canonical_headers + '\\n' + \\\n signed_headers + '\\n' + payload_hash\n\n algorithm = 'AWS4-HMAC-SHA256'\n credential_scope = datestamp + '/' + region + '/' + service + '/' + 'aws4_request'\n\n string_to_sign = algorithm + '\\n' + amz_date + '\\n' + \\\n credential_scope + '\\n' + \\\n salt.utils.hashutils.sha256_digest(canonical_request)\n\n kDate = sign(('AWS4' + provider['key']).encode('utf-8'), datestamp)\n kRegion = sign(kDate, region)\n kService = sign(kRegion, service)\n signing_key = sign(kService, 'aws4_request')\n\n signature = hmac.new(signing_key, (string_to_sign).encode('utf-8'),\n hashlib.sha256).hexdigest()\n\n authorization_header = algorithm + ' ' + 'Credential=' + \\\n provider['id'] + '/' + credential_scope + \\\n ', ' + 'SignedHeaders=' + signed_headers + \\\n ', ' + 'Signature=' + signature\n headers = {'x-amz-date': amz_date, 'Authorization': authorization_header}\n\n log.debug('EC2 Request: %s', requesturl)\n log.trace('EC2 Request Parameters: %s', params_with_headers)\n try:\n result = requests.get(requesturl, headers=headers, params=params_with_headers)\n log.debug(\n 'EC2 Response Status Code: %s',\n # result.getcode()\n result.status_code\n )\n log.trace('EC2 Response Text: %s', result.text)\n result.raise_for_status()\n break\n except requests.exceptions.HTTPError as exc:\n root = ET.fromstring(exc.response.content)\n data = _xml_to_dict(root)\n\n # check to see if we should retry the query\n err_code = data.get('Errors', {}).get('Error', {}).get('Code', '')\n if err_code and err_code in EC2_RETRY_CODES:\n attempts += 1\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s; '\n 'Attempts remaining: %s',\n exc.response.status_code, exc, data, attempts\n )\n aws.sleep_exponential_backoff(attempts)\n continue\n\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n else:\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n\n response = result.text\n\n root = ET.fromstring(response)\n items = root[1]\n if return_root is True:\n items = root\n\n if setname:\n if sys.version_info < (2, 7):\n children_len = len(root.getchildren())\n else:\n children_len = len(root)\n\n for item in range(0, children_len):\n comps = root[item].tag.split('}')\n if comps[1] == setname:\n items = root[item]\n\n ret = []\n for item in items:\n ret.append(_xml_to_dict(item))\n\n if return_url is True:\n return ret, requesturl\n\n return ret\n\n\ndef _wait_for_spot_instance(update_callback,\n update_args=None,\n update_kwargs=None,\n timeout=10 * 60,\n interval=30,\n interval_multiplier=1,\n max_failures=10):\n '''\n Helper function that waits for a spot instance request to become active\n for a specific maximum amount of time.\n\n :param update_callback: callback function which queries the cloud provider\n for spot instance request. It must return None if\n the required data, running instance included, is\n not available yet.\n :param update_args: Arguments to pass to update_callback\n :param update_kwargs: Keyword arguments to pass to update_callback\n :param timeout: The maximum amount of time(in seconds) to wait for the IP\n address.\n :param interval: The looping interval, i.e., the amount of time to sleep\n before the next iteration.\n :param interval_multiplier: Increase the interval by this multiplier after\n each request; helps with throttling\n :param max_failures: If update_callback returns ``False`` it's considered\n query failure. This value is the amount of failures\n accepted before giving up.\n :returns: The update_callback returned data\n :raises: SaltCloudExecutionTimeout\n\n '''\n if update_args is None:\n update_args = ()\n if update_kwargs is None:\n update_kwargs = {}\n\n duration = timeout\n while True:\n log.debug(\n 'Waiting for spot instance reservation. Giving up in '\n '00:%02d:%02d', int(timeout // 60), int(timeout % 60)\n )\n data = update_callback(*update_args, **update_kwargs)\n if data is False:\n log.debug(\n 'update_callback has returned False which is considered a '\n 'failure. Remaining Failures: %s', max_failures\n )\n max_failures -= 1\n if max_failures <= 0:\n raise SaltCloudExecutionFailure(\n 'Too many failures occurred while waiting for '\n 'the spot instance reservation to become active.'\n )\n elif data is not None:\n return data\n\n if timeout < 0:\n raise SaltCloudExecutionTimeout(\n 'Unable to get an active spot instance request for '\n '00:{0:02d}:{1:02d}'.format(\n int(duration // 60),\n int(duration % 60)\n )\n )\n time.sleep(interval)\n timeout -= interval\n\n if interval_multiplier > 1:\n interval *= interval_multiplier\n if interval > timeout:\n interval = timeout + 1\n log.info('Interval multiplier in effect; interval is '\n 'now %ss', interval)\n\n\ndef avail_sizes(call=None):\n '''\n Return a dict of all available VM sizes on the cloud provider with\n relevant data. Latest version can be found at:\n\n http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_sizes function must be called with '\n '-f or --function, or with the --list-sizes option'\n )\n\n sizes = {\n 'Cluster Compute': {\n 'cc2.8xlarge': {\n 'id': 'cc2.8xlarge',\n 'cores': '16 (2 x Intel Xeon E5-2670, eight-core with '\n 'hyperthread)',\n 'disk': '3360 GiB (4 x 840 GiB)',\n 'ram': '60.5 GiB'\n },\n 'cc1.4xlarge': {\n 'id': 'cc1.4xlarge',\n 'cores': '8 (2 x Intel Xeon X5570, quad-core with '\n 'hyperthread)',\n 'disk': '1690 GiB (2 x 840 GiB)',\n 'ram': '22.5 GiB'\n },\n },\n 'Cluster CPU': {\n 'cg1.4xlarge': {\n 'id': 'cg1.4xlarge',\n 'cores': '8 (2 x Intel Xeon X5570, quad-core with '\n 'hyperthread), plus 2 NVIDIA Tesla M2050 GPUs',\n 'disk': '1680 GiB (2 x 840 GiB)',\n 'ram': '22.5 GiB'\n },\n },\n 'Compute Optimized': {\n 'c4.large': {\n 'id': 'c4.large',\n 'cores': '2',\n 'disk': 'EBS - 500 Mbps',\n 'ram': '3.75 GiB'\n },\n 'c4.xlarge': {\n 'id': 'c4.xlarge',\n 'cores': '4',\n 'disk': 'EBS - 750 Mbps',\n 'ram': '7.5 GiB'\n },\n 'c4.2xlarge': {\n 'id': 'c4.2xlarge',\n 'cores': '8',\n 'disk': 'EBS - 1000 Mbps',\n 'ram': '15 GiB'\n },\n 'c4.4xlarge': {\n 'id': 'c4.4xlarge',\n 'cores': '16',\n 'disk': 'EBS - 2000 Mbps',\n 'ram': '30 GiB'\n },\n 'c4.8xlarge': {\n 'id': 'c4.8xlarge',\n 'cores': '36',\n 'disk': 'EBS - 4000 Mbps',\n 'ram': '60 GiB'\n },\n 'c3.large': {\n 'id': 'c3.large',\n 'cores': '2',\n 'disk': '32 GiB (2 x 16 GiB SSD)',\n 'ram': '3.75 GiB'\n },\n 'c3.xlarge': {\n 'id': 'c3.xlarge',\n 'cores': '4',\n 'disk': '80 GiB (2 x 40 GiB SSD)',\n 'ram': '7.5 GiB'\n },\n 'c3.2xlarge': {\n 'id': 'c3.2xlarge',\n 'cores': '8',\n 'disk': '160 GiB (2 x 80 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'c3.4xlarge': {\n 'id': 'c3.4xlarge',\n 'cores': '16',\n 'disk': '320 GiB (2 x 160 GiB SSD)',\n 'ram': '30 GiB'\n },\n 'c3.8xlarge': {\n 'id': 'c3.8xlarge',\n 'cores': '32',\n 'disk': '640 GiB (2 x 320 GiB SSD)',\n 'ram': '60 GiB'\n }\n },\n 'Dense Storage': {\n 'd2.xlarge': {\n 'id': 'd2.xlarge',\n 'cores': '4',\n 'disk': '6 TiB (3 x 2 TiB hard disk drives)',\n 'ram': '30.5 GiB'\n },\n 'd2.2xlarge': {\n 'id': 'd2.2xlarge',\n 'cores': '8',\n 'disk': '12 TiB (6 x 2 TiB hard disk drives)',\n 'ram': '61 GiB'\n },\n 'd2.4xlarge': {\n 'id': 'd2.4xlarge',\n 'cores': '16',\n 'disk': '24 TiB (12 x 2 TiB hard disk drives)',\n 'ram': '122 GiB'\n },\n 'd2.8xlarge': {\n 'id': 'd2.8xlarge',\n 'cores': '36',\n 'disk': '24 TiB (24 x 2 TiB hard disk drives)',\n 'ram': '244 GiB'\n },\n },\n 'GPU': {\n 'g2.2xlarge': {\n 'id': 'g2.2xlarge',\n 'cores': '8',\n 'disk': '60 GiB (1 x 60 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'g2.8xlarge': {\n 'id': 'g2.8xlarge',\n 'cores': '32',\n 'disk': '240 GiB (2 x 120 GiB SSD)',\n 'ram': '60 GiB'\n },\n },\n 'GPU Compute': {\n 'p2.xlarge': {\n 'id': 'p2.xlarge',\n 'cores': '4',\n 'disk': 'EBS',\n 'ram': '61 GiB'\n },\n 'p2.8xlarge': {\n 'id': 'p2.8xlarge',\n 'cores': '32',\n 'disk': 'EBS',\n 'ram': '488 GiB'\n },\n 'p2.16xlarge': {\n 'id': 'p2.16xlarge',\n 'cores': '64',\n 'disk': 'EBS',\n 'ram': '732 GiB'\n },\n },\n 'High I/O': {\n 'i2.xlarge': {\n 'id': 'i2.xlarge',\n 'cores': '4',\n 'disk': 'SSD (1 x 800 GiB)',\n 'ram': '30.5 GiB'\n },\n 'i2.2xlarge': {\n 'id': 'i2.2xlarge',\n 'cores': '8',\n 'disk': 'SSD (2 x 800 GiB)',\n 'ram': '61 GiB'\n },\n 'i2.4xlarge': {\n 'id': 'i2.4xlarge',\n 'cores': '16',\n 'disk': 'SSD (4 x 800 GiB)',\n 'ram': '122 GiB'\n },\n 'i2.8xlarge': {\n 'id': 'i2.8xlarge',\n 'cores': '32',\n 'disk': 'SSD (8 x 800 GiB)',\n 'ram': '244 GiB'\n }\n },\n 'High Memory': {\n 'x1.16xlarge': {\n 'id': 'x1.16xlarge',\n 'cores': '64 (with 5.45 ECUs each)',\n 'disk': '1920 GiB (1 x 1920 GiB)',\n 'ram': '976 GiB'\n },\n 'x1.32xlarge': {\n 'id': 'x1.32xlarge',\n 'cores': '128 (with 2.73 ECUs each)',\n 'disk': '3840 GiB (2 x 1920 GiB)',\n 'ram': '1952 GiB'\n },\n 'r4.large': {\n 'id': 'r4.large',\n 'cores': '2 (with 3.45 ECUs each)',\n 'disk': 'EBS',\n 'ram': '15.25 GiB'\n },\n 'r4.xlarge': {\n 'id': 'r4.xlarge',\n 'cores': '4 (with 3.35 ECUs each)',\n 'disk': 'EBS',\n 'ram': '30.5 GiB'\n },\n 'r4.2xlarge': {\n 'id': 'r4.2xlarge',\n 'cores': '8 (with 3.35 ECUs each)',\n 'disk': 'EBS',\n 'ram': '61 GiB'\n },\n 'r4.4xlarge': {\n 'id': 'r4.4xlarge',\n 'cores': '16 (with 3.3 ECUs each)',\n 'disk': 'EBS',\n 'ram': '122 GiB'\n },\n 'r4.8xlarge': {\n 'id': 'r4.8xlarge',\n 'cores': '32 (with 3.1 ECUs each)',\n 'disk': 'EBS',\n 'ram': '244 GiB'\n },\n 'r4.16xlarge': {\n 'id': 'r4.16xlarge',\n 'cores': '64 (with 3.05 ECUs each)',\n 'disk': 'EBS',\n 'ram': '488 GiB'\n },\n 'r3.large': {\n 'id': 'r3.large',\n 'cores': '2 (with 3.25 ECUs each)',\n 'disk': '32 GiB (1 x 32 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'r3.xlarge': {\n 'id': 'r3.xlarge',\n 'cores': '4 (with 3.25 ECUs each)',\n 'disk': '80 GiB (1 x 80 GiB SSD)',\n 'ram': '30.5 GiB'\n },\n 'r3.2xlarge': {\n 'id': 'r3.2xlarge',\n 'cores': '8 (with 3.25 ECUs each)',\n 'disk': '160 GiB (1 x 160 GiB SSD)',\n 'ram': '61 GiB'\n },\n 'r3.4xlarge': {\n 'id': 'r3.4xlarge',\n 'cores': '16 (with 3.25 ECUs each)',\n 'disk': '320 GiB (1 x 320 GiB SSD)',\n 'ram': '122 GiB'\n },\n 'r3.8xlarge': {\n 'id': 'r3.8xlarge',\n 'cores': '32 (with 3.25 ECUs each)',\n 'disk': '640 GiB (2 x 320 GiB SSD)',\n 'ram': '244 GiB'\n }\n },\n 'High-Memory Cluster': {\n 'cr1.8xlarge': {\n 'id': 'cr1.8xlarge',\n 'cores': '16 (2 x Intel Xeon E5-2670, eight-core)',\n 'disk': '240 GiB (2 x 120 GiB SSD)',\n 'ram': '244 GiB'\n },\n },\n 'High Storage': {\n 'hs1.8xlarge': {\n 'id': 'hs1.8xlarge',\n 'cores': '16 (8 cores + 8 hyperthreads)',\n 'disk': '48 TiB (24 x 2 TiB hard disk drives)',\n 'ram': '117 GiB'\n },\n },\n 'General Purpose': {\n 't2.nano': {\n 'id': 't2.nano',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '512 MiB'\n },\n 't2.micro': {\n 'id': 't2.micro',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '1 GiB'\n },\n 't2.small': {\n 'id': 't2.small',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '2 GiB'\n },\n 't2.medium': {\n 'id': 't2.medium',\n 'cores': '2',\n 'disk': 'EBS',\n 'ram': '4 GiB'\n },\n 't2.large': {\n 'id': 't2.large',\n 'cores': '2',\n 'disk': 'EBS',\n 'ram': '8 GiB'\n },\n 't2.xlarge': {\n 'id': 't2.xlarge',\n 'cores': '4',\n 'disk': 'EBS',\n 'ram': '16 GiB'\n },\n 't2.2xlarge': {\n 'id': 't2.2xlarge',\n 'cores': '8',\n 'disk': 'EBS',\n 'ram': '32 GiB'\n },\n 'm4.large': {\n 'id': 'm4.large',\n 'cores': '2',\n 'disk': 'EBS - 450 Mbps',\n 'ram': '8 GiB'\n },\n 'm4.xlarge': {\n 'id': 'm4.xlarge',\n 'cores': '4',\n 'disk': 'EBS - 750 Mbps',\n 'ram': '16 GiB'\n },\n 'm4.2xlarge': {\n 'id': 'm4.2xlarge',\n 'cores': '8',\n 'disk': 'EBS - 1000 Mbps',\n 'ram': '32 GiB'\n },\n 'm4.4xlarge': {\n 'id': 'm4.4xlarge',\n 'cores': '16',\n 'disk': 'EBS - 2000 Mbps',\n 'ram': '64 GiB'\n },\n 'm4.10xlarge': {\n 'id': 'm4.10xlarge',\n 'cores': '40',\n 'disk': 'EBS - 4000 Mbps',\n 'ram': '160 GiB'\n },\n 'm4.16xlarge': {\n 'id': 'm4.16xlarge',\n 'cores': '64',\n 'disk': 'EBS - 10000 Mbps',\n 'ram': '256 GiB'\n },\n 'm3.medium': {\n 'id': 'm3.medium',\n 'cores': '1',\n 'disk': 'SSD (1 x 4)',\n 'ram': '3.75 GiB'\n },\n 'm3.large': {\n 'id': 'm3.large',\n 'cores': '2',\n 'disk': 'SSD (1 x 32)',\n 'ram': '7.5 GiB'\n },\n 'm3.xlarge': {\n 'id': 'm3.xlarge',\n 'cores': '4',\n 'disk': 'SSD (2 x 40)',\n 'ram': '15 GiB'\n },\n 'm3.2xlarge': {\n 'id': 'm3.2xlarge',\n 'cores': '8',\n 'disk': 'SSD (2 x 80)',\n 'ram': '30 GiB'\n },\n }\n }\n return sizes\n\n\ndef avail_images(kwargs=None, call=None):\n '''\n Return a dict of all available VM images on the cloud provider.\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_images function must be called with '\n '-f or --function, or with the --list-images option'\n )\n\n if not isinstance(kwargs, dict):\n kwargs = {}\n\n if 'owner' in kwargs:\n owner = kwargs['owner']\n else:\n provider = get_configured_provider()\n\n owner = config.get_cloud_config_value(\n 'owner', provider, __opts__, default='amazon'\n )\n\n ret = {}\n params = {'Action': 'DescribeImages',\n 'Owner': owner}\n images = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for image in images:\n ret[image['imageId']] = image\n return ret\n\n\ndef script(vm_):\n '''\n Return the script deployment object\n '''\n return salt.utils.cloud.os_script(\n config.get_cloud_config_value('script', vm_, __opts__),\n vm_,\n __opts__,\n salt.utils.cloud.salt_config_to_yaml(\n salt.utils.cloud.minion_config(__opts__, vm_)\n )\n )\n\n\ndef keyname(vm_):\n '''\n Return the keyname\n '''\n return config.get_cloud_config_value(\n 'keyname', vm_, __opts__, search_global=False\n )\n\n\ndef securitygroup(vm_):\n '''\n Return the security group\n '''\n return config.get_cloud_config_value(\n 'securitygroup', vm_, __opts__, search_global=False\n )\n\n\ndef iam_profile(vm_):\n '''\n Return the IAM profile.\n\n The IAM instance profile to associate with the instances.\n This is either the Amazon Resource Name (ARN) of the instance profile\n or the name of the role.\n\n Type: String\n\n Default: None\n\n Required: No\n\n Example: arn:aws:iam::111111111111:instance-profile/s3access\n\n Example: s3access\n\n '''\n return config.get_cloud_config_value(\n 'iam_profile', vm_, __opts__, search_global=False\n )\n\n\ndef ssh_interface(vm_):\n '''\n Return the ssh_interface type to connect to. Either 'public_ips' (default)\n or 'private_ips'.\n '''\n ret = config.get_cloud_config_value(\n 'ssh_interface', vm_, __opts__, default='public_ips',\n search_global=False\n )\n if ret not in ('public_ips', 'private_ips'):\n log.warning(\n 'Invalid ssh_interface: %s. '\n 'Allowed options are (\"public_ips\", \"private_ips\"). '\n 'Defaulting to \"public_ips\".', ret\n )\n ret = 'public_ips'\n return ret\n\n\ndef get_ssh_gateway_config(vm_):\n '''\n Return the ssh_gateway configuration.\n '''\n ssh_gateway = config.get_cloud_config_value(\n 'ssh_gateway', vm_, __opts__, default=None,\n search_global=False\n )\n\n # Check to see if a SSH Gateway will be used.\n if not isinstance(ssh_gateway, six.string_types):\n return None\n\n # Create dictionary of configuration items\n\n # ssh_gateway\n ssh_gateway_config = {'ssh_gateway': ssh_gateway}\n\n # ssh_gateway_port\n ssh_gateway_config['ssh_gateway_port'] = config.get_cloud_config_value(\n 'ssh_gateway_port', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_username\n ssh_gateway_config['ssh_gateway_user'] = config.get_cloud_config_value(\n 'ssh_gateway_username', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_private_key\n ssh_gateway_config['ssh_gateway_key'] = config.get_cloud_config_value(\n 'ssh_gateway_private_key', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_password\n ssh_gateway_config['ssh_gateway_password'] = config.get_cloud_config_value(\n 'ssh_gateway_password', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_command\n ssh_gateway_config['ssh_gateway_command'] = config.get_cloud_config_value(\n 'ssh_gateway_command', vm_, __opts__, default=None,\n search_global=False\n )\n\n # Check if private key exists\n key_filename = ssh_gateway_config['ssh_gateway_key']\n if key_filename is not None and not os.path.isfile(key_filename):\n raise SaltCloudConfigError(\n 'The defined ssh_gateway_private_key \\'{0}\\' does not exist'\n .format(key_filename)\n )\n elif (\n key_filename is None and\n not ssh_gateway_config['ssh_gateway_password']\n ):\n raise SaltCloudConfigError(\n 'No authentication method. Please define: '\n ' ssh_gateway_password or ssh_gateway_private_key'\n )\n\n return ssh_gateway_config\n\n\ndef get_location(vm_=None):\n '''\n Return the EC2 region to use, in this order:\n - CLI parameter\n - VM parameter\n - Cloud profile setting\n '''\n return __opts__.get(\n 'location',\n config.get_cloud_config_value(\n 'location',\n vm_ or get_configured_provider(),\n __opts__,\n default=DEFAULT_LOCATION,\n search_global=False\n )\n )\n\n\ndef avail_locations(call=None):\n '''\n List all available locations\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_locations function must be called with '\n '-f or --function, or with the --list-locations option'\n )\n\n ret = {}\n\n params = {'Action': 'DescribeRegions'}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for region in result:\n ret[region['regionName']] = {\n 'name': region['regionName'],\n 'endpoint': region['regionEndpoint'],\n }\n\n return ret\n\n\ndef get_availability_zone(vm_):\n '''\n Return the availability zone to use\n '''\n avz = config.get_cloud_config_value(\n 'availability_zone', vm_, __opts__, search_global=False\n )\n\n if avz is None:\n return None\n\n zones = _list_availability_zones(vm_)\n\n # Validate user-specified AZ\n if avz not in zones:\n raise SaltCloudException(\n 'The specified availability zone isn\\'t valid in this region: '\n '{0}\\n'.format(\n avz\n )\n )\n\n # check specified AZ is available\n elif zones[avz] != 'available':\n raise SaltCloudException(\n 'The specified availability zone isn\\'t currently available: '\n '{0}\\n'.format(\n avz\n )\n )\n\n return avz\n\n\ndef get_tenancy(vm_):\n '''\n Returns the Tenancy to use.\n\n Can be \"dedicated\" or \"default\". Cannot be present for spot instances.\n '''\n return config.get_cloud_config_value(\n 'tenancy', vm_, __opts__, search_global=False\n )\n\n\ndef get_imageid(vm_):\n '''\n Returns the ImageId to use\n '''\n image = config.get_cloud_config_value(\n 'image', vm_, __opts__, search_global=False\n )\n if image.startswith('ami-'):\n return image\n # a poor man's cache\n if not hasattr(get_imageid, 'images'):\n get_imageid.images = {}\n elif image in get_imageid.images:\n return get_imageid.images[image]\n params = {'Action': 'DescribeImages',\n 'Filter.0.Name': 'name',\n 'Filter.0.Value.0': image}\n # Query AWS, sort by 'creationDate' and get the last imageId\n _t = lambda x: datetime.datetime.strptime(x['creationDate'], '%Y-%m-%dT%H:%M:%S.%fZ')\n image_id = sorted(aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'),\n lambda i, j: salt.utils.compat.cmp(_t(i), _t(j))\n )[-1]['imageId']\n get_imageid.images[image] = image_id\n return image_id\n\n\ndef _get_subnetname_id(subnetname):\n '''\n Returns the SubnetId of a SubnetName to use\n '''\n params = {'Action': 'DescribeSubnets'}\n for subnet in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n tags = subnet.get('tagSet', {}).get('item', {})\n if not isinstance(tags, list):\n tags = [tags]\n for tag in tags:\n if tag['key'] == 'Name' and tag['value'] == subnetname:\n log.debug(\n 'AWS Subnet ID of %s is %s',\n subnetname, subnet['subnetId']\n )\n return subnet['subnetId']\n return None\n\n\ndef get_subnetid(vm_):\n '''\n Returns the SubnetId to use\n '''\n subnetid = config.get_cloud_config_value(\n 'subnetid', vm_, __opts__, search_global=False\n )\n if subnetid:\n return subnetid\n\n subnetname = config.get_cloud_config_value(\n 'subnetname', vm_, __opts__, search_global=False\n )\n if subnetname:\n return _get_subnetname_id(subnetname)\n return None\n\n\ndef _get_securitygroupname_id(securitygroupname_list):\n '''\n Returns the SecurityGroupId of a SecurityGroupName to use\n '''\n securitygroupid_set = set()\n if not isinstance(securitygroupname_list, list):\n securitygroupname_list = [securitygroupname_list]\n params = {'Action': 'DescribeSecurityGroups'}\n for sg in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n if sg['groupName'] in securitygroupname_list:\n log.debug(\n 'AWS SecurityGroup ID of %s is %s',\n sg['groupName'], sg['groupId']\n )\n securitygroupid_set.add(sg['groupId'])\n return list(securitygroupid_set)\n\n\ndef securitygroupid(vm_):\n '''\n Returns the SecurityGroupId\n '''\n securitygroupid_set = set()\n securitygroupid_list = config.get_cloud_config_value(\n 'securitygroupid',\n vm_,\n __opts__,\n search_global=False\n )\n # If the list is None, then the set will remain empty\n # If the list is already a set then calling 'set' on it is a no-op\n # If the list is a string, then calling 'set' generates a one-element set\n # If the list is anything else, stacktrace\n if securitygroupid_list:\n securitygroupid_set = securitygroupid_set.union(set(securitygroupid_list))\n\n securitygroupname_list = config.get_cloud_config_value(\n 'securitygroupname', vm_, __opts__, search_global=False\n )\n if securitygroupname_list:\n if not isinstance(securitygroupname_list, list):\n securitygroupname_list = [securitygroupname_list]\n params = {'Action': 'DescribeSecurityGroups'}\n for sg in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n if sg['groupName'] in securitygroupname_list:\n log.debug(\n 'AWS SecurityGroup ID of %s is %s',\n sg['groupName'], sg['groupId']\n )\n securitygroupid_set.add(sg['groupId'])\n return list(securitygroupid_set)\n\n\ndef get_placementgroup(vm_):\n '''\n Returns the PlacementGroup to use\n '''\n return config.get_cloud_config_value(\n 'placementgroup', vm_, __opts__, search_global=False\n )\n\n\ndef get_spot_config(vm_):\n '''\n Returns the spot instance configuration for the provided vm\n '''\n return config.get_cloud_config_value(\n 'spot_config', vm_, __opts__, search_global=False\n )\n\n\ndef get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_comps[0]\n return provider\n\n\ndef _list_availability_zones(vm_=None):\n '''\n List all availability zones in the current region\n '''\n ret = {}\n\n params = {'Action': 'DescribeAvailabilityZones',\n 'Filter.0.Name': 'region-name',\n 'Filter.0.Value.0': get_location(vm_)}\n result = aws.query(params,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for zone in result:\n ret[zone['zoneName']] = zone['zoneState']\n\n return ret\n\n\ndef block_device_mappings(vm_):\n '''\n Return the block device mapping:\n\n .. code-block:: python\n\n [{'DeviceName': '/dev/sdb', 'VirtualName': 'ephemeral0'},\n {'DeviceName': '/dev/sdc', 'VirtualName': 'ephemeral1'}]\n '''\n return config.get_cloud_config_value(\n 'block_device_mappings', vm_, __opts__, search_global=True\n )\n\n\ndef _request_eip(interface, vm_):\n '''\n Request and return Elastic IP\n '''\n params = {'Action': 'AllocateAddress'}\n params['Domain'] = interface.setdefault('domain', 'vpc')\n eips = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n for eip in eips:\n if 'allocationId' in eip:\n return eip['allocationId']\n return None\n\n\ndef _create_eni_if_necessary(interface, vm_):\n '''\n Create an Elastic Interface if necessary and return a Network Interface Specification\n '''\n if 'NetworkInterfaceId' in interface and interface['NetworkInterfaceId'] is not None:\n return {'DeviceIndex': interface['DeviceIndex'],\n 'NetworkInterfaceId': interface['NetworkInterfaceId']}\n\n params = {'Action': 'DescribeSubnets'}\n subnet_query = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if 'SecurityGroupId' not in interface and 'securitygroupname' in interface:\n interface['SecurityGroupId'] = _get_securitygroupname_id(interface['securitygroupname'])\n if 'SubnetId' not in interface and 'subnetname' in interface:\n interface['SubnetId'] = _get_subnetname_id(interface['subnetname'])\n\n subnet_id = _get_subnet_id_for_interface(subnet_query, interface)\n if not subnet_id:\n raise SaltCloudConfigError(\n 'No such subnet <{0}>'.format(interface.get('SubnetId'))\n )\n params = {'SubnetId': subnet_id}\n\n for k in 'Description', 'PrivateIpAddress', 'SecondaryPrivateIpAddressCount':\n if k in interface:\n params[k] = interface[k]\n\n for k in 'PrivateIpAddresses', 'SecurityGroupId':\n if k in interface:\n params.update(_param_from_config(k, interface[k]))\n\n if 'AssociatePublicIpAddress' in interface:\n # Associating a public address in a VPC only works when the interface is not\n # created beforehand, but as a part of the machine creation request.\n for k in ('DeviceIndex', 'AssociatePublicIpAddress', 'NetworkInterfaceId'):\n if k in interface:\n params[k] = interface[k]\n params['DeleteOnTermination'] = interface.get('delete_interface_on_terminate', True)\n return params\n\n params['Action'] = 'CreateNetworkInterface'\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n eni_desc = result[1]\n if not eni_desc or not eni_desc.get('networkInterfaceId'):\n raise SaltCloudException('Failed to create interface: {0}'.format(result))\n\n eni_id = eni_desc.get('networkInterfaceId')\n log.debug(\n 'Created network interface %s inst %s',\n eni_id, interface['DeviceIndex']\n )\n\n associate_public_ip = interface.get('AssociatePublicIpAddress', False)\n if isinstance(associate_public_ip, six.string_types):\n # Assume id of EIP as value\n _associate_eip_with_interface(eni_id, associate_public_ip, vm_=vm_)\n\n if interface.get('associate_eip'):\n _associate_eip_with_interface(eni_id, interface.get('associate_eip'), vm_=vm_)\n elif interface.get('allocate_new_eip'):\n _new_eip = _request_eip(interface, vm_)\n _associate_eip_with_interface(eni_id, _new_eip, vm_=vm_)\n elif interface.get('allocate_new_eips'):\n addr_list = _list_interface_private_addrs(eni_desc)\n eip_list = []\n for idx, addr in enumerate(addr_list):\n eip_list.append(_request_eip(interface, vm_))\n for idx, addr in enumerate(addr_list):\n _associate_eip_with_interface(eni_id, eip_list[idx], addr, vm_=vm_)\n\n if 'Name' in interface:\n tag_params = {'Action': 'CreateTags',\n 'ResourceId.0': eni_id,\n 'Tag.0.Key': 'Name',\n 'Tag.0.Value': interface['Name']}\n tag_response = aws.query(tag_params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in tag_response:\n log.error('Failed to set name of interface {0}')\n\n return {'DeviceIndex': interface['DeviceIndex'],\n 'NetworkInterfaceId': eni_id}\n\n\ndef _get_subnet_id_for_interface(subnet_query, interface):\n for subnet_query_result in subnet_query:\n if 'item' in subnet_query_result:\n if isinstance(subnet_query_result['item'], dict):\n subnet_id = _get_subnet_from_subnet_query(subnet_query_result['item'],\n interface)\n if subnet_id is not None:\n return subnet_id\n\n else:\n for subnet in subnet_query_result['item']:\n subnet_id = _get_subnet_from_subnet_query(subnet, interface)\n if subnet_id is not None:\n return subnet_id\n\n\ndef _get_subnet_from_subnet_query(subnet_query, interface):\n if 'subnetId' in subnet_query:\n if interface.get('SubnetId'):\n if subnet_query['subnetId'] == interface['SubnetId']:\n return subnet_query['subnetId']\n else:\n return subnet_query['subnetId']\n\n\ndef _list_interface_private_addrs(eni_desc):\n '''\n Returns a list of all of the private IP addresses attached to a\n network interface. The 'primary' address will be listed first.\n '''\n primary = eni_desc.get('privateIpAddress')\n if not primary:\n return None\n\n addresses = [primary]\n\n lst = eni_desc.get('privateIpAddressesSet', {}).get('item', [])\n if not isinstance(lst, list):\n return addresses\n\n for entry in lst:\n if entry.get('primary') == 'true':\n continue\n if entry.get('privateIpAddress'):\n addresses.append(entry.get('privateIpAddress'))\n\n return addresses\n\n\ndef _modify_eni_properties(eni_id, properties=None, vm_=None):\n '''\n Change properties of the interface\n with id eni_id to the values in properties dict\n '''\n if not isinstance(properties, dict):\n raise SaltCloudException(\n 'ENI properties must be a dictionary'\n )\n\n params = {'Action': 'ModifyNetworkInterfaceAttribute',\n 'NetworkInterfaceId': eni_id}\n for k, v in six.iteritems(properties):\n params[k] = v\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if isinstance(result, dict) and result.get('error'):\n raise SaltCloudException(\n 'Could not change interface <{0}> attributes <\\'{1}\\'>'.format(\n eni_id, properties\n )\n )\n else:\n return result\n\n\ndef _associate_eip_with_interface(eni_id, eip_id, private_ip=None, vm_=None):\n '''\n Accept the id of a network interface, and the id of an elastic ip\n address, and associate the two of them, such that traffic sent to the\n elastic ip address will be forwarded (NATted) to this network interface.\n\n Optionally specify the private (10.x.x.x) IP address that traffic should\n be NATted to - useful if you have multiple IP addresses assigned to an\n interface.\n '''\n params = {'Action': 'AssociateAddress',\n 'NetworkInterfaceId': eni_id,\n 'AllocationId': eip_id}\n\n if private_ip:\n params['PrivateIpAddress'] = private_ip\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if not result[2].get('associationId'):\n raise SaltCloudException(\n 'Could not associate elastic ip address '\n '<{0}> with network interface <{1}>'.format(\n eip_id, eni_id\n )\n )\n\n log.debug(\n 'Associated ElasticIP address %s with interface %s',\n eip_id, eni_id\n )\n\n return result[2].get('associationId')\n\n\ndef _update_enis(interfaces, instance, vm_=None):\n config_enis = {}\n instance_enis = []\n for interface in interfaces:\n if 'DeviceIndex' in interface:\n if interface['DeviceIndex'] in config_enis:\n log.error(\n 'Duplicate DeviceIndex in profile. Cannot update ENIs.'\n )\n return None\n config_enis[six.text_type(interface['DeviceIndex'])] = interface\n query_enis = instance[0]['instancesSet']['item']['networkInterfaceSet']['item']\n if isinstance(query_enis, list):\n for query_eni in query_enis:\n instance_enis.append((query_eni['networkInterfaceId'], query_eni['attachment']))\n else:\n instance_enis.append((query_enis['networkInterfaceId'], query_enis['attachment']))\n\n for eni_id, eni_data in instance_enis:\n delete_on_terminate = True\n if 'DeleteOnTermination' in config_enis[eni_data['deviceIndex']]:\n delete_on_terminate = config_enis[eni_data['deviceIndex']]['DeleteOnTermination']\n elif 'delete_interface_on_terminate' in config_enis[eni_data['deviceIndex']]:\n delete_on_terminate = config_enis[eni_data['deviceIndex']]['delete_interface_on_terminate']\n\n params_attachment = {'Attachment.AttachmentId': eni_data['attachmentId'],\n 'Attachment.DeleteOnTermination': delete_on_terminate}\n set_eni_attachment_attributes = _modify_eni_properties(eni_id, params_attachment, vm_=vm_)\n\n if 'SourceDestCheck' in config_enis[eni_data['deviceIndex']]:\n params_sourcedest = {'SourceDestCheck.Value': config_enis[eni_data['deviceIndex']]['SourceDestCheck']}\n set_eni_sourcedest_property = _modify_eni_properties(eni_id, params_sourcedest, vm_=vm_)\n\n return None\n\n\ndef _param_from_config(key, data):\n '''\n Return EC2 API parameters based on the given config data.\n\n Examples:\n 1. List of dictionaries\n >>> data = [\n ... {'DeviceIndex': 0, 'SubnetId': 'subid0',\n ... 'AssociatePublicIpAddress': True},\n ... {'DeviceIndex': 1,\n ... 'SubnetId': 'subid1',\n ... 'PrivateIpAddress': '192.168.1.128'}\n ... ]\n >>> _param_from_config('NetworkInterface', data)\n ... {'NetworkInterface.0.SubnetId': 'subid0',\n ... 'NetworkInterface.0.DeviceIndex': 0,\n ... 'NetworkInterface.1.SubnetId': 'subid1',\n ... 'NetworkInterface.1.PrivateIpAddress': '192.168.1.128',\n ... 'NetworkInterface.0.AssociatePublicIpAddress': 'true',\n ... 'NetworkInterface.1.DeviceIndex': 1}\n\n 2. List of nested dictionaries\n >>> data = [\n ... {'DeviceName': '/dev/sdf',\n ... 'Ebs': {\n ... 'SnapshotId': 'dummy0',\n ... 'VolumeSize': 200,\n ... 'VolumeType': 'standard'}},\n ... {'DeviceName': '/dev/sdg',\n ... 'Ebs': {\n ... 'SnapshotId': 'dummy1',\n ... 'VolumeSize': 100,\n ... 'VolumeType': 'standard'}}\n ... ]\n >>> _param_from_config('BlockDeviceMapping', data)\n ... {'BlockDeviceMapping.0.Ebs.VolumeType': 'standard',\n ... 'BlockDeviceMapping.1.Ebs.SnapshotId': 'dummy1',\n ... 'BlockDeviceMapping.0.Ebs.VolumeSize': 200,\n ... 'BlockDeviceMapping.0.Ebs.SnapshotId': 'dummy0',\n ... 'BlockDeviceMapping.1.Ebs.VolumeType': 'standard',\n ... 'BlockDeviceMapping.1.DeviceName': '/dev/sdg',\n ... 'BlockDeviceMapping.1.Ebs.VolumeSize': 100,\n ... 'BlockDeviceMapping.0.DeviceName': '/dev/sdf'}\n\n 3. Dictionary of dictionaries\n >>> data = { 'Arn': 'dummyarn', 'Name': 'Tester' }\n >>> _param_from_config('IamInstanceProfile', data)\n {'IamInstanceProfile.Arn': 'dummyarn', 'IamInstanceProfile.Name': 'Tester'}\n\n '''\n\n param = {}\n\n if isinstance(data, dict):\n for k, v in six.iteritems(data):\n param.update(_param_from_config('{0}.{1}'.format(key, k), v))\n\n elif isinstance(data, list) or isinstance(data, tuple):\n for idx, conf_item in enumerate(data):\n prefix = '{0}.{1}'.format(key, idx)\n param.update(_param_from_config(prefix, conf_item))\n\n else:\n if isinstance(data, bool):\n # convert boolean True/False to 'true'/'false'\n param.update({key: six.text_type(data).lower()})\n else:\n param.update({key: data})\n\n return param\n\n\ndef request_instance(vm_=None, call=None):\n '''\n Put together all of the information necessary to request an instance on EC2,\n and then fire off the request the instance.\n\n Returns data about the instance\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The request_instance action must be called with -a or --action.'\n )\n\n location = vm_.get('location', get_location(vm_))\n\n # do we launch a regular vm or a spot instance?\n # see http://goo.gl/hYZ13f for more information on EC2 API\n spot_config = get_spot_config(vm_)\n if spot_config is not None:\n if 'spot_price' not in spot_config:\n raise SaltCloudSystemExit(\n 'Spot instance config for {0} requires a spot_price '\n 'attribute.'.format(vm_['name'])\n )\n\n params = {'Action': 'RequestSpotInstances',\n 'InstanceCount': '1',\n 'Type': spot_config['type']\n if 'type' in spot_config else 'one-time',\n 'SpotPrice': spot_config['spot_price']}\n\n # All of the necessary launch parameters for a VM when using\n # spot instances are the same except for the prefix below\n # being tacked on.\n spot_prefix = 'LaunchSpecification.'\n\n # regular EC2 instance\n else:\n # WARNING! EXPERIMENTAL!\n # This allows more than one instance to be spun up in a single call.\n # The first instance will be called by the name provided, but all other\n # instances will be nameless (or more specifically, they will use the\n # InstanceId as the name). This interface is expected to change, so\n # use at your own risk.\n min_instance = config.get_cloud_config_value(\n 'min_instance', vm_, __opts__, search_global=False, default=1\n )\n max_instance = config.get_cloud_config_value(\n 'max_instance', vm_, __opts__, search_global=False, default=1\n )\n params = {'Action': 'RunInstances',\n 'MinCount': min_instance,\n 'MaxCount': max_instance}\n\n # Normal instances should have no prefix.\n spot_prefix = ''\n\n image_id = get_imageid(vm_)\n params[spot_prefix + 'ImageId'] = image_id\n\n userdata = None\n userdata_file = config.get_cloud_config_value(\n 'userdata_file', vm_, __opts__, search_global=False, default=None\n )\n if userdata_file is None:\n userdata = config.get_cloud_config_value(\n 'userdata', vm_, __opts__, search_global=False, default=None\n )\n else:\n log.trace('userdata_file: %s', userdata_file)\n if os.path.exists(userdata_file):\n with salt.utils.files.fopen(userdata_file, 'r') as fh_:\n userdata = salt.utils.stringutils.to_unicode(fh_.read())\n\n userdata = salt.utils.cloud.userdata_template(__opts__, vm_, userdata)\n\n if userdata is not None:\n try:\n params[spot_prefix + 'UserData'] = base64.b64encode(\n salt.utils.stringutils.to_bytes(userdata)\n )\n except Exception as exc:\n log.exception('Failed to encode userdata: %s', exc)\n\n vm_size = config.get_cloud_config_value(\n 'size', vm_, __opts__, search_global=False\n )\n params[spot_prefix + 'InstanceType'] = vm_size\n\n ex_keyname = keyname(vm_)\n if ex_keyname:\n params[spot_prefix + 'KeyName'] = ex_keyname\n\n ex_securitygroup = securitygroup(vm_)\n if ex_securitygroup:\n if not isinstance(ex_securitygroup, list):\n params[spot_prefix + 'SecurityGroup.1'] = ex_securitygroup\n else:\n for counter, sg_ in enumerate(ex_securitygroup):\n params[spot_prefix + 'SecurityGroup.{0}'.format(counter)] = sg_\n\n ex_iam_profile = iam_profile(vm_)\n if ex_iam_profile:\n try:\n if ex_iam_profile.startswith('arn:aws:iam:'):\n params[\n spot_prefix + 'IamInstanceProfile.Arn'\n ] = ex_iam_profile\n else:\n params[\n spot_prefix + 'IamInstanceProfile.Name'\n ] = ex_iam_profile\n except AttributeError:\n raise SaltCloudConfigError(\n '\\'iam_profile\\' should be a string value.'\n )\n\n az_ = get_availability_zone(vm_)\n if az_ is not None:\n params[spot_prefix + 'Placement.AvailabilityZone'] = az_\n\n tenancy_ = get_tenancy(vm_)\n if tenancy_ is not None:\n if spot_config is not None:\n raise SaltCloudConfigError(\n 'Spot instance config for {0} does not support '\n 'specifying tenancy.'.format(vm_['name'])\n )\n params['Placement.Tenancy'] = tenancy_\n\n subnetid_ = get_subnetid(vm_)\n if subnetid_ is not None:\n params[spot_prefix + 'SubnetId'] = subnetid_\n\n ex_securitygroupid = securitygroupid(vm_)\n if ex_securitygroupid:\n if not isinstance(ex_securitygroupid, list):\n params[spot_prefix + 'SecurityGroupId.1'] = ex_securitygroupid\n else:\n for counter, sg_ in enumerate(ex_securitygroupid):\n params[\n spot_prefix + 'SecurityGroupId.{0}'.format(counter)\n ] = sg_\n\n placementgroup_ = get_placementgroup(vm_)\n if placementgroup_ is not None:\n params[spot_prefix + 'Placement.GroupName'] = placementgroup_\n\n blockdevicemappings_holder = block_device_mappings(vm_)\n if blockdevicemappings_holder:\n for _bd in blockdevicemappings_holder:\n if 'tag' in _bd:\n _bd.pop('tag')\n\n ex_blockdevicemappings = blockdevicemappings_holder\n if ex_blockdevicemappings:\n params.update(_param_from_config(spot_prefix + 'BlockDeviceMapping',\n ex_blockdevicemappings))\n\n network_interfaces = config.get_cloud_config_value(\n 'network_interfaces',\n vm_,\n __opts__,\n search_global=False\n )\n\n if network_interfaces:\n eni_devices = []\n for interface in network_interfaces:\n log.debug('Create network interface: %s', interface)\n _new_eni = _create_eni_if_necessary(interface, vm_)\n eni_devices.append(_new_eni)\n params.update(_param_from_config(spot_prefix + 'NetworkInterface',\n eni_devices))\n\n set_ebs_optimized = config.get_cloud_config_value(\n 'ebs_optimized', vm_, __opts__, search_global=False\n )\n\n if set_ebs_optimized is not None:\n if not isinstance(set_ebs_optimized, bool):\n raise SaltCloudConfigError(\n '\\'ebs_optimized\\' should be a boolean value.'\n )\n params[spot_prefix + 'EbsOptimized'] = set_ebs_optimized\n\n set_del_root_vol_on_destroy = config.get_cloud_config_value(\n 'del_root_vol_on_destroy', vm_, __opts__, search_global=False\n )\n\n set_termination_protection = config.get_cloud_config_value(\n 'termination_protection', vm_, __opts__, search_global=False\n )\n\n if set_termination_protection is not None:\n if not isinstance(set_termination_protection, bool):\n raise SaltCloudConfigError(\n '\\'termination_protection\\' should be a boolean value.'\n )\n params.update(_param_from_config(spot_prefix + 'DisableApiTermination',\n set_termination_protection))\n\n if set_del_root_vol_on_destroy and not isinstance(set_del_root_vol_on_destroy, bool):\n raise SaltCloudConfigError(\n '\\'del_root_vol_on_destroy\\' should be a boolean value.'\n )\n\n vm_['set_del_root_vol_on_destroy'] = set_del_root_vol_on_destroy\n\n if set_del_root_vol_on_destroy:\n # first make sure to look up the root device name\n # as Ubuntu and CentOS (and most likely other OSs)\n # use different device identifiers\n\n log.info('Attempting to look up root device name for image id %s on '\n 'VM %s', image_id, vm_['name'])\n\n rd_params = {\n 'Action': 'DescribeImages',\n 'ImageId.1': image_id\n }\n try:\n rd_data = aws.query(rd_params,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in rd_data:\n return rd_data['error']\n log.debug('EC2 Response: \\'%s\\'', rd_data)\n except Exception as exc:\n log.error(\n 'Error getting root device name for image id %s for '\n 'VM %s: \\n%s', image_id, vm_['name'], exc,\n # Show the traceback if the debug logging level is enabled\n exc_info_on_loglevel=logging.DEBUG\n )\n raise\n\n # make sure we have a response\n if not rd_data:\n err_msg = 'There was an error querying EC2 for the root device ' \\\n 'of image id {0}. Empty response.'.format(image_id)\n raise SaltCloudSystemExit(err_msg)\n\n # pull the root device name from the result and use it when\n # launching the new VM\n rd_name = None\n rd_type = None\n if 'blockDeviceMapping' in rd_data[0]:\n # Some ami instances do not have a root volume. Ignore such cases\n if rd_data[0]['blockDeviceMapping'] is not None:\n item = rd_data[0]['blockDeviceMapping']['item']\n if isinstance(item, list):\n item = item[0]\n rd_name = item['deviceName']\n # Grab the volume type\n rd_type = item['ebs'].get('volumeType', None)\n\n log.info('Found root device name: %s', rd_name)\n\n if rd_name is not None:\n if ex_blockdevicemappings:\n dev_list = [\n dev['DeviceName'] for dev in ex_blockdevicemappings\n ]\n else:\n dev_list = []\n\n if rd_name in dev_list:\n # Device already listed, just grab the index\n dev_index = dev_list.index(rd_name)\n else:\n dev_index = len(dev_list)\n # Add the device name in since it wasn't already there\n params[\n '{0}BlockDeviceMapping.{1}.DeviceName'.format(\n spot_prefix, dev_index\n )\n ] = rd_name\n\n # Set the termination value\n termination_key = '{0}BlockDeviceMapping.{1}.Ebs.DeleteOnTermination'.format(spot_prefix, dev_index)\n params[termination_key] = six.text_type(set_del_root_vol_on_destroy).lower()\n\n # Use default volume type if not specified\n if ex_blockdevicemappings and dev_index < len(ex_blockdevicemappings) and \\\n 'Ebs.VolumeType' not in ex_blockdevicemappings[dev_index]:\n type_key = '{0}BlockDeviceMapping.{1}.Ebs.VolumeType'.format(spot_prefix, dev_index)\n params[type_key] = rd_type\n\n set_del_all_vols_on_destroy = config.get_cloud_config_value(\n 'del_all_vols_on_destroy', vm_, __opts__, search_global=False, default=False\n )\n\n if set_del_all_vols_on_destroy and not isinstance(set_del_all_vols_on_destroy, bool):\n raise SaltCloudConfigError(\n '\\'del_all_vols_on_destroy\\' should be a boolean value.'\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'requesting instance',\n 'salt/cloud/{0}/requesting'.format(vm_['name']),\n args={\n 'kwargs': __utils__['cloud.filter_event'](\n 'requesting', params, list(params)\n ),\n 'location': location,\n },\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n provider = get_provider(vm_)\n\n try:\n data = aws.query(params,\n 'instancesSet',\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if 'error' in data:\n return data['error']\n except Exception as exc:\n log.error(\n 'Error creating %s on EC2 when trying to run the initial '\n 'deployment: \\n%s', vm_['name'], exc,\n # Show the traceback if the debug logging level is enabled\n exc_info_on_loglevel=logging.DEBUG\n )\n raise\n\n # if we're using spot instances, we need to wait for the spot request\n # to become active before we continue\n if spot_config:\n sir_id = data[0]['spotInstanceRequestId']\n\n vm_['spotRequestId'] = sir_id\n\n def __query_spot_instance_request(sir_id, location):\n params = {'Action': 'DescribeSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if not data:\n log.error(\n 'There was an error while querying EC2. Empty response'\n )\n # Trigger a failure in the wait for spot instance method\n return False\n\n if isinstance(data, dict) and 'error' in data:\n log.warning('There was an error in the query. %s', data['error'])\n # Trigger a failure in the wait for spot instance method\n return False\n\n log.debug('Returned query data: %s', data)\n\n state = data[0].get('state')\n\n if state == 'active':\n return data\n\n if state == 'open':\n # Still waiting for an active state\n log.info('Spot instance status: %s', data[0]['status']['message'])\n return None\n\n if state in ['cancelled', 'failed', 'closed']:\n # Request will never be active, fail\n log.error('Spot instance request resulted in state \\'{0}\\'. '\n 'Nothing else we can do here.')\n return False\n\n __utils__['cloud.fire_event'](\n 'event',\n 'waiting for spot instance',\n 'salt/cloud/{0}/waiting_for_spot'.format(vm_['name']),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n try:\n data = _wait_for_spot_instance(\n __query_spot_instance_request,\n update_args=(sir_id, location),\n timeout=config.get_cloud_config_value(\n 'wait_for_spot_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_spot_interval', vm_, __opts__, default=30),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_spot_interval_multiplier',\n vm_,\n __opts__,\n default=1),\n max_failures=config.get_cloud_config_value(\n 'wait_for_spot_max_failures',\n vm_,\n __opts__,\n default=10),\n )\n log.debug('wait_for_spot_instance data %s', data)\n\n except (SaltCloudExecutionTimeout, SaltCloudExecutionFailure) as exc:\n try:\n # Cancel the existing spot instance request\n params = {'Action': 'CancelSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n\n log.debug('Canceled spot instance request %s. Data '\n 'returned: %s', sir_id, data)\n\n except SaltCloudSystemExit:\n pass\n finally:\n raise SaltCloudSystemExit(six.text_type(exc))\n\n return data, vm_\n\n\ndef query_instance(vm_=None, call=None):\n '''\n Query an instance upon creation from the EC2 API\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The query_instance action must be called with -a or --action.'\n )\n\n instance_id = vm_['instance_id']\n location = vm_.get('location', get_location(vm_))\n __utils__['cloud.fire_event'](\n 'event',\n 'querying instance',\n 'salt/cloud/{0}/querying'.format(vm_['name']),\n args={'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n log.debug('The new VM instance_id is %s', instance_id)\n\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n\n provider = get_provider(vm_)\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n data, requesturl = aws.query(params, # pylint: disable=unbalanced-tuple-unpacking\n location=location,\n provider=provider,\n opts=__opts__,\n return_url=True,\n sigver='4')\n log.debug('The query returned: %s', data)\n\n if isinstance(data, dict) and 'error' in data:\n log.warning(\n 'There was an error in the query. %s attempts '\n 'remaining: %s', attempts, data['error']\n )\n elif isinstance(data, list) and not data:\n log.warning(\n 'Query returned an empty list. %s attempts '\n 'remaining.', attempts\n )\n else:\n break\n\n aws.sleep_exponential_backoff(attempts)\n attempts += 1\n continue\n else:\n raise SaltCloudSystemExit(\n 'An error occurred while creating VM: {0}'.format(data['error'])\n )\n\n def __query_ip_address(params, url): # pylint: disable=W0613\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if not data:\n log.error(\n 'There was an error while querying EC2. Empty response'\n )\n # Trigger a failure in the wait for IP function\n return False\n\n if isinstance(data, dict) and 'error' in data:\n log.warning('There was an error in the query. %s', data['error'])\n # Trigger a failure in the wait for IP function\n return False\n\n log.debug('Returned query data: %s', data)\n\n if ssh_interface(vm_) == 'public_ips':\n if 'ipAddress' in data[0]['instancesSet']['item']:\n return data\n else:\n log.error(\n 'Public IP not detected.'\n )\n\n if ssh_interface(vm_) == 'private_ips':\n if 'privateIpAddress' in data[0]['instancesSet']['item']:\n return data\n else:\n log.error(\n 'Private IP not detected.'\n )\n\n try:\n data = salt.utils.cloud.wait_for_ip(\n __query_ip_address,\n update_args=(params, requesturl),\n timeout=config.get_cloud_config_value(\n 'wait_for_ip_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_ip_interval', vm_, __opts__, default=10),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_ip_interval_multiplier', vm_, __opts__, default=1),\n )\n except (SaltCloudExecutionTimeout, SaltCloudExecutionFailure) as exc:\n try:\n # It might be already up, let's destroy it!\n destroy(vm_['name'])\n except SaltCloudSystemExit:\n pass\n finally:\n raise SaltCloudSystemExit(six.text_type(exc))\n\n if 'reactor' in vm_ and vm_['reactor'] is True:\n __utils__['cloud.fire_event'](\n 'event',\n 'instance queried',\n 'salt/cloud/{0}/query_reactor'.format(vm_['name']),\n args={'data': data},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n return data\n\n\ndef wait_for_instance(\n vm_=None,\n data=None,\n ip_address=None,\n display_ssh_output=True,\n call=None,\n ):\n '''\n Wait for an instance upon creation from the EC2 API, to become available\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The wait_for_instance action must be called with -a or --action.'\n )\n\n if vm_ is None:\n vm_ = {}\n\n if data is None:\n data = {}\n\n ssh_gateway_config = vm_.get(\n 'gateway', get_ssh_gateway_config(vm_)\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'waiting for ssh',\n 'salt/cloud/{0}/waiting_for_ssh'.format(vm_['name']),\n args={'ip_address': ip_address},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n ssh_connect_timeout = config.get_cloud_config_value(\n 'ssh_connect_timeout', vm_, __opts__, 900 # 15 minutes\n )\n ssh_port = config.get_cloud_config_value(\n 'ssh_port', vm_, __opts__, 22\n )\n\n if config.get_cloud_config_value('win_installer', vm_, __opts__):\n username = config.get_cloud_config_value(\n 'win_username', vm_, __opts__, default='Administrator'\n )\n win_passwd = config.get_cloud_config_value(\n 'win_password', vm_, __opts__, default=''\n )\n win_deploy_auth_retries = config.get_cloud_config_value(\n 'win_deploy_auth_retries', vm_, __opts__, default=10\n )\n win_deploy_auth_retry_delay = config.get_cloud_config_value(\n 'win_deploy_auth_retry_delay', vm_, __opts__, default=1\n )\n use_winrm = config.get_cloud_config_value(\n 'use_winrm', vm_, __opts__, default=False\n )\n winrm_verify_ssl = config.get_cloud_config_value(\n 'winrm_verify_ssl', vm_, __opts__, default=True\n )\n\n if win_passwd and win_passwd == 'auto':\n log.debug('Waiting for auto-generated Windows EC2 password')\n while True:\n password_data = get_password_data(\n name=vm_['name'],\n kwargs={\n 'key_file': vm_['private_key'],\n },\n call='action',\n )\n win_passwd = password_data.get('password', None)\n if win_passwd is None:\n log.debug(password_data)\n # This wait is so high, because the password is unlikely to\n # be generated for at least 4 minutes\n time.sleep(60)\n else:\n logging_data = password_data\n\n logging_data['password'] = 'XXX-REDACTED-XXX'\n logging_data['passwordData'] = 'XXX-REDACTED-XXX'\n log.debug(logging_data)\n\n vm_['win_password'] = win_passwd\n break\n\n # SMB used whether psexec or winrm\n if not salt.utils.cloud.wait_for_port(ip_address,\n port=445,\n timeout=ssh_connect_timeout):\n raise SaltCloudSystemExit(\n 'Failed to connect to remote windows host'\n )\n\n # If not using winrm keep same psexec behavior\n if not use_winrm:\n\n log.debug('Trying to authenticate via SMB using psexec')\n\n if not salt.utils.cloud.validate_windows_cred(ip_address,\n username,\n win_passwd,\n retries=win_deploy_auth_retries,\n retry_delay=win_deploy_auth_retry_delay):\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote windows host (smb)'\n )\n\n # If using winrm\n else:\n\n # Default HTTPS port can be changed in cloud configuration\n winrm_port = config.get_cloud_config_value(\n 'winrm_port', vm_, __opts__, default=5986\n )\n\n # Wait for winrm port to be available\n if not salt.utils.cloud.wait_for_port(ip_address,\n port=winrm_port,\n timeout=ssh_connect_timeout):\n raise SaltCloudSystemExit(\n 'Failed to connect to remote windows host (winrm)'\n )\n\n log.debug('Trying to authenticate via Winrm using pywinrm')\n\n if not salt.utils.cloud.wait_for_winrm(ip_address,\n winrm_port,\n username,\n win_passwd,\n timeout=ssh_connect_timeout,\n verify=winrm_verify_ssl):\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote windows host'\n )\n\n elif salt.utils.cloud.wait_for_port(ip_address,\n port=ssh_port,\n timeout=ssh_connect_timeout,\n gateway=ssh_gateway_config\n ):\n # If a known_hosts_file is configured, this instance will not be\n # accessible until it has a host key. Since this is provided on\n # supported instances by cloud-init, and viewable to us only from the\n # console output (which may take several minutes to become available,\n # we have some more waiting to do here.\n known_hosts_file = config.get_cloud_config_value(\n 'known_hosts_file', vm_, __opts__, default=None\n )\n if known_hosts_file:\n console = {}\n while 'output_decoded' not in console:\n console = get_console_output(\n instance_id=vm_['instance_id'],\n call='action',\n location=get_location(vm_)\n )\n pprint.pprint(console)\n time.sleep(5)\n output = salt.utils.stringutils.to_unicode(console['output_decoded'])\n comps = output.split('-----BEGIN SSH HOST KEY KEYS-----')\n if len(comps) < 2:\n # Fail; there are no host keys\n return False\n\n comps = comps[1].split('-----END SSH HOST KEY KEYS-----')\n keys = ''\n for line in comps[0].splitlines():\n if not line:\n continue\n keys += '\\n{0} {1}'.format(ip_address, line)\n\n with salt.utils.files.fopen(known_hosts_file, 'a') as fp_:\n fp_.write(salt.utils.stringutils.to_str(keys))\n fp_.close()\n\n for user in vm_['usernames']:\n if salt.utils.cloud.wait_for_passwd(\n host=ip_address,\n port=ssh_port,\n username=user,\n ssh_timeout=config.get_cloud_config_value(\n 'wait_for_passwd_timeout', vm_, __opts__, default=1 * 60\n ),\n key_filename=vm_['key_filename'],\n display_ssh_output=display_ssh_output,\n gateway=ssh_gateway_config,\n maxtries=config.get_cloud_config_value(\n 'wait_for_passwd_maxtries', vm_, __opts__, default=15\n ),\n known_hosts_file=config.get_cloud_config_value(\n 'known_hosts_file', vm_, __opts__,\n default='/dev/null'\n ),\n ):\n __opts__['ssh_username'] = user\n vm_['ssh_username'] = user\n break\n else:\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote ssh'\n )\n else:\n raise SaltCloudSystemExit(\n 'Failed to connect to remote ssh'\n )\n\n if 'reactor' in vm_ and vm_['reactor'] is True:\n __utils__['cloud.fire_event'](\n 'event',\n 'ssh is available',\n 'salt/cloud/{0}/ssh_ready_reactor'.format(vm_['name']),\n args={'ip_address': ip_address},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n return vm_\n\n\ndef _validate_key_path_and_mode(key_filename):\n if key_filename is None:\n raise SaltCloudSystemExit(\n 'The required \\'private_key\\' configuration setting is missing from the '\n '\\'ec2\\' driver.'\n )\n\n if not os.path.exists(key_filename):\n raise SaltCloudSystemExit(\n 'The EC2 key file \\'{0}\\' does not exist.\\n'.format(\n key_filename\n )\n )\n\n key_mode = stat.S_IMODE(os.stat(key_filename).st_mode)\n if key_mode not in (0o400, 0o600):\n raise SaltCloudSystemExit(\n 'The EC2 key file \\'{0}\\' needs to be set to mode 0400 or 0600.\\n'.format(\n key_filename\n )\n )\n\n return True\n\n\ndef create(vm_=None, call=None):\n '''\n Create a single VM from a data dict\n '''\n if call:\n raise SaltCloudSystemExit(\n 'You cannot create an instance with -a or -f.'\n )\n\n try:\n # Check for required profile parameters before sending any API calls.\n if vm_['profile'] and config.is_profile_configured(__opts__,\n __active_provider_name__ or 'ec2',\n vm_['profile'],\n vm_=vm_) is False:\n return False\n except AttributeError:\n pass\n\n # Check for private_key and keyfile name for bootstrapping new instances\n deploy = config.get_cloud_config_value(\n 'deploy', vm_, __opts__, default=True\n )\n win_password = config.get_cloud_config_value(\n 'win_password', vm_, __opts__, default=''\n )\n key_filename = config.get_cloud_config_value(\n 'private_key', vm_, __opts__, search_global=False, default=None\n )\n if deploy:\n # The private_key and keyname settings are only needed for bootstrapping\n # new instances when deploy is True\n _validate_key_path_and_mode(key_filename)\n\n __utils__['cloud.fire_event'](\n 'event',\n 'starting create',\n 'salt/cloud/{0}/creating'.format(vm_['name']),\n args=__utils__['cloud.filter_event']('creating', vm_, ['name', 'profile', 'provider', 'driver']),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n __utils__['cloud.cachedir_index_add'](\n vm_['name'], vm_['profile'], 'ec2', vm_['driver']\n )\n\n vm_['key_filename'] = key_filename\n # wait_for_instance requires private_key\n vm_['private_key'] = key_filename\n\n # Get SSH Gateway config early to verify the private_key,\n # if used, exists or not. We don't want to deploy an instance\n # and not be able to access it via the gateway.\n vm_['gateway'] = get_ssh_gateway_config(vm_)\n\n location = get_location(vm_)\n vm_['location'] = location\n\n log.info('Creating Cloud VM %s in %s', vm_['name'], location)\n vm_['usernames'] = salt.utils.cloud.ssh_usernames(\n vm_,\n __opts__,\n default_users=(\n 'ec2-user', # Amazon Linux, Fedora, RHEL; FreeBSD\n 'centos', # CentOS AMIs from AWS Marketplace\n 'ubuntu', # Ubuntu\n 'admin', # Debian GNU/Linux\n 'bitnami', # BitNami AMIs\n 'root' # Last resort, default user on RHEL 5, SUSE\n )\n )\n\n if 'instance_id' in vm_:\n # This was probably created via another process, and doesn't have\n # things like salt keys created yet, so let's create them now.\n if 'pub_key' not in vm_ and 'priv_key' not in vm_:\n log.debug('Generating minion keys for \\'%s\\'', vm_['name'])\n vm_['priv_key'], vm_['pub_key'] = salt.utils.cloud.gen_keys(\n salt.config.get_cloud_config_value(\n 'keysize',\n vm_,\n __opts__\n )\n )\n else:\n # Put together all of the information required to request the instance,\n # and then fire off the request for it\n if keyname(vm_) is None:\n raise SaltCloudSystemExit(\n 'The required \\'keyname\\' configuration setting is missing from the '\n '\\'ec2\\' driver.'\n )\n\n data, vm_ = request_instance(vm_, location)\n\n # If data is a str, it's an error\n if isinstance(data, six.string_types):\n log.error('Error requesting instance: %s', data)\n return {}\n\n # Pull the instance ID, valid for both spot and normal instances\n\n # Multiple instances may have been spun up, get all their IDs\n vm_['instance_id_list'] = []\n for instance in data:\n vm_['instance_id_list'].append(instance['instanceId'])\n\n vm_['instance_id'] = vm_['instance_id_list'].pop()\n if vm_['instance_id_list']:\n # Multiple instances were spun up, get one now, and queue the rest\n queue_instances(vm_['instance_id_list'])\n\n # Wait for vital information, such as IP addresses, to be available\n # for the new instance\n data = query_instance(vm_)\n\n # Now that the instance is available, tag it appropriately. Should\n # mitigate race conditions with tags\n tags = config.get_cloud_config_value('tag',\n vm_,\n __opts__,\n {},\n search_global=False)\n if not isinstance(tags, dict):\n raise SaltCloudConfigError(\n '\\'tag\\' should be a dict.'\n )\n\n for value in six.itervalues(tags):\n if not isinstance(value, six.string_types):\n raise SaltCloudConfigError(\n '\\'tag\\' values must be strings. Try quoting the values. '\n 'e.g. \"2013-09-19T20:09:46Z\".'\n )\n\n tags['Name'] = vm_['name']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/{0}/tagging'.format(vm_['name']),\n args={'tags': tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n salt.utils.cloud.wait_for_fun(\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=tags,\n instance_id=vm_['instance_id'],\n call='action',\n location=location\n )\n\n # Once instance tags are set, tag the spot request if configured\n if 'spot_config' in vm_ and 'tag' in vm_['spot_config']:\n\n if not isinstance(vm_['spot_config']['tag'], dict):\n raise SaltCloudConfigError(\n '\\'tag\\' should be a dict.'\n )\n\n for value in six.itervalues(vm_['spot_config']['tag']):\n if not isinstance(value, str):\n raise SaltCloudConfigError(\n '\\'tag\\' values must be strings. Try quoting the values. '\n 'e.g. \"2013-09-19T20:09:46Z\".'\n )\n\n spot_request_tags = {}\n\n if 'spotRequestId' not in vm_:\n raise SaltCloudConfigError('Failed to find spotRequestId')\n\n sir_id = vm_['spotRequestId']\n\n spot_request_tags['Name'] = vm_['name']\n\n for k, v in six.iteritems(vm_['spot_config']['tag']):\n spot_request_tags[k] = v\n\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/spot_request_{0}/tagging'.format(sir_id),\n args={'tags': spot_request_tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n salt.utils.cloud.wait_for_fun(\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=spot_request_tags,\n instance_id=sir_id,\n call='action',\n location=location\n )\n\n network_interfaces = config.get_cloud_config_value(\n 'network_interfaces',\n vm_,\n __opts__,\n search_global=False\n )\n\n if network_interfaces:\n _update_enis(network_interfaces, data, vm_)\n\n # At this point, the node is created and tagged, and now needs to be\n # bootstrapped, once the necessary port is available.\n log.info('Created node %s', vm_['name'])\n\n instance = data[0]['instancesSet']['item']\n\n # Wait for the necessary port to become available to bootstrap\n if ssh_interface(vm_) == 'private_ips':\n ip_address = instance['privateIpAddress']\n log.info('Salt node data. Private_ip: %s', ip_address)\n else:\n ip_address = instance['ipAddress']\n log.info('Salt node data. Public_ip: %s', ip_address)\n vm_['ssh_host'] = ip_address\n\n if salt.utils.cloud.get_salt_interface(vm_, __opts__) == 'private_ips':\n salt_ip_address = instance['privateIpAddress']\n log.info('Salt interface set to: %s', salt_ip_address)\n else:\n salt_ip_address = instance['ipAddress']\n log.debug('Salt interface set to: %s', salt_ip_address)\n vm_['salt_host'] = salt_ip_address\n\n if deploy:\n display_ssh_output = config.get_cloud_config_value(\n 'display_ssh_output', vm_, __opts__, default=True\n )\n\n vm_ = wait_for_instance(\n vm_, data, ip_address, display_ssh_output\n )\n\n # The instance is booted and accessible, let's Salt it!\n ret = instance.copy()\n\n # Get ANY defined volumes settings, merging data, in the following order\n # 1. VM config\n # 2. Profile config\n # 3. Global configuration\n volumes = config.get_cloud_config_value(\n 'volumes', vm_, __opts__, search_global=True\n )\n if volumes:\n __utils__['cloud.fire_event'](\n 'event',\n 'attaching volumes',\n 'salt/cloud/{0}/attaching_volumes'.format(vm_['name']),\n args={'volumes': volumes},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n log.info('Create and attach volumes to node %s', vm_['name'])\n created = create_attach_volumes(\n vm_['name'],\n {\n 'volumes': volumes,\n 'zone': ret['placement']['availabilityZone'],\n 'instance_id': ret['instanceId'],\n 'del_all_vols_on_destroy': vm_.get('del_all_vols_on_destroy', False)\n },\n call='action'\n )\n ret['Attached Volumes'] = created\n\n # Associate instance with a ssm document, if present\n ssm_document = config.get_cloud_config_value(\n 'ssm_document', vm_, __opts__, None, search_global=False\n )\n if ssm_document:\n log.debug('Associating with ssm document: %s', ssm_document)\n assoc = ssm_create_association(\n vm_['name'],\n {'ssm_document': ssm_document},\n instance_id=vm_['instance_id'],\n call='action'\n )\n if isinstance(assoc, dict) and assoc.get('error', None):\n log.error(\n 'Failed to associate instance %s with ssm document %s',\n vm_['instance_id'], ssm_document\n )\n return {}\n\n for key, value in six.iteritems(__utils__['cloud.bootstrap'](vm_, __opts__)):\n ret.setdefault(key, value)\n\n log.info('Created Cloud VM \\'%s\\'', vm_['name'])\n log.debug(\n '\\'%s\\' VM creation details:\\n%s',\n vm_['name'], pprint.pformat(instance)\n )\n\n event_data = {\n 'name': vm_['name'],\n 'profile': vm_['profile'],\n 'provider': vm_['driver'],\n 'instance_id': vm_['instance_id'],\n }\n if volumes:\n event_data['volumes'] = volumes\n if ssm_document:\n event_data['ssm_document'] = ssm_document\n\n __utils__['cloud.fire_event'](\n 'event',\n 'created instance',\n 'salt/cloud/{0}/created'.format(vm_['name']),\n args=__utils__['cloud.filter_event']('created', event_data, list(event_data)),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n # Ensure that the latest node data is returned\n node = _get_node(instance_id=vm_['instance_id'])\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n ret.update(node)\n\n # Add any block device tags specified\n ex_blockdevicetags = {}\n blockdevicemappings_holder = block_device_mappings(vm_)\n if blockdevicemappings_holder:\n for _bd in blockdevicemappings_holder:\n if 'tag' in _bd:\n ex_blockdevicetags[_bd['DeviceName']] = _bd['tag']\n\n block_device_volume_id_map = {}\n\n if ex_blockdevicetags:\n for _device, _map in six.iteritems(ret['blockDeviceMapping']):\n bd_items = []\n if isinstance(_map, dict):\n bd_items.append(_map)\n else:\n for mapitem in _map:\n bd_items.append(mapitem)\n\n for blockitem in bd_items:\n if blockitem['deviceName'] in ex_blockdevicetags and 'Name' not in ex_blockdevicetags[blockitem['deviceName']]:\n ex_blockdevicetags[blockitem['deviceName']]['Name'] = vm_['name']\n if blockitem['deviceName'] in ex_blockdevicetags:\n block_device_volume_id_map[blockitem[ret['rootDeviceType']]['volumeId']] = ex_blockdevicetags[blockitem['deviceName']]\n\n if block_device_volume_id_map:\n\n for volid, tags in six.iteritems(block_device_volume_id_map):\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/block_volume_{0}/tagging'.format(str(volid)),\n args={'tags': tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n __utils__['cloud.wait_for_fun'](\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=tags,\n resource_id=volid,\n call='action',\n location=location\n )\n\n return ret\n\n\ndef queue_instances(instances):\n '''\n Queue a set of instances to be provisioned later. Expects a list.\n\n Currently this only queries node data, and then places it in the cloud\n cache (if configured). If the salt-cloud-reactor is being used, these\n instances will be automatically provisioned using that.\n\n For more information about the salt-cloud-reactor, see:\n\n https://github.com/saltstack-formulas/salt-cloud-reactor\n '''\n for instance_id in instances:\n node = _get_node(instance_id=instance_id)\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n\n\ndef create_attach_volumes(name, kwargs, call=None, wait_to_finish=True):\n '''\n Create and attach volumes to created node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The create_attach_volumes action must be called with '\n '-a or --action.'\n )\n\n if 'instance_id' not in kwargs:\n kwargs['instance_id'] = _get_node(name)['instanceId']\n\n if isinstance(kwargs['volumes'], six.string_types):\n volumes = salt.utils.yaml.safe_load(kwargs['volumes'])\n else:\n volumes = kwargs['volumes']\n\n ret = []\n for volume in volumes:\n created = False\n volume_name = '{0} on {1}'.format(volume['device'], name)\n\n volume_dict = {\n 'volume_name': volume_name,\n 'zone': kwargs['zone']\n }\n if 'volume_id' in volume:\n volume_dict['volume_id'] = volume['volume_id']\n elif 'snapshot' in volume:\n volume_dict['snapshot'] = volume['snapshot']\n elif 'size' in volume:\n volume_dict['size'] = volume['size']\n else:\n raise SaltCloudConfigError(\n 'Cannot create volume. Please define one of \\'volume_id\\', '\n '\\'snapshot\\', or \\'size\\''\n )\n\n if 'tags' in volume:\n volume_dict['tags'] = volume['tags']\n if 'type' in volume:\n volume_dict['type'] = volume['type']\n if 'iops' in volume:\n volume_dict['iops'] = volume['iops']\n if 'encrypted' in volume:\n volume_dict['encrypted'] = volume['encrypted']\n if 'kmskeyid' in volume:\n volume_dict['kmskeyid'] = volume['kmskeyid']\n\n if 'volume_id' not in volume_dict:\n created_volume = create_volume(volume_dict, call='function', wait_to_finish=wait_to_finish)\n created = True\n if 'volumeId' in created_volume:\n volume_dict['volume_id'] = created_volume['volumeId']\n\n attach = attach_volume(\n name,\n {'volume_id': volume_dict['volume_id'],\n 'device': volume['device']},\n instance_id=kwargs['instance_id'],\n call='action'\n )\n\n # Update the delvol parameter for this volume\n delvols_on_destroy = kwargs.get('del_all_vols_on_destroy', None)\n\n if attach and created and delvols_on_destroy is not None:\n _toggle_delvol(instance_id=kwargs['instance_id'],\n device=volume['device'],\n value=delvols_on_destroy)\n\n if attach:\n msg = (\n '{0} attached to {1} (aka {2}) as device {3}'.format(\n volume_dict['volume_id'],\n kwargs['instance_id'],\n name,\n volume['device']\n )\n )\n log.info(msg)\n ret.append(msg)\n return ret\n\n\ndef stop(name, call=None):\n '''\n Stop a node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The stop action must be called with -a or --action.'\n )\n\n log.info('Stopping node %s', name)\n\n instance_id = _get_node(name)['instanceId']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'stopping instance',\n 'salt/cloud/{0}/stopping'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n params = {'Action': 'StopInstances',\n 'InstanceId.1': instance_id}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n return result\n\n\ndef start(name, call=None):\n '''\n Start a node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The start action must be called with -a or --action.'\n )\n\n log.info('Starting node %s', name)\n\n instance_id = _get_node(name)['instanceId']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'starting instance',\n 'salt/cloud/{0}/starting'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n params = {'Action': 'StartInstances',\n 'InstanceId.1': instance_id}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n return result\n\n\ndef set_tags(name=None,\n tags=None,\n call=None,\n location=None,\n instance_id=None,\n resource_id=None,\n kwargs=None): # pylint: disable=W0613\n '''\n Set tags for a resource. Normally a VM name or instance_id is passed in,\n but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a set_tags mymachine tag1=somestuff tag2='Other stuff'\n salt-cloud -a set_tags resource_id=vol-3267ab32 tag=somestuff\n '''\n if kwargs is None:\n kwargs = {}\n\n if location is None:\n location = get_location()\n\n if instance_id is None:\n if 'resource_id' in kwargs:\n resource_id = kwargs['resource_id']\n del kwargs['resource_id']\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n if resource_id is None:\n if instance_id is None:\n instance_id = _get_node(name=name, instance_id=None, location=location)['instanceId']\n else:\n instance_id = resource_id\n\n # This second check is a safety, in case the above still failed to produce\n # a usable ID\n if instance_id is None:\n return {\n 'Error': 'A valid instance_id or resource_id was not specified.'\n }\n\n params = {'Action': 'CreateTags',\n 'ResourceId.1': instance_id}\n\n log.debug('Tags to set for %s: %s', name, tags)\n\n if kwargs and not tags:\n tags = kwargs\n\n for idx, (tag_k, tag_v) in enumerate(six.iteritems(tags)):\n params['Tag.{0}.Key'.format(idx)] = tag_k\n params['Tag.{0}.Value'.format(idx)] = tag_v\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n aws.query(params,\n setname='tagSet',\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n settags = get_tags(\n instance_id=instance_id, call='action', location=location\n )\n\n log.debug('Setting the tags returned: %s', settags)\n\n failed_to_set_tags = False\n for tag in settags:\n if tag['key'] not in tags:\n # We were not setting this tag\n continue\n\n if tag.get('value') is None and tags.get(tag['key']) == '':\n # This is a correctly set tag with no value\n continue\n\n if six.text_type(tags.get(tag['key'])) != six.text_type(tag['value']):\n # Not set to the proper value!?\n log.debug(\n 'Setting the tag %s returned %s instead of %s',\n tag['key'], tags.get(tag['key']), tag['value']\n )\n failed_to_set_tags = True\n break\n\n if failed_to_set_tags:\n log.warning('Failed to set tags. Remaining attempts %s', attempts)\n attempts += 1\n aws.sleep_exponential_backoff(attempts)\n continue\n\n return settags\n\n raise SaltCloudSystemExit(\n 'Failed to set tags on {0}!'.format(name)\n )\n\n\ndef get_tags(name=None,\n instance_id=None,\n call=None,\n location=None,\n kwargs=None,\n resource_id=None): # pylint: disable=W0613\n '''\n Retrieve tags for a resource. Normally a VM name or instance_id is passed\n in, but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a get_tags mymachine\n salt-cloud -a get_tags resource_id=vol-3267ab32\n '''\n if location is None:\n location = get_location()\n\n if instance_id is None:\n if resource_id is None:\n if name:\n instance_id = _get_node(name)['instanceId']\n elif 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n elif 'resource_id' in kwargs:\n instance_id = kwargs['resource_id']\n else:\n instance_id = resource_id\n\n params = {'Action': 'DescribeTags',\n 'Filter.1.Name': 'resource-id',\n 'Filter.1.Value': instance_id}\n\n return aws.query(params,\n setname='tagSet',\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n\ndef del_tags(name=None,\n kwargs=None,\n call=None,\n instance_id=None,\n resource_id=None): # pylint: disable=W0613\n '''\n Delete tags for a resource. Normally a VM name or instance_id is passed in,\n but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a del_tags mymachine tags=mytag,\n salt-cloud -a del_tags mymachine tags=tag1,tag2,tag3\n salt-cloud -a del_tags resource_id=vol-3267ab32 tags=tag1,tag2,tag3\n '''\n if kwargs is None:\n kwargs = {}\n\n if 'tags' not in kwargs:\n raise SaltCloudSystemExit(\n 'A tag or tags must be specified using tags=list,of,tags'\n )\n\n if not name and 'resource_id' in kwargs:\n instance_id = kwargs['resource_id']\n del kwargs['resource_id']\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n params = {'Action': 'DeleteTags',\n 'ResourceId.1': instance_id}\n\n for idx, tag in enumerate(kwargs['tags'].split(',')):\n params['Tag.{0}.Key'.format(idx)] = tag\n\n aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if resource_id:\n return get_tags(resource_id=resource_id)\n else:\n return get_tags(instance_id=instance_id)\n\n\ndef rename(name, kwargs, call=None):\n '''\n Properly rename a node. Pass in the new name as \"new name\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a rename mymachine newname=yourmachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The rename action must be called with -a or --action.'\n )\n\n log.info('Renaming %s to %s', name, kwargs['newname'])\n\n set_tags(name, {'Name': kwargs['newname']}, call='action')\n\n salt.utils.cloud.rename_key(\n __opts__['pki_dir'], name, kwargs['newname']\n )\n\n\ndef destroy(name, call=None):\n '''\n Destroy a node. Will check termination protection and warn if enabled.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud --destroy mymachine\n '''\n if call == 'function':\n raise SaltCloudSystemExit(\n 'The destroy action must be called with -d, --destroy, '\n '-a or --action.'\n )\n\n node_metadata = _get_node(name)\n instance_id = node_metadata['instanceId']\n sir_id = node_metadata.get('spotInstanceRequestId')\n protected = show_term_protect(\n name=name,\n instance_id=instance_id,\n call='action',\n quiet=True\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'destroying instance',\n 'salt/cloud/{0}/destroying'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n if protected == 'true':\n raise SaltCloudSystemExit(\n 'This instance has been protected from being destroyed. '\n 'Use the following command to disable protection:\\n\\n'\n 'salt-cloud -a disable_term_protect {0}'.format(\n name\n )\n )\n\n ret = {}\n\n # Default behavior is to rename EC2 VMs when destroyed\n # via salt-cloud, unless explicitly set to False.\n rename_on_destroy = config.get_cloud_config_value('rename_on_destroy',\n get_configured_provider(),\n __opts__,\n search_global=False)\n if rename_on_destroy is not False:\n newname = '{0}-DEL{1}'.format(name, uuid.uuid4().hex)\n rename(name, kwargs={'newname': newname}, call='action')\n log.info(\n 'Machine will be identified as %s until it has been '\n 'cleaned up.', newname\n )\n ret['newname'] = newname\n\n params = {'Action': 'TerminateInstances',\n 'InstanceId.1': instance_id}\n\n location = get_location()\n provider = get_provider()\n result = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n\n log.info(result)\n ret.update(result[0])\n\n # If this instance is part of a spot instance request, we\n # need to cancel it as well\n if sir_id is not None:\n params = {'Action': 'CancelSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n result = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n ret['spotInstance'] = result[0]\n\n __utils__['cloud.fire_event'](\n 'event',\n 'destroyed instance',\n 'salt/cloud/{0}/destroyed'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n __utils__['cloud.cachedir_index_del'](name)\n\n if __opts__.get('update_cachedir', False) is True:\n __utils__['cloud.delete_minion_cachedir'](name, __active_provider_name__.split(':')[0], __opts__)\n\n return ret\n\n\ndef reboot(name, call=None):\n '''\n Reboot a node.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a reboot mymachine\n '''\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'RebootInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if result == []:\n log.info('Complete')\n\n return {'Reboot': 'Complete'}\n\n\ndef show_image(kwargs, call=None):\n '''\n Show the details from EC2 concerning an AMI\n '''\n if call != 'function':\n raise SaltCloudSystemExit(\n 'The show_image action must be called with -f or --function.'\n )\n\n params = {'ImageId.1': kwargs['image'],\n 'Action': 'DescribeImages'}\n result = aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n log.info(result)\n\n return result\n\n\ndef show_instance(name=None, instance_id=None, call=None, kwargs=None):\n '''\n Show the details from EC2 concerning an AMI.\n\n Can be called as an action (which requires a name):\n\n .. code-block:: bash\n\n salt-cloud -a show_instance myinstance\n\n ...or as a function (which requires either a name or instance_id):\n\n .. code-block:: bash\n\n salt-cloud -f show_instance my-ec2 name=myinstance\n salt-cloud -f show_instance my-ec2 instance_id=i-d34db33f\n '''\n if not name and call == 'action':\n raise SaltCloudSystemExit(\n 'The show_instance action requires a name.'\n )\n\n if call == 'function':\n name = kwargs.get('name', None)\n instance_id = kwargs.get('instance_id', None)\n\n if not name and not instance_id:\n raise SaltCloudSystemExit(\n 'The show_instance function requires '\n 'either a name or an instance_id'\n )\n\n node = _get_node(name=name, instance_id=instance_id)\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n return node\n\n\ndef _get_node(name=None, instance_id=None, location=None):\n if location is None:\n location = get_location()\n\n params = {'Action': 'DescribeInstances'}\n\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if instance_id:\n params['InstanceId.1'] = instance_id\n else:\n params['Filter.1.Name'] = 'tag:Name'\n params['Filter.1.Value.1'] = name\n\n log.trace(params)\n\n provider = get_provider()\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n try:\n instances = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n instance_info = _extract_instance_info(instances).values()\n return next(iter(instance_info))\n except IndexError:\n attempts += 1\n log.debug(\n 'Failed to get the data for node \\'%s\\'. Remaining '\n 'attempts: %s', instance_id or name, attempts\n )\n aws.sleep_exponential_backoff(attempts)\n return {}\n\n\ndef list_nodes_full(location=None, call=None):\n '''\n Return a list of the VMs that are on the provider\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes_full function must be called with -f '\n 'or --function.'\n )\n\n return _list_nodes_full(location or get_location())\n\n\ndef _extract_name_tag(item):\n if 'tagSet' in item and item['tagSet'] is not None:\n tagset = item['tagSet']\n if isinstance(tagset['item'], list):\n for tag in tagset['item']:\n if tag['key'] == 'Name':\n return tag['value']\n return item['instanceId']\n return item['tagSet']['item']['value']\n return item['instanceId']\n\n\ndef _extract_instance_info(instances):\n '''\n Given an instance query, return a dict of all instance data\n '''\n ret = {}\n for instance in instances:\n # items could be type dict or list (for stopped EC2 instances)\n if isinstance(instance['instancesSet']['item'], list):\n for item in instance['instancesSet']['item']:\n name = _extract_name_tag(item)\n ret[name] = item\n ret[name]['name'] = name\n ret[name].update(\n dict(\n id=item['instanceId'],\n image=item['imageId'],\n size=item['instanceType'],\n state=item['instanceState']['name'],\n private_ips=item.get('privateIpAddress', []),\n public_ips=item.get('ipAddress', [])\n )\n )\n else:\n item = instance['instancesSet']['item']\n name = _extract_name_tag(item)\n ret[name] = item\n ret[name]['name'] = name\n ret[name].update(\n dict(\n id=item['instanceId'],\n image=item['imageId'],\n size=item['instanceType'],\n state=item['instanceState']['name'],\n private_ips=item.get('privateIpAddress', []),\n public_ips=item.get('ipAddress', [])\n )\n )\n\n return ret\n\n\ndef _list_nodes_full(location=None):\n '''\n Return a list of the VMs that in this location\n '''\n provider = __active_provider_name__ or 'ec2'\n if ':' in provider:\n comps = provider.split(':')\n provider = comps[0]\n\n params = {'Action': 'DescribeInstances'}\n instances = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if 'error' in instances:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n instances['error']['Errors']['Error']['Message']\n )\n )\n\n ret = _extract_instance_info(instances)\n\n __utils__['cloud.cache_node_list'](ret, provider, __opts__)\n return ret\n\n\ndef list_nodes_min(location=None, call=None):\n '''\n Return a list of the VMs that are on the provider. Only a list of VM names,\n and their state, is returned. This is the minimum amount of information\n needed to check for existing VMs.\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes_min function must be called with -f or --function.'\n )\n\n ret = {}\n params = {'Action': 'DescribeInstances'}\n instances = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in instances:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n instances['error']['Errors']['Error']['Message']\n )\n )\n\n for instance in instances:\n if isinstance(instance['instancesSet']['item'], list):\n items = instance['instancesSet']['item']\n else:\n items = [instance['instancesSet']['item']]\n\n for item in items:\n state = item['instanceState']['name']\n name = _extract_name_tag(item)\n id = item['instanceId']\n ret[name] = {'state': state, 'id': id}\n return ret\n\n\ndef list_nodes(call=None):\n '''\n Return a list of the VMs that are on the provider\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes function must be called with -f or --function.'\n )\n\n ret = {}\n nodes = list_nodes_full(get_location())\n if 'error' in nodes:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n nodes['error']['Errors']['Error']['Message']\n )\n )\n for node in nodes:\n ret[node] = {\n 'id': nodes[node]['id'],\n 'image': nodes[node]['image'],\n 'name': nodes[node]['name'],\n 'size': nodes[node]['size'],\n 'state': nodes[node]['state'],\n 'private_ips': nodes[node]['private_ips'],\n 'public_ips': nodes[node]['public_ips'],\n }\n return ret\n\n\ndef list_nodes_select(call=None):\n '''\n Return a list of the VMs that are on the provider, with select fields\n '''\n return salt.utils.cloud.list_nodes_select(\n list_nodes_full(get_location()), __opts__['query.selection'], call,\n )\n\n\ndef show_term_protect(name=None, instance_id=None, call=None, quiet=False):\n '''\n Show the details from EC2 concerning an instance's termination protection state\n\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_term_protect action must be called with -a or --action.'\n )\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'DescribeInstanceAttribute',\n 'InstanceId': instance_id,\n 'Attribute': 'disableApiTermination'}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n disable_protect = False\n for item in result:\n if 'value' in item:\n disable_protect = item['value']\n break\n\n log.log(\n logging.DEBUG if quiet is True else logging.INFO,\n 'Termination Protection is %s for %s',\n disable_protect == 'true' and 'enabled' or 'disabled', name\n )\n\n return disable_protect\n\n\ndef show_detailed_monitoring(name=None, instance_id=None, call=None, quiet=False):\n '''\n Show the details from EC2 regarding cloudwatch detailed monitoring.\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_detailed_monitoring action must be called with -a or --action.'\n )\n location = get_location()\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if not name and not instance_id:\n raise SaltCloudSystemExit(\n 'The show_detailed_monitoring action must be provided with a name or instance\\\n ID'\n )\n matched = _get_node(name=name, instance_id=instance_id, location=location)\n log.log(\n logging.DEBUG if quiet is True else logging.INFO,\n 'Detailed Monitoring is %s for %s', matched['monitoring'], name\n )\n return matched['monitoring']\n\n\ndef _toggle_term_protect(name, value):\n '''\n Enable or Disable termination protection on a node\n\n '''\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'ModifyInstanceAttribute',\n 'InstanceId': instance_id,\n 'DisableApiTermination.Value': value}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_term_protect(name=name, instance_id=instance_id, call='action')\n\n\ndef enable_term_protect(name, call=None):\n '''\n Enable termination protection on a node\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a enable_term_protect mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n return _toggle_term_protect(name, 'true')\n\n\ndef disable_term_protect(name, call=None):\n '''\n Disable termination protection on a node\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a disable_term_protect mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n return _toggle_term_protect(name, 'false')\n\n\ndef disable_detailed_monitoring(name, call=None):\n '''\n Enable/disable detailed monitoring on a node\n\n CLI Example:\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'UnmonitorInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_detailed_monitoring(name=name, instance_id=instance_id, call='action')\n\n\ndef enable_detailed_monitoring(name, call=None):\n '''\n Enable/disable detailed monitoring on a node\n\n CLI Example:\n\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'MonitorInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_detailed_monitoring(name=name, instance_id=instance_id, call='action')\n\n\ndef show_delvol_on_destroy(name, kwargs=None, call=None):\n '''\n Do not delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a show_delvol_on_destroy mymachine\n '''\n\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_delvol_on_destroy action must be called '\n 'with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n instance_id = kwargs.get('instance_id', None)\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n if instance_id is None:\n instance_id = _get_node(name)['instanceId']\n\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n\n data = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n blockmap = data[0]['instancesSet']['item']['blockDeviceMapping']\n\n if not isinstance(blockmap['item'], list):\n blockmap['item'] = [blockmap['item']]\n\n items = []\n\n for idx, item in enumerate(blockmap['item']):\n device_name = item['deviceName']\n\n if device is not None and device != device_name:\n continue\n\n if volume_id is not None and volume_id != item['ebs']['volumeId']:\n continue\n\n info = {\n 'device_name': device_name,\n 'volume_id': item['ebs']['volumeId'],\n 'deleteOnTermination': item['ebs']['deleteOnTermination']\n }\n\n items.append(info)\n\n return items\n\n\ndef keepvol_on_destroy(name, kwargs=None, call=None):\n '''\n Do not delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a keepvol_on_destroy mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The keepvol_on_destroy action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n return _toggle_delvol(name=name, device=device,\n volume_id=volume_id, value='false')\n\n\ndef delvol_on_destroy(name, kwargs=None, call=None):\n '''\n Delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a delvol_on_destroy mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The delvol_on_destroy action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n return _toggle_delvol(name=name, device=device,\n volume_id=volume_id, value='true')\n\n\ndef _toggle_delvol(name=None, instance_id=None, device=None, volume_id=None,\n value=None, requesturl=None):\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if requesturl:\n data = aws.query(requesturl=requesturl,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n else:\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n data, requesturl = aws.query(params, # pylint: disable=unbalanced-tuple-unpacking\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n blockmap = data[0]['instancesSet']['item']['blockDeviceMapping']\n\n params = {'Action': 'ModifyInstanceAttribute',\n 'InstanceId': instance_id}\n\n if not isinstance(blockmap['item'], list):\n blockmap['item'] = [blockmap['item']]\n\n for idx, item in enumerate(blockmap['item']):\n device_name = item['deviceName']\n\n if device is not None and device != device_name:\n continue\n if volume_id is not None and volume_id != item['ebs']['volumeId']:\n continue\n\n params['BlockDeviceMapping.{0}.DeviceName'.format(idx)] = device_name\n params['BlockDeviceMapping.{0}.Ebs.DeleteOnTermination'.format(idx)] = value\n\n aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n kwargs = {'instance_id': instance_id,\n 'device': device,\n 'volume_id': volume_id}\n return show_delvol_on_destroy(name, kwargs, call='action')\n\n\ndef register_image(kwargs=None, call=None):\n '''\n Create an ami from a snapshot\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -f register_image my-ec2-config ami_name=my_ami description=\"my description\"\n root_device_name=/dev/xvda snapshot_id=snap-xxxxxxxx\n '''\n\n if call != 'function':\n log.error(\n 'The create_volume function must be called with -f or --function.'\n )\n return False\n\n if 'ami_name' not in kwargs:\n log.error('ami_name must be specified to register an image.')\n return False\n\n block_device_mapping = kwargs.get('block_device_mapping', None)\n if not block_device_mapping:\n if 'snapshot_id' not in kwargs:\n log.error('snapshot_id or block_device_mapping must be specified to register an image.')\n return False\n if 'root_device_name' not in kwargs:\n log.error('root_device_name or block_device_mapping must be specified to register an image.')\n return False\n block_device_mapping = [{\n 'DeviceName': kwargs['root_device_name'],\n 'Ebs': {\n 'VolumeType': kwargs.get('volume_type', 'gp2'),\n 'SnapshotId': kwargs['snapshot_id'],\n }\n }]\n\n if not isinstance(block_device_mapping, list):\n block_device_mapping = [block_device_mapping]\n\n params = {'Action': 'RegisterImage',\n 'Name': kwargs['ami_name']}\n\n params.update(_param_from_config('BlockDeviceMapping', block_device_mapping))\n\n if 'root_device_name' in kwargs:\n params['RootDeviceName'] = kwargs['root_device_name']\n\n if 'description' in kwargs:\n params['Description'] = kwargs['description']\n\n if 'virtualization_type' in kwargs:\n params['VirtualizationType'] = kwargs['virtualization_type']\n\n if 'architecture' in kwargs:\n params['Architecture'] = kwargs['architecture']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n r_data = {}\n for d in data[0]:\n for k, v in d.items():\n r_data[k] = v\n\n return r_data\n\n\ndef volume_create(**kwargs):\n '''\n Wrapper around create_volume.\n Here just to ensure the compatibility with the cloud module.\n '''\n return create_volume(kwargs, 'function')\n\n\ndef create_volume(kwargs=None, call=None, wait_to_finish=False):\n '''\n Create a volume.\n\n zone\n The availability zone used to create the volume. Required. String.\n\n size\n The size of the volume, in GiBs. Defaults to ``10``. Integer.\n\n snapshot\n The snapshot-id from which to create the volume. Integer.\n\n type\n The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned\n IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for\n Magnetic volumes. String.\n\n iops\n The number of I/O operations per second (IOPS) to provision for the volume,\n with a maximum ratio of 50 IOPS/GiB. Only valid for Provisioned IOPS SSD\n volumes. Integer.\n\n This option will only be set if ``type`` is also specified as ``io1``.\n\n encrypted\n Specifies whether the volume will be encrypted. Boolean.\n\n If ``snapshot`` is also given in the list of kwargs, then this value is ignored\n since volumes that are created from encrypted snapshots are also automatically\n encrypted.\n\n tags\n The tags to apply to the volume during creation. Dictionary.\n\n call\n The ``create_volume`` function must be called with ``-f`` or ``--function``.\n String.\n\n wait_to_finish\n Whether or not to wait for the volume to be available. Boolean. Defaults to\n ``False``.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f create_volume my-ec2-config zone=us-east-1b\n salt-cloud -f create_volume my-ec2-config zone=us-east-1b tags='{\"tag1\": \"val1\", \"tag2\", \"val2\"}'\n '''\n if call != 'function':\n log.error(\n 'The create_volume function must be called with -f or --function.'\n )\n return False\n\n if 'zone' not in kwargs:\n log.error('An availability zone must be specified to create a volume.')\n return False\n\n if 'size' not in kwargs and 'snapshot' not in kwargs:\n # This number represents GiB\n kwargs['size'] = '10'\n\n params = {'Action': 'CreateVolume',\n 'AvailabilityZone': kwargs['zone']}\n\n if 'size' in kwargs:\n params['Size'] = kwargs['size']\n\n if 'snapshot' in kwargs:\n params['SnapshotId'] = kwargs['snapshot']\n\n if 'type' in kwargs:\n params['VolumeType'] = kwargs['type']\n\n if 'iops' in kwargs and kwargs.get('type', 'standard') == 'io1':\n params['Iops'] = kwargs['iops']\n\n # You can't set `encrypted` if you pass a snapshot\n if 'encrypted' in kwargs and 'snapshot' not in kwargs:\n params['Encrypted'] = kwargs['encrypted']\n if 'kmskeyid' in kwargs:\n params['KmsKeyId'] = kwargs['kmskeyid']\n if 'kmskeyid' in kwargs and 'encrypted' not in kwargs:\n log.error(\n 'If a KMS Key ID is specified, encryption must be enabled'\n )\n return False\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n r_data = {}\n for d in data[0]:\n for k, v in six.iteritems(d):\n r_data[k] = v\n volume_id = r_data['volumeId']\n\n # Allow tags to be set upon creation\n if 'tags' in kwargs:\n if isinstance(kwargs['tags'], six.string_types):\n tags = salt.utils.yaml.safe_load(kwargs['tags'])\n else:\n tags = kwargs['tags']\n\n if isinstance(tags, dict):\n new_tags = set_tags(tags=tags,\n resource_id=volume_id,\n call='action',\n location=get_location())\n r_data['tags'] = new_tags\n\n # Waits till volume is available\n if wait_to_finish:\n salt.utils.cloud.run_func_until_ret_arg(fun=describe_volumes,\n kwargs={'volume_id': volume_id},\n fun_call=call,\n argument_being_watched='status',\n required_argument_response='available')\n\n return r_data\n\n\ndef __attach_vol_to_instance(params, kws, instance_id):\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if data[0]:\n log.warning(\n 'Error attaching volume %s to instance %s. Retrying!',\n kws['volume_id'], instance_id\n )\n return False\n\n return data\n\n\ndef attach_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Attach a volume to an instance\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The attach_volume action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n if 'device' not in kwargs:\n log.error('A device is required (ex. /dev/sdb1).')\n return False\n\n params = {'Action': 'AttachVolume',\n 'VolumeId': kwargs['volume_id'],\n 'InstanceId': instance_id,\n 'Device': kwargs['device']}\n\n log.debug(params)\n\n vm_ = get_configured_provider()\n\n data = salt.utils.cloud.wait_for_ip(\n __attach_vol_to_instance,\n update_args=(params, kwargs, instance_id),\n timeout=config.get_cloud_config_value(\n 'wait_for_ip_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_ip_interval', vm_, __opts__, default=10),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_ip_interval_multiplier', vm_, __opts__, default=1),\n )\n\n return data\n\n\ndef show_volume(kwargs=None, call=None):\n '''\n Wrapper around describe_volumes.\n Here just to keep functionality.\n Might be depreciated later.\n '''\n if not kwargs:\n kwargs = {}\n\n return describe_volumes(kwargs, call)\n\n\ndef detach_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Detach a volume from an instance\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The detach_volume action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n params = {'Action': 'DetachVolume',\n 'VolumeId': kwargs['volume_id']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef delete_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Delete a volume\n '''\n if not kwargs:\n kwargs = {}\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n params = {'Action': 'DeleteVolume',\n 'VolumeId': kwargs['volume_id']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef volume_list(**kwargs):\n '''\n Wrapper around describe_volumes.\n Here just to ensure the compatibility with the cloud module.\n '''\n return describe_volumes(kwargs, 'function')\n\n\ndef describe_volumes(kwargs=None, call=None):\n '''\n Describe a volume (or volumes)\n\n volume_id\n One or more volume IDs. Multiple IDs must be separated by \",\".\n\n TODO: Add all of the filters.\n '''\n if call != 'function':\n log.error(\n 'The describe_volumes function must be called with -f '\n 'or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n params = {'Action': 'DescribeVolumes'}\n\n if 'volume_id' in kwargs:\n volume_id = kwargs['volume_id'].split(',')\n for volume_index, volume_id in enumerate(volume_id):\n params['VolumeId.{0}'.format(volume_index)] = volume_id\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef create_keypair(kwargs=None, call=None):\n '''\n Create an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The create_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'CreateKeyPair',\n 'KeyName': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n keys = [x for x in data[0] if 'requestId' not in x]\n\n return (keys, data[1])\n\n\ndef import_keypair(kwargs=None, call=None):\n '''\n Import an SSH public key.\n\n .. versionadded:: 2015.8.3\n '''\n if call != 'function':\n log.error(\n 'The import_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n if 'file' not in kwargs:\n log.error('A public key file is required.')\n return False\n\n params = {'Action': 'ImportKeyPair',\n 'KeyName': kwargs['keyname']}\n\n public_key_file = kwargs['file']\n\n if os.path.exists(public_key_file):\n with salt.utils.files.fopen(public_key_file, 'r') as fh_:\n public_key = salt.utils.stringutils.to_unicode(fh_.read())\n\n if public_key is not None:\n params['PublicKeyMaterial'] = base64.b64encode(public_key)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef show_keypair(kwargs=None, call=None):\n '''\n Show the details of an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The show_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'DescribeKeyPairs',\n 'KeyName.1': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef delete_keypair(kwargs=None, call=None):\n '''\n Delete an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The delete_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'DeleteKeyPair',\n 'KeyName': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef create_snapshot(kwargs=None, call=None, wait_to_finish=False):\n '''\n Create a snapshot.\n\n volume_id\n The ID of the Volume from which to create a snapshot.\n\n description\n The optional description of the snapshot.\n\n CLI Exampe:\n\n .. code-block:: bash\n\n salt-cloud -f create_snapshot my-ec2-config volume_id=vol-351d8826\n salt-cloud -f create_snapshot my-ec2-config volume_id=vol-351d8826 \\\\\n description=\"My Snapshot Description\"\n '''\n if call != 'function':\n raise SaltCloudSystemExit(\n 'The create_snapshot function must be called with -f '\n 'or --function.'\n )\n\n if kwargs is None:\n kwargs = {}\n\n volume_id = kwargs.get('volume_id', None)\n description = kwargs.get('description', '')\n\n if volume_id is None:\n raise SaltCloudSystemExit(\n 'A volume_id must be specified to create a snapshot.'\n )\n\n params = {'Action': 'CreateSnapshot',\n 'VolumeId': volume_id,\n 'Description': description}\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')[0]\n\n r_data = {}\n for d in data:\n for k, v in six.iteritems(d):\n r_data[k] = v\n\n if 'snapshotId' in r_data:\n snapshot_id = r_data['snapshotId']\n\n # Waits till volume is available\n if wait_to_finish:\n salt.utils.cloud.run_func_until_ret_arg(fun=describe_snapshots,\n kwargs={'snapshot_id': snapshot_id},\n fun_call=call,\n argument_being_watched='status',\n required_argument_response='completed')\n\n return r_data\n\n\ndef delete_snapshot(kwargs=None, call=None):\n '''\n Delete a snapshot\n '''\n if call != 'function':\n log.error(\n 'The delete_snapshot function must be called with -f '\n 'or --function.'\n )\n return False\n\n if 'snapshot_id' not in kwargs:\n log.error('A snapshot_id must be specified to delete a snapshot.')\n return False\n\n params = {'Action': 'DeleteSnapshot'}\n\n if 'snapshot_id' in kwargs:\n params['SnapshotId'] = kwargs['snapshot_id']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef copy_snapshot(kwargs=None, call=None):\n '''\n Copy a snapshot\n '''\n if call != 'function':\n log.error(\n 'The copy_snapshot function must be called with -f or --function.'\n )\n return False\n\n if 'source_region' not in kwargs:\n log.error('A source_region must be specified to copy a snapshot.')\n return False\n\n if 'source_snapshot_id' not in kwargs:\n log.error('A source_snapshot_id must be specified to copy a snapshot.')\n return False\n\n if 'description' not in kwargs:\n kwargs['description'] = ''\n\n params = {'Action': 'CopySnapshot'}\n\n if 'source_region' in kwargs:\n params['SourceRegion'] = kwargs['source_region']\n\n if 'source_snapshot_id' in kwargs:\n params['SourceSnapshotId'] = kwargs['source_snapshot_id']\n\n if 'description' in kwargs:\n params['Description'] = kwargs['description']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef describe_snapshots(kwargs=None, call=None):\n '''\n Describe a snapshot (or snapshots)\n\n snapshot_id\n One or more snapshot IDs. Multiple IDs must be separated by \",\".\n\n owner\n Return the snapshots owned by the specified owner. Valid values\n include: self, amazon, <AWS Account ID>. Multiple values must be\n separated by \",\".\n\n restorable_by\n One or more AWS accounts IDs that can create volumes from the snapshot.\n Multiple aws account IDs must be separated by \",\".\n\n TODO: Add all of the filters.\n '''\n if call != 'function':\n log.error(\n 'The describe_snapshot function must be called with -f '\n 'or --function.'\n )\n return False\n\n params = {'Action': 'DescribeSnapshots'}\n\n # The AWS correct way is to use non-plurals like snapshot_id INSTEAD of snapshot_ids.\n if 'snapshot_ids' in kwargs:\n kwargs['snapshot_id'] = kwargs['snapshot_ids']\n\n if 'snapshot_id' in kwargs:\n snapshot_ids = kwargs['snapshot_id'].split(',')\n for snapshot_index, snapshot_id in enumerate(snapshot_ids):\n params['SnapshotId.{0}'.format(snapshot_index)] = snapshot_id\n\n if 'owner' in kwargs:\n owners = kwargs['owner'].split(',')\n for owner_index, owner in enumerate(owners):\n params['Owner.{0}'.format(owner_index)] = owner\n\n if 'restorable_by' in kwargs:\n restorable_bys = kwargs['restorable_by'].split(',')\n for restorable_by_index, restorable_by in enumerate(restorable_bys):\n params[\n 'RestorableBy.{0}'.format(restorable_by_index)\n ] = restorable_by\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef get_console_output(\n name=None,\n location=None,\n instance_id=None,\n call=None,\n kwargs=None,\n ):\n '''\n Show the console output from the instance.\n\n By default, returns decoded data, not the Base64-encoded data that is\n actually returned from the EC2 API.\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The get_console_output action must be called with '\n '-a or --action.'\n )\n\n if location is None:\n location = get_location()\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if kwargs is None:\n kwargs = {}\n\n if instance_id is None:\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n params = {'Action': 'GetConsoleOutput',\n 'InstanceId': instance_id}\n\n ret = {}\n data = aws.query(params,\n return_root=True,\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for item in data:\n if next(six.iterkeys(item)) == 'output':\n ret['output_decoded'] = binascii.a2b_base64(next(six.itervalues(item)))\n else:\n ret[next(six.iterkeys(item))] = next(six.itervalues(item))\n\n return ret\n\n\ndef get_password_data(\n name=None,\n kwargs=None,\n instance_id=None,\n call=None,\n ):\n '''\n Return password data for a Windows instance.\n\n By default only the encrypted password data will be returned. However, if a\n key_file is passed in, then a decrypted password will also be returned.\n\n Note that the key_file references the private key that was used to generate\n the keypair associated with this instance. This private key will _not_ be\n transmitted to Amazon; it is only used internally inside of Salt Cloud to\n decrypt data _after_ it has been received from Amazon.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a get_password_data mymachine\n salt-cloud -a get_password_data mymachine key_file=/root/ec2key.pem\n\n Note: PKCS1_v1_5 was added in PyCrypto 2.5\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The get_password_data action must be called with '\n '-a or --action.'\n )\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if kwargs is None:\n kwargs = {}\n\n if instance_id is None:\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n params = {'Action': 'GetPasswordData',\n 'InstanceId': instance_id}\n\n ret = {}\n data = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for item in data:\n ret[next(six.iterkeys(item))] = next(six.itervalues(item))\n\n if not HAS_M2 and not HAS_PYCRYPTO:\n return ret\n\n if 'key' not in kwargs:\n if 'key_file' in kwargs:\n with salt.utils.files.fopen(kwargs['key_file'], 'r') as kf_:\n kwargs['key'] = salt.utils.stringutils.to_unicode(kf_.read())\n\n if 'key' in kwargs:\n pwdata = ret.get('passwordData', None)\n if pwdata is not None:\n rsa_key = kwargs['key']\n pwdata = base64.b64decode(pwdata)\n if HAS_M2:\n key = RSA.load_key_string(rsa_key.encode('ascii'))\n password = key.private_decrypt(pwdata, RSA.pkcs1_padding)\n else:\n dsize = Crypto.Hash.SHA.digest_size\n sentinel = Crypto.Random.new().read(15 + dsize)\n key_obj = Crypto.PublicKey.RSA.importKey(rsa_key)\n key_obj = PKCS1_v1_5.new(key_obj)\n password = key_obj.decrypt(pwdata, sentinel)\n ret['password'] = salt.utils.stringutils.to_unicode(password)\n\n return ret\n\n\n\ndef _parse_pricing(url, name):\n '''\n Download and parse an individual pricing file from AWS\n\n .. versionadded:: 2015.8.0\n '''\n price_js = http.query(url, text=True)\n\n items = []\n current_item = ''\n\n price_js = re.sub(JS_COMMENT_RE, '', price_js['text'])\n price_js = price_js.strip().rstrip(');').lstrip('callback(')\n for keyword in (\n 'vers',\n 'config',\n 'rate',\n 'valueColumns',\n 'currencies',\n 'instanceTypes',\n 'type',\n 'ECU',\n 'storageGB',\n 'name',\n 'vCPU',\n 'memoryGiB',\n 'storageGiB',\n 'USD',\n ):\n price_js = price_js.replace(keyword, '\"{0}\"'.format(keyword))\n\n for keyword in ('region', 'price', 'size'):\n price_js = price_js.replace(keyword, '\"{0}\"'.format(keyword))\n price_js = price_js.replace('\"{0}\"s'.format(keyword), '\"{0}s\"'.format(keyword))\n\n price_js = price_js.replace('\"\"', '\"')\n\n # Turn the data into something that's easier/faster to process\n regions = {}\n price_json = salt.utils.json.loads(price_js)\n for region in price_json['config']['regions']:\n sizes = {}\n for itype in region['instanceTypes']:\n for size in itype['sizes']:\n sizes[size['size']] = size\n regions[region['region']] = sizes\n\n outfile = os.path.join(\n __opts__['cachedir'], 'ec2-pricing-{0}.p'.format(name)\n )\n with salt.utils.files.fopen(outfile, 'w') as fho:\n salt.utils.msgpack.dump(regions, fho)\n\n return True\n\n\ndef show_pricing(kwargs=None, call=None):\n '''\n Show pricing for a particular profile. This is only an estimate, based on\n unofficial pricing sources.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f show_pricing my-ec2-config profile=my-profile\n\n If pricing sources have not been cached, they will be downloaded. Once they\n have been cached, they will not be updated automatically. To manually update\n all prices, use the following command:\n\n .. code-block:: bash\n\n salt-cloud -f update_pricing <provider>\n\n .. versionadded:: 2015.8.0\n '''\n profile = __opts__['profiles'].get(kwargs['profile'], {})\n if not profile:\n return {'Error': 'The requested profile was not found'}\n\n # Make sure the profile belongs to ec2\n provider = profile.get('provider', '0:0')\n comps = provider.split(':')\n if len(comps) < 2 or comps[1] != 'ec2':\n return {'Error': 'The requested profile does not belong to EC2'}\n\n image_id = profile.get('image', None)\n image_dict = show_image({'image': image_id}, 'function')\n image_info = image_dict[0]\n\n # Find out what platform it is\n if image_info.get('imageOwnerAlias', '') == 'amazon':\n if image_info.get('platform', '') == 'windows':\n image_description = image_info.get('description', '')\n if 'sql' in image_description.lower():\n if 'web' in image_description.lower():\n name = 'mswinsqlweb'\n else:\n name = 'mswinsql'\n else:\n name = 'mswin'\n elif image_info.get('imageLocation', '').strip().startswith('amazon/suse'):\n name = 'sles'\n else:\n name = 'linux'\n elif image_info.get('imageOwnerId', '') == '309956199498':\n name = 'rhel'\n else:\n name = 'linux'\n\n pricefile = os.path.join(\n __opts__['cachedir'], 'ec2-pricing-{0}.p'.format(name)\n )\n\n if not os.path.isfile(pricefile):\n update_pricing({'type': name}, 'function')\n\n with salt.utils.files.fopen(pricefile, 'r') as fhi:\n ec2_price = salt.utils.stringutils.to_unicode(\n salt.utils.msgpack.load(fhi))\n\n region = get_location(profile)\n size = profile.get('size', None)\n if size is None:\n return {'Error': 'The requested profile does not contain a size'}\n\n try:\n raw = ec2_price[region][size]\n except KeyError:\n return {'Error': 'The size ({0}) in the requested profile does not have '\n 'a price associated with it for the {1} region'.format(size, region)}\n\n ret = {}\n if kwargs.get('raw', False):\n ret['_raw'] = raw\n\n ret['per_hour'] = 0\n for col in raw.get('valueColumns', []):\n ret['per_hour'] += decimal.Decimal(col['prices'].get('USD', 0))\n\n ret['per_hour'] = decimal.Decimal(ret['per_hour'])\n ret['per_day'] = ret['per_hour'] * 24\n ret['per_week'] = ret['per_day'] * 7\n ret['per_month'] = ret['per_day'] * 30\n ret['per_year'] = ret['per_week'] * 52\n\n return {profile['profile']: ret}\n\n\ndef ssm_create_association(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Associates the specified SSM document with the specified instance\n\n http://docs.aws.amazon.com/ssm/latest/APIReference/API_CreateAssociation.html\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a ssm_create_association ec2-instance-name ssm_document=ssm-document-name\n '''\n\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The ssm_create_association action must be called with '\n '-a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'ssm_document' not in kwargs:\n log.error('A ssm_document is required.')\n return False\n\n params = {'Action': 'CreateAssociation',\n 'InstanceId': instance_id,\n 'Name': kwargs['ssm_document']}\n\n result = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n product='ssm',\n opts=__opts__,\n sigver='4')\n log.info(result)\n return result\n\n\ndef ssm_describe_association(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Describes the associations for the specified SSM document or instance.\n\n http://docs.aws.amazon.com/ssm/latest/APIReference/API_DescribeAssociation.html\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a ssm_describe_association ec2-instance-name ssm_document=ssm-document-name\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The ssm_describe_association action must be called with '\n '-a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'ssm_document' not in kwargs:\n log.error('A ssm_document is required.')\n return False\n\n params = {'Action': 'DescribeAssociation',\n 'InstanceId': instance_id,\n 'Name': kwargs['ssm_document']}\n\n result = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n product='ssm',\n opts=__opts__,\n sigver='4')\n log.info(result)\n return result\n"}}},{"rowIdx":356,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/cloud/clouds/ec2.py"},"func_name":{"kind":"string","value":"_parse_pricing"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def _parse_pricing(url, name):\n '''\n Download and parse an individual pricing file from AWS\n\n .. versionadded:: 2015.8.0\n '''\n price_js = http.query(url, text=True)\n\n items = []\n current_item = ''\n\n price_js = re.sub(JS_COMMENT_RE, '', price_js['text'])\n price_js = price_js.strip().rstrip(');').lstrip('callback(')\n for keyword in (\n 'vers',\n 'config',\n 'rate',\n 'valueColumns',\n 'currencies',\n 'instanceTypes',\n 'type',\n 'ECU',\n 'storageGB',\n 'name',\n 'vCPU',\n 'memoryGiB',\n 'storageGiB',\n 'USD',\n ):\n price_js = price_js.replace(keyword, '\"{0}\"'.format(keyword))\n\n for keyword in ('region', 'price', 'size'):\n price_js = price_js.replace(keyword, '\"{0}\"'.format(keyword))\n price_js = price_js.replace('\"{0}\"s'.format(keyword), '\"{0}s\"'.format(keyword))\n\n price_js = price_js.replace('\"\"', '\"')\n\n # Turn the data into something that's easier/faster to process\n regions = {}\n price_json = salt.utils.json.loads(price_js)\n for region in price_json['config']['regions']:\n sizes = {}\n for itype in region['instanceTypes']:\n for size in itype['sizes']:\n sizes[size['size']] = size\n regions[region['region']] = sizes\n\n outfile = os.path.join(\n __opts__['cachedir'], 'ec2-pricing-{0}.p'.format(name)\n )\n with salt.utils.files.fopen(outfile, 'w') as fho:\n salt.utils.msgpack.dump(regions, fho)\n\n return True"},"func_documentation_string":{"kind":"string","value":"Download and parse an individual pricing file from AWS\n\n .. versionadded:: 2015.8.0"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4968-L5021"},"called_functions":{"kind":"list like","value":["def pack(o, stream, **kwargs):\n '''\n .. versionadded:: 2018.3.4\n\n Wraps msgpack.pack and ensures that the passed object is unwrapped if it is\n a proxy.\n\n By default, this function uses the msgpack module and falls back to\n msgpack_pure, if the msgpack is not available. You can pass an alternate\n msgpack module using the _msgpack_module argument.\n '''\n msgpack_module = kwargs.pop('_msgpack_module', msgpack)\n orig_enc_func = kwargs.pop('default', lambda x: x)\n\n def _enc_func(obj):\n obj = ThreadLocalProxy.unproxy(obj)\n return orig_enc_func(obj)\n\n return msgpack_module.pack(o, stream, default=_enc_func, **kwargs)\n","def loads(s, **kwargs):\n '''\n .. versionadded:: 2018.3.0\n\n Wraps json.loads and prevents a traceback in the event that a bytestring is\n passed to the function. (Python < 3.6 cannot load bytestrings)\n\n You can pass an alternate json module (loaded via import_json() above)\n using the _json_module argument)\n '''\n json_module = kwargs.pop('_json_module', json)\n try:\n return json_module.loads(s, **kwargs)\n except TypeError as exc:\n # json.loads cannot load bytestrings in Python < 3.6\n if six.PY3 and isinstance(s, bytes):\n return json_module.loads(salt.utils.stringutils.to_unicode(s), **kwargs)\n else:\n raise exc\n","def fopen(*args, **kwargs):\n '''\n Wrapper around open() built-in to set CLOEXEC on the fd.\n\n This flag specifies that the file descriptor should be closed when an exec\n function is invoked;\n\n When a file descriptor is allocated (as with open or dup), this bit is\n initially cleared on the new file descriptor, meaning that descriptor will\n survive into the new program after exec.\n\n NB! We still have small race condition between open and fcntl.\n '''\n if six.PY3:\n try:\n # Don't permit stdin/stdout/stderr to be opened. The boolean False\n # and True are treated by Python 3's open() as file descriptors 0\n # and 1, respectively.\n if args[0] in (0, 1, 2):\n raise TypeError(\n '{0} is not a permitted file descriptor'.format(args[0])\n )\n except IndexError:\n pass\n binary = None\n # ensure 'binary' mode is always used on Windows in Python 2\n if ((six.PY2 and salt.utils.platform.is_windows() and 'binary' not in kwargs) or\n kwargs.pop('binary', False)):\n if len(args) > 1:\n args = list(args)\n if 'b' not in args[1]:\n args[1] = args[1].replace('t', 'b')\n if 'b' not in args[1]:\n args[1] += 'b'\n elif kwargs.get('mode'):\n if 'b' not in kwargs['mode']:\n kwargs['mode'] = kwargs['mode'].replace('t', 'b')\n if 'b' not in kwargs['mode']:\n kwargs['mode'] += 'b'\n else:\n # the default is to read\n kwargs['mode'] = 'rb'\n elif six.PY3 and 'encoding' not in kwargs:\n # In Python 3, if text mode is used and the encoding\n # is not specified, set the encoding to 'utf-8'.\n binary = False\n if len(args) > 1:\n args = list(args)\n if 'b' in args[1]:\n binary = True\n if kwargs.get('mode', None):\n if 'b' in kwargs['mode']:\n binary = True\n if not binary:\n kwargs['encoding'] = __salt_system_encoding__\n\n if six.PY3 and not binary and not kwargs.get('newline', None):\n kwargs['newline'] = ''\n\n f_handle = open(*args, **kwargs) # pylint: disable=resource-leakage\n\n if is_fcntl_available():\n # modify the file descriptor on systems with fcntl\n # unix and unix-like systems only\n try:\n FD_CLOEXEC = fcntl.FD_CLOEXEC # pylint: disable=C0103\n except AttributeError:\n FD_CLOEXEC = 1 # pylint: disable=C0103\n old_flags = fcntl.fcntl(f_handle.fileno(), fcntl.F_GETFD)\n fcntl.fcntl(f_handle.fileno(), fcntl.F_SETFD, old_flags | FD_CLOEXEC)\n\n return f_handle\n"],"string":"[\n \"def pack(o, stream, **kwargs):\\n '''\\n .. versionadded:: 2018.3.4\\n\\n Wraps msgpack.pack and ensures that the passed object is unwrapped if it is\\n a proxy.\\n\\n By default, this function uses the msgpack module and falls back to\\n msgpack_pure, if the msgpack is not available. You can pass an alternate\\n msgpack module using the _msgpack_module argument.\\n '''\\n msgpack_module = kwargs.pop('_msgpack_module', msgpack)\\n orig_enc_func = kwargs.pop('default', lambda x: x)\\n\\n def _enc_func(obj):\\n obj = ThreadLocalProxy.unproxy(obj)\\n return orig_enc_func(obj)\\n\\n return msgpack_module.pack(o, stream, default=_enc_func, **kwargs)\\n\",\n \"def loads(s, **kwargs):\\n '''\\n .. versionadded:: 2018.3.0\\n\\n Wraps json.loads and prevents a traceback in the event that a bytestring is\\n passed to the function. (Python < 3.6 cannot load bytestrings)\\n\\n You can pass an alternate json module (loaded via import_json() above)\\n using the _json_module argument)\\n '''\\n json_module = kwargs.pop('_json_module', json)\\n try:\\n return json_module.loads(s, **kwargs)\\n except TypeError as exc:\\n # json.loads cannot load bytestrings in Python < 3.6\\n if six.PY3 and isinstance(s, bytes):\\n return json_module.loads(salt.utils.stringutils.to_unicode(s), **kwargs)\\n else:\\n raise exc\\n\",\n \"def fopen(*args, **kwargs):\\n '''\\n Wrapper around open() built-in to set CLOEXEC on the fd.\\n\\n This flag specifies that the file descriptor should be closed when an exec\\n function is invoked;\\n\\n When a file descriptor is allocated (as with open or dup), this bit is\\n initially cleared on the new file descriptor, meaning that descriptor will\\n survive into the new program after exec.\\n\\n NB! We still have small race condition between open and fcntl.\\n '''\\n if six.PY3:\\n try:\\n # Don't permit stdin/stdout/stderr to be opened. The boolean False\\n # and True are treated by Python 3's open() as file descriptors 0\\n # and 1, respectively.\\n if args[0] in (0, 1, 2):\\n raise TypeError(\\n '{0} is not a permitted file descriptor'.format(args[0])\\n )\\n except IndexError:\\n pass\\n binary = None\\n # ensure 'binary' mode is always used on Windows in Python 2\\n if ((six.PY2 and salt.utils.platform.is_windows() and 'binary' not in kwargs) or\\n kwargs.pop('binary', False)):\\n if len(args) > 1:\\n args = list(args)\\n if 'b' not in args[1]:\\n args[1] = args[1].replace('t', 'b')\\n if 'b' not in args[1]:\\n args[1] += 'b'\\n elif kwargs.get('mode'):\\n if 'b' not in kwargs['mode']:\\n kwargs['mode'] = kwargs['mode'].replace('t', 'b')\\n if 'b' not in kwargs['mode']:\\n kwargs['mode'] += 'b'\\n else:\\n # the default is to read\\n kwargs['mode'] = 'rb'\\n elif six.PY3 and 'encoding' not in kwargs:\\n # In Python 3, if text mode is used and the encoding\\n # is not specified, set the encoding to 'utf-8'.\\n binary = False\\n if len(args) > 1:\\n args = list(args)\\n if 'b' in args[1]:\\n binary = True\\n if kwargs.get('mode', None):\\n if 'b' in kwargs['mode']:\\n binary = True\\n if not binary:\\n kwargs['encoding'] = __salt_system_encoding__\\n\\n if six.PY3 and not binary and not kwargs.get('newline', None):\\n kwargs['newline'] = ''\\n\\n f_handle = open(*args, **kwargs) # pylint: disable=resource-leakage\\n\\n if is_fcntl_available():\\n # modify the file descriptor on systems with fcntl\\n # unix and unix-like systems only\\n try:\\n FD_CLOEXEC = fcntl.FD_CLOEXEC # pylint: disable=C0103\\n except AttributeError:\\n FD_CLOEXEC = 1 # pylint: disable=C0103\\n old_flags = fcntl.fcntl(f_handle.fileno(), fcntl.F_GETFD)\\n fcntl.fcntl(f_handle.fileno(), fcntl.F_SETFD, old_flags | FD_CLOEXEC)\\n\\n return f_handle\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nThe EC2 Cloud Module\n====================\n\nThe EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.\n\nTo use the EC2 cloud module, set up the cloud configuration at\n ``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:\n\n.. code-block:: yaml\n\n my-ec2-config:\n # EC2 API credentials: Access Key ID and Secret Access Key.\n # Alternatively, to use IAM Instance Role credentials available via\n # EC2 metadata set both id and key to 'use-instance-role-credentials'\n id: GKTADJGHEIQSXMKKRBJ08H\n key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs\n\n # If 'role_arn' is specified the above credentials are used to\n # to assume to the role. By default, role_arn is set to None.\n role_arn: arn:aws:iam::012345678910:role/SomeRoleName\n\n # The ssh keyname to use\n keyname: default\n # The amazon security group\n securitygroup: ssh_open\n # The location of the private key which corresponds to the keyname\n private_key: /root/default.pem\n\n # Be default, service_url is set to amazonaws.com. If you are using this\n # driver for something other than Amazon EC2, change it here:\n service_url: amazonaws.com\n\n # The endpoint that is ultimately used is usually formed using the region\n # and the service_url. If you would like to override that entirely, you\n # can explicitly define the endpoint:\n endpoint: myendpoint.example.com:1138/services/Cloud\n\n # SSH Gateways can be used with this provider. Gateways can be used\n # when a salt-master is not on the same private network as the instance\n # that is being deployed.\n\n # Defaults to None\n # Required\n ssh_gateway: gateway.example.com\n\n # Defaults to port 22\n # Optional\n ssh_gateway_port: 22\n\n # Defaults to root\n # Optional\n ssh_gateway_username: root\n\n # Default to nc -q0 %h %p\n # Optional\n ssh_gateway_command: \"-W %h:%p\"\n\n # One authentication method is required. If both\n # are specified, Private key wins.\n\n # Private key defaults to None\n ssh_gateway_private_key: /path/to/key.pem\n\n # Password defaults to None\n ssh_gateway_password: ExamplePasswordHere\n\n driver: ec2\n\n # Pass userdata to the instance to be created\n userdata_file: /etc/salt/my-userdata-file\n\n # Instance termination protection setting\n # Default is disabled\n termination_protection: False\n\n:depends: requests\n'''\n# pylint: disable=invalid-name,function-redefined\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport os\nimport sys\nimport stat\nimport time\nimport uuid\nimport pprint\nimport logging\n\n# Import libs for talking to the EC2 API\nimport hmac\nimport hashlib\nimport binascii\nimport datetime\nimport base64\nimport re\nimport decimal\n\n# Import Salt Libs\nimport salt.utils.cloud\nimport salt.utils.compat\nimport salt.utils.files\nimport salt.utils.hashutils\nimport salt.utils.json\nimport salt.utils.msgpack\nimport salt.utils.stringutils\nimport salt.utils.yaml\nfrom salt._compat import ElementTree as ET\nimport salt.utils.http as http\nimport salt.utils.aws as aws\nimport salt.config as config\nfrom salt.exceptions import (\n SaltCloudException,\n SaltCloudSystemExit,\n SaltCloudConfigError,\n SaltCloudExecutionTimeout,\n SaltCloudExecutionFailure\n)\n\n# pylint: disable=import-error,no-name-in-module,redefined-builtin\nfrom salt.ext import six\nfrom salt.ext.six.moves import map, range, zip\nfrom salt.ext.six.moves.urllib.parse import urlparse as _urlparse, urlencode as _urlencode\n\n# Import 3rd-Party Libs\n# Try to import PyCrypto, which may not be installed on a RAET-based system\ntry:\n from M2Crypto import RSA\n HAS_M2 = True\nexcept ImportError:\n HAS_M2 = False\n\ntry:\n import Crypto\n # PKCS1_v1_5 was added in PyCrypto 2.5\n from Crypto.Cipher import PKCS1_v1_5 # pylint: disable=E0611\n from Crypto.Hash import SHA # pylint: disable=E0611,W0611\n HAS_PYCRYPTO = True\nexcept ImportError:\n HAS_PYCRYPTO = False\n\ntry:\n import requests\n HAS_REQUESTS = True\nexcept ImportError:\n HAS_REQUESTS = False\n# pylint: enable=import-error,no-name-in-module,redefined-builtin\n\n# Get logging started\nlog = logging.getLogger(__name__)\n\n\nEC2_LOCATIONS = {\n 'ap-northeast-1': 'ec2_ap_northeast',\n 'ap-northeast-2': 'ec2_ap_northeast_2',\n 'ap-southeast-1': 'ec2_ap_southeast',\n 'ap-southeast-2': 'ec2_ap_southeast_2',\n 'eu-west-1': 'ec2_eu_west',\n 'eu-central-1': 'ec2_eu_central',\n 'sa-east-1': 'ec2_sa_east',\n 'us-east-1': 'ec2_us_east',\n 'us-gov-west-1': 'ec2_us_gov_west_1',\n 'us-west-1': 'ec2_us_west',\n 'us-west-2': 'ec2_us_west_oregon',\n}\nDEFAULT_LOCATION = 'us-east-1'\n\nDEFAULT_EC2_API_VERSION = '2014-10-01'\n\nEC2_RETRY_CODES = [\n 'RequestLimitExceeded',\n 'InsufficientInstanceCapacity',\n 'InternalError',\n 'Unavailable',\n 'InsufficientAddressCapacity',\n 'InsufficientReservedInstanceCapacity',\n]\n\nJS_COMMENT_RE = re.compile(r'/\\*.*?\\*/', re.S)\n\n__virtualname__ = 'ec2'\n\n\n# Only load in this module if the EC2 configurations are in place\ndef __virtual__():\n '''\n Set up the libcloud functions and check for EC2 configurations\n '''\n if get_configured_provider() is False:\n return False\n\n if get_dependencies() is False:\n return False\n\n return __virtualname__\n\n\ndef get_configured_provider():\n '''\n Return the first configured instance.\n '''\n return config.is_provider_configured(\n __opts__,\n __active_provider_name__ or __virtualname__,\n ('id', 'key')\n )\n\n\ndef get_dependencies():\n '''\n Warn if dependencies aren't met.\n '''\n deps = {\n 'requests': HAS_REQUESTS,\n 'pycrypto or m2crypto': HAS_M2 or HAS_PYCRYPTO\n }\n return config.check_driver_dependencies(\n __virtualname__,\n deps\n )\n\n\ndef _xml_to_dict(xmltree):\n '''\n Convert an XML tree into a dict\n '''\n if sys.version_info < (2, 7):\n children_len = len(xmltree.getchildren())\n else:\n children_len = len(xmltree)\n\n if children_len < 1:\n name = xmltree.tag\n if '}' in name:\n comps = name.split('}')\n name = comps[1]\n return {name: xmltree.text}\n\n xmldict = {}\n for item in xmltree:\n name = item.tag\n if '}' in name:\n comps = name.split('}')\n name = comps[1]\n if name not in xmldict:\n if sys.version_info < (2, 7):\n children_len = len(item.getchildren())\n else:\n children_len = len(item)\n\n if children_len > 0:\n xmldict[name] = _xml_to_dict(item)\n else:\n xmldict[name] = item.text\n else:\n if not isinstance(xmldict[name], list):\n tempvar = xmldict[name]\n xmldict[name] = []\n xmldict[name].append(tempvar)\n xmldict[name].append(_xml_to_dict(item))\n return xmldict\n\n\ndef optimize_providers(providers):\n '''\n Return an optimized list of providers.\n\n We want to reduce the duplication of querying\n the same region.\n\n If a provider is using the same credentials for the same region\n the same data will be returned for each provider, thus causing\n un-wanted duplicate data and API calls to EC2.\n\n '''\n tmp_providers = {}\n optimized_providers = {}\n\n for name, data in six.iteritems(providers):\n if 'location' not in data:\n data['location'] = DEFAULT_LOCATION\n\n if data['location'] not in tmp_providers:\n tmp_providers[data['location']] = {}\n\n creds = (data['id'], data['key'])\n if creds not in tmp_providers[data['location']]:\n tmp_providers[data['location']][creds] = {'name': name,\n 'data': data,\n }\n\n for location, tmp_data in six.iteritems(tmp_providers):\n for creds, data in six.iteritems(tmp_data):\n _id, _key = creds\n _name = data['name']\n _data = data['data']\n if _name not in optimized_providers:\n optimized_providers[_name] = _data\n\n return optimized_providers\n\n\ndef sign(key, msg):\n return hmac.new(key, msg.encode('utf-8'), hashlib.sha256).digest()\n\n\ndef query(params=None, setname=None, requesturl=None, location=None,\n return_url=False, return_root=False):\n\n provider = get_configured_provider()\n service_url = provider.get('service_url', 'amazonaws.com')\n\n # Retrieve access credentials from meta-data, or use provided\n access_key_id, secret_access_key, token = aws.creds(provider)\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n params_with_headers = params.copy()\n timestamp = datetime.datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%SZ')\n\n if not location:\n location = get_location()\n\n if not requesturl:\n endpoint = provider.get(\n 'endpoint',\n 'ec2.{0}.{1}'.format(location, service_url)\n )\n\n requesturl = 'https://{0}/'.format(endpoint)\n endpoint = _urlparse(requesturl).netloc\n endpoint_path = _urlparse(requesturl).path\n else:\n endpoint = _urlparse(requesturl).netloc\n endpoint_path = _urlparse(requesturl).path\n if endpoint == '':\n endpoint_err = (\n 'Could not find a valid endpoint in the '\n 'requesturl: {0}. Looking for something '\n 'like https://some.ec2.endpoint/?args').format(requesturl)\n log.error(endpoint_err)\n if return_url is True:\n return {'error': endpoint_err}, requesturl\n return {'error': endpoint_err}\n\n log.debug('Using EC2 endpoint: %s', endpoint)\n # AWS v4 signature\n\n method = 'GET'\n region = location\n service = 'ec2'\n canonical_uri = _urlparse(requesturl).path\n host = endpoint.strip()\n\n # Create a date for headers and the credential string\n t = datetime.datetime.utcnow()\n amz_date = t.strftime('%Y%m%dT%H%M%SZ') # Format date as YYYYMMDD'T'HHMMSS'Z'\n datestamp = t.strftime('%Y%m%d') # Date w/o time, used in credential scope\n\n canonical_headers = 'host:' + host + '\\n' + 'x-amz-date:' + amz_date + '\\n'\n signed_headers = 'host;x-amz-date'\n\n payload_hash = salt.utils.hashutils.sha256_digest('')\n\n ec2_api_version = provider.get(\n 'ec2_api_version',\n DEFAULT_EC2_API_VERSION\n )\n\n params_with_headers['Version'] = ec2_api_version\n\n keys = sorted(list(params_with_headers))\n values = map(params_with_headers.get, keys)\n querystring = _urlencode(list(zip(keys, values)))\n querystring = querystring.replace('+', '%20')\n\n canonical_request = method + '\\n' + canonical_uri + '\\n' + \\\n querystring + '\\n' + canonical_headers + '\\n' + \\\n signed_headers + '\\n' + payload_hash\n\n algorithm = 'AWS4-HMAC-SHA256'\n credential_scope = datestamp + '/' + region + '/' + service + '/' + 'aws4_request'\n\n string_to_sign = algorithm + '\\n' + amz_date + '\\n' + \\\n credential_scope + '\\n' + \\\n salt.utils.hashutils.sha256_digest(canonical_request)\n\n kDate = sign(('AWS4' + provider['key']).encode('utf-8'), datestamp)\n kRegion = sign(kDate, region)\n kService = sign(kRegion, service)\n signing_key = sign(kService, 'aws4_request')\n\n signature = hmac.new(signing_key, (string_to_sign).encode('utf-8'),\n hashlib.sha256).hexdigest()\n\n authorization_header = algorithm + ' ' + 'Credential=' + \\\n provider['id'] + '/' + credential_scope + \\\n ', ' + 'SignedHeaders=' + signed_headers + \\\n ', ' + 'Signature=' + signature\n headers = {'x-amz-date': amz_date, 'Authorization': authorization_header}\n\n log.debug('EC2 Request: %s', requesturl)\n log.trace('EC2 Request Parameters: %s', params_with_headers)\n try:\n result = requests.get(requesturl, headers=headers, params=params_with_headers)\n log.debug(\n 'EC2 Response Status Code: %s',\n # result.getcode()\n result.status_code\n )\n log.trace('EC2 Response Text: %s', result.text)\n result.raise_for_status()\n break\n except requests.exceptions.HTTPError as exc:\n root = ET.fromstring(exc.response.content)\n data = _xml_to_dict(root)\n\n # check to see if we should retry the query\n err_code = data.get('Errors', {}).get('Error', {}).get('Code', '')\n if err_code and err_code in EC2_RETRY_CODES:\n attempts += 1\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s; '\n 'Attempts remaining: %s',\n exc.response.status_code, exc, data, attempts\n )\n aws.sleep_exponential_backoff(attempts)\n continue\n\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n else:\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n\n response = result.text\n\n root = ET.fromstring(response)\n items = root[1]\n if return_root is True:\n items = root\n\n if setname:\n if sys.version_info < (2, 7):\n children_len = len(root.getchildren())\n else:\n children_len = len(root)\n\n for item in range(0, children_len):\n comps = root[item].tag.split('}')\n if comps[1] == setname:\n items = root[item]\n\n ret = []\n for item in items:\n ret.append(_xml_to_dict(item))\n\n if return_url is True:\n return ret, requesturl\n\n return ret\n\n\ndef _wait_for_spot_instance(update_callback,\n update_args=None,\n update_kwargs=None,\n timeout=10 * 60,\n interval=30,\n interval_multiplier=1,\n max_failures=10):\n '''\n Helper function that waits for a spot instance request to become active\n for a specific maximum amount of time.\n\n :param update_callback: callback function which queries the cloud provider\n for spot instance request. It must return None if\n the required data, running instance included, is\n not available yet.\n :param update_args: Arguments to pass to update_callback\n :param update_kwargs: Keyword arguments to pass to update_callback\n :param timeout: The maximum amount of time(in seconds) to wait for the IP\n address.\n :param interval: The looping interval, i.e., the amount of time to sleep\n before the next iteration.\n :param interval_multiplier: Increase the interval by this multiplier after\n each request; helps with throttling\n :param max_failures: If update_callback returns ``False`` it's considered\n query failure. This value is the amount of failures\n accepted before giving up.\n :returns: The update_callback returned data\n :raises: SaltCloudExecutionTimeout\n\n '''\n if update_args is None:\n update_args = ()\n if update_kwargs is None:\n update_kwargs = {}\n\n duration = timeout\n while True:\n log.debug(\n 'Waiting for spot instance reservation. Giving up in '\n '00:%02d:%02d', int(timeout // 60), int(timeout % 60)\n )\n data = update_callback(*update_args, **update_kwargs)\n if data is False:\n log.debug(\n 'update_callback has returned False which is considered a '\n 'failure. Remaining Failures: %s', max_failures\n )\n max_failures -= 1\n if max_failures <= 0:\n raise SaltCloudExecutionFailure(\n 'Too many failures occurred while waiting for '\n 'the spot instance reservation to become active.'\n )\n elif data is not None:\n return data\n\n if timeout < 0:\n raise SaltCloudExecutionTimeout(\n 'Unable to get an active spot instance request for '\n '00:{0:02d}:{1:02d}'.format(\n int(duration // 60),\n int(duration % 60)\n )\n )\n time.sleep(interval)\n timeout -= interval\n\n if interval_multiplier > 1:\n interval *= interval_multiplier\n if interval > timeout:\n interval = timeout + 1\n log.info('Interval multiplier in effect; interval is '\n 'now %ss', interval)\n\n\ndef avail_sizes(call=None):\n '''\n Return a dict of all available VM sizes on the cloud provider with\n relevant data. Latest version can be found at:\n\n http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_sizes function must be called with '\n '-f or --function, or with the --list-sizes option'\n )\n\n sizes = {\n 'Cluster Compute': {\n 'cc2.8xlarge': {\n 'id': 'cc2.8xlarge',\n 'cores': '16 (2 x Intel Xeon E5-2670, eight-core with '\n 'hyperthread)',\n 'disk': '3360 GiB (4 x 840 GiB)',\n 'ram': '60.5 GiB'\n },\n 'cc1.4xlarge': {\n 'id': 'cc1.4xlarge',\n 'cores': '8 (2 x Intel Xeon X5570, quad-core with '\n 'hyperthread)',\n 'disk': '1690 GiB (2 x 840 GiB)',\n 'ram': '22.5 GiB'\n },\n },\n 'Cluster CPU': {\n 'cg1.4xlarge': {\n 'id': 'cg1.4xlarge',\n 'cores': '8 (2 x Intel Xeon X5570, quad-core with '\n 'hyperthread), plus 2 NVIDIA Tesla M2050 GPUs',\n 'disk': '1680 GiB (2 x 840 GiB)',\n 'ram': '22.5 GiB'\n },\n },\n 'Compute Optimized': {\n 'c4.large': {\n 'id': 'c4.large',\n 'cores': '2',\n 'disk': 'EBS - 500 Mbps',\n 'ram': '3.75 GiB'\n },\n 'c4.xlarge': {\n 'id': 'c4.xlarge',\n 'cores': '4',\n 'disk': 'EBS - 750 Mbps',\n 'ram': '7.5 GiB'\n },\n 'c4.2xlarge': {\n 'id': 'c4.2xlarge',\n 'cores': '8',\n 'disk': 'EBS - 1000 Mbps',\n 'ram': '15 GiB'\n },\n 'c4.4xlarge': {\n 'id': 'c4.4xlarge',\n 'cores': '16',\n 'disk': 'EBS - 2000 Mbps',\n 'ram': '30 GiB'\n },\n 'c4.8xlarge': {\n 'id': 'c4.8xlarge',\n 'cores': '36',\n 'disk': 'EBS - 4000 Mbps',\n 'ram': '60 GiB'\n },\n 'c3.large': {\n 'id': 'c3.large',\n 'cores': '2',\n 'disk': '32 GiB (2 x 16 GiB SSD)',\n 'ram': '3.75 GiB'\n },\n 'c3.xlarge': {\n 'id': 'c3.xlarge',\n 'cores': '4',\n 'disk': '80 GiB (2 x 40 GiB SSD)',\n 'ram': '7.5 GiB'\n },\n 'c3.2xlarge': {\n 'id': 'c3.2xlarge',\n 'cores': '8',\n 'disk': '160 GiB (2 x 80 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'c3.4xlarge': {\n 'id': 'c3.4xlarge',\n 'cores': '16',\n 'disk': '320 GiB (2 x 160 GiB SSD)',\n 'ram': '30 GiB'\n },\n 'c3.8xlarge': {\n 'id': 'c3.8xlarge',\n 'cores': '32',\n 'disk': '640 GiB (2 x 320 GiB SSD)',\n 'ram': '60 GiB'\n }\n },\n 'Dense Storage': {\n 'd2.xlarge': {\n 'id': 'd2.xlarge',\n 'cores': '4',\n 'disk': '6 TiB (3 x 2 TiB hard disk drives)',\n 'ram': '30.5 GiB'\n },\n 'd2.2xlarge': {\n 'id': 'd2.2xlarge',\n 'cores': '8',\n 'disk': '12 TiB (6 x 2 TiB hard disk drives)',\n 'ram': '61 GiB'\n },\n 'd2.4xlarge': {\n 'id': 'd2.4xlarge',\n 'cores': '16',\n 'disk': '24 TiB (12 x 2 TiB hard disk drives)',\n 'ram': '122 GiB'\n },\n 'd2.8xlarge': {\n 'id': 'd2.8xlarge',\n 'cores': '36',\n 'disk': '24 TiB (24 x 2 TiB hard disk drives)',\n 'ram': '244 GiB'\n },\n },\n 'GPU': {\n 'g2.2xlarge': {\n 'id': 'g2.2xlarge',\n 'cores': '8',\n 'disk': '60 GiB (1 x 60 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'g2.8xlarge': {\n 'id': 'g2.8xlarge',\n 'cores': '32',\n 'disk': '240 GiB (2 x 120 GiB SSD)',\n 'ram': '60 GiB'\n },\n },\n 'GPU Compute': {\n 'p2.xlarge': {\n 'id': 'p2.xlarge',\n 'cores': '4',\n 'disk': 'EBS',\n 'ram': '61 GiB'\n },\n 'p2.8xlarge': {\n 'id': 'p2.8xlarge',\n 'cores': '32',\n 'disk': 'EBS',\n 'ram': '488 GiB'\n },\n 'p2.16xlarge': {\n 'id': 'p2.16xlarge',\n 'cores': '64',\n 'disk': 'EBS',\n 'ram': '732 GiB'\n },\n },\n 'High I/O': {\n 'i2.xlarge': {\n 'id': 'i2.xlarge',\n 'cores': '4',\n 'disk': 'SSD (1 x 800 GiB)',\n 'ram': '30.5 GiB'\n },\n 'i2.2xlarge': {\n 'id': 'i2.2xlarge',\n 'cores': '8',\n 'disk': 'SSD (2 x 800 GiB)',\n 'ram': '61 GiB'\n },\n 'i2.4xlarge': {\n 'id': 'i2.4xlarge',\n 'cores': '16',\n 'disk': 'SSD (4 x 800 GiB)',\n 'ram': '122 GiB'\n },\n 'i2.8xlarge': {\n 'id': 'i2.8xlarge',\n 'cores': '32',\n 'disk': 'SSD (8 x 800 GiB)',\n 'ram': '244 GiB'\n }\n },\n 'High Memory': {\n 'x1.16xlarge': {\n 'id': 'x1.16xlarge',\n 'cores': '64 (with 5.45 ECUs each)',\n 'disk': '1920 GiB (1 x 1920 GiB)',\n 'ram': '976 GiB'\n },\n 'x1.32xlarge': {\n 'id': 'x1.32xlarge',\n 'cores': '128 (with 2.73 ECUs each)',\n 'disk': '3840 GiB (2 x 1920 GiB)',\n 'ram': '1952 GiB'\n },\n 'r4.large': {\n 'id': 'r4.large',\n 'cores': '2 (with 3.45 ECUs each)',\n 'disk': 'EBS',\n 'ram': '15.25 GiB'\n },\n 'r4.xlarge': {\n 'id': 'r4.xlarge',\n 'cores': '4 (with 3.35 ECUs each)',\n 'disk': 'EBS',\n 'ram': '30.5 GiB'\n },\n 'r4.2xlarge': {\n 'id': 'r4.2xlarge',\n 'cores': '8 (with 3.35 ECUs each)',\n 'disk': 'EBS',\n 'ram': '61 GiB'\n },\n 'r4.4xlarge': {\n 'id': 'r4.4xlarge',\n 'cores': '16 (with 3.3 ECUs each)',\n 'disk': 'EBS',\n 'ram': '122 GiB'\n },\n 'r4.8xlarge': {\n 'id': 'r4.8xlarge',\n 'cores': '32 (with 3.1 ECUs each)',\n 'disk': 'EBS',\n 'ram': '244 GiB'\n },\n 'r4.16xlarge': {\n 'id': 'r4.16xlarge',\n 'cores': '64 (with 3.05 ECUs each)',\n 'disk': 'EBS',\n 'ram': '488 GiB'\n },\n 'r3.large': {\n 'id': 'r3.large',\n 'cores': '2 (with 3.25 ECUs each)',\n 'disk': '32 GiB (1 x 32 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'r3.xlarge': {\n 'id': 'r3.xlarge',\n 'cores': '4 (with 3.25 ECUs each)',\n 'disk': '80 GiB (1 x 80 GiB SSD)',\n 'ram': '30.5 GiB'\n },\n 'r3.2xlarge': {\n 'id': 'r3.2xlarge',\n 'cores': '8 (with 3.25 ECUs each)',\n 'disk': '160 GiB (1 x 160 GiB SSD)',\n 'ram': '61 GiB'\n },\n 'r3.4xlarge': {\n 'id': 'r3.4xlarge',\n 'cores': '16 (with 3.25 ECUs each)',\n 'disk': '320 GiB (1 x 320 GiB SSD)',\n 'ram': '122 GiB'\n },\n 'r3.8xlarge': {\n 'id': 'r3.8xlarge',\n 'cores': '32 (with 3.25 ECUs each)',\n 'disk': '640 GiB (2 x 320 GiB SSD)',\n 'ram': '244 GiB'\n }\n },\n 'High-Memory Cluster': {\n 'cr1.8xlarge': {\n 'id': 'cr1.8xlarge',\n 'cores': '16 (2 x Intel Xeon E5-2670, eight-core)',\n 'disk': '240 GiB (2 x 120 GiB SSD)',\n 'ram': '244 GiB'\n },\n },\n 'High Storage': {\n 'hs1.8xlarge': {\n 'id': 'hs1.8xlarge',\n 'cores': '16 (8 cores + 8 hyperthreads)',\n 'disk': '48 TiB (24 x 2 TiB hard disk drives)',\n 'ram': '117 GiB'\n },\n },\n 'General Purpose': {\n 't2.nano': {\n 'id': 't2.nano',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '512 MiB'\n },\n 't2.micro': {\n 'id': 't2.micro',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '1 GiB'\n },\n 't2.small': {\n 'id': 't2.small',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '2 GiB'\n },\n 't2.medium': {\n 'id': 't2.medium',\n 'cores': '2',\n 'disk': 'EBS',\n 'ram': '4 GiB'\n },\n 't2.large': {\n 'id': 't2.large',\n 'cores': '2',\n 'disk': 'EBS',\n 'ram': '8 GiB'\n },\n 't2.xlarge': {\n 'id': 't2.xlarge',\n 'cores': '4',\n 'disk': 'EBS',\n 'ram': '16 GiB'\n },\n 't2.2xlarge': {\n 'id': 't2.2xlarge',\n 'cores': '8',\n 'disk': 'EBS',\n 'ram': '32 GiB'\n },\n 'm4.large': {\n 'id': 'm4.large',\n 'cores': '2',\n 'disk': 'EBS - 450 Mbps',\n 'ram': '8 GiB'\n },\n 'm4.xlarge': {\n 'id': 'm4.xlarge',\n 'cores': '4',\n 'disk': 'EBS - 750 Mbps',\n 'ram': '16 GiB'\n },\n 'm4.2xlarge': {\n 'id': 'm4.2xlarge',\n 'cores': '8',\n 'disk': 'EBS - 1000 Mbps',\n 'ram': '32 GiB'\n },\n 'm4.4xlarge': {\n 'id': 'm4.4xlarge',\n 'cores': '16',\n 'disk': 'EBS - 2000 Mbps',\n 'ram': '64 GiB'\n },\n 'm4.10xlarge': {\n 'id': 'm4.10xlarge',\n 'cores': '40',\n 'disk': 'EBS - 4000 Mbps',\n 'ram': '160 GiB'\n },\n 'm4.16xlarge': {\n 'id': 'm4.16xlarge',\n 'cores': '64',\n 'disk': 'EBS - 10000 Mbps',\n 'ram': '256 GiB'\n },\n 'm3.medium': {\n 'id': 'm3.medium',\n 'cores': '1',\n 'disk': 'SSD (1 x 4)',\n 'ram': '3.75 GiB'\n },\n 'm3.large': {\n 'id': 'm3.large',\n 'cores': '2',\n 'disk': 'SSD (1 x 32)',\n 'ram': '7.5 GiB'\n },\n 'm3.xlarge': {\n 'id': 'm3.xlarge',\n 'cores': '4',\n 'disk': 'SSD (2 x 40)',\n 'ram': '15 GiB'\n },\n 'm3.2xlarge': {\n 'id': 'm3.2xlarge',\n 'cores': '8',\n 'disk': 'SSD (2 x 80)',\n 'ram': '30 GiB'\n },\n }\n }\n return sizes\n\n\ndef avail_images(kwargs=None, call=None):\n '''\n Return a dict of all available VM images on the cloud provider.\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_images function must be called with '\n '-f or --function, or with the --list-images option'\n )\n\n if not isinstance(kwargs, dict):\n kwargs = {}\n\n if 'owner' in kwargs:\n owner = kwargs['owner']\n else:\n provider = get_configured_provider()\n\n owner = config.get_cloud_config_value(\n 'owner', provider, __opts__, default='amazon'\n )\n\n ret = {}\n params = {'Action': 'DescribeImages',\n 'Owner': owner}\n images = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for image in images:\n ret[image['imageId']] = image\n return ret\n\n\ndef script(vm_):\n '''\n Return the script deployment object\n '''\n return salt.utils.cloud.os_script(\n config.get_cloud_config_value('script', vm_, __opts__),\n vm_,\n __opts__,\n salt.utils.cloud.salt_config_to_yaml(\n salt.utils.cloud.minion_config(__opts__, vm_)\n )\n )\n\n\ndef keyname(vm_):\n '''\n Return the keyname\n '''\n return config.get_cloud_config_value(\n 'keyname', vm_, __opts__, search_global=False\n )\n\n\ndef securitygroup(vm_):\n '''\n Return the security group\n '''\n return config.get_cloud_config_value(\n 'securitygroup', vm_, __opts__, search_global=False\n )\n\n\ndef iam_profile(vm_):\n '''\n Return the IAM profile.\n\n The IAM instance profile to associate with the instances.\n This is either the Amazon Resource Name (ARN) of the instance profile\n or the name of the role.\n\n Type: String\n\n Default: None\n\n Required: No\n\n Example: arn:aws:iam::111111111111:instance-profile/s3access\n\n Example: s3access\n\n '''\n return config.get_cloud_config_value(\n 'iam_profile', vm_, __opts__, search_global=False\n )\n\n\ndef ssh_interface(vm_):\n '''\n Return the ssh_interface type to connect to. Either 'public_ips' (default)\n or 'private_ips'.\n '''\n ret = config.get_cloud_config_value(\n 'ssh_interface', vm_, __opts__, default='public_ips',\n search_global=False\n )\n if ret not in ('public_ips', 'private_ips'):\n log.warning(\n 'Invalid ssh_interface: %s. '\n 'Allowed options are (\"public_ips\", \"private_ips\"). '\n 'Defaulting to \"public_ips\".', ret\n )\n ret = 'public_ips'\n return ret\n\n\ndef get_ssh_gateway_config(vm_):\n '''\n Return the ssh_gateway configuration.\n '''\n ssh_gateway = config.get_cloud_config_value(\n 'ssh_gateway', vm_, __opts__, default=None,\n search_global=False\n )\n\n # Check to see if a SSH Gateway will be used.\n if not isinstance(ssh_gateway, six.string_types):\n return None\n\n # Create dictionary of configuration items\n\n # ssh_gateway\n ssh_gateway_config = {'ssh_gateway': ssh_gateway}\n\n # ssh_gateway_port\n ssh_gateway_config['ssh_gateway_port'] = config.get_cloud_config_value(\n 'ssh_gateway_port', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_username\n ssh_gateway_config['ssh_gateway_user'] = config.get_cloud_config_value(\n 'ssh_gateway_username', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_private_key\n ssh_gateway_config['ssh_gateway_key'] = config.get_cloud_config_value(\n 'ssh_gateway_private_key', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_password\n ssh_gateway_config['ssh_gateway_password'] = config.get_cloud_config_value(\n 'ssh_gateway_password', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_command\n ssh_gateway_config['ssh_gateway_command'] = config.get_cloud_config_value(\n 'ssh_gateway_command', vm_, __opts__, default=None,\n search_global=False\n )\n\n # Check if private key exists\n key_filename = ssh_gateway_config['ssh_gateway_key']\n if key_filename is not None and not os.path.isfile(key_filename):\n raise SaltCloudConfigError(\n 'The defined ssh_gateway_private_key \\'{0}\\' does not exist'\n .format(key_filename)\n )\n elif (\n key_filename is None and\n not ssh_gateway_config['ssh_gateway_password']\n ):\n raise SaltCloudConfigError(\n 'No authentication method. Please define: '\n ' ssh_gateway_password or ssh_gateway_private_key'\n )\n\n return ssh_gateway_config\n\n\ndef get_location(vm_=None):\n '''\n Return the EC2 region to use, in this order:\n - CLI parameter\n - VM parameter\n - Cloud profile setting\n '''\n return __opts__.get(\n 'location',\n config.get_cloud_config_value(\n 'location',\n vm_ or get_configured_provider(),\n __opts__,\n default=DEFAULT_LOCATION,\n search_global=False\n )\n )\n\n\ndef avail_locations(call=None):\n '''\n List all available locations\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_locations function must be called with '\n '-f or --function, or with the --list-locations option'\n )\n\n ret = {}\n\n params = {'Action': 'DescribeRegions'}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for region in result:\n ret[region['regionName']] = {\n 'name': region['regionName'],\n 'endpoint': region['regionEndpoint'],\n }\n\n return ret\n\n\ndef get_availability_zone(vm_):\n '''\n Return the availability zone to use\n '''\n avz = config.get_cloud_config_value(\n 'availability_zone', vm_, __opts__, search_global=False\n )\n\n if avz is None:\n return None\n\n zones = _list_availability_zones(vm_)\n\n # Validate user-specified AZ\n if avz not in zones:\n raise SaltCloudException(\n 'The specified availability zone isn\\'t valid in this region: '\n '{0}\\n'.format(\n avz\n )\n )\n\n # check specified AZ is available\n elif zones[avz] != 'available':\n raise SaltCloudException(\n 'The specified availability zone isn\\'t currently available: '\n '{0}\\n'.format(\n avz\n )\n )\n\n return avz\n\n\ndef get_tenancy(vm_):\n '''\n Returns the Tenancy to use.\n\n Can be \"dedicated\" or \"default\". Cannot be present for spot instances.\n '''\n return config.get_cloud_config_value(\n 'tenancy', vm_, __opts__, search_global=False\n )\n\n\ndef get_imageid(vm_):\n '''\n Returns the ImageId to use\n '''\n image = config.get_cloud_config_value(\n 'image', vm_, __opts__, search_global=False\n )\n if image.startswith('ami-'):\n return image\n # a poor man's cache\n if not hasattr(get_imageid, 'images'):\n get_imageid.images = {}\n elif image in get_imageid.images:\n return get_imageid.images[image]\n params = {'Action': 'DescribeImages',\n 'Filter.0.Name': 'name',\n 'Filter.0.Value.0': image}\n # Query AWS, sort by 'creationDate' and get the last imageId\n _t = lambda x: datetime.datetime.strptime(x['creationDate'], '%Y-%m-%dT%H:%M:%S.%fZ')\n image_id = sorted(aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'),\n lambda i, j: salt.utils.compat.cmp(_t(i), _t(j))\n )[-1]['imageId']\n get_imageid.images[image] = image_id\n return image_id\n\n\ndef _get_subnetname_id(subnetname):\n '''\n Returns the SubnetId of a SubnetName to use\n '''\n params = {'Action': 'DescribeSubnets'}\n for subnet in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n tags = subnet.get('tagSet', {}).get('item', {})\n if not isinstance(tags, list):\n tags = [tags]\n for tag in tags:\n if tag['key'] == 'Name' and tag['value'] == subnetname:\n log.debug(\n 'AWS Subnet ID of %s is %s',\n subnetname, subnet['subnetId']\n )\n return subnet['subnetId']\n return None\n\n\ndef get_subnetid(vm_):\n '''\n Returns the SubnetId to use\n '''\n subnetid = config.get_cloud_config_value(\n 'subnetid', vm_, __opts__, search_global=False\n )\n if subnetid:\n return subnetid\n\n subnetname = config.get_cloud_config_value(\n 'subnetname', vm_, __opts__, search_global=False\n )\n if subnetname:\n return _get_subnetname_id(subnetname)\n return None\n\n\ndef _get_securitygroupname_id(securitygroupname_list):\n '''\n Returns the SecurityGroupId of a SecurityGroupName to use\n '''\n securitygroupid_set = set()\n if not isinstance(securitygroupname_list, list):\n securitygroupname_list = [securitygroupname_list]\n params = {'Action': 'DescribeSecurityGroups'}\n for sg in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n if sg['groupName'] in securitygroupname_list:\n log.debug(\n 'AWS SecurityGroup ID of %s is %s',\n sg['groupName'], sg['groupId']\n )\n securitygroupid_set.add(sg['groupId'])\n return list(securitygroupid_set)\n\n\ndef securitygroupid(vm_):\n '''\n Returns the SecurityGroupId\n '''\n securitygroupid_set = set()\n securitygroupid_list = config.get_cloud_config_value(\n 'securitygroupid',\n vm_,\n __opts__,\n search_global=False\n )\n # If the list is None, then the set will remain empty\n # If the list is already a set then calling 'set' on it is a no-op\n # If the list is a string, then calling 'set' generates a one-element set\n # If the list is anything else, stacktrace\n if securitygroupid_list:\n securitygroupid_set = securitygroupid_set.union(set(securitygroupid_list))\n\n securitygroupname_list = config.get_cloud_config_value(\n 'securitygroupname', vm_, __opts__, search_global=False\n )\n if securitygroupname_list:\n if not isinstance(securitygroupname_list, list):\n securitygroupname_list = [securitygroupname_list]\n params = {'Action': 'DescribeSecurityGroups'}\n for sg in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n if sg['groupName'] in securitygroupname_list:\n log.debug(\n 'AWS SecurityGroup ID of %s is %s',\n sg['groupName'], sg['groupId']\n )\n securitygroupid_set.add(sg['groupId'])\n return list(securitygroupid_set)\n\n\ndef get_placementgroup(vm_):\n '''\n Returns the PlacementGroup to use\n '''\n return config.get_cloud_config_value(\n 'placementgroup', vm_, __opts__, search_global=False\n )\n\n\ndef get_spot_config(vm_):\n '''\n Returns the spot instance configuration for the provided vm\n '''\n return config.get_cloud_config_value(\n 'spot_config', vm_, __opts__, search_global=False\n )\n\n\ndef get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_comps[0]\n return provider\n\n\ndef _list_availability_zones(vm_=None):\n '''\n List all availability zones in the current region\n '''\n ret = {}\n\n params = {'Action': 'DescribeAvailabilityZones',\n 'Filter.0.Name': 'region-name',\n 'Filter.0.Value.0': get_location(vm_)}\n result = aws.query(params,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for zone in result:\n ret[zone['zoneName']] = zone['zoneState']\n\n return ret\n\n\ndef block_device_mappings(vm_):\n '''\n Return the block device mapping:\n\n .. code-block:: python\n\n [{'DeviceName': '/dev/sdb', 'VirtualName': 'ephemeral0'},\n {'DeviceName': '/dev/sdc', 'VirtualName': 'ephemeral1'}]\n '''\n return config.get_cloud_config_value(\n 'block_device_mappings', vm_, __opts__, search_global=True\n )\n\n\ndef _request_eip(interface, vm_):\n '''\n Request and return Elastic IP\n '''\n params = {'Action': 'AllocateAddress'}\n params['Domain'] = interface.setdefault('domain', 'vpc')\n eips = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n for eip in eips:\n if 'allocationId' in eip:\n return eip['allocationId']\n return None\n\n\ndef _create_eni_if_necessary(interface, vm_):\n '''\n Create an Elastic Interface if necessary and return a Network Interface Specification\n '''\n if 'NetworkInterfaceId' in interface and interface['NetworkInterfaceId'] is not None:\n return {'DeviceIndex': interface['DeviceIndex'],\n 'NetworkInterfaceId': interface['NetworkInterfaceId']}\n\n params = {'Action': 'DescribeSubnets'}\n subnet_query = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if 'SecurityGroupId' not in interface and 'securitygroupname' in interface:\n interface['SecurityGroupId'] = _get_securitygroupname_id(interface['securitygroupname'])\n if 'SubnetId' not in interface and 'subnetname' in interface:\n interface['SubnetId'] = _get_subnetname_id(interface['subnetname'])\n\n subnet_id = _get_subnet_id_for_interface(subnet_query, interface)\n if not subnet_id:\n raise SaltCloudConfigError(\n 'No such subnet <{0}>'.format(interface.get('SubnetId'))\n )\n params = {'SubnetId': subnet_id}\n\n for k in 'Description', 'PrivateIpAddress', 'SecondaryPrivateIpAddressCount':\n if k in interface:\n params[k] = interface[k]\n\n for k in 'PrivateIpAddresses', 'SecurityGroupId':\n if k in interface:\n params.update(_param_from_config(k, interface[k]))\n\n if 'AssociatePublicIpAddress' in interface:\n # Associating a public address in a VPC only works when the interface is not\n # created beforehand, but as a part of the machine creation request.\n for k in ('DeviceIndex', 'AssociatePublicIpAddress', 'NetworkInterfaceId'):\n if k in interface:\n params[k] = interface[k]\n params['DeleteOnTermination'] = interface.get('delete_interface_on_terminate', True)\n return params\n\n params['Action'] = 'CreateNetworkInterface'\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n eni_desc = result[1]\n if not eni_desc or not eni_desc.get('networkInterfaceId'):\n raise SaltCloudException('Failed to create interface: {0}'.format(result))\n\n eni_id = eni_desc.get('networkInterfaceId')\n log.debug(\n 'Created network interface %s inst %s',\n eni_id, interface['DeviceIndex']\n )\n\n associate_public_ip = interface.get('AssociatePublicIpAddress', False)\n if isinstance(associate_public_ip, six.string_types):\n # Assume id of EIP as value\n _associate_eip_with_interface(eni_id, associate_public_ip, vm_=vm_)\n\n if interface.get('associate_eip'):\n _associate_eip_with_interface(eni_id, interface.get('associate_eip'), vm_=vm_)\n elif interface.get('allocate_new_eip'):\n _new_eip = _request_eip(interface, vm_)\n _associate_eip_with_interface(eni_id, _new_eip, vm_=vm_)\n elif interface.get('allocate_new_eips'):\n addr_list = _list_interface_private_addrs(eni_desc)\n eip_list = []\n for idx, addr in enumerate(addr_list):\n eip_list.append(_request_eip(interface, vm_))\n for idx, addr in enumerate(addr_list):\n _associate_eip_with_interface(eni_id, eip_list[idx], addr, vm_=vm_)\n\n if 'Name' in interface:\n tag_params = {'Action': 'CreateTags',\n 'ResourceId.0': eni_id,\n 'Tag.0.Key': 'Name',\n 'Tag.0.Value': interface['Name']}\n tag_response = aws.query(tag_params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in tag_response:\n log.error('Failed to set name of interface {0}')\n\n return {'DeviceIndex': interface['DeviceIndex'],\n 'NetworkInterfaceId': eni_id}\n\n\ndef _get_subnet_id_for_interface(subnet_query, interface):\n for subnet_query_result in subnet_query:\n if 'item' in subnet_query_result:\n if isinstance(subnet_query_result['item'], dict):\n subnet_id = _get_subnet_from_subnet_query(subnet_query_result['item'],\n interface)\n if subnet_id is not None:\n return subnet_id\n\n else:\n for subnet in subnet_query_result['item']:\n subnet_id = _get_subnet_from_subnet_query(subnet, interface)\n if subnet_id is not None:\n return subnet_id\n\n\ndef _get_subnet_from_subnet_query(subnet_query, interface):\n if 'subnetId' in subnet_query:\n if interface.get('SubnetId'):\n if subnet_query['subnetId'] == interface['SubnetId']:\n return subnet_query['subnetId']\n else:\n return subnet_query['subnetId']\n\n\ndef _list_interface_private_addrs(eni_desc):\n '''\n Returns a list of all of the private IP addresses attached to a\n network interface. The 'primary' address will be listed first.\n '''\n primary = eni_desc.get('privateIpAddress')\n if not primary:\n return None\n\n addresses = [primary]\n\n lst = eni_desc.get('privateIpAddressesSet', {}).get('item', [])\n if not isinstance(lst, list):\n return addresses\n\n for entry in lst:\n if entry.get('primary') == 'true':\n continue\n if entry.get('privateIpAddress'):\n addresses.append(entry.get('privateIpAddress'))\n\n return addresses\n\n\ndef _modify_eni_properties(eni_id, properties=None, vm_=None):\n '''\n Change properties of the interface\n with id eni_id to the values in properties dict\n '''\n if not isinstance(properties, dict):\n raise SaltCloudException(\n 'ENI properties must be a dictionary'\n )\n\n params = {'Action': 'ModifyNetworkInterfaceAttribute',\n 'NetworkInterfaceId': eni_id}\n for k, v in six.iteritems(properties):\n params[k] = v\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if isinstance(result, dict) and result.get('error'):\n raise SaltCloudException(\n 'Could not change interface <{0}> attributes <\\'{1}\\'>'.format(\n eni_id, properties\n )\n )\n else:\n return result\n\n\ndef _associate_eip_with_interface(eni_id, eip_id, private_ip=None, vm_=None):\n '''\n Accept the id of a network interface, and the id of an elastic ip\n address, and associate the two of them, such that traffic sent to the\n elastic ip address will be forwarded (NATted) to this network interface.\n\n Optionally specify the private (10.x.x.x) IP address that traffic should\n be NATted to - useful if you have multiple IP addresses assigned to an\n interface.\n '''\n params = {'Action': 'AssociateAddress',\n 'NetworkInterfaceId': eni_id,\n 'AllocationId': eip_id}\n\n if private_ip:\n params['PrivateIpAddress'] = private_ip\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if not result[2].get('associationId'):\n raise SaltCloudException(\n 'Could not associate elastic ip address '\n '<{0}> with network interface <{1}>'.format(\n eip_id, eni_id\n )\n )\n\n log.debug(\n 'Associated ElasticIP address %s with interface %s',\n eip_id, eni_id\n )\n\n return result[2].get('associationId')\n\n\ndef _update_enis(interfaces, instance, vm_=None):\n config_enis = {}\n instance_enis = []\n for interface in interfaces:\n if 'DeviceIndex' in interface:\n if interface['DeviceIndex'] in config_enis:\n log.error(\n 'Duplicate DeviceIndex in profile. Cannot update ENIs.'\n )\n return None\n config_enis[six.text_type(interface['DeviceIndex'])] = interface\n query_enis = instance[0]['instancesSet']['item']['networkInterfaceSet']['item']\n if isinstance(query_enis, list):\n for query_eni in query_enis:\n instance_enis.append((query_eni['networkInterfaceId'], query_eni['attachment']))\n else:\n instance_enis.append((query_enis['networkInterfaceId'], query_enis['attachment']))\n\n for eni_id, eni_data in instance_enis:\n delete_on_terminate = True\n if 'DeleteOnTermination' in config_enis[eni_data['deviceIndex']]:\n delete_on_terminate = config_enis[eni_data['deviceIndex']]['DeleteOnTermination']\n elif 'delete_interface_on_terminate' in config_enis[eni_data['deviceIndex']]:\n delete_on_terminate = config_enis[eni_data['deviceIndex']]['delete_interface_on_terminate']\n\n params_attachment = {'Attachment.AttachmentId': eni_data['attachmentId'],\n 'Attachment.DeleteOnTermination': delete_on_terminate}\n set_eni_attachment_attributes = _modify_eni_properties(eni_id, params_attachment, vm_=vm_)\n\n if 'SourceDestCheck' in config_enis[eni_data['deviceIndex']]:\n params_sourcedest = {'SourceDestCheck.Value': config_enis[eni_data['deviceIndex']]['SourceDestCheck']}\n set_eni_sourcedest_property = _modify_eni_properties(eni_id, params_sourcedest, vm_=vm_)\n\n return None\n\n\ndef _param_from_config(key, data):\n '''\n Return EC2 API parameters based on the given config data.\n\n Examples:\n 1. List of dictionaries\n >>> data = [\n ... {'DeviceIndex': 0, 'SubnetId': 'subid0',\n ... 'AssociatePublicIpAddress': True},\n ... {'DeviceIndex': 1,\n ... 'SubnetId': 'subid1',\n ... 'PrivateIpAddress': '192.168.1.128'}\n ... ]\n >>> _param_from_config('NetworkInterface', data)\n ... {'NetworkInterface.0.SubnetId': 'subid0',\n ... 'NetworkInterface.0.DeviceIndex': 0,\n ... 'NetworkInterface.1.SubnetId': 'subid1',\n ... 'NetworkInterface.1.PrivateIpAddress': '192.168.1.128',\n ... 'NetworkInterface.0.AssociatePublicIpAddress': 'true',\n ... 'NetworkInterface.1.DeviceIndex': 1}\n\n 2. List of nested dictionaries\n >>> data = [\n ... {'DeviceName': '/dev/sdf',\n ... 'Ebs': {\n ... 'SnapshotId': 'dummy0',\n ... 'VolumeSize': 200,\n ... 'VolumeType': 'standard'}},\n ... {'DeviceName': '/dev/sdg',\n ... 'Ebs': {\n ... 'SnapshotId': 'dummy1',\n ... 'VolumeSize': 100,\n ... 'VolumeType': 'standard'}}\n ... ]\n >>> _param_from_config('BlockDeviceMapping', data)\n ... {'BlockDeviceMapping.0.Ebs.VolumeType': 'standard',\n ... 'BlockDeviceMapping.1.Ebs.SnapshotId': 'dummy1',\n ... 'BlockDeviceMapping.0.Ebs.VolumeSize': 200,\n ... 'BlockDeviceMapping.0.Ebs.SnapshotId': 'dummy0',\n ... 'BlockDeviceMapping.1.Ebs.VolumeType': 'standard',\n ... 'BlockDeviceMapping.1.DeviceName': '/dev/sdg',\n ... 'BlockDeviceMapping.1.Ebs.VolumeSize': 100,\n ... 'BlockDeviceMapping.0.DeviceName': '/dev/sdf'}\n\n 3. Dictionary of dictionaries\n >>> data = { 'Arn': 'dummyarn', 'Name': 'Tester' }\n >>> _param_from_config('IamInstanceProfile', data)\n {'IamInstanceProfile.Arn': 'dummyarn', 'IamInstanceProfile.Name': 'Tester'}\n\n '''\n\n param = {}\n\n if isinstance(data, dict):\n for k, v in six.iteritems(data):\n param.update(_param_from_config('{0}.{1}'.format(key, k), v))\n\n elif isinstance(data, list) or isinstance(data, tuple):\n for idx, conf_item in enumerate(data):\n prefix = '{0}.{1}'.format(key, idx)\n param.update(_param_from_config(prefix, conf_item))\n\n else:\n if isinstance(data, bool):\n # convert boolean True/False to 'true'/'false'\n param.update({key: six.text_type(data).lower()})\n else:\n param.update({key: data})\n\n return param\n\n\ndef request_instance(vm_=None, call=None):\n '''\n Put together all of the information necessary to request an instance on EC2,\n and then fire off the request the instance.\n\n Returns data about the instance\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The request_instance action must be called with -a or --action.'\n )\n\n location = vm_.get('location', get_location(vm_))\n\n # do we launch a regular vm or a spot instance?\n # see http://goo.gl/hYZ13f for more information on EC2 API\n spot_config = get_spot_config(vm_)\n if spot_config is not None:\n if 'spot_price' not in spot_config:\n raise SaltCloudSystemExit(\n 'Spot instance config for {0} requires a spot_price '\n 'attribute.'.format(vm_['name'])\n )\n\n params = {'Action': 'RequestSpotInstances',\n 'InstanceCount': '1',\n 'Type': spot_config['type']\n if 'type' in spot_config else 'one-time',\n 'SpotPrice': spot_config['spot_price']}\n\n # All of the necessary launch parameters for a VM when using\n # spot instances are the same except for the prefix below\n # being tacked on.\n spot_prefix = 'LaunchSpecification.'\n\n # regular EC2 instance\n else:\n # WARNING! EXPERIMENTAL!\n # This allows more than one instance to be spun up in a single call.\n # The first instance will be called by the name provided, but all other\n # instances will be nameless (or more specifically, they will use the\n # InstanceId as the name). This interface is expected to change, so\n # use at your own risk.\n min_instance = config.get_cloud_config_value(\n 'min_instance', vm_, __opts__, search_global=False, default=1\n )\n max_instance = config.get_cloud_config_value(\n 'max_instance', vm_, __opts__, search_global=False, default=1\n )\n params = {'Action': 'RunInstances',\n 'MinCount': min_instance,\n 'MaxCount': max_instance}\n\n # Normal instances should have no prefix.\n spot_prefix = ''\n\n image_id = get_imageid(vm_)\n params[spot_prefix + 'ImageId'] = image_id\n\n userdata = None\n userdata_file = config.get_cloud_config_value(\n 'userdata_file', vm_, __opts__, search_global=False, default=None\n )\n if userdata_file is None:\n userdata = config.get_cloud_config_value(\n 'userdata', vm_, __opts__, search_global=False, default=None\n )\n else:\n log.trace('userdata_file: %s', userdata_file)\n if os.path.exists(userdata_file):\n with salt.utils.files.fopen(userdata_file, 'r') as fh_:\n userdata = salt.utils.stringutils.to_unicode(fh_.read())\n\n userdata = salt.utils.cloud.userdata_template(__opts__, vm_, userdata)\n\n if userdata is not None:\n try:\n params[spot_prefix + 'UserData'] = base64.b64encode(\n salt.utils.stringutils.to_bytes(userdata)\n )\n except Exception as exc:\n log.exception('Failed to encode userdata: %s', exc)\n\n vm_size = config.get_cloud_config_value(\n 'size', vm_, __opts__, search_global=False\n )\n params[spot_prefix + 'InstanceType'] = vm_size\n\n ex_keyname = keyname(vm_)\n if ex_keyname:\n params[spot_prefix + 'KeyName'] = ex_keyname\n\n ex_securitygroup = securitygroup(vm_)\n if ex_securitygroup:\n if not isinstance(ex_securitygroup, list):\n params[spot_prefix + 'SecurityGroup.1'] = ex_securitygroup\n else:\n for counter, sg_ in enumerate(ex_securitygroup):\n params[spot_prefix + 'SecurityGroup.{0}'.format(counter)] = sg_\n\n ex_iam_profile = iam_profile(vm_)\n if ex_iam_profile:\n try:\n if ex_iam_profile.startswith('arn:aws:iam:'):\n params[\n spot_prefix + 'IamInstanceProfile.Arn'\n ] = ex_iam_profile\n else:\n params[\n spot_prefix + 'IamInstanceProfile.Name'\n ] = ex_iam_profile\n except AttributeError:\n raise SaltCloudConfigError(\n '\\'iam_profile\\' should be a string value.'\n )\n\n az_ = get_availability_zone(vm_)\n if az_ is not None:\n params[spot_prefix + 'Placement.AvailabilityZone'] = az_\n\n tenancy_ = get_tenancy(vm_)\n if tenancy_ is not None:\n if spot_config is not None:\n raise SaltCloudConfigError(\n 'Spot instance config for {0} does not support '\n 'specifying tenancy.'.format(vm_['name'])\n )\n params['Placement.Tenancy'] = tenancy_\n\n subnetid_ = get_subnetid(vm_)\n if subnetid_ is not None:\n params[spot_prefix + 'SubnetId'] = subnetid_\n\n ex_securitygroupid = securitygroupid(vm_)\n if ex_securitygroupid:\n if not isinstance(ex_securitygroupid, list):\n params[spot_prefix + 'SecurityGroupId.1'] = ex_securitygroupid\n else:\n for counter, sg_ in enumerate(ex_securitygroupid):\n params[\n spot_prefix + 'SecurityGroupId.{0}'.format(counter)\n ] = sg_\n\n placementgroup_ = get_placementgroup(vm_)\n if placementgroup_ is not None:\n params[spot_prefix + 'Placement.GroupName'] = placementgroup_\n\n blockdevicemappings_holder = block_device_mappings(vm_)\n if blockdevicemappings_holder:\n for _bd in blockdevicemappings_holder:\n if 'tag' in _bd:\n _bd.pop('tag')\n\n ex_blockdevicemappings = blockdevicemappings_holder\n if ex_blockdevicemappings:\n params.update(_param_from_config(spot_prefix + 'BlockDeviceMapping',\n ex_blockdevicemappings))\n\n network_interfaces = config.get_cloud_config_value(\n 'network_interfaces',\n vm_,\n __opts__,\n search_global=False\n )\n\n if network_interfaces:\n eni_devices = []\n for interface in network_interfaces:\n log.debug('Create network interface: %s', interface)\n _new_eni = _create_eni_if_necessary(interface, vm_)\n eni_devices.append(_new_eni)\n params.update(_param_from_config(spot_prefix + 'NetworkInterface',\n eni_devices))\n\n set_ebs_optimized = config.get_cloud_config_value(\n 'ebs_optimized', vm_, __opts__, search_global=False\n )\n\n if set_ebs_optimized is not None:\n if not isinstance(set_ebs_optimized, bool):\n raise SaltCloudConfigError(\n '\\'ebs_optimized\\' should be a boolean value.'\n )\n params[spot_prefix + 'EbsOptimized'] = set_ebs_optimized\n\n set_del_root_vol_on_destroy = config.get_cloud_config_value(\n 'del_root_vol_on_destroy', vm_, __opts__, search_global=False\n )\n\n set_termination_protection = config.get_cloud_config_value(\n 'termination_protection', vm_, __opts__, search_global=False\n )\n\n if set_termination_protection is not None:\n if not isinstance(set_termination_protection, bool):\n raise SaltCloudConfigError(\n '\\'termination_protection\\' should be a boolean value.'\n )\n params.update(_param_from_config(spot_prefix + 'DisableApiTermination',\n set_termination_protection))\n\n if set_del_root_vol_on_destroy and not isinstance(set_del_root_vol_on_destroy, bool):\n raise SaltCloudConfigError(\n '\\'del_root_vol_on_destroy\\' should be a boolean value.'\n )\n\n vm_['set_del_root_vol_on_destroy'] = set_del_root_vol_on_destroy\n\n if set_del_root_vol_on_destroy:\n # first make sure to look up the root device name\n # as Ubuntu and CentOS (and most likely other OSs)\n # use different device identifiers\n\n log.info('Attempting to look up root device name for image id %s on '\n 'VM %s', image_id, vm_['name'])\n\n rd_params = {\n 'Action': 'DescribeImages',\n 'ImageId.1': image_id\n }\n try:\n rd_data = aws.query(rd_params,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in rd_data:\n return rd_data['error']\n log.debug('EC2 Response: \\'%s\\'', rd_data)\n except Exception as exc:\n log.error(\n 'Error getting root device name for image id %s for '\n 'VM %s: \\n%s', image_id, vm_['name'], exc,\n # Show the traceback if the debug logging level is enabled\n exc_info_on_loglevel=logging.DEBUG\n )\n raise\n\n # make sure we have a response\n if not rd_data:\n err_msg = 'There was an error querying EC2 for the root device ' \\\n 'of image id {0}. Empty response.'.format(image_id)\n raise SaltCloudSystemExit(err_msg)\n\n # pull the root device name from the result and use it when\n # launching the new VM\n rd_name = None\n rd_type = None\n if 'blockDeviceMapping' in rd_data[0]:\n # Some ami instances do not have a root volume. Ignore such cases\n if rd_data[0]['blockDeviceMapping'] is not None:\n item = rd_data[0]['blockDeviceMapping']['item']\n if isinstance(item, list):\n item = item[0]\n rd_name = item['deviceName']\n # Grab the volume type\n rd_type = item['ebs'].get('volumeType', None)\n\n log.info('Found root device name: %s', rd_name)\n\n if rd_name is not None:\n if ex_blockdevicemappings:\n dev_list = [\n dev['DeviceName'] for dev in ex_blockdevicemappings\n ]\n else:\n dev_list = []\n\n if rd_name in dev_list:\n # Device already listed, just grab the index\n dev_index = dev_list.index(rd_name)\n else:\n dev_index = len(dev_list)\n # Add the device name in since it wasn't already there\n params[\n '{0}BlockDeviceMapping.{1}.DeviceName'.format(\n spot_prefix, dev_index\n )\n ] = rd_name\n\n # Set the termination value\n termination_key = '{0}BlockDeviceMapping.{1}.Ebs.DeleteOnTermination'.format(spot_prefix, dev_index)\n params[termination_key] = six.text_type(set_del_root_vol_on_destroy).lower()\n\n # Use default volume type if not specified\n if ex_blockdevicemappings and dev_index < len(ex_blockdevicemappings) and \\\n 'Ebs.VolumeType' not in ex_blockdevicemappings[dev_index]:\n type_key = '{0}BlockDeviceMapping.{1}.Ebs.VolumeType'.format(spot_prefix, dev_index)\n params[type_key] = rd_type\n\n set_del_all_vols_on_destroy = config.get_cloud_config_value(\n 'del_all_vols_on_destroy', vm_, __opts__, search_global=False, default=False\n )\n\n if set_del_all_vols_on_destroy and not isinstance(set_del_all_vols_on_destroy, bool):\n raise SaltCloudConfigError(\n '\\'del_all_vols_on_destroy\\' should be a boolean value.'\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'requesting instance',\n 'salt/cloud/{0}/requesting'.format(vm_['name']),\n args={\n 'kwargs': __utils__['cloud.filter_event'](\n 'requesting', params, list(params)\n ),\n 'location': location,\n },\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n provider = get_provider(vm_)\n\n try:\n data = aws.query(params,\n 'instancesSet',\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if 'error' in data:\n return data['error']\n except Exception as exc:\n log.error(\n 'Error creating %s on EC2 when trying to run the initial '\n 'deployment: \\n%s', vm_['name'], exc,\n # Show the traceback if the debug logging level is enabled\n exc_info_on_loglevel=logging.DEBUG\n )\n raise\n\n # if we're using spot instances, we need to wait for the spot request\n # to become active before we continue\n if spot_config:\n sir_id = data[0]['spotInstanceRequestId']\n\n vm_['spotRequestId'] = sir_id\n\n def __query_spot_instance_request(sir_id, location):\n params = {'Action': 'DescribeSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if not data:\n log.error(\n 'There was an error while querying EC2. Empty response'\n )\n # Trigger a failure in the wait for spot instance method\n return False\n\n if isinstance(data, dict) and 'error' in data:\n log.warning('There was an error in the query. %s', data['error'])\n # Trigger a failure in the wait for spot instance method\n return False\n\n log.debug('Returned query data: %s', data)\n\n state = data[0].get('state')\n\n if state == 'active':\n return data\n\n if state == 'open':\n # Still waiting for an active state\n log.info('Spot instance status: %s', data[0]['status']['message'])\n return None\n\n if state in ['cancelled', 'failed', 'closed']:\n # Request will never be active, fail\n log.error('Spot instance request resulted in state \\'{0}\\'. '\n 'Nothing else we can do here.')\n return False\n\n __utils__['cloud.fire_event'](\n 'event',\n 'waiting for spot instance',\n 'salt/cloud/{0}/waiting_for_spot'.format(vm_['name']),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n try:\n data = _wait_for_spot_instance(\n __query_spot_instance_request,\n update_args=(sir_id, location),\n timeout=config.get_cloud_config_value(\n 'wait_for_spot_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_spot_interval', vm_, __opts__, default=30),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_spot_interval_multiplier',\n vm_,\n __opts__,\n default=1),\n max_failures=config.get_cloud_config_value(\n 'wait_for_spot_max_failures',\n vm_,\n __opts__,\n default=10),\n )\n log.debug('wait_for_spot_instance data %s', data)\n\n except (SaltCloudExecutionTimeout, SaltCloudExecutionFailure) as exc:\n try:\n # Cancel the existing spot instance request\n params = {'Action': 'CancelSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n\n log.debug('Canceled spot instance request %s. Data '\n 'returned: %s', sir_id, data)\n\n except SaltCloudSystemExit:\n pass\n finally:\n raise SaltCloudSystemExit(six.text_type(exc))\n\n return data, vm_\n\n\ndef query_instance(vm_=None, call=None):\n '''\n Query an instance upon creation from the EC2 API\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The query_instance action must be called with -a or --action.'\n )\n\n instance_id = vm_['instance_id']\n location = vm_.get('location', get_location(vm_))\n __utils__['cloud.fire_event'](\n 'event',\n 'querying instance',\n 'salt/cloud/{0}/querying'.format(vm_['name']),\n args={'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n log.debug('The new VM instance_id is %s', instance_id)\n\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n\n provider = get_provider(vm_)\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n data, requesturl = aws.query(params, # pylint: disable=unbalanced-tuple-unpacking\n location=location,\n provider=provider,\n opts=__opts__,\n return_url=True,\n sigver='4')\n log.debug('The query returned: %s', data)\n\n if isinstance(data, dict) and 'error' in data:\n log.warning(\n 'There was an error in the query. %s attempts '\n 'remaining: %s', attempts, data['error']\n )\n elif isinstance(data, list) and not data:\n log.warning(\n 'Query returned an empty list. %s attempts '\n 'remaining.', attempts\n )\n else:\n break\n\n aws.sleep_exponential_backoff(attempts)\n attempts += 1\n continue\n else:\n raise SaltCloudSystemExit(\n 'An error occurred while creating VM: {0}'.format(data['error'])\n )\n\n def __query_ip_address(params, url): # pylint: disable=W0613\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if not data:\n log.error(\n 'There was an error while querying EC2. Empty response'\n )\n # Trigger a failure in the wait for IP function\n return False\n\n if isinstance(data, dict) and 'error' in data:\n log.warning('There was an error in the query. %s', data['error'])\n # Trigger a failure in the wait for IP function\n return False\n\n log.debug('Returned query data: %s', data)\n\n if ssh_interface(vm_) == 'public_ips':\n if 'ipAddress' in data[0]['instancesSet']['item']:\n return data\n else:\n log.error(\n 'Public IP not detected.'\n )\n\n if ssh_interface(vm_) == 'private_ips':\n if 'privateIpAddress' in data[0]['instancesSet']['item']:\n return data\n else:\n log.error(\n 'Private IP not detected.'\n )\n\n try:\n data = salt.utils.cloud.wait_for_ip(\n __query_ip_address,\n update_args=(params, requesturl),\n timeout=config.get_cloud_config_value(\n 'wait_for_ip_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_ip_interval', vm_, __opts__, default=10),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_ip_interval_multiplier', vm_, __opts__, default=1),\n )\n except (SaltCloudExecutionTimeout, SaltCloudExecutionFailure) as exc:\n try:\n # It might be already up, let's destroy it!\n destroy(vm_['name'])\n except SaltCloudSystemExit:\n pass\n finally:\n raise SaltCloudSystemExit(six.text_type(exc))\n\n if 'reactor' in vm_ and vm_['reactor'] is True:\n __utils__['cloud.fire_event'](\n 'event',\n 'instance queried',\n 'salt/cloud/{0}/query_reactor'.format(vm_['name']),\n args={'data': data},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n return data\n\n\ndef wait_for_instance(\n vm_=None,\n data=None,\n ip_address=None,\n display_ssh_output=True,\n call=None,\n ):\n '''\n Wait for an instance upon creation from the EC2 API, to become available\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The wait_for_instance action must be called with -a or --action.'\n )\n\n if vm_ is None:\n vm_ = {}\n\n if data is None:\n data = {}\n\n ssh_gateway_config = vm_.get(\n 'gateway', get_ssh_gateway_config(vm_)\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'waiting for ssh',\n 'salt/cloud/{0}/waiting_for_ssh'.format(vm_['name']),\n args={'ip_address': ip_address},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n ssh_connect_timeout = config.get_cloud_config_value(\n 'ssh_connect_timeout', vm_, __opts__, 900 # 15 minutes\n )\n ssh_port = config.get_cloud_config_value(\n 'ssh_port', vm_, __opts__, 22\n )\n\n if config.get_cloud_config_value('win_installer', vm_, __opts__):\n username = config.get_cloud_config_value(\n 'win_username', vm_, __opts__, default='Administrator'\n )\n win_passwd = config.get_cloud_config_value(\n 'win_password', vm_, __opts__, default=''\n )\n win_deploy_auth_retries = config.get_cloud_config_value(\n 'win_deploy_auth_retries', vm_, __opts__, default=10\n )\n win_deploy_auth_retry_delay = config.get_cloud_config_value(\n 'win_deploy_auth_retry_delay', vm_, __opts__, default=1\n )\n use_winrm = config.get_cloud_config_value(\n 'use_winrm', vm_, __opts__, default=False\n )\n winrm_verify_ssl = config.get_cloud_config_value(\n 'winrm_verify_ssl', vm_, __opts__, default=True\n )\n\n if win_passwd and win_passwd == 'auto':\n log.debug('Waiting for auto-generated Windows EC2 password')\n while True:\n password_data = get_password_data(\n name=vm_['name'],\n kwargs={\n 'key_file': vm_['private_key'],\n },\n call='action',\n )\n win_passwd = password_data.get('password', None)\n if win_passwd is None:\n log.debug(password_data)\n # This wait is so high, because the password is unlikely to\n # be generated for at least 4 minutes\n time.sleep(60)\n else:\n logging_data = password_data\n\n logging_data['password'] = 'XXX-REDACTED-XXX'\n logging_data['passwordData'] = 'XXX-REDACTED-XXX'\n log.debug(logging_data)\n\n vm_['win_password'] = win_passwd\n break\n\n # SMB used whether psexec or winrm\n if not salt.utils.cloud.wait_for_port(ip_address,\n port=445,\n timeout=ssh_connect_timeout):\n raise SaltCloudSystemExit(\n 'Failed to connect to remote windows host'\n )\n\n # If not using winrm keep same psexec behavior\n if not use_winrm:\n\n log.debug('Trying to authenticate via SMB using psexec')\n\n if not salt.utils.cloud.validate_windows_cred(ip_address,\n username,\n win_passwd,\n retries=win_deploy_auth_retries,\n retry_delay=win_deploy_auth_retry_delay):\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote windows host (smb)'\n )\n\n # If using winrm\n else:\n\n # Default HTTPS port can be changed in cloud configuration\n winrm_port = config.get_cloud_config_value(\n 'winrm_port', vm_, __opts__, default=5986\n )\n\n # Wait for winrm port to be available\n if not salt.utils.cloud.wait_for_port(ip_address,\n port=winrm_port,\n timeout=ssh_connect_timeout):\n raise SaltCloudSystemExit(\n 'Failed to connect to remote windows host (winrm)'\n )\n\n log.debug('Trying to authenticate via Winrm using pywinrm')\n\n if not salt.utils.cloud.wait_for_winrm(ip_address,\n winrm_port,\n username,\n win_passwd,\n timeout=ssh_connect_timeout,\n verify=winrm_verify_ssl):\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote windows host'\n )\n\n elif salt.utils.cloud.wait_for_port(ip_address,\n port=ssh_port,\n timeout=ssh_connect_timeout,\n gateway=ssh_gateway_config\n ):\n # If a known_hosts_file is configured, this instance will not be\n # accessible until it has a host key. Since this is provided on\n # supported instances by cloud-init, and viewable to us only from the\n # console output (which may take several minutes to become available,\n # we have some more waiting to do here.\n known_hosts_file = config.get_cloud_config_value(\n 'known_hosts_file', vm_, __opts__, default=None\n )\n if known_hosts_file:\n console = {}\n while 'output_decoded' not in console:\n console = get_console_output(\n instance_id=vm_['instance_id'],\n call='action',\n location=get_location(vm_)\n )\n pprint.pprint(console)\n time.sleep(5)\n output = salt.utils.stringutils.to_unicode(console['output_decoded'])\n comps = output.split('-----BEGIN SSH HOST KEY KEYS-----')\n if len(comps) < 2:\n # Fail; there are no host keys\n return False\n\n comps = comps[1].split('-----END SSH HOST KEY KEYS-----')\n keys = ''\n for line in comps[0].splitlines():\n if not line:\n continue\n keys += '\\n{0} {1}'.format(ip_address, line)\n\n with salt.utils.files.fopen(known_hosts_file, 'a') as fp_:\n fp_.write(salt.utils.stringutils.to_str(keys))\n fp_.close()\n\n for user in vm_['usernames']:\n if salt.utils.cloud.wait_for_passwd(\n host=ip_address,\n port=ssh_port,\n username=user,\n ssh_timeout=config.get_cloud_config_value(\n 'wait_for_passwd_timeout', vm_, __opts__, default=1 * 60\n ),\n key_filename=vm_['key_filename'],\n display_ssh_output=display_ssh_output,\n gateway=ssh_gateway_config,\n maxtries=config.get_cloud_config_value(\n 'wait_for_passwd_maxtries', vm_, __opts__, default=15\n ),\n known_hosts_file=config.get_cloud_config_value(\n 'known_hosts_file', vm_, __opts__,\n default='/dev/null'\n ),\n ):\n __opts__['ssh_username'] = user\n vm_['ssh_username'] = user\n break\n else:\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote ssh'\n )\n else:\n raise SaltCloudSystemExit(\n 'Failed to connect to remote ssh'\n )\n\n if 'reactor' in vm_ and vm_['reactor'] is True:\n __utils__['cloud.fire_event'](\n 'event',\n 'ssh is available',\n 'salt/cloud/{0}/ssh_ready_reactor'.format(vm_['name']),\n args={'ip_address': ip_address},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n return vm_\n\n\ndef _validate_key_path_and_mode(key_filename):\n if key_filename is None:\n raise SaltCloudSystemExit(\n 'The required \\'private_key\\' configuration setting is missing from the '\n '\\'ec2\\' driver.'\n )\n\n if not os.path.exists(key_filename):\n raise SaltCloudSystemExit(\n 'The EC2 key file \\'{0}\\' does not exist.\\n'.format(\n key_filename\n )\n )\n\n key_mode = stat.S_IMODE(os.stat(key_filename).st_mode)\n if key_mode not in (0o400, 0o600):\n raise SaltCloudSystemExit(\n 'The EC2 key file \\'{0}\\' needs to be set to mode 0400 or 0600.\\n'.format(\n key_filename\n )\n )\n\n return True\n\n\ndef create(vm_=None, call=None):\n '''\n Create a single VM from a data dict\n '''\n if call:\n raise SaltCloudSystemExit(\n 'You cannot create an instance with -a or -f.'\n )\n\n try:\n # Check for required profile parameters before sending any API calls.\n if vm_['profile'] and config.is_profile_configured(__opts__,\n __active_provider_name__ or 'ec2',\n vm_['profile'],\n vm_=vm_) is False:\n return False\n except AttributeError:\n pass\n\n # Check for private_key and keyfile name for bootstrapping new instances\n deploy = config.get_cloud_config_value(\n 'deploy', vm_, __opts__, default=True\n )\n win_password = config.get_cloud_config_value(\n 'win_password', vm_, __opts__, default=''\n )\n key_filename = config.get_cloud_config_value(\n 'private_key', vm_, __opts__, search_global=False, default=None\n )\n if deploy:\n # The private_key and keyname settings are only needed for bootstrapping\n # new instances when deploy is True\n _validate_key_path_and_mode(key_filename)\n\n __utils__['cloud.fire_event'](\n 'event',\n 'starting create',\n 'salt/cloud/{0}/creating'.format(vm_['name']),\n args=__utils__['cloud.filter_event']('creating', vm_, ['name', 'profile', 'provider', 'driver']),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n __utils__['cloud.cachedir_index_add'](\n vm_['name'], vm_['profile'], 'ec2', vm_['driver']\n )\n\n vm_['key_filename'] = key_filename\n # wait_for_instance requires private_key\n vm_['private_key'] = key_filename\n\n # Get SSH Gateway config early to verify the private_key,\n # if used, exists or not. We don't want to deploy an instance\n # and not be able to access it via the gateway.\n vm_['gateway'] = get_ssh_gateway_config(vm_)\n\n location = get_location(vm_)\n vm_['location'] = location\n\n log.info('Creating Cloud VM %s in %s', vm_['name'], location)\n vm_['usernames'] = salt.utils.cloud.ssh_usernames(\n vm_,\n __opts__,\n default_users=(\n 'ec2-user', # Amazon Linux, Fedora, RHEL; FreeBSD\n 'centos', # CentOS AMIs from AWS Marketplace\n 'ubuntu', # Ubuntu\n 'admin', # Debian GNU/Linux\n 'bitnami', # BitNami AMIs\n 'root' # Last resort, default user on RHEL 5, SUSE\n )\n )\n\n if 'instance_id' in vm_:\n # This was probably created via another process, and doesn't have\n # things like salt keys created yet, so let's create them now.\n if 'pub_key' not in vm_ and 'priv_key' not in vm_:\n log.debug('Generating minion keys for \\'%s\\'', vm_['name'])\n vm_['priv_key'], vm_['pub_key'] = salt.utils.cloud.gen_keys(\n salt.config.get_cloud_config_value(\n 'keysize',\n vm_,\n __opts__\n )\n )\n else:\n # Put together all of the information required to request the instance,\n # and then fire off the request for it\n if keyname(vm_) is None:\n raise SaltCloudSystemExit(\n 'The required \\'keyname\\' configuration setting is missing from the '\n '\\'ec2\\' driver.'\n )\n\n data, vm_ = request_instance(vm_, location)\n\n # If data is a str, it's an error\n if isinstance(data, six.string_types):\n log.error('Error requesting instance: %s', data)\n return {}\n\n # Pull the instance ID, valid for both spot and normal instances\n\n # Multiple instances may have been spun up, get all their IDs\n vm_['instance_id_list'] = []\n for instance in data:\n vm_['instance_id_list'].append(instance['instanceId'])\n\n vm_['instance_id'] = vm_['instance_id_list'].pop()\n if vm_['instance_id_list']:\n # Multiple instances were spun up, get one now, and queue the rest\n queue_instances(vm_['instance_id_list'])\n\n # Wait for vital information, such as IP addresses, to be available\n # for the new instance\n data = query_instance(vm_)\n\n # Now that the instance is available, tag it appropriately. Should\n # mitigate race conditions with tags\n tags = config.get_cloud_config_value('tag',\n vm_,\n __opts__,\n {},\n search_global=False)\n if not isinstance(tags, dict):\n raise SaltCloudConfigError(\n '\\'tag\\' should be a dict.'\n )\n\n for value in six.itervalues(tags):\n if not isinstance(value, six.string_types):\n raise SaltCloudConfigError(\n '\\'tag\\' values must be strings. Try quoting the values. '\n 'e.g. \"2013-09-19T20:09:46Z\".'\n )\n\n tags['Name'] = vm_['name']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/{0}/tagging'.format(vm_['name']),\n args={'tags': tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n salt.utils.cloud.wait_for_fun(\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=tags,\n instance_id=vm_['instance_id'],\n call='action',\n location=location\n )\n\n # Once instance tags are set, tag the spot request if configured\n if 'spot_config' in vm_ and 'tag' in vm_['spot_config']:\n\n if not isinstance(vm_['spot_config']['tag'], dict):\n raise SaltCloudConfigError(\n '\\'tag\\' should be a dict.'\n )\n\n for value in six.itervalues(vm_['spot_config']['tag']):\n if not isinstance(value, str):\n raise SaltCloudConfigError(\n '\\'tag\\' values must be strings. Try quoting the values. '\n 'e.g. \"2013-09-19T20:09:46Z\".'\n )\n\n spot_request_tags = {}\n\n if 'spotRequestId' not in vm_:\n raise SaltCloudConfigError('Failed to find spotRequestId')\n\n sir_id = vm_['spotRequestId']\n\n spot_request_tags['Name'] = vm_['name']\n\n for k, v in six.iteritems(vm_['spot_config']['tag']):\n spot_request_tags[k] = v\n\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/spot_request_{0}/tagging'.format(sir_id),\n args={'tags': spot_request_tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n salt.utils.cloud.wait_for_fun(\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=spot_request_tags,\n instance_id=sir_id,\n call='action',\n location=location\n )\n\n network_interfaces = config.get_cloud_config_value(\n 'network_interfaces',\n vm_,\n __opts__,\n search_global=False\n )\n\n if network_interfaces:\n _update_enis(network_interfaces, data, vm_)\n\n # At this point, the node is created and tagged, and now needs to be\n # bootstrapped, once the necessary port is available.\n log.info('Created node %s', vm_['name'])\n\n instance = data[0]['instancesSet']['item']\n\n # Wait for the necessary port to become available to bootstrap\n if ssh_interface(vm_) == 'private_ips':\n ip_address = instance['privateIpAddress']\n log.info('Salt node data. Private_ip: %s', ip_address)\n else:\n ip_address = instance['ipAddress']\n log.info('Salt node data. Public_ip: %s', ip_address)\n vm_['ssh_host'] = ip_address\n\n if salt.utils.cloud.get_salt_interface(vm_, __opts__) == 'private_ips':\n salt_ip_address = instance['privateIpAddress']\n log.info('Salt interface set to: %s', salt_ip_address)\n else:\n salt_ip_address = instance['ipAddress']\n log.debug('Salt interface set to: %s', salt_ip_address)\n vm_['salt_host'] = salt_ip_address\n\n if deploy:\n display_ssh_output = config.get_cloud_config_value(\n 'display_ssh_output', vm_, __opts__, default=True\n )\n\n vm_ = wait_for_instance(\n vm_, data, ip_address, display_ssh_output\n )\n\n # The instance is booted and accessible, let's Salt it!\n ret = instance.copy()\n\n # Get ANY defined volumes settings, merging data, in the following order\n # 1. VM config\n # 2. Profile config\n # 3. Global configuration\n volumes = config.get_cloud_config_value(\n 'volumes', vm_, __opts__, search_global=True\n )\n if volumes:\n __utils__['cloud.fire_event'](\n 'event',\n 'attaching volumes',\n 'salt/cloud/{0}/attaching_volumes'.format(vm_['name']),\n args={'volumes': volumes},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n log.info('Create and attach volumes to node %s', vm_['name'])\n created = create_attach_volumes(\n vm_['name'],\n {\n 'volumes': volumes,\n 'zone': ret['placement']['availabilityZone'],\n 'instance_id': ret['instanceId'],\n 'del_all_vols_on_destroy': vm_.get('del_all_vols_on_destroy', False)\n },\n call='action'\n )\n ret['Attached Volumes'] = created\n\n # Associate instance with a ssm document, if present\n ssm_document = config.get_cloud_config_value(\n 'ssm_document', vm_, __opts__, None, search_global=False\n )\n if ssm_document:\n log.debug('Associating with ssm document: %s', ssm_document)\n assoc = ssm_create_association(\n vm_['name'],\n {'ssm_document': ssm_document},\n instance_id=vm_['instance_id'],\n call='action'\n )\n if isinstance(assoc, dict) and assoc.get('error', None):\n log.error(\n 'Failed to associate instance %s with ssm document %s',\n vm_['instance_id'], ssm_document\n )\n return {}\n\n for key, value in six.iteritems(__utils__['cloud.bootstrap'](vm_, __opts__)):\n ret.setdefault(key, value)\n\n log.info('Created Cloud VM \\'%s\\'', vm_['name'])\n log.debug(\n '\\'%s\\' VM creation details:\\n%s',\n vm_['name'], pprint.pformat(instance)\n )\n\n event_data = {\n 'name': vm_['name'],\n 'profile': vm_['profile'],\n 'provider': vm_['driver'],\n 'instance_id': vm_['instance_id'],\n }\n if volumes:\n event_data['volumes'] = volumes\n if ssm_document:\n event_data['ssm_document'] = ssm_document\n\n __utils__['cloud.fire_event'](\n 'event',\n 'created instance',\n 'salt/cloud/{0}/created'.format(vm_['name']),\n args=__utils__['cloud.filter_event']('created', event_data, list(event_data)),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n # Ensure that the latest node data is returned\n node = _get_node(instance_id=vm_['instance_id'])\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n ret.update(node)\n\n # Add any block device tags specified\n ex_blockdevicetags = {}\n blockdevicemappings_holder = block_device_mappings(vm_)\n if blockdevicemappings_holder:\n for _bd in blockdevicemappings_holder:\n if 'tag' in _bd:\n ex_blockdevicetags[_bd['DeviceName']] = _bd['tag']\n\n block_device_volume_id_map = {}\n\n if ex_blockdevicetags:\n for _device, _map in six.iteritems(ret['blockDeviceMapping']):\n bd_items = []\n if isinstance(_map, dict):\n bd_items.append(_map)\n else:\n for mapitem in _map:\n bd_items.append(mapitem)\n\n for blockitem in bd_items:\n if blockitem['deviceName'] in ex_blockdevicetags and 'Name' not in ex_blockdevicetags[blockitem['deviceName']]:\n ex_blockdevicetags[blockitem['deviceName']]['Name'] = vm_['name']\n if blockitem['deviceName'] in ex_blockdevicetags:\n block_device_volume_id_map[blockitem[ret['rootDeviceType']]['volumeId']] = ex_blockdevicetags[blockitem['deviceName']]\n\n if block_device_volume_id_map:\n\n for volid, tags in six.iteritems(block_device_volume_id_map):\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/block_volume_{0}/tagging'.format(str(volid)),\n args={'tags': tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n __utils__['cloud.wait_for_fun'](\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=tags,\n resource_id=volid,\n call='action',\n location=location\n )\n\n return ret\n\n\ndef queue_instances(instances):\n '''\n Queue a set of instances to be provisioned later. Expects a list.\n\n Currently this only queries node data, and then places it in the cloud\n cache (if configured). If the salt-cloud-reactor is being used, these\n instances will be automatically provisioned using that.\n\n For more information about the salt-cloud-reactor, see:\n\n https://github.com/saltstack-formulas/salt-cloud-reactor\n '''\n for instance_id in instances:\n node = _get_node(instance_id=instance_id)\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n\n\ndef create_attach_volumes(name, kwargs, call=None, wait_to_finish=True):\n '''\n Create and attach volumes to created node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The create_attach_volumes action must be called with '\n '-a or --action.'\n )\n\n if 'instance_id' not in kwargs:\n kwargs['instance_id'] = _get_node(name)['instanceId']\n\n if isinstance(kwargs['volumes'], six.string_types):\n volumes = salt.utils.yaml.safe_load(kwargs['volumes'])\n else:\n volumes = kwargs['volumes']\n\n ret = []\n for volume in volumes:\n created = False\n volume_name = '{0} on {1}'.format(volume['device'], name)\n\n volume_dict = {\n 'volume_name': volume_name,\n 'zone': kwargs['zone']\n }\n if 'volume_id' in volume:\n volume_dict['volume_id'] = volume['volume_id']\n elif 'snapshot' in volume:\n volume_dict['snapshot'] = volume['snapshot']\n elif 'size' in volume:\n volume_dict['size'] = volume['size']\n else:\n raise SaltCloudConfigError(\n 'Cannot create volume. Please define one of \\'volume_id\\', '\n '\\'snapshot\\', or \\'size\\''\n )\n\n if 'tags' in volume:\n volume_dict['tags'] = volume['tags']\n if 'type' in volume:\n volume_dict['type'] = volume['type']\n if 'iops' in volume:\n volume_dict['iops'] = volume['iops']\n if 'encrypted' in volume:\n volume_dict['encrypted'] = volume['encrypted']\n if 'kmskeyid' in volume:\n volume_dict['kmskeyid'] = volume['kmskeyid']\n\n if 'volume_id' not in volume_dict:\n created_volume = create_volume(volume_dict, call='function', wait_to_finish=wait_to_finish)\n created = True\n if 'volumeId' in created_volume:\n volume_dict['volume_id'] = created_volume['volumeId']\n\n attach = attach_volume(\n name,\n {'volume_id': volume_dict['volume_id'],\n 'device': volume['device']},\n instance_id=kwargs['instance_id'],\n call='action'\n )\n\n # Update the delvol parameter for this volume\n delvols_on_destroy = kwargs.get('del_all_vols_on_destroy', None)\n\n if attach and created and delvols_on_destroy is not None:\n _toggle_delvol(instance_id=kwargs['instance_id'],\n device=volume['device'],\n value=delvols_on_destroy)\n\n if attach:\n msg = (\n '{0} attached to {1} (aka {2}) as device {3}'.format(\n volume_dict['volume_id'],\n kwargs['instance_id'],\n name,\n volume['device']\n )\n )\n log.info(msg)\n ret.append(msg)\n return ret\n\n\ndef stop(name, call=None):\n '''\n Stop a node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The stop action must be called with -a or --action.'\n )\n\n log.info('Stopping node %s', name)\n\n instance_id = _get_node(name)['instanceId']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'stopping instance',\n 'salt/cloud/{0}/stopping'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n params = {'Action': 'StopInstances',\n 'InstanceId.1': instance_id}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n return result\n\n\ndef start(name, call=None):\n '''\n Start a node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The start action must be called with -a or --action.'\n )\n\n log.info('Starting node %s', name)\n\n instance_id = _get_node(name)['instanceId']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'starting instance',\n 'salt/cloud/{0}/starting'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n params = {'Action': 'StartInstances',\n 'InstanceId.1': instance_id}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n return result\n\n\ndef set_tags(name=None,\n tags=None,\n call=None,\n location=None,\n instance_id=None,\n resource_id=None,\n kwargs=None): # pylint: disable=W0613\n '''\n Set tags for a resource. Normally a VM name or instance_id is passed in,\n but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a set_tags mymachine tag1=somestuff tag2='Other stuff'\n salt-cloud -a set_tags resource_id=vol-3267ab32 tag=somestuff\n '''\n if kwargs is None:\n kwargs = {}\n\n if location is None:\n location = get_location()\n\n if instance_id is None:\n if 'resource_id' in kwargs:\n resource_id = kwargs['resource_id']\n del kwargs['resource_id']\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n if resource_id is None:\n if instance_id is None:\n instance_id = _get_node(name=name, instance_id=None, location=location)['instanceId']\n else:\n instance_id = resource_id\n\n # This second check is a safety, in case the above still failed to produce\n # a usable ID\n if instance_id is None:\n return {\n 'Error': 'A valid instance_id or resource_id was not specified.'\n }\n\n params = {'Action': 'CreateTags',\n 'ResourceId.1': instance_id}\n\n log.debug('Tags to set for %s: %s', name, tags)\n\n if kwargs and not tags:\n tags = kwargs\n\n for idx, (tag_k, tag_v) in enumerate(six.iteritems(tags)):\n params['Tag.{0}.Key'.format(idx)] = tag_k\n params['Tag.{0}.Value'.format(idx)] = tag_v\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n aws.query(params,\n setname='tagSet',\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n settags = get_tags(\n instance_id=instance_id, call='action', location=location\n )\n\n log.debug('Setting the tags returned: %s', settags)\n\n failed_to_set_tags = False\n for tag in settags:\n if tag['key'] not in tags:\n # We were not setting this tag\n continue\n\n if tag.get('value') is None and tags.get(tag['key']) == '':\n # This is a correctly set tag with no value\n continue\n\n if six.text_type(tags.get(tag['key'])) != six.text_type(tag['value']):\n # Not set to the proper value!?\n log.debug(\n 'Setting the tag %s returned %s instead of %s',\n tag['key'], tags.get(tag['key']), tag['value']\n )\n failed_to_set_tags = True\n break\n\n if failed_to_set_tags:\n log.warning('Failed to set tags. Remaining attempts %s', attempts)\n attempts += 1\n aws.sleep_exponential_backoff(attempts)\n continue\n\n return settags\n\n raise SaltCloudSystemExit(\n 'Failed to set tags on {0}!'.format(name)\n )\n\n\ndef get_tags(name=None,\n instance_id=None,\n call=None,\n location=None,\n kwargs=None,\n resource_id=None): # pylint: disable=W0613\n '''\n Retrieve tags for a resource. Normally a VM name or instance_id is passed\n in, but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a get_tags mymachine\n salt-cloud -a get_tags resource_id=vol-3267ab32\n '''\n if location is None:\n location = get_location()\n\n if instance_id is None:\n if resource_id is None:\n if name:\n instance_id = _get_node(name)['instanceId']\n elif 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n elif 'resource_id' in kwargs:\n instance_id = kwargs['resource_id']\n else:\n instance_id = resource_id\n\n params = {'Action': 'DescribeTags',\n 'Filter.1.Name': 'resource-id',\n 'Filter.1.Value': instance_id}\n\n return aws.query(params,\n setname='tagSet',\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n\ndef del_tags(name=None,\n kwargs=None,\n call=None,\n instance_id=None,\n resource_id=None): # pylint: disable=W0613\n '''\n Delete tags for a resource. Normally a VM name or instance_id is passed in,\n but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a del_tags mymachine tags=mytag,\n salt-cloud -a del_tags mymachine tags=tag1,tag2,tag3\n salt-cloud -a del_tags resource_id=vol-3267ab32 tags=tag1,tag2,tag3\n '''\n if kwargs is None:\n kwargs = {}\n\n if 'tags' not in kwargs:\n raise SaltCloudSystemExit(\n 'A tag or tags must be specified using tags=list,of,tags'\n )\n\n if not name and 'resource_id' in kwargs:\n instance_id = kwargs['resource_id']\n del kwargs['resource_id']\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n params = {'Action': 'DeleteTags',\n 'ResourceId.1': instance_id}\n\n for idx, tag in enumerate(kwargs['tags'].split(',')):\n params['Tag.{0}.Key'.format(idx)] = tag\n\n aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if resource_id:\n return get_tags(resource_id=resource_id)\n else:\n return get_tags(instance_id=instance_id)\n\n\ndef rename(name, kwargs, call=None):\n '''\n Properly rename a node. Pass in the new name as \"new name\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a rename mymachine newname=yourmachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The rename action must be called with -a or --action.'\n )\n\n log.info('Renaming %s to %s', name, kwargs['newname'])\n\n set_tags(name, {'Name': kwargs['newname']}, call='action')\n\n salt.utils.cloud.rename_key(\n __opts__['pki_dir'], name, kwargs['newname']\n )\n\n\ndef destroy(name, call=None):\n '''\n Destroy a node. Will check termination protection and warn if enabled.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud --destroy mymachine\n '''\n if call == 'function':\n raise SaltCloudSystemExit(\n 'The destroy action must be called with -d, --destroy, '\n '-a or --action.'\n )\n\n node_metadata = _get_node(name)\n instance_id = node_metadata['instanceId']\n sir_id = node_metadata.get('spotInstanceRequestId')\n protected = show_term_protect(\n name=name,\n instance_id=instance_id,\n call='action',\n quiet=True\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'destroying instance',\n 'salt/cloud/{0}/destroying'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n if protected == 'true':\n raise SaltCloudSystemExit(\n 'This instance has been protected from being destroyed. '\n 'Use the following command to disable protection:\\n\\n'\n 'salt-cloud -a disable_term_protect {0}'.format(\n name\n )\n )\n\n ret = {}\n\n # Default behavior is to rename EC2 VMs when destroyed\n # via salt-cloud, unless explicitly set to False.\n rename_on_destroy = config.get_cloud_config_value('rename_on_destroy',\n get_configured_provider(),\n __opts__,\n search_global=False)\n if rename_on_destroy is not False:\n newname = '{0}-DEL{1}'.format(name, uuid.uuid4().hex)\n rename(name, kwargs={'newname': newname}, call='action')\n log.info(\n 'Machine will be identified as %s until it has been '\n 'cleaned up.', newname\n )\n ret['newname'] = newname\n\n params = {'Action': 'TerminateInstances',\n 'InstanceId.1': instance_id}\n\n location = get_location()\n provider = get_provider()\n result = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n\n log.info(result)\n ret.update(result[0])\n\n # If this instance is part of a spot instance request, we\n # need to cancel it as well\n if sir_id is not None:\n params = {'Action': 'CancelSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n result = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n ret['spotInstance'] = result[0]\n\n __utils__['cloud.fire_event'](\n 'event',\n 'destroyed instance',\n 'salt/cloud/{0}/destroyed'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n __utils__['cloud.cachedir_index_del'](name)\n\n if __opts__.get('update_cachedir', False) is True:\n __utils__['cloud.delete_minion_cachedir'](name, __active_provider_name__.split(':')[0], __opts__)\n\n return ret\n\n\ndef reboot(name, call=None):\n '''\n Reboot a node.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a reboot mymachine\n '''\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'RebootInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if result == []:\n log.info('Complete')\n\n return {'Reboot': 'Complete'}\n\n\ndef show_image(kwargs, call=None):\n '''\n Show the details from EC2 concerning an AMI\n '''\n if call != 'function':\n raise SaltCloudSystemExit(\n 'The show_image action must be called with -f or --function.'\n )\n\n params = {'ImageId.1': kwargs['image'],\n 'Action': 'DescribeImages'}\n result = aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n log.info(result)\n\n return result\n\n\ndef show_instance(name=None, instance_id=None, call=None, kwargs=None):\n '''\n Show the details from EC2 concerning an AMI.\n\n Can be called as an action (which requires a name):\n\n .. code-block:: bash\n\n salt-cloud -a show_instance myinstance\n\n ...or as a function (which requires either a name or instance_id):\n\n .. code-block:: bash\n\n salt-cloud -f show_instance my-ec2 name=myinstance\n salt-cloud -f show_instance my-ec2 instance_id=i-d34db33f\n '''\n if not name and call == 'action':\n raise SaltCloudSystemExit(\n 'The show_instance action requires a name.'\n )\n\n if call == 'function':\n name = kwargs.get('name', None)\n instance_id = kwargs.get('instance_id', None)\n\n if not name and not instance_id:\n raise SaltCloudSystemExit(\n 'The show_instance function requires '\n 'either a name or an instance_id'\n )\n\n node = _get_node(name=name, instance_id=instance_id)\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n return node\n\n\ndef _get_node(name=None, instance_id=None, location=None):\n if location is None:\n location = get_location()\n\n params = {'Action': 'DescribeInstances'}\n\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if instance_id:\n params['InstanceId.1'] = instance_id\n else:\n params['Filter.1.Name'] = 'tag:Name'\n params['Filter.1.Value.1'] = name\n\n log.trace(params)\n\n provider = get_provider()\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n try:\n instances = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n instance_info = _extract_instance_info(instances).values()\n return next(iter(instance_info))\n except IndexError:\n attempts += 1\n log.debug(\n 'Failed to get the data for node \\'%s\\'. Remaining '\n 'attempts: %s', instance_id or name, attempts\n )\n aws.sleep_exponential_backoff(attempts)\n return {}\n\n\ndef list_nodes_full(location=None, call=None):\n '''\n Return a list of the VMs that are on the provider\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes_full function must be called with -f '\n 'or --function.'\n )\n\n return _list_nodes_full(location or get_location())\n\n\ndef _extract_name_tag(item):\n if 'tagSet' in item and item['tagSet'] is not None:\n tagset = item['tagSet']\n if isinstance(tagset['item'], list):\n for tag in tagset['item']:\n if tag['key'] == 'Name':\n return tag['value']\n return item['instanceId']\n return item['tagSet']['item']['value']\n return item['instanceId']\n\n\ndef _extract_instance_info(instances):\n '''\n Given an instance query, return a dict of all instance data\n '''\n ret = {}\n for instance in instances:\n # items could be type dict or list (for stopped EC2 instances)\n if isinstance(instance['instancesSet']['item'], list):\n for item in instance['instancesSet']['item']:\n name = _extract_name_tag(item)\n ret[name] = item\n ret[name]['name'] = name\n ret[name].update(\n dict(\n id=item['instanceId'],\n image=item['imageId'],\n size=item['instanceType'],\n state=item['instanceState']['name'],\n private_ips=item.get('privateIpAddress', []),\n public_ips=item.get('ipAddress', [])\n )\n )\n else:\n item = instance['instancesSet']['item']\n name = _extract_name_tag(item)\n ret[name] = item\n ret[name]['name'] = name\n ret[name].update(\n dict(\n id=item['instanceId'],\n image=item['imageId'],\n size=item['instanceType'],\n state=item['instanceState']['name'],\n private_ips=item.get('privateIpAddress', []),\n public_ips=item.get('ipAddress', [])\n )\n )\n\n return ret\n\n\ndef _list_nodes_full(location=None):\n '''\n Return a list of the VMs that in this location\n '''\n provider = __active_provider_name__ or 'ec2'\n if ':' in provider:\n comps = provider.split(':')\n provider = comps[0]\n\n params = {'Action': 'DescribeInstances'}\n instances = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if 'error' in instances:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n instances['error']['Errors']['Error']['Message']\n )\n )\n\n ret = _extract_instance_info(instances)\n\n __utils__['cloud.cache_node_list'](ret, provider, __opts__)\n return ret\n\n\ndef list_nodes_min(location=None, call=None):\n '''\n Return a list of the VMs that are on the provider. Only a list of VM names,\n and their state, is returned. This is the minimum amount of information\n needed to check for existing VMs.\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes_min function must be called with -f or --function.'\n )\n\n ret = {}\n params = {'Action': 'DescribeInstances'}\n instances = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in instances:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n instances['error']['Errors']['Error']['Message']\n )\n )\n\n for instance in instances:\n if isinstance(instance['instancesSet']['item'], list):\n items = instance['instancesSet']['item']\n else:\n items = [instance['instancesSet']['item']]\n\n for item in items:\n state = item['instanceState']['name']\n name = _extract_name_tag(item)\n id = item['instanceId']\n ret[name] = {'state': state, 'id': id}\n return ret\n\n\ndef list_nodes(call=None):\n '''\n Return a list of the VMs that are on the provider\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes function must be called with -f or --function.'\n )\n\n ret = {}\n nodes = list_nodes_full(get_location())\n if 'error' in nodes:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n nodes['error']['Errors']['Error']['Message']\n )\n )\n for node in nodes:\n ret[node] = {\n 'id': nodes[node]['id'],\n 'image': nodes[node]['image'],\n 'name': nodes[node]['name'],\n 'size': nodes[node]['size'],\n 'state': nodes[node]['state'],\n 'private_ips': nodes[node]['private_ips'],\n 'public_ips': nodes[node]['public_ips'],\n }\n return ret\n\n\ndef list_nodes_select(call=None):\n '''\n Return a list of the VMs that are on the provider, with select fields\n '''\n return salt.utils.cloud.list_nodes_select(\n list_nodes_full(get_location()), __opts__['query.selection'], call,\n )\n\n\ndef show_term_protect(name=None, instance_id=None, call=None, quiet=False):\n '''\n Show the details from EC2 concerning an instance's termination protection state\n\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_term_protect action must be called with -a or --action.'\n )\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'DescribeInstanceAttribute',\n 'InstanceId': instance_id,\n 'Attribute': 'disableApiTermination'}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n disable_protect = False\n for item in result:\n if 'value' in item:\n disable_protect = item['value']\n break\n\n log.log(\n logging.DEBUG if quiet is True else logging.INFO,\n 'Termination Protection is %s for %s',\n disable_protect == 'true' and 'enabled' or 'disabled', name\n )\n\n return disable_protect\n\n\ndef show_detailed_monitoring(name=None, instance_id=None, call=None, quiet=False):\n '''\n Show the details from EC2 regarding cloudwatch detailed monitoring.\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_detailed_monitoring action must be called with -a or --action.'\n )\n location = get_location()\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if not name and not instance_id:\n raise SaltCloudSystemExit(\n 'The show_detailed_monitoring action must be provided with a name or instance\\\n ID'\n )\n matched = _get_node(name=name, instance_id=instance_id, location=location)\n log.log(\n logging.DEBUG if quiet is True else logging.INFO,\n 'Detailed Monitoring is %s for %s', matched['monitoring'], name\n )\n return matched['monitoring']\n\n\ndef _toggle_term_protect(name, value):\n '''\n Enable or Disable termination protection on a node\n\n '''\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'ModifyInstanceAttribute',\n 'InstanceId': instance_id,\n 'DisableApiTermination.Value': value}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_term_protect(name=name, instance_id=instance_id, call='action')\n\n\ndef enable_term_protect(name, call=None):\n '''\n Enable termination protection on a node\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a enable_term_protect mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n return _toggle_term_protect(name, 'true')\n\n\ndef disable_term_protect(name, call=None):\n '''\n Disable termination protection on a node\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a disable_term_protect mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n return _toggle_term_protect(name, 'false')\n\n\ndef disable_detailed_monitoring(name, call=None):\n '''\n Enable/disable detailed monitoring on a node\n\n CLI Example:\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'UnmonitorInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_detailed_monitoring(name=name, instance_id=instance_id, call='action')\n\n\ndef enable_detailed_monitoring(name, call=None):\n '''\n Enable/disable detailed monitoring on a node\n\n CLI Example:\n\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'MonitorInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_detailed_monitoring(name=name, instance_id=instance_id, call='action')\n\n\ndef show_delvol_on_destroy(name, kwargs=None, call=None):\n '''\n Do not delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a show_delvol_on_destroy mymachine\n '''\n\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_delvol_on_destroy action must be called '\n 'with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n instance_id = kwargs.get('instance_id', None)\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n if instance_id is None:\n instance_id = _get_node(name)['instanceId']\n\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n\n data = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n blockmap = data[0]['instancesSet']['item']['blockDeviceMapping']\n\n if not isinstance(blockmap['item'], list):\n blockmap['item'] = [blockmap['item']]\n\n items = []\n\n for idx, item in enumerate(blockmap['item']):\n device_name = item['deviceName']\n\n if device is not None and device != device_name:\n continue\n\n if volume_id is not None and volume_id != item['ebs']['volumeId']:\n continue\n\n info = {\n 'device_name': device_name,\n 'volume_id': item['ebs']['volumeId'],\n 'deleteOnTermination': item['ebs']['deleteOnTermination']\n }\n\n items.append(info)\n\n return items\n\n\ndef keepvol_on_destroy(name, kwargs=None, call=None):\n '''\n Do not delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a keepvol_on_destroy mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The keepvol_on_destroy action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n return _toggle_delvol(name=name, device=device,\n volume_id=volume_id, value='false')\n\n\ndef delvol_on_destroy(name, kwargs=None, call=None):\n '''\n Delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a delvol_on_destroy mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The delvol_on_destroy action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n return _toggle_delvol(name=name, device=device,\n volume_id=volume_id, value='true')\n\n\ndef _toggle_delvol(name=None, instance_id=None, device=None, volume_id=None,\n value=None, requesturl=None):\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if requesturl:\n data = aws.query(requesturl=requesturl,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n else:\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n data, requesturl = aws.query(params, # pylint: disable=unbalanced-tuple-unpacking\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n blockmap = data[0]['instancesSet']['item']['blockDeviceMapping']\n\n params = {'Action': 'ModifyInstanceAttribute',\n 'InstanceId': instance_id}\n\n if not isinstance(blockmap['item'], list):\n blockmap['item'] = [blockmap['item']]\n\n for idx, item in enumerate(blockmap['item']):\n device_name = item['deviceName']\n\n if device is not None and device != device_name:\n continue\n if volume_id is not None and volume_id != item['ebs']['volumeId']:\n continue\n\n params['BlockDeviceMapping.{0}.DeviceName'.format(idx)] = device_name\n params['BlockDeviceMapping.{0}.Ebs.DeleteOnTermination'.format(idx)] = value\n\n aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n kwargs = {'instance_id': instance_id,\n 'device': device,\n 'volume_id': volume_id}\n return show_delvol_on_destroy(name, kwargs, call='action')\n\n\ndef register_image(kwargs=None, call=None):\n '''\n Create an ami from a snapshot\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -f register_image my-ec2-config ami_name=my_ami description=\"my description\"\n root_device_name=/dev/xvda snapshot_id=snap-xxxxxxxx\n '''\n\n if call != 'function':\n log.error(\n 'The create_volume function must be called with -f or --function.'\n )\n return False\n\n if 'ami_name' not in kwargs:\n log.error('ami_name must be specified to register an image.')\n return False\n\n block_device_mapping = kwargs.get('block_device_mapping', None)\n if not block_device_mapping:\n if 'snapshot_id' not in kwargs:\n log.error('snapshot_id or block_device_mapping must be specified to register an image.')\n return False\n if 'root_device_name' not in kwargs:\n log.error('root_device_name or block_device_mapping must be specified to register an image.')\n return False\n block_device_mapping = [{\n 'DeviceName': kwargs['root_device_name'],\n 'Ebs': {\n 'VolumeType': kwargs.get('volume_type', 'gp2'),\n 'SnapshotId': kwargs['snapshot_id'],\n }\n }]\n\n if not isinstance(block_device_mapping, list):\n block_device_mapping = [block_device_mapping]\n\n params = {'Action': 'RegisterImage',\n 'Name': kwargs['ami_name']}\n\n params.update(_param_from_config('BlockDeviceMapping', block_device_mapping))\n\n if 'root_device_name' in kwargs:\n params['RootDeviceName'] = kwargs['root_device_name']\n\n if 'description' in kwargs:\n params['Description'] = kwargs['description']\n\n if 'virtualization_type' in kwargs:\n params['VirtualizationType'] = kwargs['virtualization_type']\n\n if 'architecture' in kwargs:\n params['Architecture'] = kwargs['architecture']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n r_data = {}\n for d in data[0]:\n for k, v in d.items():\n r_data[k] = v\n\n return r_data\n\n\ndef volume_create(**kwargs):\n '''\n Wrapper around create_volume.\n Here just to ensure the compatibility with the cloud module.\n '''\n return create_volume(kwargs, 'function')\n\n\ndef create_volume(kwargs=None, call=None, wait_to_finish=False):\n '''\n Create a volume.\n\n zone\n The availability zone used to create the volume. Required. String.\n\n size\n The size of the volume, in GiBs. Defaults to ``10``. Integer.\n\n snapshot\n The snapshot-id from which to create the volume. Integer.\n\n type\n The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned\n IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for\n Magnetic volumes. String.\n\n iops\n The number of I/O operations per second (IOPS) to provision for the volume,\n with a maximum ratio of 50 IOPS/GiB. Only valid for Provisioned IOPS SSD\n volumes. Integer.\n\n This option will only be set if ``type`` is also specified as ``io1``.\n\n encrypted\n Specifies whether the volume will be encrypted. Boolean.\n\n If ``snapshot`` is also given in the list of kwargs, then this value is ignored\n since volumes that are created from encrypted snapshots are also automatically\n encrypted.\n\n tags\n The tags to apply to the volume during creation. Dictionary.\n\n call\n The ``create_volume`` function must be called with ``-f`` or ``--function``.\n String.\n\n wait_to_finish\n Whether or not to wait for the volume to be available. Boolean. Defaults to\n ``False``.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f create_volume my-ec2-config zone=us-east-1b\n salt-cloud -f create_volume my-ec2-config zone=us-east-1b tags='{\"tag1\": \"val1\", \"tag2\", \"val2\"}'\n '''\n if call != 'function':\n log.error(\n 'The create_volume function must be called with -f or --function.'\n )\n return False\n\n if 'zone' not in kwargs:\n log.error('An availability zone must be specified to create a volume.')\n return False\n\n if 'size' not in kwargs and 'snapshot' not in kwargs:\n # This number represents GiB\n kwargs['size'] = '10'\n\n params = {'Action': 'CreateVolume',\n 'AvailabilityZone': kwargs['zone']}\n\n if 'size' in kwargs:\n params['Size'] = kwargs['size']\n\n if 'snapshot' in kwargs:\n params['SnapshotId'] = kwargs['snapshot']\n\n if 'type' in kwargs:\n params['VolumeType'] = kwargs['type']\n\n if 'iops' in kwargs and kwargs.get('type', 'standard') == 'io1':\n params['Iops'] = kwargs['iops']\n\n # You can't set `encrypted` if you pass a snapshot\n if 'encrypted' in kwargs and 'snapshot' not in kwargs:\n params['Encrypted'] = kwargs['encrypted']\n if 'kmskeyid' in kwargs:\n params['KmsKeyId'] = kwargs['kmskeyid']\n if 'kmskeyid' in kwargs and 'encrypted' not in kwargs:\n log.error(\n 'If a KMS Key ID is specified, encryption must be enabled'\n )\n return False\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n r_data = {}\n for d in data[0]:\n for k, v in six.iteritems(d):\n r_data[k] = v\n volume_id = r_data['volumeId']\n\n # Allow tags to be set upon creation\n if 'tags' in kwargs:\n if isinstance(kwargs['tags'], six.string_types):\n tags = salt.utils.yaml.safe_load(kwargs['tags'])\n else:\n tags = kwargs['tags']\n\n if isinstance(tags, dict):\n new_tags = set_tags(tags=tags,\n resource_id=volume_id,\n call='action',\n location=get_location())\n r_data['tags'] = new_tags\n\n # Waits till volume is available\n if wait_to_finish:\n salt.utils.cloud.run_func_until_ret_arg(fun=describe_volumes,\n kwargs={'volume_id': volume_id},\n fun_call=call,\n argument_being_watched='status',\n required_argument_response='available')\n\n return r_data\n\n\ndef __attach_vol_to_instance(params, kws, instance_id):\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if data[0]:\n log.warning(\n 'Error attaching volume %s to instance %s. Retrying!',\n kws['volume_id'], instance_id\n )\n return False\n\n return data\n\n\ndef attach_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Attach a volume to an instance\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The attach_volume action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n if 'device' not in kwargs:\n log.error('A device is required (ex. /dev/sdb1).')\n return False\n\n params = {'Action': 'AttachVolume',\n 'VolumeId': kwargs['volume_id'],\n 'InstanceId': instance_id,\n 'Device': kwargs['device']}\n\n log.debug(params)\n\n vm_ = get_configured_provider()\n\n data = salt.utils.cloud.wait_for_ip(\n __attach_vol_to_instance,\n update_args=(params, kwargs, instance_id),\n timeout=config.get_cloud_config_value(\n 'wait_for_ip_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_ip_interval', vm_, __opts__, default=10),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_ip_interval_multiplier', vm_, __opts__, default=1),\n )\n\n return data\n\n\ndef show_volume(kwargs=None, call=None):\n '''\n Wrapper around describe_volumes.\n Here just to keep functionality.\n Might be depreciated later.\n '''\n if not kwargs:\n kwargs = {}\n\n return describe_volumes(kwargs, call)\n\n\ndef detach_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Detach a volume from an instance\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The detach_volume action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n params = {'Action': 'DetachVolume',\n 'VolumeId': kwargs['volume_id']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef delete_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Delete a volume\n '''\n if not kwargs:\n kwargs = {}\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n params = {'Action': 'DeleteVolume',\n 'VolumeId': kwargs['volume_id']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef volume_list(**kwargs):\n '''\n Wrapper around describe_volumes.\n Here just to ensure the compatibility with the cloud module.\n '''\n return describe_volumes(kwargs, 'function')\n\n\ndef describe_volumes(kwargs=None, call=None):\n '''\n Describe a volume (or volumes)\n\n volume_id\n One or more volume IDs. Multiple IDs must be separated by \",\".\n\n TODO: Add all of the filters.\n '''\n if call != 'function':\n log.error(\n 'The describe_volumes function must be called with -f '\n 'or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n params = {'Action': 'DescribeVolumes'}\n\n if 'volume_id' in kwargs:\n volume_id = kwargs['volume_id'].split(',')\n for volume_index, volume_id in enumerate(volume_id):\n params['VolumeId.{0}'.format(volume_index)] = volume_id\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef create_keypair(kwargs=None, call=None):\n '''\n Create an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The create_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'CreateKeyPair',\n 'KeyName': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n keys = [x for x in data[0] if 'requestId' not in x]\n\n return (keys, data[1])\n\n\ndef import_keypair(kwargs=None, call=None):\n '''\n Import an SSH public key.\n\n .. versionadded:: 2015.8.3\n '''\n if call != 'function':\n log.error(\n 'The import_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n if 'file' not in kwargs:\n log.error('A public key file is required.')\n return False\n\n params = {'Action': 'ImportKeyPair',\n 'KeyName': kwargs['keyname']}\n\n public_key_file = kwargs['file']\n\n if os.path.exists(public_key_file):\n with salt.utils.files.fopen(public_key_file, 'r') as fh_:\n public_key = salt.utils.stringutils.to_unicode(fh_.read())\n\n if public_key is not None:\n params['PublicKeyMaterial'] = base64.b64encode(public_key)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef show_keypair(kwargs=None, call=None):\n '''\n Show the details of an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The show_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'DescribeKeyPairs',\n 'KeyName.1': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef delete_keypair(kwargs=None, call=None):\n '''\n Delete an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The delete_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'DeleteKeyPair',\n 'KeyName': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef create_snapshot(kwargs=None, call=None, wait_to_finish=False):\n '''\n Create a snapshot.\n\n volume_id\n The ID of the Volume from which to create a snapshot.\n\n description\n The optional description of the snapshot.\n\n CLI Exampe:\n\n .. code-block:: bash\n\n salt-cloud -f create_snapshot my-ec2-config volume_id=vol-351d8826\n salt-cloud -f create_snapshot my-ec2-config volume_id=vol-351d8826 \\\\\n description=\"My Snapshot Description\"\n '''\n if call != 'function':\n raise SaltCloudSystemExit(\n 'The create_snapshot function must be called with -f '\n 'or --function.'\n )\n\n if kwargs is None:\n kwargs = {}\n\n volume_id = kwargs.get('volume_id', None)\n description = kwargs.get('description', '')\n\n if volume_id is None:\n raise SaltCloudSystemExit(\n 'A volume_id must be specified to create a snapshot.'\n )\n\n params = {'Action': 'CreateSnapshot',\n 'VolumeId': volume_id,\n 'Description': description}\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')[0]\n\n r_data = {}\n for d in data:\n for k, v in six.iteritems(d):\n r_data[k] = v\n\n if 'snapshotId' in r_data:\n snapshot_id = r_data['snapshotId']\n\n # Waits till volume is available\n if wait_to_finish:\n salt.utils.cloud.run_func_until_ret_arg(fun=describe_snapshots,\n kwargs={'snapshot_id': snapshot_id},\n fun_call=call,\n argument_being_watched='status',\n required_argument_response='completed')\n\n return r_data\n\n\ndef delete_snapshot(kwargs=None, call=None):\n '''\n Delete a snapshot\n '''\n if call != 'function':\n log.error(\n 'The delete_snapshot function must be called with -f '\n 'or --function.'\n )\n return False\n\n if 'snapshot_id' not in kwargs:\n log.error('A snapshot_id must be specified to delete a snapshot.')\n return False\n\n params = {'Action': 'DeleteSnapshot'}\n\n if 'snapshot_id' in kwargs:\n params['SnapshotId'] = kwargs['snapshot_id']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef copy_snapshot(kwargs=None, call=None):\n '''\n Copy a snapshot\n '''\n if call != 'function':\n log.error(\n 'The copy_snapshot function must be called with -f or --function.'\n )\n return False\n\n if 'source_region' not in kwargs:\n log.error('A source_region must be specified to copy a snapshot.')\n return False\n\n if 'source_snapshot_id' not in kwargs:\n log.error('A source_snapshot_id must be specified to copy a snapshot.')\n return False\n\n if 'description' not in kwargs:\n kwargs['description'] = ''\n\n params = {'Action': 'CopySnapshot'}\n\n if 'source_region' in kwargs:\n params['SourceRegion'] = kwargs['source_region']\n\n if 'source_snapshot_id' in kwargs:\n params['SourceSnapshotId'] = kwargs['source_snapshot_id']\n\n if 'description' in kwargs:\n params['Description'] = kwargs['description']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef describe_snapshots(kwargs=None, call=None):\n '''\n Describe a snapshot (or snapshots)\n\n snapshot_id\n One or more snapshot IDs. Multiple IDs must be separated by \",\".\n\n owner\n Return the snapshots owned by the specified owner. Valid values\n include: self, amazon, <AWS Account ID>. Multiple values must be\n separated by \",\".\n\n restorable_by\n One or more AWS accounts IDs that can create volumes from the snapshot.\n Multiple aws account IDs must be separated by \",\".\n\n TODO: Add all of the filters.\n '''\n if call != 'function':\n log.error(\n 'The describe_snapshot function must be called with -f '\n 'or --function.'\n )\n return False\n\n params = {'Action': 'DescribeSnapshots'}\n\n # The AWS correct way is to use non-plurals like snapshot_id INSTEAD of snapshot_ids.\n if 'snapshot_ids' in kwargs:\n kwargs['snapshot_id'] = kwargs['snapshot_ids']\n\n if 'snapshot_id' in kwargs:\n snapshot_ids = kwargs['snapshot_id'].split(',')\n for snapshot_index, snapshot_id in enumerate(snapshot_ids):\n params['SnapshotId.{0}'.format(snapshot_index)] = snapshot_id\n\n if 'owner' in kwargs:\n owners = kwargs['owner'].split(',')\n for owner_index, owner in enumerate(owners):\n params['Owner.{0}'.format(owner_index)] = owner\n\n if 'restorable_by' in kwargs:\n restorable_bys = kwargs['restorable_by'].split(',')\n for restorable_by_index, restorable_by in enumerate(restorable_bys):\n params[\n 'RestorableBy.{0}'.format(restorable_by_index)\n ] = restorable_by\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef get_console_output(\n name=None,\n location=None,\n instance_id=None,\n call=None,\n kwargs=None,\n ):\n '''\n Show the console output from the instance.\n\n By default, returns decoded data, not the Base64-encoded data that is\n actually returned from the EC2 API.\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The get_console_output action must be called with '\n '-a or --action.'\n )\n\n if location is None:\n location = get_location()\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if kwargs is None:\n kwargs = {}\n\n if instance_id is None:\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n params = {'Action': 'GetConsoleOutput',\n 'InstanceId': instance_id}\n\n ret = {}\n data = aws.query(params,\n return_root=True,\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for item in data:\n if next(six.iterkeys(item)) == 'output':\n ret['output_decoded'] = binascii.a2b_base64(next(six.itervalues(item)))\n else:\n ret[next(six.iterkeys(item))] = next(six.itervalues(item))\n\n return ret\n\n\ndef get_password_data(\n name=None,\n kwargs=None,\n instance_id=None,\n call=None,\n ):\n '''\n Return password data for a Windows instance.\n\n By default only the encrypted password data will be returned. However, if a\n key_file is passed in, then a decrypted password will also be returned.\n\n Note that the key_file references the private key that was used to generate\n the keypair associated with this instance. This private key will _not_ be\n transmitted to Amazon; it is only used internally inside of Salt Cloud to\n decrypt data _after_ it has been received from Amazon.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a get_password_data mymachine\n salt-cloud -a get_password_data mymachine key_file=/root/ec2key.pem\n\n Note: PKCS1_v1_5 was added in PyCrypto 2.5\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The get_password_data action must be called with '\n '-a or --action.'\n )\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if kwargs is None:\n kwargs = {}\n\n if instance_id is None:\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n params = {'Action': 'GetPasswordData',\n 'InstanceId': instance_id}\n\n ret = {}\n data = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for item in data:\n ret[next(six.iterkeys(item))] = next(six.itervalues(item))\n\n if not HAS_M2 and not HAS_PYCRYPTO:\n return ret\n\n if 'key' not in kwargs:\n if 'key_file' in kwargs:\n with salt.utils.files.fopen(kwargs['key_file'], 'r') as kf_:\n kwargs['key'] = salt.utils.stringutils.to_unicode(kf_.read())\n\n if 'key' in kwargs:\n pwdata = ret.get('passwordData', None)\n if pwdata is not None:\n rsa_key = kwargs['key']\n pwdata = base64.b64decode(pwdata)\n if HAS_M2:\n key = RSA.load_key_string(rsa_key.encode('ascii'))\n password = key.private_decrypt(pwdata, RSA.pkcs1_padding)\n else:\n dsize = Crypto.Hash.SHA.digest_size\n sentinel = Crypto.Random.new().read(15 + dsize)\n key_obj = Crypto.PublicKey.RSA.importKey(rsa_key)\n key_obj = PKCS1_v1_5.new(key_obj)\n password = key_obj.decrypt(pwdata, sentinel)\n ret['password'] = salt.utils.stringutils.to_unicode(password)\n\n return ret\n\n\ndef update_pricing(kwargs=None, call=None):\n '''\n Download most recent pricing information from AWS and convert to a local\n JSON file.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f update_pricing my-ec2-config\n salt-cloud -f update_pricing my-ec2-config type=linux\n\n .. versionadded:: 2015.8.0\n '''\n sources = {\n 'linux': 'https://a0.awsstatic.com/pricing/1/ec2/linux-od.min.js',\n 'rhel': 'https://a0.awsstatic.com/pricing/1/ec2/rhel-od.min.js',\n 'sles': 'https://a0.awsstatic.com/pricing/1/ec2/sles-od.min.js',\n 'mswin': 'https://a0.awsstatic.com/pricing/1/ec2/mswin-od.min.js',\n 'mswinsql': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQL-od.min.js',\n 'mswinsqlweb': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQLWeb-od.min.js',\n }\n\n if kwargs is None:\n kwargs = {}\n\n if 'type' not in kwargs:\n for source in sources:\n _parse_pricing(sources[source], source)\n else:\n _parse_pricing(sources[kwargs['type']], kwargs['type'])\n\n\n\ndef show_pricing(kwargs=None, call=None):\n '''\n Show pricing for a particular profile. This is only an estimate, based on\n unofficial pricing sources.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f show_pricing my-ec2-config profile=my-profile\n\n If pricing sources have not been cached, they will be downloaded. Once they\n have been cached, they will not be updated automatically. To manually update\n all prices, use the following command:\n\n .. code-block:: bash\n\n salt-cloud -f update_pricing <provider>\n\n .. versionadded:: 2015.8.0\n '''\n profile = __opts__['profiles'].get(kwargs['profile'], {})\n if not profile:\n return {'Error': 'The requested profile was not found'}\n\n # Make sure the profile belongs to ec2\n provider = profile.get('provider', '0:0')\n comps = provider.split(':')\n if len(comps) < 2 or comps[1] != 'ec2':\n return {'Error': 'The requested profile does not belong to EC2'}\n\n image_id = profile.get('image', None)\n image_dict = show_image({'image': image_id}, 'function')\n image_info = image_dict[0]\n\n # Find out what platform it is\n if image_info.get('imageOwnerAlias', '') == 'amazon':\n if image_info.get('platform', '') == 'windows':\n image_description = image_info.get('description', '')\n if 'sql' in image_description.lower():\n if 'web' in image_description.lower():\n name = 'mswinsqlweb'\n else:\n name = 'mswinsql'\n else:\n name = 'mswin'\n elif image_info.get('imageLocation', '').strip().startswith('amazon/suse'):\n name = 'sles'\n else:\n name = 'linux'\n elif image_info.get('imageOwnerId', '') == '309956199498':\n name = 'rhel'\n else:\n name = 'linux'\n\n pricefile = os.path.join(\n __opts__['cachedir'], 'ec2-pricing-{0}.p'.format(name)\n )\n\n if not os.path.isfile(pricefile):\n update_pricing({'type': name}, 'function')\n\n with salt.utils.files.fopen(pricefile, 'r') as fhi:\n ec2_price = salt.utils.stringutils.to_unicode(\n salt.utils.msgpack.load(fhi))\n\n region = get_location(profile)\n size = profile.get('size', None)\n if size is None:\n return {'Error': 'The requested profile does not contain a size'}\n\n try:\n raw = ec2_price[region][size]\n except KeyError:\n return {'Error': 'The size ({0}) in the requested profile does not have '\n 'a price associated with it for the {1} region'.format(size, region)}\n\n ret = {}\n if kwargs.get('raw', False):\n ret['_raw'] = raw\n\n ret['per_hour'] = 0\n for col in raw.get('valueColumns', []):\n ret['per_hour'] += decimal.Decimal(col['prices'].get('USD', 0))\n\n ret['per_hour'] = decimal.Decimal(ret['per_hour'])\n ret['per_day'] = ret['per_hour'] * 24\n ret['per_week'] = ret['per_day'] * 7\n ret['per_month'] = ret['per_day'] * 30\n ret['per_year'] = ret['per_week'] * 52\n\n return {profile['profile']: ret}\n\n\ndef ssm_create_association(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Associates the specified SSM document with the specified instance\n\n http://docs.aws.amazon.com/ssm/latest/APIReference/API_CreateAssociation.html\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a ssm_create_association ec2-instance-name ssm_document=ssm-document-name\n '''\n\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The ssm_create_association action must be called with '\n '-a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'ssm_document' not in kwargs:\n log.error('A ssm_document is required.')\n return False\n\n params = {'Action': 'CreateAssociation',\n 'InstanceId': instance_id,\n 'Name': kwargs['ssm_document']}\n\n result = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n product='ssm',\n opts=__opts__,\n sigver='4')\n log.info(result)\n return result\n\n\ndef ssm_describe_association(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Describes the associations for the specified SSM document or instance.\n\n http://docs.aws.amazon.com/ssm/latest/APIReference/API_DescribeAssociation.html\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a ssm_describe_association ec2-instance-name ssm_document=ssm-document-name\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The ssm_describe_association action must be called with '\n '-a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'ssm_document' not in kwargs:\n log.error('A ssm_document is required.')\n return False\n\n params = {'Action': 'DescribeAssociation',\n 'InstanceId': instance_id,\n 'Name': kwargs['ssm_document']}\n\n result = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n product='ssm',\n opts=__opts__,\n sigver='4')\n log.info(result)\n return result\n"}}},{"rowIdx":357,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/cloud/clouds/ec2.py"},"func_name":{"kind":"string","value":"show_pricing"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def show_pricing(kwargs=None, call=None):\n '''\n Show pricing for a particular profile. This is only an estimate, based on\n unofficial pricing sources.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f show_pricing my-ec2-config profile=my-profile\n\n If pricing sources have not been cached, they will be downloaded. Once they\n have been cached, they will not be updated automatically. To manually update\n all prices, use the following command:\n\n .. code-block:: bash\n\n salt-cloud -f update_pricing <provider>\n\n .. versionadded:: 2015.8.0\n '''\n profile = __opts__['profiles'].get(kwargs['profile'], {})\n if not profile:\n return {'Error': 'The requested profile was not found'}\n\n # Make sure the profile belongs to ec2\n provider = profile.get('provider', '0:0')\n comps = provider.split(':')\n if len(comps) < 2 or comps[1] != 'ec2':\n return {'Error': 'The requested profile does not belong to EC2'}\n\n image_id = profile.get('image', None)\n image_dict = show_image({'image': image_id}, 'function')\n image_info = image_dict[0]\n\n # Find out what platform it is\n if image_info.get('imageOwnerAlias', '') == 'amazon':\n if image_info.get('platform', '') == 'windows':\n image_description = image_info.get('description', '')\n if 'sql' in image_description.lower():\n if 'web' in image_description.lower():\n name = 'mswinsqlweb'\n else:\n name = 'mswinsql'\n else:\n name = 'mswin'\n elif image_info.get('imageLocation', '').strip().startswith('amazon/suse'):\n name = 'sles'\n else:\n name = 'linux'\n elif image_info.get('imageOwnerId', '') == '309956199498':\n name = 'rhel'\n else:\n name = 'linux'\n\n pricefile = os.path.join(\n __opts__['cachedir'], 'ec2-pricing-{0}.p'.format(name)\n )\n\n if not os.path.isfile(pricefile):\n update_pricing({'type': name}, 'function')\n\n with salt.utils.files.fopen(pricefile, 'r') as fhi:\n ec2_price = salt.utils.stringutils.to_unicode(\n salt.utils.msgpack.load(fhi))\n\n region = get_location(profile)\n size = profile.get('size', None)\n if size is None:\n return {'Error': 'The requested profile does not contain a size'}\n\n try:\n raw = ec2_price[region][size]\n except KeyError:\n return {'Error': 'The size ({0}) in the requested profile does not have '\n 'a price associated with it for the {1} region'.format(size, region)}\n\n ret = {}\n if kwargs.get('raw', False):\n ret['_raw'] = raw\n\n ret['per_hour'] = 0\n for col in raw.get('valueColumns', []):\n ret['per_hour'] += decimal.Decimal(col['prices'].get('USD', 0))\n\n ret['per_hour'] = decimal.Decimal(ret['per_hour'])\n ret['per_day'] = ret['per_hour'] * 24\n ret['per_week'] = ret['per_day'] * 7\n ret['per_month'] = ret['per_day'] * 30\n ret['per_year'] = ret['per_week'] * 52\n\n return {profile['profile']: ret}"},"func_documentation_string":{"kind":"string","value":"Show pricing for a particular profile. This is only an estimate, based on\n unofficial pricing sources.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f show_pricing my-ec2-config profile=my-profile\n\n If pricing sources have not been cached, they will be downloaded. Once they\n have been cached, they will not be updated automatically. To manually update\n all prices, use the following command:\n\n .. code-block:: bash\n\n salt-cloud -f update_pricing <provider>\n\n .. versionadded:: 2015.8.0"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L5024-L5115"},"called_functions":{"kind":"list like","value":["def unpack(stream, **kwargs):\n '''\n .. versionadded:: 2018.3.4\n\n Wraps msgpack.unpack.\n\n By default, this function uses the msgpack module and falls back to\n msgpack_pure, if the msgpack is not available. You can pass an alternate\n msgpack module using the _msgpack_module argument.\n '''\n msgpack_module = kwargs.pop('_msgpack_module', msgpack)\n return msgpack_module.unpack(stream, **kwargs)\n","def show_image(kwargs, call=None):\n '''\n Show the details from EC2 concerning an AMI\n '''\n if call != 'function':\n raise SaltCloudSystemExit(\n 'The show_image action must be called with -f or --function.'\n )\n\n params = {'ImageId.1': kwargs['image'],\n 'Action': 'DescribeImages'}\n result = aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n log.info(result)\n\n return result\n","def fopen(*args, **kwargs):\n '''\n Wrapper around open() built-in to set CLOEXEC on the fd.\n\n This flag specifies that the file descriptor should be closed when an exec\n function is invoked;\n\n When a file descriptor is allocated (as with open or dup), this bit is\n initially cleared on the new file descriptor, meaning that descriptor will\n survive into the new program after exec.\n\n NB! We still have small race condition between open and fcntl.\n '''\n if six.PY3:\n try:\n # Don't permit stdin/stdout/stderr to be opened. The boolean False\n # and True are treated by Python 3's open() as file descriptors 0\n # and 1, respectively.\n if args[0] in (0, 1, 2):\n raise TypeError(\n '{0} is not a permitted file descriptor'.format(args[0])\n )\n except IndexError:\n pass\n binary = None\n # ensure 'binary' mode is always used on Windows in Python 2\n if ((six.PY2 and salt.utils.platform.is_windows() and 'binary' not in kwargs) or\n kwargs.pop('binary', False)):\n if len(args) > 1:\n args = list(args)\n if 'b' not in args[1]:\n args[1] = args[1].replace('t', 'b')\n if 'b' not in args[1]:\n args[1] += 'b'\n elif kwargs.get('mode'):\n if 'b' not in kwargs['mode']:\n kwargs['mode'] = kwargs['mode'].replace('t', 'b')\n if 'b' not in kwargs['mode']:\n kwargs['mode'] += 'b'\n else:\n # the default is to read\n kwargs['mode'] = 'rb'\n elif six.PY3 and 'encoding' not in kwargs:\n # In Python 3, if text mode is used and the encoding\n # is not specified, set the encoding to 'utf-8'.\n binary = False\n if len(args) > 1:\n args = list(args)\n if 'b' in args[1]:\n binary = True\n if kwargs.get('mode', None):\n if 'b' in kwargs['mode']:\n binary = True\n if not binary:\n kwargs['encoding'] = __salt_system_encoding__\n\n if six.PY3 and not binary and not kwargs.get('newline', None):\n kwargs['newline'] = ''\n\n f_handle = open(*args, **kwargs) # pylint: disable=resource-leakage\n\n if is_fcntl_available():\n # modify the file descriptor on systems with fcntl\n # unix and unix-like systems only\n try:\n FD_CLOEXEC = fcntl.FD_CLOEXEC # pylint: disable=C0103\n except AttributeError:\n FD_CLOEXEC = 1 # pylint: disable=C0103\n old_flags = fcntl.fcntl(f_handle.fileno(), fcntl.F_GETFD)\n fcntl.fcntl(f_handle.fileno(), fcntl.F_SETFD, old_flags | FD_CLOEXEC)\n\n return f_handle\n","def to_unicode(s, encoding=None, errors='strict', normalize=False):\n '''\n Given str or unicode, return unicode (str for python 3)\n '''\n def _normalize(s):\n return unicodedata.normalize('NFC', s) if normalize else s\n\n if encoding is None:\n # Try utf-8 first, and fall back to detected encoding\n encoding = ('utf-8', __salt_system_encoding__)\n if not isinstance(encoding, (tuple, list)):\n encoding = (encoding,)\n\n if not encoding:\n raise ValueError('encoding cannot be empty')\n\n exc = None\n if six.PY3:\n if isinstance(s, str):\n return _normalize(s)\n elif isinstance(s, (bytes, bytearray)):\n return _normalize(to_str(s, encoding, errors))\n raise TypeError('expected str, bytes, or bytearray')\n else:\n # This needs to be str and not six.string_types, since if the string is\n # already a unicode type, it does not need to be decoded (and doing so\n # will raise an exception).\n if isinstance(s, unicode): # pylint: disable=incompatible-py3-code,undefined-variable\n return _normalize(s)\n elif isinstance(s, (str, bytearray)):\n for enc in encoding:\n try:\n return _normalize(s.decode(enc, errors))\n except UnicodeDecodeError as err:\n exc = err\n continue\n # The only way we get this far is if a UnicodeDecodeError was\n # raised, otherwise we would have already returned (or raised some\n # other exception).\n raise exc # pylint: disable=raising-bad-type\n raise TypeError('expected str or bytearray')\n","def get_location(vm_=None):\n '''\n Return the EC2 region to use, in this order:\n - CLI parameter\n - VM parameter\n - Cloud profile setting\n '''\n return __opts__.get(\n 'location',\n config.get_cloud_config_value(\n 'location',\n vm_ or get_configured_provider(),\n __opts__,\n default=DEFAULT_LOCATION,\n search_global=False\n )\n )\n","def update_pricing(kwargs=None, call=None):\n '''\n Download most recent pricing information from AWS and convert to a local\n JSON file.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f update_pricing my-ec2-config\n salt-cloud -f update_pricing my-ec2-config type=linux\n\n .. versionadded:: 2015.8.0\n '''\n sources = {\n 'linux': 'https://a0.awsstatic.com/pricing/1/ec2/linux-od.min.js',\n 'rhel': 'https://a0.awsstatic.com/pricing/1/ec2/rhel-od.min.js',\n 'sles': 'https://a0.awsstatic.com/pricing/1/ec2/sles-od.min.js',\n 'mswin': 'https://a0.awsstatic.com/pricing/1/ec2/mswin-od.min.js',\n 'mswinsql': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQL-od.min.js',\n 'mswinsqlweb': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQLWeb-od.min.js',\n }\n\n if kwargs is None:\n kwargs = {}\n\n if 'type' not in kwargs:\n for source in sources:\n _parse_pricing(sources[source], source)\n else:\n _parse_pricing(sources[kwargs['type']], kwargs['type'])\n"],"string":"[\n \"def unpack(stream, **kwargs):\\n '''\\n .. versionadded:: 2018.3.4\\n\\n Wraps msgpack.unpack.\\n\\n By default, this function uses the msgpack module and falls back to\\n msgpack_pure, if the msgpack is not available. You can pass an alternate\\n msgpack module using the _msgpack_module argument.\\n '''\\n msgpack_module = kwargs.pop('_msgpack_module', msgpack)\\n return msgpack_module.unpack(stream, **kwargs)\\n\",\n \"def show_image(kwargs, call=None):\\n '''\\n Show the details from EC2 concerning an AMI\\n '''\\n if call != 'function':\\n raise SaltCloudSystemExit(\\n 'The show_image action must be called with -f or --function.'\\n )\\n\\n params = {'ImageId.1': kwargs['image'],\\n 'Action': 'DescribeImages'}\\n result = aws.query(params,\\n setname='tagSet',\\n location=get_location(),\\n provider=get_provider(),\\n opts=__opts__,\\n sigver='4')\\n log.info(result)\\n\\n return result\\n\",\n \"def fopen(*args, **kwargs):\\n '''\\n Wrapper around open() built-in to set CLOEXEC on the fd.\\n\\n This flag specifies that the file descriptor should be closed when an exec\\n function is invoked;\\n\\n When a file descriptor is allocated (as with open or dup), this bit is\\n initially cleared on the new file descriptor, meaning that descriptor will\\n survive into the new program after exec.\\n\\n NB! We still have small race condition between open and fcntl.\\n '''\\n if six.PY3:\\n try:\\n # Don't permit stdin/stdout/stderr to be opened. The boolean False\\n # and True are treated by Python 3's open() as file descriptors 0\\n # and 1, respectively.\\n if args[0] in (0, 1, 2):\\n raise TypeError(\\n '{0} is not a permitted file descriptor'.format(args[0])\\n )\\n except IndexError:\\n pass\\n binary = None\\n # ensure 'binary' mode is always used on Windows in Python 2\\n if ((six.PY2 and salt.utils.platform.is_windows() and 'binary' not in kwargs) or\\n kwargs.pop('binary', False)):\\n if len(args) > 1:\\n args = list(args)\\n if 'b' not in args[1]:\\n args[1] = args[1].replace('t', 'b')\\n if 'b' not in args[1]:\\n args[1] += 'b'\\n elif kwargs.get('mode'):\\n if 'b' not in kwargs['mode']:\\n kwargs['mode'] = kwargs['mode'].replace('t', 'b')\\n if 'b' not in kwargs['mode']:\\n kwargs['mode'] += 'b'\\n else:\\n # the default is to read\\n kwargs['mode'] = 'rb'\\n elif six.PY3 and 'encoding' not in kwargs:\\n # In Python 3, if text mode is used and the encoding\\n # is not specified, set the encoding to 'utf-8'.\\n binary = False\\n if len(args) > 1:\\n args = list(args)\\n if 'b' in args[1]:\\n binary = True\\n if kwargs.get('mode', None):\\n if 'b' in kwargs['mode']:\\n binary = True\\n if not binary:\\n kwargs['encoding'] = __salt_system_encoding__\\n\\n if six.PY3 and not binary and not kwargs.get('newline', None):\\n kwargs['newline'] = ''\\n\\n f_handle = open(*args, **kwargs) # pylint: disable=resource-leakage\\n\\n if is_fcntl_available():\\n # modify the file descriptor on systems with fcntl\\n # unix and unix-like systems only\\n try:\\n FD_CLOEXEC = fcntl.FD_CLOEXEC # pylint: disable=C0103\\n except AttributeError:\\n FD_CLOEXEC = 1 # pylint: disable=C0103\\n old_flags = fcntl.fcntl(f_handle.fileno(), fcntl.F_GETFD)\\n fcntl.fcntl(f_handle.fileno(), fcntl.F_SETFD, old_flags | FD_CLOEXEC)\\n\\n return f_handle\\n\",\n \"def to_unicode(s, encoding=None, errors='strict', normalize=False):\\n '''\\n Given str or unicode, return unicode (str for python 3)\\n '''\\n def _normalize(s):\\n return unicodedata.normalize('NFC', s) if normalize else s\\n\\n if encoding is None:\\n # Try utf-8 first, and fall back to detected encoding\\n encoding = ('utf-8', __salt_system_encoding__)\\n if not isinstance(encoding, (tuple, list)):\\n encoding = (encoding,)\\n\\n if not encoding:\\n raise ValueError('encoding cannot be empty')\\n\\n exc = None\\n if six.PY3:\\n if isinstance(s, str):\\n return _normalize(s)\\n elif isinstance(s, (bytes, bytearray)):\\n return _normalize(to_str(s, encoding, errors))\\n raise TypeError('expected str, bytes, or bytearray')\\n else:\\n # This needs to be str and not six.string_types, since if the string is\\n # already a unicode type, it does not need to be decoded (and doing so\\n # will raise an exception).\\n if isinstance(s, unicode): # pylint: disable=incompatible-py3-code,undefined-variable\\n return _normalize(s)\\n elif isinstance(s, (str, bytearray)):\\n for enc in encoding:\\n try:\\n return _normalize(s.decode(enc, errors))\\n except UnicodeDecodeError as err:\\n exc = err\\n continue\\n # The only way we get this far is if a UnicodeDecodeError was\\n # raised, otherwise we would have already returned (or raised some\\n # other exception).\\n raise exc # pylint: disable=raising-bad-type\\n raise TypeError('expected str or bytearray')\\n\",\n \"def get_location(vm_=None):\\n '''\\n Return the EC2 region to use, in this order:\\n - CLI parameter\\n - VM parameter\\n - Cloud profile setting\\n '''\\n return __opts__.get(\\n 'location',\\n config.get_cloud_config_value(\\n 'location',\\n vm_ or get_configured_provider(),\\n __opts__,\\n default=DEFAULT_LOCATION,\\n search_global=False\\n )\\n )\\n\",\n \"def update_pricing(kwargs=None, call=None):\\n '''\\n Download most recent pricing information from AWS and convert to a local\\n JSON file.\\n\\n CLI Examples:\\n\\n .. code-block:: bash\\n\\n salt-cloud -f update_pricing my-ec2-config\\n salt-cloud -f update_pricing my-ec2-config type=linux\\n\\n .. versionadded:: 2015.8.0\\n '''\\n sources = {\\n 'linux': 'https://a0.awsstatic.com/pricing/1/ec2/linux-od.min.js',\\n 'rhel': 'https://a0.awsstatic.com/pricing/1/ec2/rhel-od.min.js',\\n 'sles': 'https://a0.awsstatic.com/pricing/1/ec2/sles-od.min.js',\\n 'mswin': 'https://a0.awsstatic.com/pricing/1/ec2/mswin-od.min.js',\\n 'mswinsql': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQL-od.min.js',\\n 'mswinsqlweb': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQLWeb-od.min.js',\\n }\\n\\n if kwargs is None:\\n kwargs = {}\\n\\n if 'type' not in kwargs:\\n for source in sources:\\n _parse_pricing(sources[source], source)\\n else:\\n _parse_pricing(sources[kwargs['type']], kwargs['type'])\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nThe EC2 Cloud Module\n====================\n\nThe EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.\n\nTo use the EC2 cloud module, set up the cloud configuration at\n ``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:\n\n.. code-block:: yaml\n\n my-ec2-config:\n # EC2 API credentials: Access Key ID and Secret Access Key.\n # Alternatively, to use IAM Instance Role credentials available via\n # EC2 metadata set both id and key to 'use-instance-role-credentials'\n id: GKTADJGHEIQSXMKKRBJ08H\n key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs\n\n # If 'role_arn' is specified the above credentials are used to\n # to assume to the role. By default, role_arn is set to None.\n role_arn: arn:aws:iam::012345678910:role/SomeRoleName\n\n # The ssh keyname to use\n keyname: default\n # The amazon security group\n securitygroup: ssh_open\n # The location of the private key which corresponds to the keyname\n private_key: /root/default.pem\n\n # Be default, service_url is set to amazonaws.com. If you are using this\n # driver for something other than Amazon EC2, change it here:\n service_url: amazonaws.com\n\n # The endpoint that is ultimately used is usually formed using the region\n # and the service_url. If you would like to override that entirely, you\n # can explicitly define the endpoint:\n endpoint: myendpoint.example.com:1138/services/Cloud\n\n # SSH Gateways can be used with this provider. Gateways can be used\n # when a salt-master is not on the same private network as the instance\n # that is being deployed.\n\n # Defaults to None\n # Required\n ssh_gateway: gateway.example.com\n\n # Defaults to port 22\n # Optional\n ssh_gateway_port: 22\n\n # Defaults to root\n # Optional\n ssh_gateway_username: root\n\n # Default to nc -q0 %h %p\n # Optional\n ssh_gateway_command: \"-W %h:%p\"\n\n # One authentication method is required. If both\n # are specified, Private key wins.\n\n # Private key defaults to None\n ssh_gateway_private_key: /path/to/key.pem\n\n # Password defaults to None\n ssh_gateway_password: ExamplePasswordHere\n\n driver: ec2\n\n # Pass userdata to the instance to be created\n userdata_file: /etc/salt/my-userdata-file\n\n # Instance termination protection setting\n # Default is disabled\n termination_protection: False\n\n:depends: requests\n'''\n# pylint: disable=invalid-name,function-redefined\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport os\nimport sys\nimport stat\nimport time\nimport uuid\nimport pprint\nimport logging\n\n# Import libs for talking to the EC2 API\nimport hmac\nimport hashlib\nimport binascii\nimport datetime\nimport base64\nimport re\nimport decimal\n\n# Import Salt Libs\nimport salt.utils.cloud\nimport salt.utils.compat\nimport salt.utils.files\nimport salt.utils.hashutils\nimport salt.utils.json\nimport salt.utils.msgpack\nimport salt.utils.stringutils\nimport salt.utils.yaml\nfrom salt._compat import ElementTree as ET\nimport salt.utils.http as http\nimport salt.utils.aws as aws\nimport salt.config as config\nfrom salt.exceptions import (\n SaltCloudException,\n SaltCloudSystemExit,\n SaltCloudConfigError,\n SaltCloudExecutionTimeout,\n SaltCloudExecutionFailure\n)\n\n# pylint: disable=import-error,no-name-in-module,redefined-builtin\nfrom salt.ext import six\nfrom salt.ext.six.moves import map, range, zip\nfrom salt.ext.six.moves.urllib.parse import urlparse as _urlparse, urlencode as _urlencode\n\n# Import 3rd-Party Libs\n# Try to import PyCrypto, which may not be installed on a RAET-based system\ntry:\n from M2Crypto import RSA\n HAS_M2 = True\nexcept ImportError:\n HAS_M2 = False\n\ntry:\n import Crypto\n # PKCS1_v1_5 was added in PyCrypto 2.5\n from Crypto.Cipher import PKCS1_v1_5 # pylint: disable=E0611\n from Crypto.Hash import SHA # pylint: disable=E0611,W0611\n HAS_PYCRYPTO = True\nexcept ImportError:\n HAS_PYCRYPTO = False\n\ntry:\n import requests\n HAS_REQUESTS = True\nexcept ImportError:\n HAS_REQUESTS = False\n# pylint: enable=import-error,no-name-in-module,redefined-builtin\n\n# Get logging started\nlog = logging.getLogger(__name__)\n\n\nEC2_LOCATIONS = {\n 'ap-northeast-1': 'ec2_ap_northeast',\n 'ap-northeast-2': 'ec2_ap_northeast_2',\n 'ap-southeast-1': 'ec2_ap_southeast',\n 'ap-southeast-2': 'ec2_ap_southeast_2',\n 'eu-west-1': 'ec2_eu_west',\n 'eu-central-1': 'ec2_eu_central',\n 'sa-east-1': 'ec2_sa_east',\n 'us-east-1': 'ec2_us_east',\n 'us-gov-west-1': 'ec2_us_gov_west_1',\n 'us-west-1': 'ec2_us_west',\n 'us-west-2': 'ec2_us_west_oregon',\n}\nDEFAULT_LOCATION = 'us-east-1'\n\nDEFAULT_EC2_API_VERSION = '2014-10-01'\n\nEC2_RETRY_CODES = [\n 'RequestLimitExceeded',\n 'InsufficientInstanceCapacity',\n 'InternalError',\n 'Unavailable',\n 'InsufficientAddressCapacity',\n 'InsufficientReservedInstanceCapacity',\n]\n\nJS_COMMENT_RE = re.compile(r'/\\*.*?\\*/', re.S)\n\n__virtualname__ = 'ec2'\n\n\n# Only load in this module if the EC2 configurations are in place\ndef __virtual__():\n '''\n Set up the libcloud functions and check for EC2 configurations\n '''\n if get_configured_provider() is False:\n return False\n\n if get_dependencies() is False:\n return False\n\n return __virtualname__\n\n\ndef get_configured_provider():\n '''\n Return the first configured instance.\n '''\n return config.is_provider_configured(\n __opts__,\n __active_provider_name__ or __virtualname__,\n ('id', 'key')\n )\n\n\ndef get_dependencies():\n '''\n Warn if dependencies aren't met.\n '''\n deps = {\n 'requests': HAS_REQUESTS,\n 'pycrypto or m2crypto': HAS_M2 or HAS_PYCRYPTO\n }\n return config.check_driver_dependencies(\n __virtualname__,\n deps\n )\n\n\ndef _xml_to_dict(xmltree):\n '''\n Convert an XML tree into a dict\n '''\n if sys.version_info < (2, 7):\n children_len = len(xmltree.getchildren())\n else:\n children_len = len(xmltree)\n\n if children_len < 1:\n name = xmltree.tag\n if '}' in name:\n comps = name.split('}')\n name = comps[1]\n return {name: xmltree.text}\n\n xmldict = {}\n for item in xmltree:\n name = item.tag\n if '}' in name:\n comps = name.split('}')\n name = comps[1]\n if name not in xmldict:\n if sys.version_info < (2, 7):\n children_len = len(item.getchildren())\n else:\n children_len = len(item)\n\n if children_len > 0:\n xmldict[name] = _xml_to_dict(item)\n else:\n xmldict[name] = item.text\n else:\n if not isinstance(xmldict[name], list):\n tempvar = xmldict[name]\n xmldict[name] = []\n xmldict[name].append(tempvar)\n xmldict[name].append(_xml_to_dict(item))\n return xmldict\n\n\ndef optimize_providers(providers):\n '''\n Return an optimized list of providers.\n\n We want to reduce the duplication of querying\n the same region.\n\n If a provider is using the same credentials for the same region\n the same data will be returned for each provider, thus causing\n un-wanted duplicate data and API calls to EC2.\n\n '''\n tmp_providers = {}\n optimized_providers = {}\n\n for name, data in six.iteritems(providers):\n if 'location' not in data:\n data['location'] = DEFAULT_LOCATION\n\n if data['location'] not in tmp_providers:\n tmp_providers[data['location']] = {}\n\n creds = (data['id'], data['key'])\n if creds not in tmp_providers[data['location']]:\n tmp_providers[data['location']][creds] = {'name': name,\n 'data': data,\n }\n\n for location, tmp_data in six.iteritems(tmp_providers):\n for creds, data in six.iteritems(tmp_data):\n _id, _key = creds\n _name = data['name']\n _data = data['data']\n if _name not in optimized_providers:\n optimized_providers[_name] = _data\n\n return optimized_providers\n\n\ndef sign(key, msg):\n return hmac.new(key, msg.encode('utf-8'), hashlib.sha256).digest()\n\n\ndef query(params=None, setname=None, requesturl=None, location=None,\n return_url=False, return_root=False):\n\n provider = get_configured_provider()\n service_url = provider.get('service_url', 'amazonaws.com')\n\n # Retrieve access credentials from meta-data, or use provided\n access_key_id, secret_access_key, token = aws.creds(provider)\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n params_with_headers = params.copy()\n timestamp = datetime.datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%SZ')\n\n if not location:\n location = get_location()\n\n if not requesturl:\n endpoint = provider.get(\n 'endpoint',\n 'ec2.{0}.{1}'.format(location, service_url)\n )\n\n requesturl = 'https://{0}/'.format(endpoint)\n endpoint = _urlparse(requesturl).netloc\n endpoint_path = _urlparse(requesturl).path\n else:\n endpoint = _urlparse(requesturl).netloc\n endpoint_path = _urlparse(requesturl).path\n if endpoint == '':\n endpoint_err = (\n 'Could not find a valid endpoint in the '\n 'requesturl: {0}. Looking for something '\n 'like https://some.ec2.endpoint/?args').format(requesturl)\n log.error(endpoint_err)\n if return_url is True:\n return {'error': endpoint_err}, requesturl\n return {'error': endpoint_err}\n\n log.debug('Using EC2 endpoint: %s', endpoint)\n # AWS v4 signature\n\n method = 'GET'\n region = location\n service = 'ec2'\n canonical_uri = _urlparse(requesturl).path\n host = endpoint.strip()\n\n # Create a date for headers and the credential string\n t = datetime.datetime.utcnow()\n amz_date = t.strftime('%Y%m%dT%H%M%SZ') # Format date as YYYYMMDD'T'HHMMSS'Z'\n datestamp = t.strftime('%Y%m%d') # Date w/o time, used in credential scope\n\n canonical_headers = 'host:' + host + '\\n' + 'x-amz-date:' + amz_date + '\\n'\n signed_headers = 'host;x-amz-date'\n\n payload_hash = salt.utils.hashutils.sha256_digest('')\n\n ec2_api_version = provider.get(\n 'ec2_api_version',\n DEFAULT_EC2_API_VERSION\n )\n\n params_with_headers['Version'] = ec2_api_version\n\n keys = sorted(list(params_with_headers))\n values = map(params_with_headers.get, keys)\n querystring = _urlencode(list(zip(keys, values)))\n querystring = querystring.replace('+', '%20')\n\n canonical_request = method + '\\n' + canonical_uri + '\\n' + \\\n querystring + '\\n' + canonical_headers + '\\n' + \\\n signed_headers + '\\n' + payload_hash\n\n algorithm = 'AWS4-HMAC-SHA256'\n credential_scope = datestamp + '/' + region + '/' + service + '/' + 'aws4_request'\n\n string_to_sign = algorithm + '\\n' + amz_date + '\\n' + \\\n credential_scope + '\\n' + \\\n salt.utils.hashutils.sha256_digest(canonical_request)\n\n kDate = sign(('AWS4' + provider['key']).encode('utf-8'), datestamp)\n kRegion = sign(kDate, region)\n kService = sign(kRegion, service)\n signing_key = sign(kService, 'aws4_request')\n\n signature = hmac.new(signing_key, (string_to_sign).encode('utf-8'),\n hashlib.sha256).hexdigest()\n\n authorization_header = algorithm + ' ' + 'Credential=' + \\\n provider['id'] + '/' + credential_scope + \\\n ', ' + 'SignedHeaders=' + signed_headers + \\\n ', ' + 'Signature=' + signature\n headers = {'x-amz-date': amz_date, 'Authorization': authorization_header}\n\n log.debug('EC2 Request: %s', requesturl)\n log.trace('EC2 Request Parameters: %s', params_with_headers)\n try:\n result = requests.get(requesturl, headers=headers, params=params_with_headers)\n log.debug(\n 'EC2 Response Status Code: %s',\n # result.getcode()\n result.status_code\n )\n log.trace('EC2 Response Text: %s', result.text)\n result.raise_for_status()\n break\n except requests.exceptions.HTTPError as exc:\n root = ET.fromstring(exc.response.content)\n data = _xml_to_dict(root)\n\n # check to see if we should retry the query\n err_code = data.get('Errors', {}).get('Error', {}).get('Code', '')\n if err_code and err_code in EC2_RETRY_CODES:\n attempts += 1\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s; '\n 'Attempts remaining: %s',\n exc.response.status_code, exc, data, attempts\n )\n aws.sleep_exponential_backoff(attempts)\n continue\n\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n else:\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n\n response = result.text\n\n root = ET.fromstring(response)\n items = root[1]\n if return_root is True:\n items = root\n\n if setname:\n if sys.version_info < (2, 7):\n children_len = len(root.getchildren())\n else:\n children_len = len(root)\n\n for item in range(0, children_len):\n comps = root[item].tag.split('}')\n if comps[1] == setname:\n items = root[item]\n\n ret = []\n for item in items:\n ret.append(_xml_to_dict(item))\n\n if return_url is True:\n return ret, requesturl\n\n return ret\n\n\ndef _wait_for_spot_instance(update_callback,\n update_args=None,\n update_kwargs=None,\n timeout=10 * 60,\n interval=30,\n interval_multiplier=1,\n max_failures=10):\n '''\n Helper function that waits for a spot instance request to become active\n for a specific maximum amount of time.\n\n :param update_callback: callback function which queries the cloud provider\n for spot instance request. It must return None if\n the required data, running instance included, is\n not available yet.\n :param update_args: Arguments to pass to update_callback\n :param update_kwargs: Keyword arguments to pass to update_callback\n :param timeout: The maximum amount of time(in seconds) to wait for the IP\n address.\n :param interval: The looping interval, i.e., the amount of time to sleep\n before the next iteration.\n :param interval_multiplier: Increase the interval by this multiplier after\n each request; helps with throttling\n :param max_failures: If update_callback returns ``False`` it's considered\n query failure. This value is the amount of failures\n accepted before giving up.\n :returns: The update_callback returned data\n :raises: SaltCloudExecutionTimeout\n\n '''\n if update_args is None:\n update_args = ()\n if update_kwargs is None:\n update_kwargs = {}\n\n duration = timeout\n while True:\n log.debug(\n 'Waiting for spot instance reservation. Giving up in '\n '00:%02d:%02d', int(timeout // 60), int(timeout % 60)\n )\n data = update_callback(*update_args, **update_kwargs)\n if data is False:\n log.debug(\n 'update_callback has returned False which is considered a '\n 'failure. Remaining Failures: %s', max_failures\n )\n max_failures -= 1\n if max_failures <= 0:\n raise SaltCloudExecutionFailure(\n 'Too many failures occurred while waiting for '\n 'the spot instance reservation to become active.'\n )\n elif data is not None:\n return data\n\n if timeout < 0:\n raise SaltCloudExecutionTimeout(\n 'Unable to get an active spot instance request for '\n '00:{0:02d}:{1:02d}'.format(\n int(duration // 60),\n int(duration % 60)\n )\n )\n time.sleep(interval)\n timeout -= interval\n\n if interval_multiplier > 1:\n interval *= interval_multiplier\n if interval > timeout:\n interval = timeout + 1\n log.info('Interval multiplier in effect; interval is '\n 'now %ss', interval)\n\n\ndef avail_sizes(call=None):\n '''\n Return a dict of all available VM sizes on the cloud provider with\n relevant data. Latest version can be found at:\n\n http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_sizes function must be called with '\n '-f or --function, or with the --list-sizes option'\n )\n\n sizes = {\n 'Cluster Compute': {\n 'cc2.8xlarge': {\n 'id': 'cc2.8xlarge',\n 'cores': '16 (2 x Intel Xeon E5-2670, eight-core with '\n 'hyperthread)',\n 'disk': '3360 GiB (4 x 840 GiB)',\n 'ram': '60.5 GiB'\n },\n 'cc1.4xlarge': {\n 'id': 'cc1.4xlarge',\n 'cores': '8 (2 x Intel Xeon X5570, quad-core with '\n 'hyperthread)',\n 'disk': '1690 GiB (2 x 840 GiB)',\n 'ram': '22.5 GiB'\n },\n },\n 'Cluster CPU': {\n 'cg1.4xlarge': {\n 'id': 'cg1.4xlarge',\n 'cores': '8 (2 x Intel Xeon X5570, quad-core with '\n 'hyperthread), plus 2 NVIDIA Tesla M2050 GPUs',\n 'disk': '1680 GiB (2 x 840 GiB)',\n 'ram': '22.5 GiB'\n },\n },\n 'Compute Optimized': {\n 'c4.large': {\n 'id': 'c4.large',\n 'cores': '2',\n 'disk': 'EBS - 500 Mbps',\n 'ram': '3.75 GiB'\n },\n 'c4.xlarge': {\n 'id': 'c4.xlarge',\n 'cores': '4',\n 'disk': 'EBS - 750 Mbps',\n 'ram': '7.5 GiB'\n },\n 'c4.2xlarge': {\n 'id': 'c4.2xlarge',\n 'cores': '8',\n 'disk': 'EBS - 1000 Mbps',\n 'ram': '15 GiB'\n },\n 'c4.4xlarge': {\n 'id': 'c4.4xlarge',\n 'cores': '16',\n 'disk': 'EBS - 2000 Mbps',\n 'ram': '30 GiB'\n },\n 'c4.8xlarge': {\n 'id': 'c4.8xlarge',\n 'cores': '36',\n 'disk': 'EBS - 4000 Mbps',\n 'ram': '60 GiB'\n },\n 'c3.large': {\n 'id': 'c3.large',\n 'cores': '2',\n 'disk': '32 GiB (2 x 16 GiB SSD)',\n 'ram': '3.75 GiB'\n },\n 'c3.xlarge': {\n 'id': 'c3.xlarge',\n 'cores': '4',\n 'disk': '80 GiB (2 x 40 GiB SSD)',\n 'ram': '7.5 GiB'\n },\n 'c3.2xlarge': {\n 'id': 'c3.2xlarge',\n 'cores': '8',\n 'disk': '160 GiB (2 x 80 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'c3.4xlarge': {\n 'id': 'c3.4xlarge',\n 'cores': '16',\n 'disk': '320 GiB (2 x 160 GiB SSD)',\n 'ram': '30 GiB'\n },\n 'c3.8xlarge': {\n 'id': 'c3.8xlarge',\n 'cores': '32',\n 'disk': '640 GiB (2 x 320 GiB SSD)',\n 'ram': '60 GiB'\n }\n },\n 'Dense Storage': {\n 'd2.xlarge': {\n 'id': 'd2.xlarge',\n 'cores': '4',\n 'disk': '6 TiB (3 x 2 TiB hard disk drives)',\n 'ram': '30.5 GiB'\n },\n 'd2.2xlarge': {\n 'id': 'd2.2xlarge',\n 'cores': '8',\n 'disk': '12 TiB (6 x 2 TiB hard disk drives)',\n 'ram': '61 GiB'\n },\n 'd2.4xlarge': {\n 'id': 'd2.4xlarge',\n 'cores': '16',\n 'disk': '24 TiB (12 x 2 TiB hard disk drives)',\n 'ram': '122 GiB'\n },\n 'd2.8xlarge': {\n 'id': 'd2.8xlarge',\n 'cores': '36',\n 'disk': '24 TiB (24 x 2 TiB hard disk drives)',\n 'ram': '244 GiB'\n },\n },\n 'GPU': {\n 'g2.2xlarge': {\n 'id': 'g2.2xlarge',\n 'cores': '8',\n 'disk': '60 GiB (1 x 60 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'g2.8xlarge': {\n 'id': 'g2.8xlarge',\n 'cores': '32',\n 'disk': '240 GiB (2 x 120 GiB SSD)',\n 'ram': '60 GiB'\n },\n },\n 'GPU Compute': {\n 'p2.xlarge': {\n 'id': 'p2.xlarge',\n 'cores': '4',\n 'disk': 'EBS',\n 'ram': '61 GiB'\n },\n 'p2.8xlarge': {\n 'id': 'p2.8xlarge',\n 'cores': '32',\n 'disk': 'EBS',\n 'ram': '488 GiB'\n },\n 'p2.16xlarge': {\n 'id': 'p2.16xlarge',\n 'cores': '64',\n 'disk': 'EBS',\n 'ram': '732 GiB'\n },\n },\n 'High I/O': {\n 'i2.xlarge': {\n 'id': 'i2.xlarge',\n 'cores': '4',\n 'disk': 'SSD (1 x 800 GiB)',\n 'ram': '30.5 GiB'\n },\n 'i2.2xlarge': {\n 'id': 'i2.2xlarge',\n 'cores': '8',\n 'disk': 'SSD (2 x 800 GiB)',\n 'ram': '61 GiB'\n },\n 'i2.4xlarge': {\n 'id': 'i2.4xlarge',\n 'cores': '16',\n 'disk': 'SSD (4 x 800 GiB)',\n 'ram': '122 GiB'\n },\n 'i2.8xlarge': {\n 'id': 'i2.8xlarge',\n 'cores': '32',\n 'disk': 'SSD (8 x 800 GiB)',\n 'ram': '244 GiB'\n }\n },\n 'High Memory': {\n 'x1.16xlarge': {\n 'id': 'x1.16xlarge',\n 'cores': '64 (with 5.45 ECUs each)',\n 'disk': '1920 GiB (1 x 1920 GiB)',\n 'ram': '976 GiB'\n },\n 'x1.32xlarge': {\n 'id': 'x1.32xlarge',\n 'cores': '128 (with 2.73 ECUs each)',\n 'disk': '3840 GiB (2 x 1920 GiB)',\n 'ram': '1952 GiB'\n },\n 'r4.large': {\n 'id': 'r4.large',\n 'cores': '2 (with 3.45 ECUs each)',\n 'disk': 'EBS',\n 'ram': '15.25 GiB'\n },\n 'r4.xlarge': {\n 'id': 'r4.xlarge',\n 'cores': '4 (with 3.35 ECUs each)',\n 'disk': 'EBS',\n 'ram': '30.5 GiB'\n },\n 'r4.2xlarge': {\n 'id': 'r4.2xlarge',\n 'cores': '8 (with 3.35 ECUs each)',\n 'disk': 'EBS',\n 'ram': '61 GiB'\n },\n 'r4.4xlarge': {\n 'id': 'r4.4xlarge',\n 'cores': '16 (with 3.3 ECUs each)',\n 'disk': 'EBS',\n 'ram': '122 GiB'\n },\n 'r4.8xlarge': {\n 'id': 'r4.8xlarge',\n 'cores': '32 (with 3.1 ECUs each)',\n 'disk': 'EBS',\n 'ram': '244 GiB'\n },\n 'r4.16xlarge': {\n 'id': 'r4.16xlarge',\n 'cores': '64 (with 3.05 ECUs each)',\n 'disk': 'EBS',\n 'ram': '488 GiB'\n },\n 'r3.large': {\n 'id': 'r3.large',\n 'cores': '2 (with 3.25 ECUs each)',\n 'disk': '32 GiB (1 x 32 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'r3.xlarge': {\n 'id': 'r3.xlarge',\n 'cores': '4 (with 3.25 ECUs each)',\n 'disk': '80 GiB (1 x 80 GiB SSD)',\n 'ram': '30.5 GiB'\n },\n 'r3.2xlarge': {\n 'id': 'r3.2xlarge',\n 'cores': '8 (with 3.25 ECUs each)',\n 'disk': '160 GiB (1 x 160 GiB SSD)',\n 'ram': '61 GiB'\n },\n 'r3.4xlarge': {\n 'id': 'r3.4xlarge',\n 'cores': '16 (with 3.25 ECUs each)',\n 'disk': '320 GiB (1 x 320 GiB SSD)',\n 'ram': '122 GiB'\n },\n 'r3.8xlarge': {\n 'id': 'r3.8xlarge',\n 'cores': '32 (with 3.25 ECUs each)',\n 'disk': '640 GiB (2 x 320 GiB SSD)',\n 'ram': '244 GiB'\n }\n },\n 'High-Memory Cluster': {\n 'cr1.8xlarge': {\n 'id': 'cr1.8xlarge',\n 'cores': '16 (2 x Intel Xeon E5-2670, eight-core)',\n 'disk': '240 GiB (2 x 120 GiB SSD)',\n 'ram': '244 GiB'\n },\n },\n 'High Storage': {\n 'hs1.8xlarge': {\n 'id': 'hs1.8xlarge',\n 'cores': '16 (8 cores + 8 hyperthreads)',\n 'disk': '48 TiB (24 x 2 TiB hard disk drives)',\n 'ram': '117 GiB'\n },\n },\n 'General Purpose': {\n 't2.nano': {\n 'id': 't2.nano',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '512 MiB'\n },\n 't2.micro': {\n 'id': 't2.micro',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '1 GiB'\n },\n 't2.small': {\n 'id': 't2.small',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '2 GiB'\n },\n 't2.medium': {\n 'id': 't2.medium',\n 'cores': '2',\n 'disk': 'EBS',\n 'ram': '4 GiB'\n },\n 't2.large': {\n 'id': 't2.large',\n 'cores': '2',\n 'disk': 'EBS',\n 'ram': '8 GiB'\n },\n 't2.xlarge': {\n 'id': 't2.xlarge',\n 'cores': '4',\n 'disk': 'EBS',\n 'ram': '16 GiB'\n },\n 't2.2xlarge': {\n 'id': 't2.2xlarge',\n 'cores': '8',\n 'disk': 'EBS',\n 'ram': '32 GiB'\n },\n 'm4.large': {\n 'id': 'm4.large',\n 'cores': '2',\n 'disk': 'EBS - 450 Mbps',\n 'ram': '8 GiB'\n },\n 'm4.xlarge': {\n 'id': 'm4.xlarge',\n 'cores': '4',\n 'disk': 'EBS - 750 Mbps',\n 'ram': '16 GiB'\n },\n 'm4.2xlarge': {\n 'id': 'm4.2xlarge',\n 'cores': '8',\n 'disk': 'EBS - 1000 Mbps',\n 'ram': '32 GiB'\n },\n 'm4.4xlarge': {\n 'id': 'm4.4xlarge',\n 'cores': '16',\n 'disk': 'EBS - 2000 Mbps',\n 'ram': '64 GiB'\n },\n 'm4.10xlarge': {\n 'id': 'm4.10xlarge',\n 'cores': '40',\n 'disk': 'EBS - 4000 Mbps',\n 'ram': '160 GiB'\n },\n 'm4.16xlarge': {\n 'id': 'm4.16xlarge',\n 'cores': '64',\n 'disk': 'EBS - 10000 Mbps',\n 'ram': '256 GiB'\n },\n 'm3.medium': {\n 'id': 'm3.medium',\n 'cores': '1',\n 'disk': 'SSD (1 x 4)',\n 'ram': '3.75 GiB'\n },\n 'm3.large': {\n 'id': 'm3.large',\n 'cores': '2',\n 'disk': 'SSD (1 x 32)',\n 'ram': '7.5 GiB'\n },\n 'm3.xlarge': {\n 'id': 'm3.xlarge',\n 'cores': '4',\n 'disk': 'SSD (2 x 40)',\n 'ram': '15 GiB'\n },\n 'm3.2xlarge': {\n 'id': 'm3.2xlarge',\n 'cores': '8',\n 'disk': 'SSD (2 x 80)',\n 'ram': '30 GiB'\n },\n }\n }\n return sizes\n\n\ndef avail_images(kwargs=None, call=None):\n '''\n Return a dict of all available VM images on the cloud provider.\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_images function must be called with '\n '-f or --function, or with the --list-images option'\n )\n\n if not isinstance(kwargs, dict):\n kwargs = {}\n\n if 'owner' in kwargs:\n owner = kwargs['owner']\n else:\n provider = get_configured_provider()\n\n owner = config.get_cloud_config_value(\n 'owner', provider, __opts__, default='amazon'\n )\n\n ret = {}\n params = {'Action': 'DescribeImages',\n 'Owner': owner}\n images = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for image in images:\n ret[image['imageId']] = image\n return ret\n\n\ndef script(vm_):\n '''\n Return the script deployment object\n '''\n return salt.utils.cloud.os_script(\n config.get_cloud_config_value('script', vm_, __opts__),\n vm_,\n __opts__,\n salt.utils.cloud.salt_config_to_yaml(\n salt.utils.cloud.minion_config(__opts__, vm_)\n )\n )\n\n\ndef keyname(vm_):\n '''\n Return the keyname\n '''\n return config.get_cloud_config_value(\n 'keyname', vm_, __opts__, search_global=False\n )\n\n\ndef securitygroup(vm_):\n '''\n Return the security group\n '''\n return config.get_cloud_config_value(\n 'securitygroup', vm_, __opts__, search_global=False\n )\n\n\ndef iam_profile(vm_):\n '''\n Return the IAM profile.\n\n The IAM instance profile to associate with the instances.\n This is either the Amazon Resource Name (ARN) of the instance profile\n or the name of the role.\n\n Type: String\n\n Default: None\n\n Required: No\n\n Example: arn:aws:iam::111111111111:instance-profile/s3access\n\n Example: s3access\n\n '''\n return config.get_cloud_config_value(\n 'iam_profile', vm_, __opts__, search_global=False\n )\n\n\ndef ssh_interface(vm_):\n '''\n Return the ssh_interface type to connect to. Either 'public_ips' (default)\n or 'private_ips'.\n '''\n ret = config.get_cloud_config_value(\n 'ssh_interface', vm_, __opts__, default='public_ips',\n search_global=False\n )\n if ret not in ('public_ips', 'private_ips'):\n log.warning(\n 'Invalid ssh_interface: %s. '\n 'Allowed options are (\"public_ips\", \"private_ips\"). '\n 'Defaulting to \"public_ips\".', ret\n )\n ret = 'public_ips'\n return ret\n\n\ndef get_ssh_gateway_config(vm_):\n '''\n Return the ssh_gateway configuration.\n '''\n ssh_gateway = config.get_cloud_config_value(\n 'ssh_gateway', vm_, __opts__, default=None,\n search_global=False\n )\n\n # Check to see if a SSH Gateway will be used.\n if not isinstance(ssh_gateway, six.string_types):\n return None\n\n # Create dictionary of configuration items\n\n # ssh_gateway\n ssh_gateway_config = {'ssh_gateway': ssh_gateway}\n\n # ssh_gateway_port\n ssh_gateway_config['ssh_gateway_port'] = config.get_cloud_config_value(\n 'ssh_gateway_port', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_username\n ssh_gateway_config['ssh_gateway_user'] = config.get_cloud_config_value(\n 'ssh_gateway_username', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_private_key\n ssh_gateway_config['ssh_gateway_key'] = config.get_cloud_config_value(\n 'ssh_gateway_private_key', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_password\n ssh_gateway_config['ssh_gateway_password'] = config.get_cloud_config_value(\n 'ssh_gateway_password', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_command\n ssh_gateway_config['ssh_gateway_command'] = config.get_cloud_config_value(\n 'ssh_gateway_command', vm_, __opts__, default=None,\n search_global=False\n )\n\n # Check if private key exists\n key_filename = ssh_gateway_config['ssh_gateway_key']\n if key_filename is not None and not os.path.isfile(key_filename):\n raise SaltCloudConfigError(\n 'The defined ssh_gateway_private_key \\'{0}\\' does not exist'\n .format(key_filename)\n )\n elif (\n key_filename is None and\n not ssh_gateway_config['ssh_gateway_password']\n ):\n raise SaltCloudConfigError(\n 'No authentication method. Please define: '\n ' ssh_gateway_password or ssh_gateway_private_key'\n )\n\n return ssh_gateway_config\n\n\ndef get_location(vm_=None):\n '''\n Return the EC2 region to use, in this order:\n - CLI parameter\n - VM parameter\n - Cloud profile setting\n '''\n return __opts__.get(\n 'location',\n config.get_cloud_config_value(\n 'location',\n vm_ or get_configured_provider(),\n __opts__,\n default=DEFAULT_LOCATION,\n search_global=False\n )\n )\n\n\ndef avail_locations(call=None):\n '''\n List all available locations\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_locations function must be called with '\n '-f or --function, or with the --list-locations option'\n )\n\n ret = {}\n\n params = {'Action': 'DescribeRegions'}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for region in result:\n ret[region['regionName']] = {\n 'name': region['regionName'],\n 'endpoint': region['regionEndpoint'],\n }\n\n return ret\n\n\ndef get_availability_zone(vm_):\n '''\n Return the availability zone to use\n '''\n avz = config.get_cloud_config_value(\n 'availability_zone', vm_, __opts__, search_global=False\n )\n\n if avz is None:\n return None\n\n zones = _list_availability_zones(vm_)\n\n # Validate user-specified AZ\n if avz not in zones:\n raise SaltCloudException(\n 'The specified availability zone isn\\'t valid in this region: '\n '{0}\\n'.format(\n avz\n )\n )\n\n # check specified AZ is available\n elif zones[avz] != 'available':\n raise SaltCloudException(\n 'The specified availability zone isn\\'t currently available: '\n '{0}\\n'.format(\n avz\n )\n )\n\n return avz\n\n\ndef get_tenancy(vm_):\n '''\n Returns the Tenancy to use.\n\n Can be \"dedicated\" or \"default\". Cannot be present for spot instances.\n '''\n return config.get_cloud_config_value(\n 'tenancy', vm_, __opts__, search_global=False\n )\n\n\ndef get_imageid(vm_):\n '''\n Returns the ImageId to use\n '''\n image = config.get_cloud_config_value(\n 'image', vm_, __opts__, search_global=False\n )\n if image.startswith('ami-'):\n return image\n # a poor man's cache\n if not hasattr(get_imageid, 'images'):\n get_imageid.images = {}\n elif image in get_imageid.images:\n return get_imageid.images[image]\n params = {'Action': 'DescribeImages',\n 'Filter.0.Name': 'name',\n 'Filter.0.Value.0': image}\n # Query AWS, sort by 'creationDate' and get the last imageId\n _t = lambda x: datetime.datetime.strptime(x['creationDate'], '%Y-%m-%dT%H:%M:%S.%fZ')\n image_id = sorted(aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'),\n lambda i, j: salt.utils.compat.cmp(_t(i), _t(j))\n )[-1]['imageId']\n get_imageid.images[image] = image_id\n return image_id\n\n\ndef _get_subnetname_id(subnetname):\n '''\n Returns the SubnetId of a SubnetName to use\n '''\n params = {'Action': 'DescribeSubnets'}\n for subnet in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n tags = subnet.get('tagSet', {}).get('item', {})\n if not isinstance(tags, list):\n tags = [tags]\n for tag in tags:\n if tag['key'] == 'Name' and tag['value'] == subnetname:\n log.debug(\n 'AWS Subnet ID of %s is %s',\n subnetname, subnet['subnetId']\n )\n return subnet['subnetId']\n return None\n\n\ndef get_subnetid(vm_):\n '''\n Returns the SubnetId to use\n '''\n subnetid = config.get_cloud_config_value(\n 'subnetid', vm_, __opts__, search_global=False\n )\n if subnetid:\n return subnetid\n\n subnetname = config.get_cloud_config_value(\n 'subnetname', vm_, __opts__, search_global=False\n )\n if subnetname:\n return _get_subnetname_id(subnetname)\n return None\n\n\ndef _get_securitygroupname_id(securitygroupname_list):\n '''\n Returns the SecurityGroupId of a SecurityGroupName to use\n '''\n securitygroupid_set = set()\n if not isinstance(securitygroupname_list, list):\n securitygroupname_list = [securitygroupname_list]\n params = {'Action': 'DescribeSecurityGroups'}\n for sg in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n if sg['groupName'] in securitygroupname_list:\n log.debug(\n 'AWS SecurityGroup ID of %s is %s',\n sg['groupName'], sg['groupId']\n )\n securitygroupid_set.add(sg['groupId'])\n return list(securitygroupid_set)\n\n\ndef securitygroupid(vm_):\n '''\n Returns the SecurityGroupId\n '''\n securitygroupid_set = set()\n securitygroupid_list = config.get_cloud_config_value(\n 'securitygroupid',\n vm_,\n __opts__,\n search_global=False\n )\n # If the list is None, then the set will remain empty\n # If the list is already a set then calling 'set' on it is a no-op\n # If the list is a string, then calling 'set' generates a one-element set\n # If the list is anything else, stacktrace\n if securitygroupid_list:\n securitygroupid_set = securitygroupid_set.union(set(securitygroupid_list))\n\n securitygroupname_list = config.get_cloud_config_value(\n 'securitygroupname', vm_, __opts__, search_global=False\n )\n if securitygroupname_list:\n if not isinstance(securitygroupname_list, list):\n securitygroupname_list = [securitygroupname_list]\n params = {'Action': 'DescribeSecurityGroups'}\n for sg in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n if sg['groupName'] in securitygroupname_list:\n log.debug(\n 'AWS SecurityGroup ID of %s is %s',\n sg['groupName'], sg['groupId']\n )\n securitygroupid_set.add(sg['groupId'])\n return list(securitygroupid_set)\n\n\ndef get_placementgroup(vm_):\n '''\n Returns the PlacementGroup to use\n '''\n return config.get_cloud_config_value(\n 'placementgroup', vm_, __opts__, search_global=False\n )\n\n\ndef get_spot_config(vm_):\n '''\n Returns the spot instance configuration for the provided vm\n '''\n return config.get_cloud_config_value(\n 'spot_config', vm_, __opts__, search_global=False\n )\n\n\ndef get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_comps[0]\n return provider\n\n\ndef _list_availability_zones(vm_=None):\n '''\n List all availability zones in the current region\n '''\n ret = {}\n\n params = {'Action': 'DescribeAvailabilityZones',\n 'Filter.0.Name': 'region-name',\n 'Filter.0.Value.0': get_location(vm_)}\n result = aws.query(params,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for zone in result:\n ret[zone['zoneName']] = zone['zoneState']\n\n return ret\n\n\ndef block_device_mappings(vm_):\n '''\n Return the block device mapping:\n\n .. code-block:: python\n\n [{'DeviceName': '/dev/sdb', 'VirtualName': 'ephemeral0'},\n {'DeviceName': '/dev/sdc', 'VirtualName': 'ephemeral1'}]\n '''\n return config.get_cloud_config_value(\n 'block_device_mappings', vm_, __opts__, search_global=True\n )\n\n\ndef _request_eip(interface, vm_):\n '''\n Request and return Elastic IP\n '''\n params = {'Action': 'AllocateAddress'}\n params['Domain'] = interface.setdefault('domain', 'vpc')\n eips = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n for eip in eips:\n if 'allocationId' in eip:\n return eip['allocationId']\n return None\n\n\ndef _create_eni_if_necessary(interface, vm_):\n '''\n Create an Elastic Interface if necessary and return a Network Interface Specification\n '''\n if 'NetworkInterfaceId' in interface and interface['NetworkInterfaceId'] is not None:\n return {'DeviceIndex': interface['DeviceIndex'],\n 'NetworkInterfaceId': interface['NetworkInterfaceId']}\n\n params = {'Action': 'DescribeSubnets'}\n subnet_query = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if 'SecurityGroupId' not in interface and 'securitygroupname' in interface:\n interface['SecurityGroupId'] = _get_securitygroupname_id(interface['securitygroupname'])\n if 'SubnetId' not in interface and 'subnetname' in interface:\n interface['SubnetId'] = _get_subnetname_id(interface['subnetname'])\n\n subnet_id = _get_subnet_id_for_interface(subnet_query, interface)\n if not subnet_id:\n raise SaltCloudConfigError(\n 'No such subnet <{0}>'.format(interface.get('SubnetId'))\n )\n params = {'SubnetId': subnet_id}\n\n for k in 'Description', 'PrivateIpAddress', 'SecondaryPrivateIpAddressCount':\n if k in interface:\n params[k] = interface[k]\n\n for k in 'PrivateIpAddresses', 'SecurityGroupId':\n if k in interface:\n params.update(_param_from_config(k, interface[k]))\n\n if 'AssociatePublicIpAddress' in interface:\n # Associating a public address in a VPC only works when the interface is not\n # created beforehand, but as a part of the machine creation request.\n for k in ('DeviceIndex', 'AssociatePublicIpAddress', 'NetworkInterfaceId'):\n if k in interface:\n params[k] = interface[k]\n params['DeleteOnTermination'] = interface.get('delete_interface_on_terminate', True)\n return params\n\n params['Action'] = 'CreateNetworkInterface'\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n eni_desc = result[1]\n if not eni_desc or not eni_desc.get('networkInterfaceId'):\n raise SaltCloudException('Failed to create interface: {0}'.format(result))\n\n eni_id = eni_desc.get('networkInterfaceId')\n log.debug(\n 'Created network interface %s inst %s',\n eni_id, interface['DeviceIndex']\n )\n\n associate_public_ip = interface.get('AssociatePublicIpAddress', False)\n if isinstance(associate_public_ip, six.string_types):\n # Assume id of EIP as value\n _associate_eip_with_interface(eni_id, associate_public_ip, vm_=vm_)\n\n if interface.get('associate_eip'):\n _associate_eip_with_interface(eni_id, interface.get('associate_eip'), vm_=vm_)\n elif interface.get('allocate_new_eip'):\n _new_eip = _request_eip(interface, vm_)\n _associate_eip_with_interface(eni_id, _new_eip, vm_=vm_)\n elif interface.get('allocate_new_eips'):\n addr_list = _list_interface_private_addrs(eni_desc)\n eip_list = []\n for idx, addr in enumerate(addr_list):\n eip_list.append(_request_eip(interface, vm_))\n for idx, addr in enumerate(addr_list):\n _associate_eip_with_interface(eni_id, eip_list[idx], addr, vm_=vm_)\n\n if 'Name' in interface:\n tag_params = {'Action': 'CreateTags',\n 'ResourceId.0': eni_id,\n 'Tag.0.Key': 'Name',\n 'Tag.0.Value': interface['Name']}\n tag_response = aws.query(tag_params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in tag_response:\n log.error('Failed to set name of interface {0}')\n\n return {'DeviceIndex': interface['DeviceIndex'],\n 'NetworkInterfaceId': eni_id}\n\n\ndef _get_subnet_id_for_interface(subnet_query, interface):\n for subnet_query_result in subnet_query:\n if 'item' in subnet_query_result:\n if isinstance(subnet_query_result['item'], dict):\n subnet_id = _get_subnet_from_subnet_query(subnet_query_result['item'],\n interface)\n if subnet_id is not None:\n return subnet_id\n\n else:\n for subnet in subnet_query_result['item']:\n subnet_id = _get_subnet_from_subnet_query(subnet, interface)\n if subnet_id is not None:\n return subnet_id\n\n\ndef _get_subnet_from_subnet_query(subnet_query, interface):\n if 'subnetId' in subnet_query:\n if interface.get('SubnetId'):\n if subnet_query['subnetId'] == interface['SubnetId']:\n return subnet_query['subnetId']\n else:\n return subnet_query['subnetId']\n\n\ndef _list_interface_private_addrs(eni_desc):\n '''\n Returns a list of all of the private IP addresses attached to a\n network interface. The 'primary' address will be listed first.\n '''\n primary = eni_desc.get('privateIpAddress')\n if not primary:\n return None\n\n addresses = [primary]\n\n lst = eni_desc.get('privateIpAddressesSet', {}).get('item', [])\n if not isinstance(lst, list):\n return addresses\n\n for entry in lst:\n if entry.get('primary') == 'true':\n continue\n if entry.get('privateIpAddress'):\n addresses.append(entry.get('privateIpAddress'))\n\n return addresses\n\n\ndef _modify_eni_properties(eni_id, properties=None, vm_=None):\n '''\n Change properties of the interface\n with id eni_id to the values in properties dict\n '''\n if not isinstance(properties, dict):\n raise SaltCloudException(\n 'ENI properties must be a dictionary'\n )\n\n params = {'Action': 'ModifyNetworkInterfaceAttribute',\n 'NetworkInterfaceId': eni_id}\n for k, v in six.iteritems(properties):\n params[k] = v\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if isinstance(result, dict) and result.get('error'):\n raise SaltCloudException(\n 'Could not change interface <{0}> attributes <\\'{1}\\'>'.format(\n eni_id, properties\n )\n )\n else:\n return result\n\n\ndef _associate_eip_with_interface(eni_id, eip_id, private_ip=None, vm_=None):\n '''\n Accept the id of a network interface, and the id of an elastic ip\n address, and associate the two of them, such that traffic sent to the\n elastic ip address will be forwarded (NATted) to this network interface.\n\n Optionally specify the private (10.x.x.x) IP address that traffic should\n be NATted to - useful if you have multiple IP addresses assigned to an\n interface.\n '''\n params = {'Action': 'AssociateAddress',\n 'NetworkInterfaceId': eni_id,\n 'AllocationId': eip_id}\n\n if private_ip:\n params['PrivateIpAddress'] = private_ip\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if not result[2].get('associationId'):\n raise SaltCloudException(\n 'Could not associate elastic ip address '\n '<{0}> with network interface <{1}>'.format(\n eip_id, eni_id\n )\n )\n\n log.debug(\n 'Associated ElasticIP address %s with interface %s',\n eip_id, eni_id\n )\n\n return result[2].get('associationId')\n\n\ndef _update_enis(interfaces, instance, vm_=None):\n config_enis = {}\n instance_enis = []\n for interface in interfaces:\n if 'DeviceIndex' in interface:\n if interface['DeviceIndex'] in config_enis:\n log.error(\n 'Duplicate DeviceIndex in profile. Cannot update ENIs.'\n )\n return None\n config_enis[six.text_type(interface['DeviceIndex'])] = interface\n query_enis = instance[0]['instancesSet']['item']['networkInterfaceSet']['item']\n if isinstance(query_enis, list):\n for query_eni in query_enis:\n instance_enis.append((query_eni['networkInterfaceId'], query_eni['attachment']))\n else:\n instance_enis.append((query_enis['networkInterfaceId'], query_enis['attachment']))\n\n for eni_id, eni_data in instance_enis:\n delete_on_terminate = True\n if 'DeleteOnTermination' in config_enis[eni_data['deviceIndex']]:\n delete_on_terminate = config_enis[eni_data['deviceIndex']]['DeleteOnTermination']\n elif 'delete_interface_on_terminate' in config_enis[eni_data['deviceIndex']]:\n delete_on_terminate = config_enis[eni_data['deviceIndex']]['delete_interface_on_terminate']\n\n params_attachment = {'Attachment.AttachmentId': eni_data['attachmentId'],\n 'Attachment.DeleteOnTermination': delete_on_terminate}\n set_eni_attachment_attributes = _modify_eni_properties(eni_id, params_attachment, vm_=vm_)\n\n if 'SourceDestCheck' in config_enis[eni_data['deviceIndex']]:\n params_sourcedest = {'SourceDestCheck.Value': config_enis[eni_data['deviceIndex']]['SourceDestCheck']}\n set_eni_sourcedest_property = _modify_eni_properties(eni_id, params_sourcedest, vm_=vm_)\n\n return None\n\n\ndef _param_from_config(key, data):\n '''\n Return EC2 API parameters based on the given config data.\n\n Examples:\n 1. List of dictionaries\n >>> data = [\n ... {'DeviceIndex': 0, 'SubnetId': 'subid0',\n ... 'AssociatePublicIpAddress': True},\n ... {'DeviceIndex': 1,\n ... 'SubnetId': 'subid1',\n ... 'PrivateIpAddress': '192.168.1.128'}\n ... ]\n >>> _param_from_config('NetworkInterface', data)\n ... {'NetworkInterface.0.SubnetId': 'subid0',\n ... 'NetworkInterface.0.DeviceIndex': 0,\n ... 'NetworkInterface.1.SubnetId': 'subid1',\n ... 'NetworkInterface.1.PrivateIpAddress': '192.168.1.128',\n ... 'NetworkInterface.0.AssociatePublicIpAddress': 'true',\n ... 'NetworkInterface.1.DeviceIndex': 1}\n\n 2. List of nested dictionaries\n >>> data = [\n ... {'DeviceName': '/dev/sdf',\n ... 'Ebs': {\n ... 'SnapshotId': 'dummy0',\n ... 'VolumeSize': 200,\n ... 'VolumeType': 'standard'}},\n ... {'DeviceName': '/dev/sdg',\n ... 'Ebs': {\n ... 'SnapshotId': 'dummy1',\n ... 'VolumeSize': 100,\n ... 'VolumeType': 'standard'}}\n ... ]\n >>> _param_from_config('BlockDeviceMapping', data)\n ... {'BlockDeviceMapping.0.Ebs.VolumeType': 'standard',\n ... 'BlockDeviceMapping.1.Ebs.SnapshotId': 'dummy1',\n ... 'BlockDeviceMapping.0.Ebs.VolumeSize': 200,\n ... 'BlockDeviceMapping.0.Ebs.SnapshotId': 'dummy0',\n ... 'BlockDeviceMapping.1.Ebs.VolumeType': 'standard',\n ... 'BlockDeviceMapping.1.DeviceName': '/dev/sdg',\n ... 'BlockDeviceMapping.1.Ebs.VolumeSize': 100,\n ... 'BlockDeviceMapping.0.DeviceName': '/dev/sdf'}\n\n 3. Dictionary of dictionaries\n >>> data = { 'Arn': 'dummyarn', 'Name': 'Tester' }\n >>> _param_from_config('IamInstanceProfile', data)\n {'IamInstanceProfile.Arn': 'dummyarn', 'IamInstanceProfile.Name': 'Tester'}\n\n '''\n\n param = {}\n\n if isinstance(data, dict):\n for k, v in six.iteritems(data):\n param.update(_param_from_config('{0}.{1}'.format(key, k), v))\n\n elif isinstance(data, list) or isinstance(data, tuple):\n for idx, conf_item in enumerate(data):\n prefix = '{0}.{1}'.format(key, idx)\n param.update(_param_from_config(prefix, conf_item))\n\n else:\n if isinstance(data, bool):\n # convert boolean True/False to 'true'/'false'\n param.update({key: six.text_type(data).lower()})\n else:\n param.update({key: data})\n\n return param\n\n\ndef request_instance(vm_=None, call=None):\n '''\n Put together all of the information necessary to request an instance on EC2,\n and then fire off the request the instance.\n\n Returns data about the instance\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The request_instance action must be called with -a or --action.'\n )\n\n location = vm_.get('location', get_location(vm_))\n\n # do we launch a regular vm or a spot instance?\n # see http://goo.gl/hYZ13f for more information on EC2 API\n spot_config = get_spot_config(vm_)\n if spot_config is not None:\n if 'spot_price' not in spot_config:\n raise SaltCloudSystemExit(\n 'Spot instance config for {0} requires a spot_price '\n 'attribute.'.format(vm_['name'])\n )\n\n params = {'Action': 'RequestSpotInstances',\n 'InstanceCount': '1',\n 'Type': spot_config['type']\n if 'type' in spot_config else 'one-time',\n 'SpotPrice': spot_config['spot_price']}\n\n # All of the necessary launch parameters for a VM when using\n # spot instances are the same except for the prefix below\n # being tacked on.\n spot_prefix = 'LaunchSpecification.'\n\n # regular EC2 instance\n else:\n # WARNING! EXPERIMENTAL!\n # This allows more than one instance to be spun up in a single call.\n # The first instance will be called by the name provided, but all other\n # instances will be nameless (or more specifically, they will use the\n # InstanceId as the name). This interface is expected to change, so\n # use at your own risk.\n min_instance = config.get_cloud_config_value(\n 'min_instance', vm_, __opts__, search_global=False, default=1\n )\n max_instance = config.get_cloud_config_value(\n 'max_instance', vm_, __opts__, search_global=False, default=1\n )\n params = {'Action': 'RunInstances',\n 'MinCount': min_instance,\n 'MaxCount': max_instance}\n\n # Normal instances should have no prefix.\n spot_prefix = ''\n\n image_id = get_imageid(vm_)\n params[spot_prefix + 'ImageId'] = image_id\n\n userdata = None\n userdata_file = config.get_cloud_config_value(\n 'userdata_file', vm_, __opts__, search_global=False, default=None\n )\n if userdata_file is None:\n userdata = config.get_cloud_config_value(\n 'userdata', vm_, __opts__, search_global=False, default=None\n )\n else:\n log.trace('userdata_file: %s', userdata_file)\n if os.path.exists(userdata_file):\n with salt.utils.files.fopen(userdata_file, 'r') as fh_:\n userdata = salt.utils.stringutils.to_unicode(fh_.read())\n\n userdata = salt.utils.cloud.userdata_template(__opts__, vm_, userdata)\n\n if userdata is not None:\n try:\n params[spot_prefix + 'UserData'] = base64.b64encode(\n salt.utils.stringutils.to_bytes(userdata)\n )\n except Exception as exc:\n log.exception('Failed to encode userdata: %s', exc)\n\n vm_size = config.get_cloud_config_value(\n 'size', vm_, __opts__, search_global=False\n )\n params[spot_prefix + 'InstanceType'] = vm_size\n\n ex_keyname = keyname(vm_)\n if ex_keyname:\n params[spot_prefix + 'KeyName'] = ex_keyname\n\n ex_securitygroup = securitygroup(vm_)\n if ex_securitygroup:\n if not isinstance(ex_securitygroup, list):\n params[spot_prefix + 'SecurityGroup.1'] = ex_securitygroup\n else:\n for counter, sg_ in enumerate(ex_securitygroup):\n params[spot_prefix + 'SecurityGroup.{0}'.format(counter)] = sg_\n\n ex_iam_profile = iam_profile(vm_)\n if ex_iam_profile:\n try:\n if ex_iam_profile.startswith('arn:aws:iam:'):\n params[\n spot_prefix + 'IamInstanceProfile.Arn'\n ] = ex_iam_profile\n else:\n params[\n spot_prefix + 'IamInstanceProfile.Name'\n ] = ex_iam_profile\n except AttributeError:\n raise SaltCloudConfigError(\n '\\'iam_profile\\' should be a string value.'\n )\n\n az_ = get_availability_zone(vm_)\n if az_ is not None:\n params[spot_prefix + 'Placement.AvailabilityZone'] = az_\n\n tenancy_ = get_tenancy(vm_)\n if tenancy_ is not None:\n if spot_config is not None:\n raise SaltCloudConfigError(\n 'Spot instance config for {0} does not support '\n 'specifying tenancy.'.format(vm_['name'])\n )\n params['Placement.Tenancy'] = tenancy_\n\n subnetid_ = get_subnetid(vm_)\n if subnetid_ is not None:\n params[spot_prefix + 'SubnetId'] = subnetid_\n\n ex_securitygroupid = securitygroupid(vm_)\n if ex_securitygroupid:\n if not isinstance(ex_securitygroupid, list):\n params[spot_prefix + 'SecurityGroupId.1'] = ex_securitygroupid\n else:\n for counter, sg_ in enumerate(ex_securitygroupid):\n params[\n spot_prefix + 'SecurityGroupId.{0}'.format(counter)\n ] = sg_\n\n placementgroup_ = get_placementgroup(vm_)\n if placementgroup_ is not None:\n params[spot_prefix + 'Placement.GroupName'] = placementgroup_\n\n blockdevicemappings_holder = block_device_mappings(vm_)\n if blockdevicemappings_holder:\n for _bd in blockdevicemappings_holder:\n if 'tag' in _bd:\n _bd.pop('tag')\n\n ex_blockdevicemappings = blockdevicemappings_holder\n if ex_blockdevicemappings:\n params.update(_param_from_config(spot_prefix + 'BlockDeviceMapping',\n ex_blockdevicemappings))\n\n network_interfaces = config.get_cloud_config_value(\n 'network_interfaces',\n vm_,\n __opts__,\n search_global=False\n )\n\n if network_interfaces:\n eni_devices = []\n for interface in network_interfaces:\n log.debug('Create network interface: %s', interface)\n _new_eni = _create_eni_if_necessary(interface, vm_)\n eni_devices.append(_new_eni)\n params.update(_param_from_config(spot_prefix + 'NetworkInterface',\n eni_devices))\n\n set_ebs_optimized = config.get_cloud_config_value(\n 'ebs_optimized', vm_, __opts__, search_global=False\n )\n\n if set_ebs_optimized is not None:\n if not isinstance(set_ebs_optimized, bool):\n raise SaltCloudConfigError(\n '\\'ebs_optimized\\' should be a boolean value.'\n )\n params[spot_prefix + 'EbsOptimized'] = set_ebs_optimized\n\n set_del_root_vol_on_destroy = config.get_cloud_config_value(\n 'del_root_vol_on_destroy', vm_, __opts__, search_global=False\n )\n\n set_termination_protection = config.get_cloud_config_value(\n 'termination_protection', vm_, __opts__, search_global=False\n )\n\n if set_termination_protection is not None:\n if not isinstance(set_termination_protection, bool):\n raise SaltCloudConfigError(\n '\\'termination_protection\\' should be a boolean value.'\n )\n params.update(_param_from_config(spot_prefix + 'DisableApiTermination',\n set_termination_protection))\n\n if set_del_root_vol_on_destroy and not isinstance(set_del_root_vol_on_destroy, bool):\n raise SaltCloudConfigError(\n '\\'del_root_vol_on_destroy\\' should be a boolean value.'\n )\n\n vm_['set_del_root_vol_on_destroy'] = set_del_root_vol_on_destroy\n\n if set_del_root_vol_on_destroy:\n # first make sure to look up the root device name\n # as Ubuntu and CentOS (and most likely other OSs)\n # use different device identifiers\n\n log.info('Attempting to look up root device name for image id %s on '\n 'VM %s', image_id, vm_['name'])\n\n rd_params = {\n 'Action': 'DescribeImages',\n 'ImageId.1': image_id\n }\n try:\n rd_data = aws.query(rd_params,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in rd_data:\n return rd_data['error']\n log.debug('EC2 Response: \\'%s\\'', rd_data)\n except Exception as exc:\n log.error(\n 'Error getting root device name for image id %s for '\n 'VM %s: \\n%s', image_id, vm_['name'], exc,\n # Show the traceback if the debug logging level is enabled\n exc_info_on_loglevel=logging.DEBUG\n )\n raise\n\n # make sure we have a response\n if not rd_data:\n err_msg = 'There was an error querying EC2 for the root device ' \\\n 'of image id {0}. Empty response.'.format(image_id)\n raise SaltCloudSystemExit(err_msg)\n\n # pull the root device name from the result and use it when\n # launching the new VM\n rd_name = None\n rd_type = None\n if 'blockDeviceMapping' in rd_data[0]:\n # Some ami instances do not have a root volume. Ignore such cases\n if rd_data[0]['blockDeviceMapping'] is not None:\n item = rd_data[0]['blockDeviceMapping']['item']\n if isinstance(item, list):\n item = item[0]\n rd_name = item['deviceName']\n # Grab the volume type\n rd_type = item['ebs'].get('volumeType', None)\n\n log.info('Found root device name: %s', rd_name)\n\n if rd_name is not None:\n if ex_blockdevicemappings:\n dev_list = [\n dev['DeviceName'] for dev in ex_blockdevicemappings\n ]\n else:\n dev_list = []\n\n if rd_name in dev_list:\n # Device already listed, just grab the index\n dev_index = dev_list.index(rd_name)\n else:\n dev_index = len(dev_list)\n # Add the device name in since it wasn't already there\n params[\n '{0}BlockDeviceMapping.{1}.DeviceName'.format(\n spot_prefix, dev_index\n )\n ] = rd_name\n\n # Set the termination value\n termination_key = '{0}BlockDeviceMapping.{1}.Ebs.DeleteOnTermination'.format(spot_prefix, dev_index)\n params[termination_key] = six.text_type(set_del_root_vol_on_destroy).lower()\n\n # Use default volume type if not specified\n if ex_blockdevicemappings and dev_index < len(ex_blockdevicemappings) and \\\n 'Ebs.VolumeType' not in ex_blockdevicemappings[dev_index]:\n type_key = '{0}BlockDeviceMapping.{1}.Ebs.VolumeType'.format(spot_prefix, dev_index)\n params[type_key] = rd_type\n\n set_del_all_vols_on_destroy = config.get_cloud_config_value(\n 'del_all_vols_on_destroy', vm_, __opts__, search_global=False, default=False\n )\n\n if set_del_all_vols_on_destroy and not isinstance(set_del_all_vols_on_destroy, bool):\n raise SaltCloudConfigError(\n '\\'del_all_vols_on_destroy\\' should be a boolean value.'\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'requesting instance',\n 'salt/cloud/{0}/requesting'.format(vm_['name']),\n args={\n 'kwargs': __utils__['cloud.filter_event'](\n 'requesting', params, list(params)\n ),\n 'location': location,\n },\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n provider = get_provider(vm_)\n\n try:\n data = aws.query(params,\n 'instancesSet',\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if 'error' in data:\n return data['error']\n except Exception as exc:\n log.error(\n 'Error creating %s on EC2 when trying to run the initial '\n 'deployment: \\n%s', vm_['name'], exc,\n # Show the traceback if the debug logging level is enabled\n exc_info_on_loglevel=logging.DEBUG\n )\n raise\n\n # if we're using spot instances, we need to wait for the spot request\n # to become active before we continue\n if spot_config:\n sir_id = data[0]['spotInstanceRequestId']\n\n vm_['spotRequestId'] = sir_id\n\n def __query_spot_instance_request(sir_id, location):\n params = {'Action': 'DescribeSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if not data:\n log.error(\n 'There was an error while querying EC2. Empty response'\n )\n # Trigger a failure in the wait for spot instance method\n return False\n\n if isinstance(data, dict) and 'error' in data:\n log.warning('There was an error in the query. %s', data['error'])\n # Trigger a failure in the wait for spot instance method\n return False\n\n log.debug('Returned query data: %s', data)\n\n state = data[0].get('state')\n\n if state == 'active':\n return data\n\n if state == 'open':\n # Still waiting for an active state\n log.info('Spot instance status: %s', data[0]['status']['message'])\n return None\n\n if state in ['cancelled', 'failed', 'closed']:\n # Request will never be active, fail\n log.error('Spot instance request resulted in state \\'{0}\\'. '\n 'Nothing else we can do here.')\n return False\n\n __utils__['cloud.fire_event'](\n 'event',\n 'waiting for spot instance',\n 'salt/cloud/{0}/waiting_for_spot'.format(vm_['name']),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n try:\n data = _wait_for_spot_instance(\n __query_spot_instance_request,\n update_args=(sir_id, location),\n timeout=config.get_cloud_config_value(\n 'wait_for_spot_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_spot_interval', vm_, __opts__, default=30),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_spot_interval_multiplier',\n vm_,\n __opts__,\n default=1),\n max_failures=config.get_cloud_config_value(\n 'wait_for_spot_max_failures',\n vm_,\n __opts__,\n default=10),\n )\n log.debug('wait_for_spot_instance data %s', data)\n\n except (SaltCloudExecutionTimeout, SaltCloudExecutionFailure) as exc:\n try:\n # Cancel the existing spot instance request\n params = {'Action': 'CancelSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n\n log.debug('Canceled spot instance request %s. Data '\n 'returned: %s', sir_id, data)\n\n except SaltCloudSystemExit:\n pass\n finally:\n raise SaltCloudSystemExit(six.text_type(exc))\n\n return data, vm_\n\n\ndef query_instance(vm_=None, call=None):\n '''\n Query an instance upon creation from the EC2 API\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The query_instance action must be called with -a or --action.'\n )\n\n instance_id = vm_['instance_id']\n location = vm_.get('location', get_location(vm_))\n __utils__['cloud.fire_event'](\n 'event',\n 'querying instance',\n 'salt/cloud/{0}/querying'.format(vm_['name']),\n args={'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n log.debug('The new VM instance_id is %s', instance_id)\n\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n\n provider = get_provider(vm_)\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n data, requesturl = aws.query(params, # pylint: disable=unbalanced-tuple-unpacking\n location=location,\n provider=provider,\n opts=__opts__,\n return_url=True,\n sigver='4')\n log.debug('The query returned: %s', data)\n\n if isinstance(data, dict) and 'error' in data:\n log.warning(\n 'There was an error in the query. %s attempts '\n 'remaining: %s', attempts, data['error']\n )\n elif isinstance(data, list) and not data:\n log.warning(\n 'Query returned an empty list. %s attempts '\n 'remaining.', attempts\n )\n else:\n break\n\n aws.sleep_exponential_backoff(attempts)\n attempts += 1\n continue\n else:\n raise SaltCloudSystemExit(\n 'An error occurred while creating VM: {0}'.format(data['error'])\n )\n\n def __query_ip_address(params, url): # pylint: disable=W0613\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if not data:\n log.error(\n 'There was an error while querying EC2. Empty response'\n )\n # Trigger a failure in the wait for IP function\n return False\n\n if isinstance(data, dict) and 'error' in data:\n log.warning('There was an error in the query. %s', data['error'])\n # Trigger a failure in the wait for IP function\n return False\n\n log.debug('Returned query data: %s', data)\n\n if ssh_interface(vm_) == 'public_ips':\n if 'ipAddress' in data[0]['instancesSet']['item']:\n return data\n else:\n log.error(\n 'Public IP not detected.'\n )\n\n if ssh_interface(vm_) == 'private_ips':\n if 'privateIpAddress' in data[0]['instancesSet']['item']:\n return data\n else:\n log.error(\n 'Private IP not detected.'\n )\n\n try:\n data = salt.utils.cloud.wait_for_ip(\n __query_ip_address,\n update_args=(params, requesturl),\n timeout=config.get_cloud_config_value(\n 'wait_for_ip_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_ip_interval', vm_, __opts__, default=10),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_ip_interval_multiplier', vm_, __opts__, default=1),\n )\n except (SaltCloudExecutionTimeout, SaltCloudExecutionFailure) as exc:\n try:\n # It might be already up, let's destroy it!\n destroy(vm_['name'])\n except SaltCloudSystemExit:\n pass\n finally:\n raise SaltCloudSystemExit(six.text_type(exc))\n\n if 'reactor' in vm_ and vm_['reactor'] is True:\n __utils__['cloud.fire_event'](\n 'event',\n 'instance queried',\n 'salt/cloud/{0}/query_reactor'.format(vm_['name']),\n args={'data': data},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n return data\n\n\ndef wait_for_instance(\n vm_=None,\n data=None,\n ip_address=None,\n display_ssh_output=True,\n call=None,\n ):\n '''\n Wait for an instance upon creation from the EC2 API, to become available\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The wait_for_instance action must be called with -a or --action.'\n )\n\n if vm_ is None:\n vm_ = {}\n\n if data is None:\n data = {}\n\n ssh_gateway_config = vm_.get(\n 'gateway', get_ssh_gateway_config(vm_)\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'waiting for ssh',\n 'salt/cloud/{0}/waiting_for_ssh'.format(vm_['name']),\n args={'ip_address': ip_address},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n ssh_connect_timeout = config.get_cloud_config_value(\n 'ssh_connect_timeout', vm_, __opts__, 900 # 15 minutes\n )\n ssh_port = config.get_cloud_config_value(\n 'ssh_port', vm_, __opts__, 22\n )\n\n if config.get_cloud_config_value('win_installer', vm_, __opts__):\n username = config.get_cloud_config_value(\n 'win_username', vm_, __opts__, default='Administrator'\n )\n win_passwd = config.get_cloud_config_value(\n 'win_password', vm_, __opts__, default=''\n )\n win_deploy_auth_retries = config.get_cloud_config_value(\n 'win_deploy_auth_retries', vm_, __opts__, default=10\n )\n win_deploy_auth_retry_delay = config.get_cloud_config_value(\n 'win_deploy_auth_retry_delay', vm_, __opts__, default=1\n )\n use_winrm = config.get_cloud_config_value(\n 'use_winrm', vm_, __opts__, default=False\n )\n winrm_verify_ssl = config.get_cloud_config_value(\n 'winrm_verify_ssl', vm_, __opts__, default=True\n )\n\n if win_passwd and win_passwd == 'auto':\n log.debug('Waiting for auto-generated Windows EC2 password')\n while True:\n password_data = get_password_data(\n name=vm_['name'],\n kwargs={\n 'key_file': vm_['private_key'],\n },\n call='action',\n )\n win_passwd = password_data.get('password', None)\n if win_passwd is None:\n log.debug(password_data)\n # This wait is so high, because the password is unlikely to\n # be generated for at least 4 minutes\n time.sleep(60)\n else:\n logging_data = password_data\n\n logging_data['password'] = 'XXX-REDACTED-XXX'\n logging_data['passwordData'] = 'XXX-REDACTED-XXX'\n log.debug(logging_data)\n\n vm_['win_password'] = win_passwd\n break\n\n # SMB used whether psexec or winrm\n if not salt.utils.cloud.wait_for_port(ip_address,\n port=445,\n timeout=ssh_connect_timeout):\n raise SaltCloudSystemExit(\n 'Failed to connect to remote windows host'\n )\n\n # If not using winrm keep same psexec behavior\n if not use_winrm:\n\n log.debug('Trying to authenticate via SMB using psexec')\n\n if not salt.utils.cloud.validate_windows_cred(ip_address,\n username,\n win_passwd,\n retries=win_deploy_auth_retries,\n retry_delay=win_deploy_auth_retry_delay):\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote windows host (smb)'\n )\n\n # If using winrm\n else:\n\n # Default HTTPS port can be changed in cloud configuration\n winrm_port = config.get_cloud_config_value(\n 'winrm_port', vm_, __opts__, default=5986\n )\n\n # Wait for winrm port to be available\n if not salt.utils.cloud.wait_for_port(ip_address,\n port=winrm_port,\n timeout=ssh_connect_timeout):\n raise SaltCloudSystemExit(\n 'Failed to connect to remote windows host (winrm)'\n )\n\n log.debug('Trying to authenticate via Winrm using pywinrm')\n\n if not salt.utils.cloud.wait_for_winrm(ip_address,\n winrm_port,\n username,\n win_passwd,\n timeout=ssh_connect_timeout,\n verify=winrm_verify_ssl):\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote windows host'\n )\n\n elif salt.utils.cloud.wait_for_port(ip_address,\n port=ssh_port,\n timeout=ssh_connect_timeout,\n gateway=ssh_gateway_config\n ):\n # If a known_hosts_file is configured, this instance will not be\n # accessible until it has a host key. Since this is provided on\n # supported instances by cloud-init, and viewable to us only from the\n # console output (which may take several minutes to become available,\n # we have some more waiting to do here.\n known_hosts_file = config.get_cloud_config_value(\n 'known_hosts_file', vm_, __opts__, default=None\n )\n if known_hosts_file:\n console = {}\n while 'output_decoded' not in console:\n console = get_console_output(\n instance_id=vm_['instance_id'],\n call='action',\n location=get_location(vm_)\n )\n pprint.pprint(console)\n time.sleep(5)\n output = salt.utils.stringutils.to_unicode(console['output_decoded'])\n comps = output.split('-----BEGIN SSH HOST KEY KEYS-----')\n if len(comps) < 2:\n # Fail; there are no host keys\n return False\n\n comps = comps[1].split('-----END SSH HOST KEY KEYS-----')\n keys = ''\n for line in comps[0].splitlines():\n if not line:\n continue\n keys += '\\n{0} {1}'.format(ip_address, line)\n\n with salt.utils.files.fopen(known_hosts_file, 'a') as fp_:\n fp_.write(salt.utils.stringutils.to_str(keys))\n fp_.close()\n\n for user in vm_['usernames']:\n if salt.utils.cloud.wait_for_passwd(\n host=ip_address,\n port=ssh_port,\n username=user,\n ssh_timeout=config.get_cloud_config_value(\n 'wait_for_passwd_timeout', vm_, __opts__, default=1 * 60\n ),\n key_filename=vm_['key_filename'],\n display_ssh_output=display_ssh_output,\n gateway=ssh_gateway_config,\n maxtries=config.get_cloud_config_value(\n 'wait_for_passwd_maxtries', vm_, __opts__, default=15\n ),\n known_hosts_file=config.get_cloud_config_value(\n 'known_hosts_file', vm_, __opts__,\n default='/dev/null'\n ),\n ):\n __opts__['ssh_username'] = user\n vm_['ssh_username'] = user\n break\n else:\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote ssh'\n )\n else:\n raise SaltCloudSystemExit(\n 'Failed to connect to remote ssh'\n )\n\n if 'reactor' in vm_ and vm_['reactor'] is True:\n __utils__['cloud.fire_event'](\n 'event',\n 'ssh is available',\n 'salt/cloud/{0}/ssh_ready_reactor'.format(vm_['name']),\n args={'ip_address': ip_address},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n return vm_\n\n\ndef _validate_key_path_and_mode(key_filename):\n if key_filename is None:\n raise SaltCloudSystemExit(\n 'The required \\'private_key\\' configuration setting is missing from the '\n '\\'ec2\\' driver.'\n )\n\n if not os.path.exists(key_filename):\n raise SaltCloudSystemExit(\n 'The EC2 key file \\'{0}\\' does not exist.\\n'.format(\n key_filename\n )\n )\n\n key_mode = stat.S_IMODE(os.stat(key_filename).st_mode)\n if key_mode not in (0o400, 0o600):\n raise SaltCloudSystemExit(\n 'The EC2 key file \\'{0}\\' needs to be set to mode 0400 or 0600.\\n'.format(\n key_filename\n )\n )\n\n return True\n\n\ndef create(vm_=None, call=None):\n '''\n Create a single VM from a data dict\n '''\n if call:\n raise SaltCloudSystemExit(\n 'You cannot create an instance with -a or -f.'\n )\n\n try:\n # Check for required profile parameters before sending any API calls.\n if vm_['profile'] and config.is_profile_configured(__opts__,\n __active_provider_name__ or 'ec2',\n vm_['profile'],\n vm_=vm_) is False:\n return False\n except AttributeError:\n pass\n\n # Check for private_key and keyfile name for bootstrapping new instances\n deploy = config.get_cloud_config_value(\n 'deploy', vm_, __opts__, default=True\n )\n win_password = config.get_cloud_config_value(\n 'win_password', vm_, __opts__, default=''\n )\n key_filename = config.get_cloud_config_value(\n 'private_key', vm_, __opts__, search_global=False, default=None\n )\n if deploy:\n # The private_key and keyname settings are only needed for bootstrapping\n # new instances when deploy is True\n _validate_key_path_and_mode(key_filename)\n\n __utils__['cloud.fire_event'](\n 'event',\n 'starting create',\n 'salt/cloud/{0}/creating'.format(vm_['name']),\n args=__utils__['cloud.filter_event']('creating', vm_, ['name', 'profile', 'provider', 'driver']),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n __utils__['cloud.cachedir_index_add'](\n vm_['name'], vm_['profile'], 'ec2', vm_['driver']\n )\n\n vm_['key_filename'] = key_filename\n # wait_for_instance requires private_key\n vm_['private_key'] = key_filename\n\n # Get SSH Gateway config early to verify the private_key,\n # if used, exists or not. We don't want to deploy an instance\n # and not be able to access it via the gateway.\n vm_['gateway'] = get_ssh_gateway_config(vm_)\n\n location = get_location(vm_)\n vm_['location'] = location\n\n log.info('Creating Cloud VM %s in %s', vm_['name'], location)\n vm_['usernames'] = salt.utils.cloud.ssh_usernames(\n vm_,\n __opts__,\n default_users=(\n 'ec2-user', # Amazon Linux, Fedora, RHEL; FreeBSD\n 'centos', # CentOS AMIs from AWS Marketplace\n 'ubuntu', # Ubuntu\n 'admin', # Debian GNU/Linux\n 'bitnami', # BitNami AMIs\n 'root' # Last resort, default user on RHEL 5, SUSE\n )\n )\n\n if 'instance_id' in vm_:\n # This was probably created via another process, and doesn't have\n # things like salt keys created yet, so let's create them now.\n if 'pub_key' not in vm_ and 'priv_key' not in vm_:\n log.debug('Generating minion keys for \\'%s\\'', vm_['name'])\n vm_['priv_key'], vm_['pub_key'] = salt.utils.cloud.gen_keys(\n salt.config.get_cloud_config_value(\n 'keysize',\n vm_,\n __opts__\n )\n )\n else:\n # Put together all of the information required to request the instance,\n # and then fire off the request for it\n if keyname(vm_) is None:\n raise SaltCloudSystemExit(\n 'The required \\'keyname\\' configuration setting is missing from the '\n '\\'ec2\\' driver.'\n )\n\n data, vm_ = request_instance(vm_, location)\n\n # If data is a str, it's an error\n if isinstance(data, six.string_types):\n log.error('Error requesting instance: %s', data)\n return {}\n\n # Pull the instance ID, valid for both spot and normal instances\n\n # Multiple instances may have been spun up, get all their IDs\n vm_['instance_id_list'] = []\n for instance in data:\n vm_['instance_id_list'].append(instance['instanceId'])\n\n vm_['instance_id'] = vm_['instance_id_list'].pop()\n if vm_['instance_id_list']:\n # Multiple instances were spun up, get one now, and queue the rest\n queue_instances(vm_['instance_id_list'])\n\n # Wait for vital information, such as IP addresses, to be available\n # for the new instance\n data = query_instance(vm_)\n\n # Now that the instance is available, tag it appropriately. Should\n # mitigate race conditions with tags\n tags = config.get_cloud_config_value('tag',\n vm_,\n __opts__,\n {},\n search_global=False)\n if not isinstance(tags, dict):\n raise SaltCloudConfigError(\n '\\'tag\\' should be a dict.'\n )\n\n for value in six.itervalues(tags):\n if not isinstance(value, six.string_types):\n raise SaltCloudConfigError(\n '\\'tag\\' values must be strings. Try quoting the values. '\n 'e.g. \"2013-09-19T20:09:46Z\".'\n )\n\n tags['Name'] = vm_['name']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/{0}/tagging'.format(vm_['name']),\n args={'tags': tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n salt.utils.cloud.wait_for_fun(\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=tags,\n instance_id=vm_['instance_id'],\n call='action',\n location=location\n )\n\n # Once instance tags are set, tag the spot request if configured\n if 'spot_config' in vm_ and 'tag' in vm_['spot_config']:\n\n if not isinstance(vm_['spot_config']['tag'], dict):\n raise SaltCloudConfigError(\n '\\'tag\\' should be a dict.'\n )\n\n for value in six.itervalues(vm_['spot_config']['tag']):\n if not isinstance(value, str):\n raise SaltCloudConfigError(\n '\\'tag\\' values must be strings. Try quoting the values. '\n 'e.g. \"2013-09-19T20:09:46Z\".'\n )\n\n spot_request_tags = {}\n\n if 'spotRequestId' not in vm_:\n raise SaltCloudConfigError('Failed to find spotRequestId')\n\n sir_id = vm_['spotRequestId']\n\n spot_request_tags['Name'] = vm_['name']\n\n for k, v in six.iteritems(vm_['spot_config']['tag']):\n spot_request_tags[k] = v\n\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/spot_request_{0}/tagging'.format(sir_id),\n args={'tags': spot_request_tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n salt.utils.cloud.wait_for_fun(\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=spot_request_tags,\n instance_id=sir_id,\n call='action',\n location=location\n )\n\n network_interfaces = config.get_cloud_config_value(\n 'network_interfaces',\n vm_,\n __opts__,\n search_global=False\n )\n\n if network_interfaces:\n _update_enis(network_interfaces, data, vm_)\n\n # At this point, the node is created and tagged, and now needs to be\n # bootstrapped, once the necessary port is available.\n log.info('Created node %s', vm_['name'])\n\n instance = data[0]['instancesSet']['item']\n\n # Wait for the necessary port to become available to bootstrap\n if ssh_interface(vm_) == 'private_ips':\n ip_address = instance['privateIpAddress']\n log.info('Salt node data. Private_ip: %s', ip_address)\n else:\n ip_address = instance['ipAddress']\n log.info('Salt node data. Public_ip: %s', ip_address)\n vm_['ssh_host'] = ip_address\n\n if salt.utils.cloud.get_salt_interface(vm_, __opts__) == 'private_ips':\n salt_ip_address = instance['privateIpAddress']\n log.info('Salt interface set to: %s', salt_ip_address)\n else:\n salt_ip_address = instance['ipAddress']\n log.debug('Salt interface set to: %s', salt_ip_address)\n vm_['salt_host'] = salt_ip_address\n\n if deploy:\n display_ssh_output = config.get_cloud_config_value(\n 'display_ssh_output', vm_, __opts__, default=True\n )\n\n vm_ = wait_for_instance(\n vm_, data, ip_address, display_ssh_output\n )\n\n # The instance is booted and accessible, let's Salt it!\n ret = instance.copy()\n\n # Get ANY defined volumes settings, merging data, in the following order\n # 1. VM config\n # 2. Profile config\n # 3. Global configuration\n volumes = config.get_cloud_config_value(\n 'volumes', vm_, __opts__, search_global=True\n )\n if volumes:\n __utils__['cloud.fire_event'](\n 'event',\n 'attaching volumes',\n 'salt/cloud/{0}/attaching_volumes'.format(vm_['name']),\n args={'volumes': volumes},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n log.info('Create and attach volumes to node %s', vm_['name'])\n created = create_attach_volumes(\n vm_['name'],\n {\n 'volumes': volumes,\n 'zone': ret['placement']['availabilityZone'],\n 'instance_id': ret['instanceId'],\n 'del_all_vols_on_destroy': vm_.get('del_all_vols_on_destroy', False)\n },\n call='action'\n )\n ret['Attached Volumes'] = created\n\n # Associate instance with a ssm document, if present\n ssm_document = config.get_cloud_config_value(\n 'ssm_document', vm_, __opts__, None, search_global=False\n )\n if ssm_document:\n log.debug('Associating with ssm document: %s', ssm_document)\n assoc = ssm_create_association(\n vm_['name'],\n {'ssm_document': ssm_document},\n instance_id=vm_['instance_id'],\n call='action'\n )\n if isinstance(assoc, dict) and assoc.get('error', None):\n log.error(\n 'Failed to associate instance %s with ssm document %s',\n vm_['instance_id'], ssm_document\n )\n return {}\n\n for key, value in six.iteritems(__utils__['cloud.bootstrap'](vm_, __opts__)):\n ret.setdefault(key, value)\n\n log.info('Created Cloud VM \\'%s\\'', vm_['name'])\n log.debug(\n '\\'%s\\' VM creation details:\\n%s',\n vm_['name'], pprint.pformat(instance)\n )\n\n event_data = {\n 'name': vm_['name'],\n 'profile': vm_['profile'],\n 'provider': vm_['driver'],\n 'instance_id': vm_['instance_id'],\n }\n if volumes:\n event_data['volumes'] = volumes\n if ssm_document:\n event_data['ssm_document'] = ssm_document\n\n __utils__['cloud.fire_event'](\n 'event',\n 'created instance',\n 'salt/cloud/{0}/created'.format(vm_['name']),\n args=__utils__['cloud.filter_event']('created', event_data, list(event_data)),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n # Ensure that the latest node data is returned\n node = _get_node(instance_id=vm_['instance_id'])\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n ret.update(node)\n\n # Add any block device tags specified\n ex_blockdevicetags = {}\n blockdevicemappings_holder = block_device_mappings(vm_)\n if blockdevicemappings_holder:\n for _bd in blockdevicemappings_holder:\n if 'tag' in _bd:\n ex_blockdevicetags[_bd['DeviceName']] = _bd['tag']\n\n block_device_volume_id_map = {}\n\n if ex_blockdevicetags:\n for _device, _map in six.iteritems(ret['blockDeviceMapping']):\n bd_items = []\n if isinstance(_map, dict):\n bd_items.append(_map)\n else:\n for mapitem in _map:\n bd_items.append(mapitem)\n\n for blockitem in bd_items:\n if blockitem['deviceName'] in ex_blockdevicetags and 'Name' not in ex_blockdevicetags[blockitem['deviceName']]:\n ex_blockdevicetags[blockitem['deviceName']]['Name'] = vm_['name']\n if blockitem['deviceName'] in ex_blockdevicetags:\n block_device_volume_id_map[blockitem[ret['rootDeviceType']]['volumeId']] = ex_blockdevicetags[blockitem['deviceName']]\n\n if block_device_volume_id_map:\n\n for volid, tags in six.iteritems(block_device_volume_id_map):\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/block_volume_{0}/tagging'.format(str(volid)),\n args={'tags': tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n __utils__['cloud.wait_for_fun'](\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=tags,\n resource_id=volid,\n call='action',\n location=location\n )\n\n return ret\n\n\ndef queue_instances(instances):\n '''\n Queue a set of instances to be provisioned later. Expects a list.\n\n Currently this only queries node data, and then places it in the cloud\n cache (if configured). If the salt-cloud-reactor is being used, these\n instances will be automatically provisioned using that.\n\n For more information about the salt-cloud-reactor, see:\n\n https://github.com/saltstack-formulas/salt-cloud-reactor\n '''\n for instance_id in instances:\n node = _get_node(instance_id=instance_id)\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n\n\ndef create_attach_volumes(name, kwargs, call=None, wait_to_finish=True):\n '''\n Create and attach volumes to created node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The create_attach_volumes action must be called with '\n '-a or --action.'\n )\n\n if 'instance_id' not in kwargs:\n kwargs['instance_id'] = _get_node(name)['instanceId']\n\n if isinstance(kwargs['volumes'], six.string_types):\n volumes = salt.utils.yaml.safe_load(kwargs['volumes'])\n else:\n volumes = kwargs['volumes']\n\n ret = []\n for volume in volumes:\n created = False\n volume_name = '{0} on {1}'.format(volume['device'], name)\n\n volume_dict = {\n 'volume_name': volume_name,\n 'zone': kwargs['zone']\n }\n if 'volume_id' in volume:\n volume_dict['volume_id'] = volume['volume_id']\n elif 'snapshot' in volume:\n volume_dict['snapshot'] = volume['snapshot']\n elif 'size' in volume:\n volume_dict['size'] = volume['size']\n else:\n raise SaltCloudConfigError(\n 'Cannot create volume. Please define one of \\'volume_id\\', '\n '\\'snapshot\\', or \\'size\\''\n )\n\n if 'tags' in volume:\n volume_dict['tags'] = volume['tags']\n if 'type' in volume:\n volume_dict['type'] = volume['type']\n if 'iops' in volume:\n volume_dict['iops'] = volume['iops']\n if 'encrypted' in volume:\n volume_dict['encrypted'] = volume['encrypted']\n if 'kmskeyid' in volume:\n volume_dict['kmskeyid'] = volume['kmskeyid']\n\n if 'volume_id' not in volume_dict:\n created_volume = create_volume(volume_dict, call='function', wait_to_finish=wait_to_finish)\n created = True\n if 'volumeId' in created_volume:\n volume_dict['volume_id'] = created_volume['volumeId']\n\n attach = attach_volume(\n name,\n {'volume_id': volume_dict['volume_id'],\n 'device': volume['device']},\n instance_id=kwargs['instance_id'],\n call='action'\n )\n\n # Update the delvol parameter for this volume\n delvols_on_destroy = kwargs.get('del_all_vols_on_destroy', None)\n\n if attach and created and delvols_on_destroy is not None:\n _toggle_delvol(instance_id=kwargs['instance_id'],\n device=volume['device'],\n value=delvols_on_destroy)\n\n if attach:\n msg = (\n '{0} attached to {1} (aka {2}) as device {3}'.format(\n volume_dict['volume_id'],\n kwargs['instance_id'],\n name,\n volume['device']\n )\n )\n log.info(msg)\n ret.append(msg)\n return ret\n\n\ndef stop(name, call=None):\n '''\n Stop a node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The stop action must be called with -a or --action.'\n )\n\n log.info('Stopping node %s', name)\n\n instance_id = _get_node(name)['instanceId']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'stopping instance',\n 'salt/cloud/{0}/stopping'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n params = {'Action': 'StopInstances',\n 'InstanceId.1': instance_id}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n return result\n\n\ndef start(name, call=None):\n '''\n Start a node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The start action must be called with -a or --action.'\n )\n\n log.info('Starting node %s', name)\n\n instance_id = _get_node(name)['instanceId']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'starting instance',\n 'salt/cloud/{0}/starting'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n params = {'Action': 'StartInstances',\n 'InstanceId.1': instance_id}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n return result\n\n\ndef set_tags(name=None,\n tags=None,\n call=None,\n location=None,\n instance_id=None,\n resource_id=None,\n kwargs=None): # pylint: disable=W0613\n '''\n Set tags for a resource. Normally a VM name or instance_id is passed in,\n but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a set_tags mymachine tag1=somestuff tag2='Other stuff'\n salt-cloud -a set_tags resource_id=vol-3267ab32 tag=somestuff\n '''\n if kwargs is None:\n kwargs = {}\n\n if location is None:\n location = get_location()\n\n if instance_id is None:\n if 'resource_id' in kwargs:\n resource_id = kwargs['resource_id']\n del kwargs['resource_id']\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n if resource_id is None:\n if instance_id is None:\n instance_id = _get_node(name=name, instance_id=None, location=location)['instanceId']\n else:\n instance_id = resource_id\n\n # This second check is a safety, in case the above still failed to produce\n # a usable ID\n if instance_id is None:\n return {\n 'Error': 'A valid instance_id or resource_id was not specified.'\n }\n\n params = {'Action': 'CreateTags',\n 'ResourceId.1': instance_id}\n\n log.debug('Tags to set for %s: %s', name, tags)\n\n if kwargs and not tags:\n tags = kwargs\n\n for idx, (tag_k, tag_v) in enumerate(six.iteritems(tags)):\n params['Tag.{0}.Key'.format(idx)] = tag_k\n params['Tag.{0}.Value'.format(idx)] = tag_v\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n aws.query(params,\n setname='tagSet',\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n settags = get_tags(\n instance_id=instance_id, call='action', location=location\n )\n\n log.debug('Setting the tags returned: %s', settags)\n\n failed_to_set_tags = False\n for tag in settags:\n if tag['key'] not in tags:\n # We were not setting this tag\n continue\n\n if tag.get('value') is None and tags.get(tag['key']) == '':\n # This is a correctly set tag with no value\n continue\n\n if six.text_type(tags.get(tag['key'])) != six.text_type(tag['value']):\n # Not set to the proper value!?\n log.debug(\n 'Setting the tag %s returned %s instead of %s',\n tag['key'], tags.get(tag['key']), tag['value']\n )\n failed_to_set_tags = True\n break\n\n if failed_to_set_tags:\n log.warning('Failed to set tags. Remaining attempts %s', attempts)\n attempts += 1\n aws.sleep_exponential_backoff(attempts)\n continue\n\n return settags\n\n raise SaltCloudSystemExit(\n 'Failed to set tags on {0}!'.format(name)\n )\n\n\ndef get_tags(name=None,\n instance_id=None,\n call=None,\n location=None,\n kwargs=None,\n resource_id=None): # pylint: disable=W0613\n '''\n Retrieve tags for a resource. Normally a VM name or instance_id is passed\n in, but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a get_tags mymachine\n salt-cloud -a get_tags resource_id=vol-3267ab32\n '''\n if location is None:\n location = get_location()\n\n if instance_id is None:\n if resource_id is None:\n if name:\n instance_id = _get_node(name)['instanceId']\n elif 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n elif 'resource_id' in kwargs:\n instance_id = kwargs['resource_id']\n else:\n instance_id = resource_id\n\n params = {'Action': 'DescribeTags',\n 'Filter.1.Name': 'resource-id',\n 'Filter.1.Value': instance_id}\n\n return aws.query(params,\n setname='tagSet',\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n\ndef del_tags(name=None,\n kwargs=None,\n call=None,\n instance_id=None,\n resource_id=None): # pylint: disable=W0613\n '''\n Delete tags for a resource. Normally a VM name or instance_id is passed in,\n but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a del_tags mymachine tags=mytag,\n salt-cloud -a del_tags mymachine tags=tag1,tag2,tag3\n salt-cloud -a del_tags resource_id=vol-3267ab32 tags=tag1,tag2,tag3\n '''\n if kwargs is None:\n kwargs = {}\n\n if 'tags' not in kwargs:\n raise SaltCloudSystemExit(\n 'A tag or tags must be specified using tags=list,of,tags'\n )\n\n if not name and 'resource_id' in kwargs:\n instance_id = kwargs['resource_id']\n del kwargs['resource_id']\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n params = {'Action': 'DeleteTags',\n 'ResourceId.1': instance_id}\n\n for idx, tag in enumerate(kwargs['tags'].split(',')):\n params['Tag.{0}.Key'.format(idx)] = tag\n\n aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if resource_id:\n return get_tags(resource_id=resource_id)\n else:\n return get_tags(instance_id=instance_id)\n\n\ndef rename(name, kwargs, call=None):\n '''\n Properly rename a node. Pass in the new name as \"new name\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a rename mymachine newname=yourmachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The rename action must be called with -a or --action.'\n )\n\n log.info('Renaming %s to %s', name, kwargs['newname'])\n\n set_tags(name, {'Name': kwargs['newname']}, call='action')\n\n salt.utils.cloud.rename_key(\n __opts__['pki_dir'], name, kwargs['newname']\n )\n\n\ndef destroy(name, call=None):\n '''\n Destroy a node. Will check termination protection and warn if enabled.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud --destroy mymachine\n '''\n if call == 'function':\n raise SaltCloudSystemExit(\n 'The destroy action must be called with -d, --destroy, '\n '-a or --action.'\n )\n\n node_metadata = _get_node(name)\n instance_id = node_metadata['instanceId']\n sir_id = node_metadata.get('spotInstanceRequestId')\n protected = show_term_protect(\n name=name,\n instance_id=instance_id,\n call='action',\n quiet=True\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'destroying instance',\n 'salt/cloud/{0}/destroying'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n if protected == 'true':\n raise SaltCloudSystemExit(\n 'This instance has been protected from being destroyed. '\n 'Use the following command to disable protection:\\n\\n'\n 'salt-cloud -a disable_term_protect {0}'.format(\n name\n )\n )\n\n ret = {}\n\n # Default behavior is to rename EC2 VMs when destroyed\n # via salt-cloud, unless explicitly set to False.\n rename_on_destroy = config.get_cloud_config_value('rename_on_destroy',\n get_configured_provider(),\n __opts__,\n search_global=False)\n if rename_on_destroy is not False:\n newname = '{0}-DEL{1}'.format(name, uuid.uuid4().hex)\n rename(name, kwargs={'newname': newname}, call='action')\n log.info(\n 'Machine will be identified as %s until it has been '\n 'cleaned up.', newname\n )\n ret['newname'] = newname\n\n params = {'Action': 'TerminateInstances',\n 'InstanceId.1': instance_id}\n\n location = get_location()\n provider = get_provider()\n result = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n\n log.info(result)\n ret.update(result[0])\n\n # If this instance is part of a spot instance request, we\n # need to cancel it as well\n if sir_id is not None:\n params = {'Action': 'CancelSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n result = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n ret['spotInstance'] = result[0]\n\n __utils__['cloud.fire_event'](\n 'event',\n 'destroyed instance',\n 'salt/cloud/{0}/destroyed'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n __utils__['cloud.cachedir_index_del'](name)\n\n if __opts__.get('update_cachedir', False) is True:\n __utils__['cloud.delete_minion_cachedir'](name, __active_provider_name__.split(':')[0], __opts__)\n\n return ret\n\n\ndef reboot(name, call=None):\n '''\n Reboot a node.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a reboot mymachine\n '''\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'RebootInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if result == []:\n log.info('Complete')\n\n return {'Reboot': 'Complete'}\n\n\ndef show_image(kwargs, call=None):\n '''\n Show the details from EC2 concerning an AMI\n '''\n if call != 'function':\n raise SaltCloudSystemExit(\n 'The show_image action must be called with -f or --function.'\n )\n\n params = {'ImageId.1': kwargs['image'],\n 'Action': 'DescribeImages'}\n result = aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n log.info(result)\n\n return result\n\n\ndef show_instance(name=None, instance_id=None, call=None, kwargs=None):\n '''\n Show the details from EC2 concerning an AMI.\n\n Can be called as an action (which requires a name):\n\n .. code-block:: bash\n\n salt-cloud -a show_instance myinstance\n\n ...or as a function (which requires either a name or instance_id):\n\n .. code-block:: bash\n\n salt-cloud -f show_instance my-ec2 name=myinstance\n salt-cloud -f show_instance my-ec2 instance_id=i-d34db33f\n '''\n if not name and call == 'action':\n raise SaltCloudSystemExit(\n 'The show_instance action requires a name.'\n )\n\n if call == 'function':\n name = kwargs.get('name', None)\n instance_id = kwargs.get('instance_id', None)\n\n if not name and not instance_id:\n raise SaltCloudSystemExit(\n 'The show_instance function requires '\n 'either a name or an instance_id'\n )\n\n node = _get_node(name=name, instance_id=instance_id)\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n return node\n\n\ndef _get_node(name=None, instance_id=None, location=None):\n if location is None:\n location = get_location()\n\n params = {'Action': 'DescribeInstances'}\n\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if instance_id:\n params['InstanceId.1'] = instance_id\n else:\n params['Filter.1.Name'] = 'tag:Name'\n params['Filter.1.Value.1'] = name\n\n log.trace(params)\n\n provider = get_provider()\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n try:\n instances = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n instance_info = _extract_instance_info(instances).values()\n return next(iter(instance_info))\n except IndexError:\n attempts += 1\n log.debug(\n 'Failed to get the data for node \\'%s\\'. Remaining '\n 'attempts: %s', instance_id or name, attempts\n )\n aws.sleep_exponential_backoff(attempts)\n return {}\n\n\ndef list_nodes_full(location=None, call=None):\n '''\n Return a list of the VMs that are on the provider\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes_full function must be called with -f '\n 'or --function.'\n )\n\n return _list_nodes_full(location or get_location())\n\n\ndef _extract_name_tag(item):\n if 'tagSet' in item and item['tagSet'] is not None:\n tagset = item['tagSet']\n if isinstance(tagset['item'], list):\n for tag in tagset['item']:\n if tag['key'] == 'Name':\n return tag['value']\n return item['instanceId']\n return item['tagSet']['item']['value']\n return item['instanceId']\n\n\ndef _extract_instance_info(instances):\n '''\n Given an instance query, return a dict of all instance data\n '''\n ret = {}\n for instance in instances:\n # items could be type dict or list (for stopped EC2 instances)\n if isinstance(instance['instancesSet']['item'], list):\n for item in instance['instancesSet']['item']:\n name = _extract_name_tag(item)\n ret[name] = item\n ret[name]['name'] = name\n ret[name].update(\n dict(\n id=item['instanceId'],\n image=item['imageId'],\n size=item['instanceType'],\n state=item['instanceState']['name'],\n private_ips=item.get('privateIpAddress', []),\n public_ips=item.get('ipAddress', [])\n )\n )\n else:\n item = instance['instancesSet']['item']\n name = _extract_name_tag(item)\n ret[name] = item\n ret[name]['name'] = name\n ret[name].update(\n dict(\n id=item['instanceId'],\n image=item['imageId'],\n size=item['instanceType'],\n state=item['instanceState']['name'],\n private_ips=item.get('privateIpAddress', []),\n public_ips=item.get('ipAddress', [])\n )\n )\n\n return ret\n\n\ndef _list_nodes_full(location=None):\n '''\n Return a list of the VMs that in this location\n '''\n provider = __active_provider_name__ or 'ec2'\n if ':' in provider:\n comps = provider.split(':')\n provider = comps[0]\n\n params = {'Action': 'DescribeInstances'}\n instances = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if 'error' in instances:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n instances['error']['Errors']['Error']['Message']\n )\n )\n\n ret = _extract_instance_info(instances)\n\n __utils__['cloud.cache_node_list'](ret, provider, __opts__)\n return ret\n\n\ndef list_nodes_min(location=None, call=None):\n '''\n Return a list of the VMs that are on the provider. Only a list of VM names,\n and their state, is returned. This is the minimum amount of information\n needed to check for existing VMs.\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes_min function must be called with -f or --function.'\n )\n\n ret = {}\n params = {'Action': 'DescribeInstances'}\n instances = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in instances:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n instances['error']['Errors']['Error']['Message']\n )\n )\n\n for instance in instances:\n if isinstance(instance['instancesSet']['item'], list):\n items = instance['instancesSet']['item']\n else:\n items = [instance['instancesSet']['item']]\n\n for item in items:\n state = item['instanceState']['name']\n name = _extract_name_tag(item)\n id = item['instanceId']\n ret[name] = {'state': state, 'id': id}\n return ret\n\n\ndef list_nodes(call=None):\n '''\n Return a list of the VMs that are on the provider\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes function must be called with -f or --function.'\n )\n\n ret = {}\n nodes = list_nodes_full(get_location())\n if 'error' in nodes:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n nodes['error']['Errors']['Error']['Message']\n )\n )\n for node in nodes:\n ret[node] = {\n 'id': nodes[node]['id'],\n 'image': nodes[node]['image'],\n 'name': nodes[node]['name'],\n 'size': nodes[node]['size'],\n 'state': nodes[node]['state'],\n 'private_ips': nodes[node]['private_ips'],\n 'public_ips': nodes[node]['public_ips'],\n }\n return ret\n\n\ndef list_nodes_select(call=None):\n '''\n Return a list of the VMs that are on the provider, with select fields\n '''\n return salt.utils.cloud.list_nodes_select(\n list_nodes_full(get_location()), __opts__['query.selection'], call,\n )\n\n\ndef show_term_protect(name=None, instance_id=None, call=None, quiet=False):\n '''\n Show the details from EC2 concerning an instance's termination protection state\n\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_term_protect action must be called with -a or --action.'\n )\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'DescribeInstanceAttribute',\n 'InstanceId': instance_id,\n 'Attribute': 'disableApiTermination'}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n disable_protect = False\n for item in result:\n if 'value' in item:\n disable_protect = item['value']\n break\n\n log.log(\n logging.DEBUG if quiet is True else logging.INFO,\n 'Termination Protection is %s for %s',\n disable_protect == 'true' and 'enabled' or 'disabled', name\n )\n\n return disable_protect\n\n\ndef show_detailed_monitoring(name=None, instance_id=None, call=None, quiet=False):\n '''\n Show the details from EC2 regarding cloudwatch detailed monitoring.\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_detailed_monitoring action must be called with -a or --action.'\n )\n location = get_location()\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if not name and not instance_id:\n raise SaltCloudSystemExit(\n 'The show_detailed_monitoring action must be provided with a name or instance\\\n ID'\n )\n matched = _get_node(name=name, instance_id=instance_id, location=location)\n log.log(\n logging.DEBUG if quiet is True else logging.INFO,\n 'Detailed Monitoring is %s for %s', matched['monitoring'], name\n )\n return matched['monitoring']\n\n\ndef _toggle_term_protect(name, value):\n '''\n Enable or Disable termination protection on a node\n\n '''\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'ModifyInstanceAttribute',\n 'InstanceId': instance_id,\n 'DisableApiTermination.Value': value}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_term_protect(name=name, instance_id=instance_id, call='action')\n\n\ndef enable_term_protect(name, call=None):\n '''\n Enable termination protection on a node\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a enable_term_protect mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n return _toggle_term_protect(name, 'true')\n\n\ndef disable_term_protect(name, call=None):\n '''\n Disable termination protection on a node\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a disable_term_protect mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n return _toggle_term_protect(name, 'false')\n\n\ndef disable_detailed_monitoring(name, call=None):\n '''\n Enable/disable detailed monitoring on a node\n\n CLI Example:\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'UnmonitorInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_detailed_monitoring(name=name, instance_id=instance_id, call='action')\n\n\ndef enable_detailed_monitoring(name, call=None):\n '''\n Enable/disable detailed monitoring on a node\n\n CLI Example:\n\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'MonitorInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_detailed_monitoring(name=name, instance_id=instance_id, call='action')\n\n\ndef show_delvol_on_destroy(name, kwargs=None, call=None):\n '''\n Do not delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a show_delvol_on_destroy mymachine\n '''\n\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_delvol_on_destroy action must be called '\n 'with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n instance_id = kwargs.get('instance_id', None)\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n if instance_id is None:\n instance_id = _get_node(name)['instanceId']\n\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n\n data = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n blockmap = data[0]['instancesSet']['item']['blockDeviceMapping']\n\n if not isinstance(blockmap['item'], list):\n blockmap['item'] = [blockmap['item']]\n\n items = []\n\n for idx, item in enumerate(blockmap['item']):\n device_name = item['deviceName']\n\n if device is not None and device != device_name:\n continue\n\n if volume_id is not None and volume_id != item['ebs']['volumeId']:\n continue\n\n info = {\n 'device_name': device_name,\n 'volume_id': item['ebs']['volumeId'],\n 'deleteOnTermination': item['ebs']['deleteOnTermination']\n }\n\n items.append(info)\n\n return items\n\n\ndef keepvol_on_destroy(name, kwargs=None, call=None):\n '''\n Do not delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a keepvol_on_destroy mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The keepvol_on_destroy action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n return _toggle_delvol(name=name, device=device,\n volume_id=volume_id, value='false')\n\n\ndef delvol_on_destroy(name, kwargs=None, call=None):\n '''\n Delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a delvol_on_destroy mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The delvol_on_destroy action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n return _toggle_delvol(name=name, device=device,\n volume_id=volume_id, value='true')\n\n\ndef _toggle_delvol(name=None, instance_id=None, device=None, volume_id=None,\n value=None, requesturl=None):\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if requesturl:\n data = aws.query(requesturl=requesturl,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n else:\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n data, requesturl = aws.query(params, # pylint: disable=unbalanced-tuple-unpacking\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n blockmap = data[0]['instancesSet']['item']['blockDeviceMapping']\n\n params = {'Action': 'ModifyInstanceAttribute',\n 'InstanceId': instance_id}\n\n if not isinstance(blockmap['item'], list):\n blockmap['item'] = [blockmap['item']]\n\n for idx, item in enumerate(blockmap['item']):\n device_name = item['deviceName']\n\n if device is not None and device != device_name:\n continue\n if volume_id is not None and volume_id != item['ebs']['volumeId']:\n continue\n\n params['BlockDeviceMapping.{0}.DeviceName'.format(idx)] = device_name\n params['BlockDeviceMapping.{0}.Ebs.DeleteOnTermination'.format(idx)] = value\n\n aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n kwargs = {'instance_id': instance_id,\n 'device': device,\n 'volume_id': volume_id}\n return show_delvol_on_destroy(name, kwargs, call='action')\n\n\ndef register_image(kwargs=None, call=None):\n '''\n Create an ami from a snapshot\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -f register_image my-ec2-config ami_name=my_ami description=\"my description\"\n root_device_name=/dev/xvda snapshot_id=snap-xxxxxxxx\n '''\n\n if call != 'function':\n log.error(\n 'The create_volume function must be called with -f or --function.'\n )\n return False\n\n if 'ami_name' not in kwargs:\n log.error('ami_name must be specified to register an image.')\n return False\n\n block_device_mapping = kwargs.get('block_device_mapping', None)\n if not block_device_mapping:\n if 'snapshot_id' not in kwargs:\n log.error('snapshot_id or block_device_mapping must be specified to register an image.')\n return False\n if 'root_device_name' not in kwargs:\n log.error('root_device_name or block_device_mapping must be specified to register an image.')\n return False\n block_device_mapping = [{\n 'DeviceName': kwargs['root_device_name'],\n 'Ebs': {\n 'VolumeType': kwargs.get('volume_type', 'gp2'),\n 'SnapshotId': kwargs['snapshot_id'],\n }\n }]\n\n if not isinstance(block_device_mapping, list):\n block_device_mapping = [block_device_mapping]\n\n params = {'Action': 'RegisterImage',\n 'Name': kwargs['ami_name']}\n\n params.update(_param_from_config('BlockDeviceMapping', block_device_mapping))\n\n if 'root_device_name' in kwargs:\n params['RootDeviceName'] = kwargs['root_device_name']\n\n if 'description' in kwargs:\n params['Description'] = kwargs['description']\n\n if 'virtualization_type' in kwargs:\n params['VirtualizationType'] = kwargs['virtualization_type']\n\n if 'architecture' in kwargs:\n params['Architecture'] = kwargs['architecture']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n r_data = {}\n for d in data[0]:\n for k, v in d.items():\n r_data[k] = v\n\n return r_data\n\n\ndef volume_create(**kwargs):\n '''\n Wrapper around create_volume.\n Here just to ensure the compatibility with the cloud module.\n '''\n return create_volume(kwargs, 'function')\n\n\ndef create_volume(kwargs=None, call=None, wait_to_finish=False):\n '''\n Create a volume.\n\n zone\n The availability zone used to create the volume. Required. String.\n\n size\n The size of the volume, in GiBs. Defaults to ``10``. Integer.\n\n snapshot\n The snapshot-id from which to create the volume. Integer.\n\n type\n The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned\n IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for\n Magnetic volumes. String.\n\n iops\n The number of I/O operations per second (IOPS) to provision for the volume,\n with a maximum ratio of 50 IOPS/GiB. Only valid for Provisioned IOPS SSD\n volumes. Integer.\n\n This option will only be set if ``type`` is also specified as ``io1``.\n\n encrypted\n Specifies whether the volume will be encrypted. Boolean.\n\n If ``snapshot`` is also given in the list of kwargs, then this value is ignored\n since volumes that are created from encrypted snapshots are also automatically\n encrypted.\n\n tags\n The tags to apply to the volume during creation. Dictionary.\n\n call\n The ``create_volume`` function must be called with ``-f`` or ``--function``.\n String.\n\n wait_to_finish\n Whether or not to wait for the volume to be available. Boolean. Defaults to\n ``False``.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f create_volume my-ec2-config zone=us-east-1b\n salt-cloud -f create_volume my-ec2-config zone=us-east-1b tags='{\"tag1\": \"val1\", \"tag2\", \"val2\"}'\n '''\n if call != 'function':\n log.error(\n 'The create_volume function must be called with -f or --function.'\n )\n return False\n\n if 'zone' not in kwargs:\n log.error('An availability zone must be specified to create a volume.')\n return False\n\n if 'size' not in kwargs and 'snapshot' not in kwargs:\n # This number represents GiB\n kwargs['size'] = '10'\n\n params = {'Action': 'CreateVolume',\n 'AvailabilityZone': kwargs['zone']}\n\n if 'size' in kwargs:\n params['Size'] = kwargs['size']\n\n if 'snapshot' in kwargs:\n params['SnapshotId'] = kwargs['snapshot']\n\n if 'type' in kwargs:\n params['VolumeType'] = kwargs['type']\n\n if 'iops' in kwargs and kwargs.get('type', 'standard') == 'io1':\n params['Iops'] = kwargs['iops']\n\n # You can't set `encrypted` if you pass a snapshot\n if 'encrypted' in kwargs and 'snapshot' not in kwargs:\n params['Encrypted'] = kwargs['encrypted']\n if 'kmskeyid' in kwargs:\n params['KmsKeyId'] = kwargs['kmskeyid']\n if 'kmskeyid' in kwargs and 'encrypted' not in kwargs:\n log.error(\n 'If a KMS Key ID is specified, encryption must be enabled'\n )\n return False\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n r_data = {}\n for d in data[0]:\n for k, v in six.iteritems(d):\n r_data[k] = v\n volume_id = r_data['volumeId']\n\n # Allow tags to be set upon creation\n if 'tags' in kwargs:\n if isinstance(kwargs['tags'], six.string_types):\n tags = salt.utils.yaml.safe_load(kwargs['tags'])\n else:\n tags = kwargs['tags']\n\n if isinstance(tags, dict):\n new_tags = set_tags(tags=tags,\n resource_id=volume_id,\n call='action',\n location=get_location())\n r_data['tags'] = new_tags\n\n # Waits till volume is available\n if wait_to_finish:\n salt.utils.cloud.run_func_until_ret_arg(fun=describe_volumes,\n kwargs={'volume_id': volume_id},\n fun_call=call,\n argument_being_watched='status',\n required_argument_response='available')\n\n return r_data\n\n\ndef __attach_vol_to_instance(params, kws, instance_id):\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if data[0]:\n log.warning(\n 'Error attaching volume %s to instance %s. Retrying!',\n kws['volume_id'], instance_id\n )\n return False\n\n return data\n\n\ndef attach_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Attach a volume to an instance\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The attach_volume action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n if 'device' not in kwargs:\n log.error('A device is required (ex. /dev/sdb1).')\n return False\n\n params = {'Action': 'AttachVolume',\n 'VolumeId': kwargs['volume_id'],\n 'InstanceId': instance_id,\n 'Device': kwargs['device']}\n\n log.debug(params)\n\n vm_ = get_configured_provider()\n\n data = salt.utils.cloud.wait_for_ip(\n __attach_vol_to_instance,\n update_args=(params, kwargs, instance_id),\n timeout=config.get_cloud_config_value(\n 'wait_for_ip_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_ip_interval', vm_, __opts__, default=10),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_ip_interval_multiplier', vm_, __opts__, default=1),\n )\n\n return data\n\n\ndef show_volume(kwargs=None, call=None):\n '''\n Wrapper around describe_volumes.\n Here just to keep functionality.\n Might be depreciated later.\n '''\n if not kwargs:\n kwargs = {}\n\n return describe_volumes(kwargs, call)\n\n\ndef detach_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Detach a volume from an instance\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The detach_volume action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n params = {'Action': 'DetachVolume',\n 'VolumeId': kwargs['volume_id']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef delete_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Delete a volume\n '''\n if not kwargs:\n kwargs = {}\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n params = {'Action': 'DeleteVolume',\n 'VolumeId': kwargs['volume_id']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef volume_list(**kwargs):\n '''\n Wrapper around describe_volumes.\n Here just to ensure the compatibility with the cloud module.\n '''\n return describe_volumes(kwargs, 'function')\n\n\ndef describe_volumes(kwargs=None, call=None):\n '''\n Describe a volume (or volumes)\n\n volume_id\n One or more volume IDs. Multiple IDs must be separated by \",\".\n\n TODO: Add all of the filters.\n '''\n if call != 'function':\n log.error(\n 'The describe_volumes function must be called with -f '\n 'or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n params = {'Action': 'DescribeVolumes'}\n\n if 'volume_id' in kwargs:\n volume_id = kwargs['volume_id'].split(',')\n for volume_index, volume_id in enumerate(volume_id):\n params['VolumeId.{0}'.format(volume_index)] = volume_id\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef create_keypair(kwargs=None, call=None):\n '''\n Create an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The create_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'CreateKeyPair',\n 'KeyName': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n keys = [x for x in data[0] if 'requestId' not in x]\n\n return (keys, data[1])\n\n\ndef import_keypair(kwargs=None, call=None):\n '''\n Import an SSH public key.\n\n .. versionadded:: 2015.8.3\n '''\n if call != 'function':\n log.error(\n 'The import_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n if 'file' not in kwargs:\n log.error('A public key file is required.')\n return False\n\n params = {'Action': 'ImportKeyPair',\n 'KeyName': kwargs['keyname']}\n\n public_key_file = kwargs['file']\n\n if os.path.exists(public_key_file):\n with salt.utils.files.fopen(public_key_file, 'r') as fh_:\n public_key = salt.utils.stringutils.to_unicode(fh_.read())\n\n if public_key is not None:\n params['PublicKeyMaterial'] = base64.b64encode(public_key)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef show_keypair(kwargs=None, call=None):\n '''\n Show the details of an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The show_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'DescribeKeyPairs',\n 'KeyName.1': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef delete_keypair(kwargs=None, call=None):\n '''\n Delete an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The delete_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'DeleteKeyPair',\n 'KeyName': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef create_snapshot(kwargs=None, call=None, wait_to_finish=False):\n '''\n Create a snapshot.\n\n volume_id\n The ID of the Volume from which to create a snapshot.\n\n description\n The optional description of the snapshot.\n\n CLI Exampe:\n\n .. code-block:: bash\n\n salt-cloud -f create_snapshot my-ec2-config volume_id=vol-351d8826\n salt-cloud -f create_snapshot my-ec2-config volume_id=vol-351d8826 \\\\\n description=\"My Snapshot Description\"\n '''\n if call != 'function':\n raise SaltCloudSystemExit(\n 'The create_snapshot function must be called with -f '\n 'or --function.'\n )\n\n if kwargs is None:\n kwargs = {}\n\n volume_id = kwargs.get('volume_id', None)\n description = kwargs.get('description', '')\n\n if volume_id is None:\n raise SaltCloudSystemExit(\n 'A volume_id must be specified to create a snapshot.'\n )\n\n params = {'Action': 'CreateSnapshot',\n 'VolumeId': volume_id,\n 'Description': description}\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')[0]\n\n r_data = {}\n for d in data:\n for k, v in six.iteritems(d):\n r_data[k] = v\n\n if 'snapshotId' in r_data:\n snapshot_id = r_data['snapshotId']\n\n # Waits till volume is available\n if wait_to_finish:\n salt.utils.cloud.run_func_until_ret_arg(fun=describe_snapshots,\n kwargs={'snapshot_id': snapshot_id},\n fun_call=call,\n argument_being_watched='status',\n required_argument_response='completed')\n\n return r_data\n\n\ndef delete_snapshot(kwargs=None, call=None):\n '''\n Delete a snapshot\n '''\n if call != 'function':\n log.error(\n 'The delete_snapshot function must be called with -f '\n 'or --function.'\n )\n return False\n\n if 'snapshot_id' not in kwargs:\n log.error('A snapshot_id must be specified to delete a snapshot.')\n return False\n\n params = {'Action': 'DeleteSnapshot'}\n\n if 'snapshot_id' in kwargs:\n params['SnapshotId'] = kwargs['snapshot_id']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef copy_snapshot(kwargs=None, call=None):\n '''\n Copy a snapshot\n '''\n if call != 'function':\n log.error(\n 'The copy_snapshot function must be called with -f or --function.'\n )\n return False\n\n if 'source_region' not in kwargs:\n log.error('A source_region must be specified to copy a snapshot.')\n return False\n\n if 'source_snapshot_id' not in kwargs:\n log.error('A source_snapshot_id must be specified to copy a snapshot.')\n return False\n\n if 'description' not in kwargs:\n kwargs['description'] = ''\n\n params = {'Action': 'CopySnapshot'}\n\n if 'source_region' in kwargs:\n params['SourceRegion'] = kwargs['source_region']\n\n if 'source_snapshot_id' in kwargs:\n params['SourceSnapshotId'] = kwargs['source_snapshot_id']\n\n if 'description' in kwargs:\n params['Description'] = kwargs['description']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef describe_snapshots(kwargs=None, call=None):\n '''\n Describe a snapshot (or snapshots)\n\n snapshot_id\n One or more snapshot IDs. Multiple IDs must be separated by \",\".\n\n owner\n Return the snapshots owned by the specified owner. Valid values\n include: self, amazon, <AWS Account ID>. Multiple values must be\n separated by \",\".\n\n restorable_by\n One or more AWS accounts IDs that can create volumes from the snapshot.\n Multiple aws account IDs must be separated by \",\".\n\n TODO: Add all of the filters.\n '''\n if call != 'function':\n log.error(\n 'The describe_snapshot function must be called with -f '\n 'or --function.'\n )\n return False\n\n params = {'Action': 'DescribeSnapshots'}\n\n # The AWS correct way is to use non-plurals like snapshot_id INSTEAD of snapshot_ids.\n if 'snapshot_ids' in kwargs:\n kwargs['snapshot_id'] = kwargs['snapshot_ids']\n\n if 'snapshot_id' in kwargs:\n snapshot_ids = kwargs['snapshot_id'].split(',')\n for snapshot_index, snapshot_id in enumerate(snapshot_ids):\n params['SnapshotId.{0}'.format(snapshot_index)] = snapshot_id\n\n if 'owner' in kwargs:\n owners = kwargs['owner'].split(',')\n for owner_index, owner in enumerate(owners):\n params['Owner.{0}'.format(owner_index)] = owner\n\n if 'restorable_by' in kwargs:\n restorable_bys = kwargs['restorable_by'].split(',')\n for restorable_by_index, restorable_by in enumerate(restorable_bys):\n params[\n 'RestorableBy.{0}'.format(restorable_by_index)\n ] = restorable_by\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef get_console_output(\n name=None,\n location=None,\n instance_id=None,\n call=None,\n kwargs=None,\n ):\n '''\n Show the console output from the instance.\n\n By default, returns decoded data, not the Base64-encoded data that is\n actually returned from the EC2 API.\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The get_console_output action must be called with '\n '-a or --action.'\n )\n\n if location is None:\n location = get_location()\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if kwargs is None:\n kwargs = {}\n\n if instance_id is None:\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n params = {'Action': 'GetConsoleOutput',\n 'InstanceId': instance_id}\n\n ret = {}\n data = aws.query(params,\n return_root=True,\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for item in data:\n if next(six.iterkeys(item)) == 'output':\n ret['output_decoded'] = binascii.a2b_base64(next(six.itervalues(item)))\n else:\n ret[next(six.iterkeys(item))] = next(six.itervalues(item))\n\n return ret\n\n\ndef get_password_data(\n name=None,\n kwargs=None,\n instance_id=None,\n call=None,\n ):\n '''\n Return password data for a Windows instance.\n\n By default only the encrypted password data will be returned. However, if a\n key_file is passed in, then a decrypted password will also be returned.\n\n Note that the key_file references the private key that was used to generate\n the keypair associated with this instance. This private key will _not_ be\n transmitted to Amazon; it is only used internally inside of Salt Cloud to\n decrypt data _after_ it has been received from Amazon.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a get_password_data mymachine\n salt-cloud -a get_password_data mymachine key_file=/root/ec2key.pem\n\n Note: PKCS1_v1_5 was added in PyCrypto 2.5\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The get_password_data action must be called with '\n '-a or --action.'\n )\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if kwargs is None:\n kwargs = {}\n\n if instance_id is None:\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n params = {'Action': 'GetPasswordData',\n 'InstanceId': instance_id}\n\n ret = {}\n data = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for item in data:\n ret[next(six.iterkeys(item))] = next(six.itervalues(item))\n\n if not HAS_M2 and not HAS_PYCRYPTO:\n return ret\n\n if 'key' not in kwargs:\n if 'key_file' in kwargs:\n with salt.utils.files.fopen(kwargs['key_file'], 'r') as kf_:\n kwargs['key'] = salt.utils.stringutils.to_unicode(kf_.read())\n\n if 'key' in kwargs:\n pwdata = ret.get('passwordData', None)\n if pwdata is not None:\n rsa_key = kwargs['key']\n pwdata = base64.b64decode(pwdata)\n if HAS_M2:\n key = RSA.load_key_string(rsa_key.encode('ascii'))\n password = key.private_decrypt(pwdata, RSA.pkcs1_padding)\n else:\n dsize = Crypto.Hash.SHA.digest_size\n sentinel = Crypto.Random.new().read(15 + dsize)\n key_obj = Crypto.PublicKey.RSA.importKey(rsa_key)\n key_obj = PKCS1_v1_5.new(key_obj)\n password = key_obj.decrypt(pwdata, sentinel)\n ret['password'] = salt.utils.stringutils.to_unicode(password)\n\n return ret\n\n\ndef update_pricing(kwargs=None, call=None):\n '''\n Download most recent pricing information from AWS and convert to a local\n JSON file.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f update_pricing my-ec2-config\n salt-cloud -f update_pricing my-ec2-config type=linux\n\n .. versionadded:: 2015.8.0\n '''\n sources = {\n 'linux': 'https://a0.awsstatic.com/pricing/1/ec2/linux-od.min.js',\n 'rhel': 'https://a0.awsstatic.com/pricing/1/ec2/rhel-od.min.js',\n 'sles': 'https://a0.awsstatic.com/pricing/1/ec2/sles-od.min.js',\n 'mswin': 'https://a0.awsstatic.com/pricing/1/ec2/mswin-od.min.js',\n 'mswinsql': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQL-od.min.js',\n 'mswinsqlweb': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQLWeb-od.min.js',\n }\n\n if kwargs is None:\n kwargs = {}\n\n if 'type' not in kwargs:\n for source in sources:\n _parse_pricing(sources[source], source)\n else:\n _parse_pricing(sources[kwargs['type']], kwargs['type'])\n\n\ndef _parse_pricing(url, name):\n '''\n Download and parse an individual pricing file from AWS\n\n .. versionadded:: 2015.8.0\n '''\n price_js = http.query(url, text=True)\n\n items = []\n current_item = ''\n\n price_js = re.sub(JS_COMMENT_RE, '', price_js['text'])\n price_js = price_js.strip().rstrip(');').lstrip('callback(')\n for keyword in (\n 'vers',\n 'config',\n 'rate',\n 'valueColumns',\n 'currencies',\n 'instanceTypes',\n 'type',\n 'ECU',\n 'storageGB',\n 'name',\n 'vCPU',\n 'memoryGiB',\n 'storageGiB',\n 'USD',\n ):\n price_js = price_js.replace(keyword, '\"{0}\"'.format(keyword))\n\n for keyword in ('region', 'price', 'size'):\n price_js = price_js.replace(keyword, '\"{0}\"'.format(keyword))\n price_js = price_js.replace('\"{0}\"s'.format(keyword), '\"{0}s\"'.format(keyword))\n\n price_js = price_js.replace('\"\"', '\"')\n\n # Turn the data into something that's easier/faster to process\n regions = {}\n price_json = salt.utils.json.loads(price_js)\n for region in price_json['config']['regions']:\n sizes = {}\n for itype in region['instanceTypes']:\n for size in itype['sizes']:\n sizes[size['size']] = size\n regions[region['region']] = sizes\n\n outfile = os.path.join(\n __opts__['cachedir'], 'ec2-pricing-{0}.p'.format(name)\n )\n with salt.utils.files.fopen(outfile, 'w') as fho:\n salt.utils.msgpack.dump(regions, fho)\n\n return True\n\n\n\ndef ssm_create_association(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Associates the specified SSM document with the specified instance\n\n http://docs.aws.amazon.com/ssm/latest/APIReference/API_CreateAssociation.html\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a ssm_create_association ec2-instance-name ssm_document=ssm-document-name\n '''\n\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The ssm_create_association action must be called with '\n '-a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'ssm_document' not in kwargs:\n log.error('A ssm_document is required.')\n return False\n\n params = {'Action': 'CreateAssociation',\n 'InstanceId': instance_id,\n 'Name': kwargs['ssm_document']}\n\n result = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n product='ssm',\n opts=__opts__,\n sigver='4')\n log.info(result)\n return result\n\n\ndef ssm_describe_association(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Describes the associations for the specified SSM document or instance.\n\n http://docs.aws.amazon.com/ssm/latest/APIReference/API_DescribeAssociation.html\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a ssm_describe_association ec2-instance-name ssm_document=ssm-document-name\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The ssm_describe_association action must be called with '\n '-a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'ssm_document' not in kwargs:\n log.error('A ssm_document is required.')\n return False\n\n params = {'Action': 'DescribeAssociation',\n 'InstanceId': instance_id,\n 'Name': kwargs['ssm_document']}\n\n result = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n product='ssm',\n opts=__opts__,\n sigver='4')\n log.info(result)\n return result\n"}}},{"rowIdx":358,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/cloud/clouds/ec2.py"},"func_name":{"kind":"string","value":"ssm_create_association"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def ssm_create_association(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Associates the specified SSM document with the specified instance\n\n http://docs.aws.amazon.com/ssm/latest/APIReference/API_CreateAssociation.html\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a ssm_create_association ec2-instance-name ssm_document=ssm-document-name\n '''\n\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The ssm_create_association action must be called with '\n '-a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'ssm_document' not in kwargs:\n log.error('A ssm_document is required.')\n return False\n\n params = {'Action': 'CreateAssociation',\n 'InstanceId': instance_id,\n 'Name': kwargs['ssm_document']}\n\n result = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n product='ssm',\n opts=__opts__,\n sigver='4')\n log.info(result)\n return result"},"func_documentation_string":{"kind":"string","value":"Associates the specified SSM document with the specified instance\n\n http://docs.aws.amazon.com/ssm/latest/APIReference/API_CreateAssociation.html\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a ssm_create_association ec2-instance-name ssm_document=ssm-document-name"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L5118-L5166"},"called_functions":{"kind":"list like","value":["def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_comps[0]\n return provider\n","def query(params=None, setname=None, requesturl=None, location=None,\n return_url=False, return_root=False, opts=None, provider=None,\n endpoint=None, product='ec2', sigver='2'):\n '''\n Perform a query against AWS services using Signature Version 2 Signing\n Process. This is documented at:\n\n http://docs.aws.amazon.com/general/latest/gr/signature-version-2.html\n\n Regions and endpoints are documented at:\n\n http://docs.aws.amazon.com/general/latest/gr/rande.html\n\n Default ``product`` is ``ec2``. Valid ``product`` names are:\n\n .. code-block: yaml\n\n - autoscaling (Auto Scaling)\n - cloudformation (CloudFormation)\n - ec2 (Elastic Compute Cloud)\n - elasticache (ElastiCache)\n - elasticbeanstalk (Elastic BeanStalk)\n - elasticloadbalancing (Elastic Load Balancing)\n - elasticmapreduce (Elastic MapReduce)\n - iam (Identity and Access Management)\n - importexport (Import/Export)\n - monitoring (CloudWatch)\n - rds (Relational Database Service)\n - simpledb (SimpleDB)\n - sns (Simple Notification Service)\n - sqs (Simple Queue Service)\n '''\n if params is None:\n params = {}\n\n if opts is None:\n opts = {}\n\n function = opts.get('function', (None, product))\n providers = opts.get('providers', {})\n\n if provider is None:\n prov_dict = providers.get(function[1], {}).get(product, {})\n if prov_dict:\n driver = list(list(prov_dict.keys()))[0]\n provider = providers.get(driver, product)\n else:\n prov_dict = providers.get(provider, {}).get(product, {})\n\n service_url = prov_dict.get('service_url', 'amazonaws.com')\n\n if not location:\n location = get_location(opts, prov_dict)\n\n if endpoint is None:\n if not requesturl:\n endpoint = prov_dict.get(\n 'endpoint',\n '{0}.{1}.{2}'.format(product, location, service_url)\n )\n\n requesturl = 'https://{0}/'.format(endpoint)\n else:\n endpoint = urlparse(requesturl).netloc\n if endpoint == '':\n endpoint_err = ('Could not find a valid endpoint in the '\n 'requesturl: {0}. Looking for something '\n 'like https://some.aws.endpoint/?args').format(\n requesturl\n )\n log.error(endpoint_err)\n if return_url is True:\n return {'error': endpoint_err}, requesturl\n return {'error': endpoint_err}\n\n log.debug('Using AWS endpoint: %s', endpoint)\n method = 'GET'\n\n aws_api_version = prov_dict.get(\n 'aws_api_version', prov_dict.get(\n '{0}_api_version'.format(product),\n DEFAULT_AWS_API_VERSION\n )\n )\n\n # Fallback to ec2's id & key if none is found, for this component\n if not prov_dict.get('id', None):\n prov_dict['id'] = providers.get(provider, {}).get('ec2', {}).get('id', {})\n prov_dict['key'] = providers.get(provider, {}).get('ec2', {}).get('key', {})\n\n if sigver == '4':\n headers, requesturl = sig4(\n method, endpoint, params, prov_dict, aws_api_version, location, product, requesturl=requesturl\n )\n params_with_headers = {}\n else:\n params_with_headers = sig2(\n method, endpoint, params, prov_dict, aws_api_version\n )\n headers = {}\n\n attempts = 0\n while attempts < AWS_MAX_RETRIES:\n log.debug('AWS Request: %s', requesturl)\n log.trace('AWS Request Parameters: %s', params_with_headers)\n try:\n result = requests.get(requesturl, headers=headers, params=params_with_headers)\n log.debug('AWS Response Status Code: %s', result.status_code)\n log.trace(\n 'AWS Response Text: %s',\n result.text\n )\n result.raise_for_status()\n break\n except requests.exceptions.HTTPError as exc:\n root = ET.fromstring(exc.response.content)\n data = xml.to_dict(root)\n\n # check to see if we should retry the query\n err_code = data.get('Errors', {}).get('Error', {}).get('Code', '')\n if attempts < AWS_MAX_RETRIES and err_code and err_code in AWS_RETRY_CODES:\n attempts += 1\n log.error(\n 'AWS Response Status Code and Error: [%s %s] %s; '\n 'Attempts remaining: %s',\n exc.response.status_code, exc, data, attempts\n )\n sleep_exponential_backoff(attempts)\n continue\n\n log.error(\n 'AWS Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n else:\n log.error(\n 'AWS Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n\n root = ET.fromstring(result.text)\n items = root[1]\n if return_root is True:\n items = root\n\n if setname:\n if sys.version_info < (2, 7):\n children_len = len(root.getchildren())\n else:\n children_len = len(root)\n\n for item in range(0, children_len):\n comps = root[item].tag.split('}')\n if comps[1] == setname:\n items = root[item]\n\n ret = []\n for item in items:\n ret.append(xml.to_dict(item))\n\n if return_url is True:\n return ret, requesturl\n\n return ret\n","def get_location(vm_=None):\n '''\n Return the EC2 region to use, in this order:\n - CLI parameter\n - VM parameter\n - Cloud profile setting\n '''\n return __opts__.get(\n 'location',\n config.get_cloud_config_value(\n 'location',\n vm_ or get_configured_provider(),\n __opts__,\n default=DEFAULT_LOCATION,\n search_global=False\n )\n )\n","def _get_node(name=None, instance_id=None, location=None):\n if location is None:\n location = get_location()\n\n params = {'Action': 'DescribeInstances'}\n\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if instance_id:\n params['InstanceId.1'] = instance_id\n else:\n params['Filter.1.Name'] = 'tag:Name'\n params['Filter.1.Value.1'] = name\n\n log.trace(params)\n\n provider = get_provider()\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n try:\n instances = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n instance_info = _extract_instance_info(instances).values()\n return next(iter(instance_info))\n except IndexError:\n attempts += 1\n log.debug(\n 'Failed to get the data for node \\'%s\\'. Remaining '\n 'attempts: %s', instance_id or name, attempts\n )\n aws.sleep_exponential_backoff(attempts)\n return {}\n"],"string":"[\n \"def get_provider(vm_=None):\\n '''\\n Extract the provider name from vm\\n '''\\n if vm_ is None:\\n provider = __active_provider_name__ or 'ec2'\\n else:\\n provider = vm_.get('provider', 'ec2')\\n\\n if ':' in provider:\\n prov_comps = provider.split(':')\\n provider = prov_comps[0]\\n return provider\\n\",\n \"def query(params=None, setname=None, requesturl=None, location=None,\\n return_url=False, return_root=False, opts=None, provider=None,\\n endpoint=None, product='ec2', sigver='2'):\\n '''\\n Perform a query against AWS services using Signature Version 2 Signing\\n Process. This is documented at:\\n\\n http://docs.aws.amazon.com/general/latest/gr/signature-version-2.html\\n\\n Regions and endpoints are documented at:\\n\\n http://docs.aws.amazon.com/general/latest/gr/rande.html\\n\\n Default ``product`` is ``ec2``. Valid ``product`` names are:\\n\\n .. code-block: yaml\\n\\n - autoscaling (Auto Scaling)\\n - cloudformation (CloudFormation)\\n - ec2 (Elastic Compute Cloud)\\n - elasticache (ElastiCache)\\n - elasticbeanstalk (Elastic BeanStalk)\\n - elasticloadbalancing (Elastic Load Balancing)\\n - elasticmapreduce (Elastic MapReduce)\\n - iam (Identity and Access Management)\\n - importexport (Import/Export)\\n - monitoring (CloudWatch)\\n - rds (Relational Database Service)\\n - simpledb (SimpleDB)\\n - sns (Simple Notification Service)\\n - sqs (Simple Queue Service)\\n '''\\n if params is None:\\n params = {}\\n\\n if opts is None:\\n opts = {}\\n\\n function = opts.get('function', (None, product))\\n providers = opts.get('providers', {})\\n\\n if provider is None:\\n prov_dict = providers.get(function[1], {}).get(product, {})\\n if prov_dict:\\n driver = list(list(prov_dict.keys()))[0]\\n provider = providers.get(driver, product)\\n else:\\n prov_dict = providers.get(provider, {}).get(product, {})\\n\\n service_url = prov_dict.get('service_url', 'amazonaws.com')\\n\\n if not location:\\n location = get_location(opts, prov_dict)\\n\\n if endpoint is None:\\n if not requesturl:\\n endpoint = prov_dict.get(\\n 'endpoint',\\n '{0}.{1}.{2}'.format(product, location, service_url)\\n )\\n\\n requesturl = 'https://{0}/'.format(endpoint)\\n else:\\n endpoint = urlparse(requesturl).netloc\\n if endpoint == '':\\n endpoint_err = ('Could not find a valid endpoint in the '\\n 'requesturl: {0}. Looking for something '\\n 'like https://some.aws.endpoint/?args').format(\\n requesturl\\n )\\n log.error(endpoint_err)\\n if return_url is True:\\n return {'error': endpoint_err}, requesturl\\n return {'error': endpoint_err}\\n\\n log.debug('Using AWS endpoint: %s', endpoint)\\n method = 'GET'\\n\\n aws_api_version = prov_dict.get(\\n 'aws_api_version', prov_dict.get(\\n '{0}_api_version'.format(product),\\n DEFAULT_AWS_API_VERSION\\n )\\n )\\n\\n # Fallback to ec2's id & key if none is found, for this component\\n if not prov_dict.get('id', None):\\n prov_dict['id'] = providers.get(provider, {}).get('ec2', {}).get('id', {})\\n prov_dict['key'] = providers.get(provider, {}).get('ec2', {}).get('key', {})\\n\\n if sigver == '4':\\n headers, requesturl = sig4(\\n method, endpoint, params, prov_dict, aws_api_version, location, product, requesturl=requesturl\\n )\\n params_with_headers = {}\\n else:\\n params_with_headers = sig2(\\n method, endpoint, params, prov_dict, aws_api_version\\n )\\n headers = {}\\n\\n attempts = 0\\n while attempts < AWS_MAX_RETRIES:\\n log.debug('AWS Request: %s', requesturl)\\n log.trace('AWS Request Parameters: %s', params_with_headers)\\n try:\\n result = requests.get(requesturl, headers=headers, params=params_with_headers)\\n log.debug('AWS Response Status Code: %s', result.status_code)\\n log.trace(\\n 'AWS Response Text: %s',\\n result.text\\n )\\n result.raise_for_status()\\n break\\n except requests.exceptions.HTTPError as exc:\\n root = ET.fromstring(exc.response.content)\\n data = xml.to_dict(root)\\n\\n # check to see if we should retry the query\\n err_code = data.get('Errors', {}).get('Error', {}).get('Code', '')\\n if attempts < AWS_MAX_RETRIES and err_code and err_code in AWS_RETRY_CODES:\\n attempts += 1\\n log.error(\\n 'AWS Response Status Code and Error: [%s %s] %s; '\\n 'Attempts remaining: %s',\\n exc.response.status_code, exc, data, attempts\\n )\\n sleep_exponential_backoff(attempts)\\n continue\\n\\n log.error(\\n 'AWS Response Status Code and Error: [%s %s] %s',\\n exc.response.status_code, exc, data\\n )\\n if return_url is True:\\n return {'error': data}, requesturl\\n return {'error': data}\\n else:\\n log.error(\\n 'AWS Response Status Code and Error: [%s %s] %s',\\n exc.response.status_code, exc, data\\n )\\n if return_url is True:\\n return {'error': data}, requesturl\\n return {'error': data}\\n\\n root = ET.fromstring(result.text)\\n items = root[1]\\n if return_root is True:\\n items = root\\n\\n if setname:\\n if sys.version_info < (2, 7):\\n children_len = len(root.getchildren())\\n else:\\n children_len = len(root)\\n\\n for item in range(0, children_len):\\n comps = root[item].tag.split('}')\\n if comps[1] == setname:\\n items = root[item]\\n\\n ret = []\\n for item in items:\\n ret.append(xml.to_dict(item))\\n\\n if return_url is True:\\n return ret, requesturl\\n\\n return ret\\n\",\n \"def get_location(vm_=None):\\n '''\\n Return the EC2 region to use, in this order:\\n - CLI parameter\\n - VM parameter\\n - Cloud profile setting\\n '''\\n return __opts__.get(\\n 'location',\\n config.get_cloud_config_value(\\n 'location',\\n vm_ or get_configured_provider(),\\n __opts__,\\n default=DEFAULT_LOCATION,\\n search_global=False\\n )\\n )\\n\",\n \"def _get_node(name=None, instance_id=None, location=None):\\n if location is None:\\n location = get_location()\\n\\n params = {'Action': 'DescribeInstances'}\\n\\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\\n instance_id = name\\n\\n if instance_id:\\n params['InstanceId.1'] = instance_id\\n else:\\n params['Filter.1.Name'] = 'tag:Name'\\n params['Filter.1.Value.1'] = name\\n\\n log.trace(params)\\n\\n provider = get_provider()\\n\\n attempts = 0\\n while attempts < aws.AWS_MAX_RETRIES:\\n try:\\n instances = aws.query(params,\\n location=location,\\n provider=provider,\\n opts=__opts__,\\n sigver='4')\\n instance_info = _extract_instance_info(instances).values()\\n return next(iter(instance_info))\\n except IndexError:\\n attempts += 1\\n log.debug(\\n 'Failed to get the data for node \\\\'%s\\\\'. Remaining '\\n 'attempts: %s', instance_id or name, attempts\\n )\\n aws.sleep_exponential_backoff(attempts)\\n return {}\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nThe EC2 Cloud Module\n====================\n\nThe EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.\n\nTo use the EC2 cloud module, set up the cloud configuration at\n ``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:\n\n.. code-block:: yaml\n\n my-ec2-config:\n # EC2 API credentials: Access Key ID and Secret Access Key.\n # Alternatively, to use IAM Instance Role credentials available via\n # EC2 metadata set both id and key to 'use-instance-role-credentials'\n id: GKTADJGHEIQSXMKKRBJ08H\n key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs\n\n # If 'role_arn' is specified the above credentials are used to\n # to assume to the role. By default, role_arn is set to None.\n role_arn: arn:aws:iam::012345678910:role/SomeRoleName\n\n # The ssh keyname to use\n keyname: default\n # The amazon security group\n securitygroup: ssh_open\n # The location of the private key which corresponds to the keyname\n private_key: /root/default.pem\n\n # Be default, service_url is set to amazonaws.com. If you are using this\n # driver for something other than Amazon EC2, change it here:\n service_url: amazonaws.com\n\n # The endpoint that is ultimately used is usually formed using the region\n # and the service_url. If you would like to override that entirely, you\n # can explicitly define the endpoint:\n endpoint: myendpoint.example.com:1138/services/Cloud\n\n # SSH Gateways can be used with this provider. Gateways can be used\n # when a salt-master is not on the same private network as the instance\n # that is being deployed.\n\n # Defaults to None\n # Required\n ssh_gateway: gateway.example.com\n\n # Defaults to port 22\n # Optional\n ssh_gateway_port: 22\n\n # Defaults to root\n # Optional\n ssh_gateway_username: root\n\n # Default to nc -q0 %h %p\n # Optional\n ssh_gateway_command: \"-W %h:%p\"\n\n # One authentication method is required. If both\n # are specified, Private key wins.\n\n # Private key defaults to None\n ssh_gateway_private_key: /path/to/key.pem\n\n # Password defaults to None\n ssh_gateway_password: ExamplePasswordHere\n\n driver: ec2\n\n # Pass userdata to the instance to be created\n userdata_file: /etc/salt/my-userdata-file\n\n # Instance termination protection setting\n # Default is disabled\n termination_protection: False\n\n:depends: requests\n'''\n# pylint: disable=invalid-name,function-redefined\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport os\nimport sys\nimport stat\nimport time\nimport uuid\nimport pprint\nimport logging\n\n# Import libs for talking to the EC2 API\nimport hmac\nimport hashlib\nimport binascii\nimport datetime\nimport base64\nimport re\nimport decimal\n\n# Import Salt Libs\nimport salt.utils.cloud\nimport salt.utils.compat\nimport salt.utils.files\nimport salt.utils.hashutils\nimport salt.utils.json\nimport salt.utils.msgpack\nimport salt.utils.stringutils\nimport salt.utils.yaml\nfrom salt._compat import ElementTree as ET\nimport salt.utils.http as http\nimport salt.utils.aws as aws\nimport salt.config as config\nfrom salt.exceptions import (\n SaltCloudException,\n SaltCloudSystemExit,\n SaltCloudConfigError,\n SaltCloudExecutionTimeout,\n SaltCloudExecutionFailure\n)\n\n# pylint: disable=import-error,no-name-in-module,redefined-builtin\nfrom salt.ext import six\nfrom salt.ext.six.moves import map, range, zip\nfrom salt.ext.six.moves.urllib.parse import urlparse as _urlparse, urlencode as _urlencode\n\n# Import 3rd-Party Libs\n# Try to import PyCrypto, which may not be installed on a RAET-based system\ntry:\n from M2Crypto import RSA\n HAS_M2 = True\nexcept ImportError:\n HAS_M2 = False\n\ntry:\n import Crypto\n # PKCS1_v1_5 was added in PyCrypto 2.5\n from Crypto.Cipher import PKCS1_v1_5 # pylint: disable=E0611\n from Crypto.Hash import SHA # pylint: disable=E0611,W0611\n HAS_PYCRYPTO = True\nexcept ImportError:\n HAS_PYCRYPTO = False\n\ntry:\n import requests\n HAS_REQUESTS = True\nexcept ImportError:\n HAS_REQUESTS = False\n# pylint: enable=import-error,no-name-in-module,redefined-builtin\n\n# Get logging started\nlog = logging.getLogger(__name__)\n\n\nEC2_LOCATIONS = {\n 'ap-northeast-1': 'ec2_ap_northeast',\n 'ap-northeast-2': 'ec2_ap_northeast_2',\n 'ap-southeast-1': 'ec2_ap_southeast',\n 'ap-southeast-2': 'ec2_ap_southeast_2',\n 'eu-west-1': 'ec2_eu_west',\n 'eu-central-1': 'ec2_eu_central',\n 'sa-east-1': 'ec2_sa_east',\n 'us-east-1': 'ec2_us_east',\n 'us-gov-west-1': 'ec2_us_gov_west_1',\n 'us-west-1': 'ec2_us_west',\n 'us-west-2': 'ec2_us_west_oregon',\n}\nDEFAULT_LOCATION = 'us-east-1'\n\nDEFAULT_EC2_API_VERSION = '2014-10-01'\n\nEC2_RETRY_CODES = [\n 'RequestLimitExceeded',\n 'InsufficientInstanceCapacity',\n 'InternalError',\n 'Unavailable',\n 'InsufficientAddressCapacity',\n 'InsufficientReservedInstanceCapacity',\n]\n\nJS_COMMENT_RE = re.compile(r'/\\*.*?\\*/', re.S)\n\n__virtualname__ = 'ec2'\n\n\n# Only load in this module if the EC2 configurations are in place\ndef __virtual__():\n '''\n Set up the libcloud functions and check for EC2 configurations\n '''\n if get_configured_provider() is False:\n return False\n\n if get_dependencies() is False:\n return False\n\n return __virtualname__\n\n\ndef get_configured_provider():\n '''\n Return the first configured instance.\n '''\n return config.is_provider_configured(\n __opts__,\n __active_provider_name__ or __virtualname__,\n ('id', 'key')\n )\n\n\ndef get_dependencies():\n '''\n Warn if dependencies aren't met.\n '''\n deps = {\n 'requests': HAS_REQUESTS,\n 'pycrypto or m2crypto': HAS_M2 or HAS_PYCRYPTO\n }\n return config.check_driver_dependencies(\n __virtualname__,\n deps\n )\n\n\ndef _xml_to_dict(xmltree):\n '''\n Convert an XML tree into a dict\n '''\n if sys.version_info < (2, 7):\n children_len = len(xmltree.getchildren())\n else:\n children_len = len(xmltree)\n\n if children_len < 1:\n name = xmltree.tag\n if '}' in name:\n comps = name.split('}')\n name = comps[1]\n return {name: xmltree.text}\n\n xmldict = {}\n for item in xmltree:\n name = item.tag\n if '}' in name:\n comps = name.split('}')\n name = comps[1]\n if name not in xmldict:\n if sys.version_info < (2, 7):\n children_len = len(item.getchildren())\n else:\n children_len = len(item)\n\n if children_len > 0:\n xmldict[name] = _xml_to_dict(item)\n else:\n xmldict[name] = item.text\n else:\n if not isinstance(xmldict[name], list):\n tempvar = xmldict[name]\n xmldict[name] = []\n xmldict[name].append(tempvar)\n xmldict[name].append(_xml_to_dict(item))\n return xmldict\n\n\ndef optimize_providers(providers):\n '''\n Return an optimized list of providers.\n\n We want to reduce the duplication of querying\n the same region.\n\n If a provider is using the same credentials for the same region\n the same data will be returned for each provider, thus causing\n un-wanted duplicate data and API calls to EC2.\n\n '''\n tmp_providers = {}\n optimized_providers = {}\n\n for name, data in six.iteritems(providers):\n if 'location' not in data:\n data['location'] = DEFAULT_LOCATION\n\n if data['location'] not in tmp_providers:\n tmp_providers[data['location']] = {}\n\n creds = (data['id'], data['key'])\n if creds not in tmp_providers[data['location']]:\n tmp_providers[data['location']][creds] = {'name': name,\n 'data': data,\n }\n\n for location, tmp_data in six.iteritems(tmp_providers):\n for creds, data in six.iteritems(tmp_data):\n _id, _key = creds\n _name = data['name']\n _data = data['data']\n if _name not in optimized_providers:\n optimized_providers[_name] = _data\n\n return optimized_providers\n\n\ndef sign(key, msg):\n return hmac.new(key, msg.encode('utf-8'), hashlib.sha256).digest()\n\n\ndef query(params=None, setname=None, requesturl=None, location=None,\n return_url=False, return_root=False):\n\n provider = get_configured_provider()\n service_url = provider.get('service_url', 'amazonaws.com')\n\n # Retrieve access credentials from meta-data, or use provided\n access_key_id, secret_access_key, token = aws.creds(provider)\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n params_with_headers = params.copy()\n timestamp = datetime.datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%SZ')\n\n if not location:\n location = get_location()\n\n if not requesturl:\n endpoint = provider.get(\n 'endpoint',\n 'ec2.{0}.{1}'.format(location, service_url)\n )\n\n requesturl = 'https://{0}/'.format(endpoint)\n endpoint = _urlparse(requesturl).netloc\n endpoint_path = _urlparse(requesturl).path\n else:\n endpoint = _urlparse(requesturl).netloc\n endpoint_path = _urlparse(requesturl).path\n if endpoint == '':\n endpoint_err = (\n 'Could not find a valid endpoint in the '\n 'requesturl: {0}. Looking for something '\n 'like https://some.ec2.endpoint/?args').format(requesturl)\n log.error(endpoint_err)\n if return_url is True:\n return {'error': endpoint_err}, requesturl\n return {'error': endpoint_err}\n\n log.debug('Using EC2 endpoint: %s', endpoint)\n # AWS v4 signature\n\n method = 'GET'\n region = location\n service = 'ec2'\n canonical_uri = _urlparse(requesturl).path\n host = endpoint.strip()\n\n # Create a date for headers and the credential string\n t = datetime.datetime.utcnow()\n amz_date = t.strftime('%Y%m%dT%H%M%SZ') # Format date as YYYYMMDD'T'HHMMSS'Z'\n datestamp = t.strftime('%Y%m%d') # Date w/o time, used in credential scope\n\n canonical_headers = 'host:' + host + '\\n' + 'x-amz-date:' + amz_date + '\\n'\n signed_headers = 'host;x-amz-date'\n\n payload_hash = salt.utils.hashutils.sha256_digest('')\n\n ec2_api_version = provider.get(\n 'ec2_api_version',\n DEFAULT_EC2_API_VERSION\n )\n\n params_with_headers['Version'] = ec2_api_version\n\n keys = sorted(list(params_with_headers))\n values = map(params_with_headers.get, keys)\n querystring = _urlencode(list(zip(keys, values)))\n querystring = querystring.replace('+', '%20')\n\n canonical_request = method + '\\n' + canonical_uri + '\\n' + \\\n querystring + '\\n' + canonical_headers + '\\n' + \\\n signed_headers + '\\n' + payload_hash\n\n algorithm = 'AWS4-HMAC-SHA256'\n credential_scope = datestamp + '/' + region + '/' + service + '/' + 'aws4_request'\n\n string_to_sign = algorithm + '\\n' + amz_date + '\\n' + \\\n credential_scope + '\\n' + \\\n salt.utils.hashutils.sha256_digest(canonical_request)\n\n kDate = sign(('AWS4' + provider['key']).encode('utf-8'), datestamp)\n kRegion = sign(kDate, region)\n kService = sign(kRegion, service)\n signing_key = sign(kService, 'aws4_request')\n\n signature = hmac.new(signing_key, (string_to_sign).encode('utf-8'),\n hashlib.sha256).hexdigest()\n\n authorization_header = algorithm + ' ' + 'Credential=' + \\\n provider['id'] + '/' + credential_scope + \\\n ', ' + 'SignedHeaders=' + signed_headers + \\\n ', ' + 'Signature=' + signature\n headers = {'x-amz-date': amz_date, 'Authorization': authorization_header}\n\n log.debug('EC2 Request: %s', requesturl)\n log.trace('EC2 Request Parameters: %s', params_with_headers)\n try:\n result = requests.get(requesturl, headers=headers, params=params_with_headers)\n log.debug(\n 'EC2 Response Status Code: %s',\n # result.getcode()\n result.status_code\n )\n log.trace('EC2 Response Text: %s', result.text)\n result.raise_for_status()\n break\n except requests.exceptions.HTTPError as exc:\n root = ET.fromstring(exc.response.content)\n data = _xml_to_dict(root)\n\n # check to see if we should retry the query\n err_code = data.get('Errors', {}).get('Error', {}).get('Code', '')\n if err_code and err_code in EC2_RETRY_CODES:\n attempts += 1\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s; '\n 'Attempts remaining: %s',\n exc.response.status_code, exc, data, attempts\n )\n aws.sleep_exponential_backoff(attempts)\n continue\n\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n else:\n log.error(\n 'EC2 Response Status Code and Error: [%s %s] %s',\n exc.response.status_code, exc, data\n )\n if return_url is True:\n return {'error': data}, requesturl\n return {'error': data}\n\n response = result.text\n\n root = ET.fromstring(response)\n items = root[1]\n if return_root is True:\n items = root\n\n if setname:\n if sys.version_info < (2, 7):\n children_len = len(root.getchildren())\n else:\n children_len = len(root)\n\n for item in range(0, children_len):\n comps = root[item].tag.split('}')\n if comps[1] == setname:\n items = root[item]\n\n ret = []\n for item in items:\n ret.append(_xml_to_dict(item))\n\n if return_url is True:\n return ret, requesturl\n\n return ret\n\n\ndef _wait_for_spot_instance(update_callback,\n update_args=None,\n update_kwargs=None,\n timeout=10 * 60,\n interval=30,\n interval_multiplier=1,\n max_failures=10):\n '''\n Helper function that waits for a spot instance request to become active\n for a specific maximum amount of time.\n\n :param update_callback: callback function which queries the cloud provider\n for spot instance request. It must return None if\n the required data, running instance included, is\n not available yet.\n :param update_args: Arguments to pass to update_callback\n :param update_kwargs: Keyword arguments to pass to update_callback\n :param timeout: The maximum amount of time(in seconds) to wait for the IP\n address.\n :param interval: The looping interval, i.e., the amount of time to sleep\n before the next iteration.\n :param interval_multiplier: Increase the interval by this multiplier after\n each request; helps with throttling\n :param max_failures: If update_callback returns ``False`` it's considered\n query failure. This value is the amount of failures\n accepted before giving up.\n :returns: The update_callback returned data\n :raises: SaltCloudExecutionTimeout\n\n '''\n if update_args is None:\n update_args = ()\n if update_kwargs is None:\n update_kwargs = {}\n\n duration = timeout\n while True:\n log.debug(\n 'Waiting for spot instance reservation. Giving up in '\n '00:%02d:%02d', int(timeout // 60), int(timeout % 60)\n )\n data = update_callback(*update_args, **update_kwargs)\n if data is False:\n log.debug(\n 'update_callback has returned False which is considered a '\n 'failure. Remaining Failures: %s', max_failures\n )\n max_failures -= 1\n if max_failures <= 0:\n raise SaltCloudExecutionFailure(\n 'Too many failures occurred while waiting for '\n 'the spot instance reservation to become active.'\n )\n elif data is not None:\n return data\n\n if timeout < 0:\n raise SaltCloudExecutionTimeout(\n 'Unable to get an active spot instance request for '\n '00:{0:02d}:{1:02d}'.format(\n int(duration // 60),\n int(duration % 60)\n )\n )\n time.sleep(interval)\n timeout -= interval\n\n if interval_multiplier > 1:\n interval *= interval_multiplier\n if interval > timeout:\n interval = timeout + 1\n log.info('Interval multiplier in effect; interval is '\n 'now %ss', interval)\n\n\ndef avail_sizes(call=None):\n '''\n Return a dict of all available VM sizes on the cloud provider with\n relevant data. Latest version can be found at:\n\n http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_sizes function must be called with '\n '-f or --function, or with the --list-sizes option'\n )\n\n sizes = {\n 'Cluster Compute': {\n 'cc2.8xlarge': {\n 'id': 'cc2.8xlarge',\n 'cores': '16 (2 x Intel Xeon E5-2670, eight-core with '\n 'hyperthread)',\n 'disk': '3360 GiB (4 x 840 GiB)',\n 'ram': '60.5 GiB'\n },\n 'cc1.4xlarge': {\n 'id': 'cc1.4xlarge',\n 'cores': '8 (2 x Intel Xeon X5570, quad-core with '\n 'hyperthread)',\n 'disk': '1690 GiB (2 x 840 GiB)',\n 'ram': '22.5 GiB'\n },\n },\n 'Cluster CPU': {\n 'cg1.4xlarge': {\n 'id': 'cg1.4xlarge',\n 'cores': '8 (2 x Intel Xeon X5570, quad-core with '\n 'hyperthread), plus 2 NVIDIA Tesla M2050 GPUs',\n 'disk': '1680 GiB (2 x 840 GiB)',\n 'ram': '22.5 GiB'\n },\n },\n 'Compute Optimized': {\n 'c4.large': {\n 'id': 'c4.large',\n 'cores': '2',\n 'disk': 'EBS - 500 Mbps',\n 'ram': '3.75 GiB'\n },\n 'c4.xlarge': {\n 'id': 'c4.xlarge',\n 'cores': '4',\n 'disk': 'EBS - 750 Mbps',\n 'ram': '7.5 GiB'\n },\n 'c4.2xlarge': {\n 'id': 'c4.2xlarge',\n 'cores': '8',\n 'disk': 'EBS - 1000 Mbps',\n 'ram': '15 GiB'\n },\n 'c4.4xlarge': {\n 'id': 'c4.4xlarge',\n 'cores': '16',\n 'disk': 'EBS - 2000 Mbps',\n 'ram': '30 GiB'\n },\n 'c4.8xlarge': {\n 'id': 'c4.8xlarge',\n 'cores': '36',\n 'disk': 'EBS - 4000 Mbps',\n 'ram': '60 GiB'\n },\n 'c3.large': {\n 'id': 'c3.large',\n 'cores': '2',\n 'disk': '32 GiB (2 x 16 GiB SSD)',\n 'ram': '3.75 GiB'\n },\n 'c3.xlarge': {\n 'id': 'c3.xlarge',\n 'cores': '4',\n 'disk': '80 GiB (2 x 40 GiB SSD)',\n 'ram': '7.5 GiB'\n },\n 'c3.2xlarge': {\n 'id': 'c3.2xlarge',\n 'cores': '8',\n 'disk': '160 GiB (2 x 80 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'c3.4xlarge': {\n 'id': 'c3.4xlarge',\n 'cores': '16',\n 'disk': '320 GiB (2 x 160 GiB SSD)',\n 'ram': '30 GiB'\n },\n 'c3.8xlarge': {\n 'id': 'c3.8xlarge',\n 'cores': '32',\n 'disk': '640 GiB (2 x 320 GiB SSD)',\n 'ram': '60 GiB'\n }\n },\n 'Dense Storage': {\n 'd2.xlarge': {\n 'id': 'd2.xlarge',\n 'cores': '4',\n 'disk': '6 TiB (3 x 2 TiB hard disk drives)',\n 'ram': '30.5 GiB'\n },\n 'd2.2xlarge': {\n 'id': 'd2.2xlarge',\n 'cores': '8',\n 'disk': '12 TiB (6 x 2 TiB hard disk drives)',\n 'ram': '61 GiB'\n },\n 'd2.4xlarge': {\n 'id': 'd2.4xlarge',\n 'cores': '16',\n 'disk': '24 TiB (12 x 2 TiB hard disk drives)',\n 'ram': '122 GiB'\n },\n 'd2.8xlarge': {\n 'id': 'd2.8xlarge',\n 'cores': '36',\n 'disk': '24 TiB (24 x 2 TiB hard disk drives)',\n 'ram': '244 GiB'\n },\n },\n 'GPU': {\n 'g2.2xlarge': {\n 'id': 'g2.2xlarge',\n 'cores': '8',\n 'disk': '60 GiB (1 x 60 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'g2.8xlarge': {\n 'id': 'g2.8xlarge',\n 'cores': '32',\n 'disk': '240 GiB (2 x 120 GiB SSD)',\n 'ram': '60 GiB'\n },\n },\n 'GPU Compute': {\n 'p2.xlarge': {\n 'id': 'p2.xlarge',\n 'cores': '4',\n 'disk': 'EBS',\n 'ram': '61 GiB'\n },\n 'p2.8xlarge': {\n 'id': 'p2.8xlarge',\n 'cores': '32',\n 'disk': 'EBS',\n 'ram': '488 GiB'\n },\n 'p2.16xlarge': {\n 'id': 'p2.16xlarge',\n 'cores': '64',\n 'disk': 'EBS',\n 'ram': '732 GiB'\n },\n },\n 'High I/O': {\n 'i2.xlarge': {\n 'id': 'i2.xlarge',\n 'cores': '4',\n 'disk': 'SSD (1 x 800 GiB)',\n 'ram': '30.5 GiB'\n },\n 'i2.2xlarge': {\n 'id': 'i2.2xlarge',\n 'cores': '8',\n 'disk': 'SSD (2 x 800 GiB)',\n 'ram': '61 GiB'\n },\n 'i2.4xlarge': {\n 'id': 'i2.4xlarge',\n 'cores': '16',\n 'disk': 'SSD (4 x 800 GiB)',\n 'ram': '122 GiB'\n },\n 'i2.8xlarge': {\n 'id': 'i2.8xlarge',\n 'cores': '32',\n 'disk': 'SSD (8 x 800 GiB)',\n 'ram': '244 GiB'\n }\n },\n 'High Memory': {\n 'x1.16xlarge': {\n 'id': 'x1.16xlarge',\n 'cores': '64 (with 5.45 ECUs each)',\n 'disk': '1920 GiB (1 x 1920 GiB)',\n 'ram': '976 GiB'\n },\n 'x1.32xlarge': {\n 'id': 'x1.32xlarge',\n 'cores': '128 (with 2.73 ECUs each)',\n 'disk': '3840 GiB (2 x 1920 GiB)',\n 'ram': '1952 GiB'\n },\n 'r4.large': {\n 'id': 'r4.large',\n 'cores': '2 (with 3.45 ECUs each)',\n 'disk': 'EBS',\n 'ram': '15.25 GiB'\n },\n 'r4.xlarge': {\n 'id': 'r4.xlarge',\n 'cores': '4 (with 3.35 ECUs each)',\n 'disk': 'EBS',\n 'ram': '30.5 GiB'\n },\n 'r4.2xlarge': {\n 'id': 'r4.2xlarge',\n 'cores': '8 (with 3.35 ECUs each)',\n 'disk': 'EBS',\n 'ram': '61 GiB'\n },\n 'r4.4xlarge': {\n 'id': 'r4.4xlarge',\n 'cores': '16 (with 3.3 ECUs each)',\n 'disk': 'EBS',\n 'ram': '122 GiB'\n },\n 'r4.8xlarge': {\n 'id': 'r4.8xlarge',\n 'cores': '32 (with 3.1 ECUs each)',\n 'disk': 'EBS',\n 'ram': '244 GiB'\n },\n 'r4.16xlarge': {\n 'id': 'r4.16xlarge',\n 'cores': '64 (with 3.05 ECUs each)',\n 'disk': 'EBS',\n 'ram': '488 GiB'\n },\n 'r3.large': {\n 'id': 'r3.large',\n 'cores': '2 (with 3.25 ECUs each)',\n 'disk': '32 GiB (1 x 32 GiB SSD)',\n 'ram': '15 GiB'\n },\n 'r3.xlarge': {\n 'id': 'r3.xlarge',\n 'cores': '4 (with 3.25 ECUs each)',\n 'disk': '80 GiB (1 x 80 GiB SSD)',\n 'ram': '30.5 GiB'\n },\n 'r3.2xlarge': {\n 'id': 'r3.2xlarge',\n 'cores': '8 (with 3.25 ECUs each)',\n 'disk': '160 GiB (1 x 160 GiB SSD)',\n 'ram': '61 GiB'\n },\n 'r3.4xlarge': {\n 'id': 'r3.4xlarge',\n 'cores': '16 (with 3.25 ECUs each)',\n 'disk': '320 GiB (1 x 320 GiB SSD)',\n 'ram': '122 GiB'\n },\n 'r3.8xlarge': {\n 'id': 'r3.8xlarge',\n 'cores': '32 (with 3.25 ECUs each)',\n 'disk': '640 GiB (2 x 320 GiB SSD)',\n 'ram': '244 GiB'\n }\n },\n 'High-Memory Cluster': {\n 'cr1.8xlarge': {\n 'id': 'cr1.8xlarge',\n 'cores': '16 (2 x Intel Xeon E5-2670, eight-core)',\n 'disk': '240 GiB (2 x 120 GiB SSD)',\n 'ram': '244 GiB'\n },\n },\n 'High Storage': {\n 'hs1.8xlarge': {\n 'id': 'hs1.8xlarge',\n 'cores': '16 (8 cores + 8 hyperthreads)',\n 'disk': '48 TiB (24 x 2 TiB hard disk drives)',\n 'ram': '117 GiB'\n },\n },\n 'General Purpose': {\n 't2.nano': {\n 'id': 't2.nano',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '512 MiB'\n },\n 't2.micro': {\n 'id': 't2.micro',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '1 GiB'\n },\n 't2.small': {\n 'id': 't2.small',\n 'cores': '1',\n 'disk': 'EBS',\n 'ram': '2 GiB'\n },\n 't2.medium': {\n 'id': 't2.medium',\n 'cores': '2',\n 'disk': 'EBS',\n 'ram': '4 GiB'\n },\n 't2.large': {\n 'id': 't2.large',\n 'cores': '2',\n 'disk': 'EBS',\n 'ram': '8 GiB'\n },\n 't2.xlarge': {\n 'id': 't2.xlarge',\n 'cores': '4',\n 'disk': 'EBS',\n 'ram': '16 GiB'\n },\n 't2.2xlarge': {\n 'id': 't2.2xlarge',\n 'cores': '8',\n 'disk': 'EBS',\n 'ram': '32 GiB'\n },\n 'm4.large': {\n 'id': 'm4.large',\n 'cores': '2',\n 'disk': 'EBS - 450 Mbps',\n 'ram': '8 GiB'\n },\n 'm4.xlarge': {\n 'id': 'm4.xlarge',\n 'cores': '4',\n 'disk': 'EBS - 750 Mbps',\n 'ram': '16 GiB'\n },\n 'm4.2xlarge': {\n 'id': 'm4.2xlarge',\n 'cores': '8',\n 'disk': 'EBS - 1000 Mbps',\n 'ram': '32 GiB'\n },\n 'm4.4xlarge': {\n 'id': 'm4.4xlarge',\n 'cores': '16',\n 'disk': 'EBS - 2000 Mbps',\n 'ram': '64 GiB'\n },\n 'm4.10xlarge': {\n 'id': 'm4.10xlarge',\n 'cores': '40',\n 'disk': 'EBS - 4000 Mbps',\n 'ram': '160 GiB'\n },\n 'm4.16xlarge': {\n 'id': 'm4.16xlarge',\n 'cores': '64',\n 'disk': 'EBS - 10000 Mbps',\n 'ram': '256 GiB'\n },\n 'm3.medium': {\n 'id': 'm3.medium',\n 'cores': '1',\n 'disk': 'SSD (1 x 4)',\n 'ram': '3.75 GiB'\n },\n 'm3.large': {\n 'id': 'm3.large',\n 'cores': '2',\n 'disk': 'SSD (1 x 32)',\n 'ram': '7.5 GiB'\n },\n 'm3.xlarge': {\n 'id': 'm3.xlarge',\n 'cores': '4',\n 'disk': 'SSD (2 x 40)',\n 'ram': '15 GiB'\n },\n 'm3.2xlarge': {\n 'id': 'm3.2xlarge',\n 'cores': '8',\n 'disk': 'SSD (2 x 80)',\n 'ram': '30 GiB'\n },\n }\n }\n return sizes\n\n\ndef avail_images(kwargs=None, call=None):\n '''\n Return a dict of all available VM images on the cloud provider.\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_images function must be called with '\n '-f or --function, or with the --list-images option'\n )\n\n if not isinstance(kwargs, dict):\n kwargs = {}\n\n if 'owner' in kwargs:\n owner = kwargs['owner']\n else:\n provider = get_configured_provider()\n\n owner = config.get_cloud_config_value(\n 'owner', provider, __opts__, default='amazon'\n )\n\n ret = {}\n params = {'Action': 'DescribeImages',\n 'Owner': owner}\n images = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for image in images:\n ret[image['imageId']] = image\n return ret\n\n\ndef script(vm_):\n '''\n Return the script deployment object\n '''\n return salt.utils.cloud.os_script(\n config.get_cloud_config_value('script', vm_, __opts__),\n vm_,\n __opts__,\n salt.utils.cloud.salt_config_to_yaml(\n salt.utils.cloud.minion_config(__opts__, vm_)\n )\n )\n\n\ndef keyname(vm_):\n '''\n Return the keyname\n '''\n return config.get_cloud_config_value(\n 'keyname', vm_, __opts__, search_global=False\n )\n\n\ndef securitygroup(vm_):\n '''\n Return the security group\n '''\n return config.get_cloud_config_value(\n 'securitygroup', vm_, __opts__, search_global=False\n )\n\n\ndef iam_profile(vm_):\n '''\n Return the IAM profile.\n\n The IAM instance profile to associate with the instances.\n This is either the Amazon Resource Name (ARN) of the instance profile\n or the name of the role.\n\n Type: String\n\n Default: None\n\n Required: No\n\n Example: arn:aws:iam::111111111111:instance-profile/s3access\n\n Example: s3access\n\n '''\n return config.get_cloud_config_value(\n 'iam_profile', vm_, __opts__, search_global=False\n )\n\n\ndef ssh_interface(vm_):\n '''\n Return the ssh_interface type to connect to. Either 'public_ips' (default)\n or 'private_ips'.\n '''\n ret = config.get_cloud_config_value(\n 'ssh_interface', vm_, __opts__, default='public_ips',\n search_global=False\n )\n if ret not in ('public_ips', 'private_ips'):\n log.warning(\n 'Invalid ssh_interface: %s. '\n 'Allowed options are (\"public_ips\", \"private_ips\"). '\n 'Defaulting to \"public_ips\".', ret\n )\n ret = 'public_ips'\n return ret\n\n\ndef get_ssh_gateway_config(vm_):\n '''\n Return the ssh_gateway configuration.\n '''\n ssh_gateway = config.get_cloud_config_value(\n 'ssh_gateway', vm_, __opts__, default=None,\n search_global=False\n )\n\n # Check to see if a SSH Gateway will be used.\n if not isinstance(ssh_gateway, six.string_types):\n return None\n\n # Create dictionary of configuration items\n\n # ssh_gateway\n ssh_gateway_config = {'ssh_gateway': ssh_gateway}\n\n # ssh_gateway_port\n ssh_gateway_config['ssh_gateway_port'] = config.get_cloud_config_value(\n 'ssh_gateway_port', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_username\n ssh_gateway_config['ssh_gateway_user'] = config.get_cloud_config_value(\n 'ssh_gateway_username', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_private_key\n ssh_gateway_config['ssh_gateway_key'] = config.get_cloud_config_value(\n 'ssh_gateway_private_key', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_password\n ssh_gateway_config['ssh_gateway_password'] = config.get_cloud_config_value(\n 'ssh_gateway_password', vm_, __opts__, default=None,\n search_global=False\n )\n\n # ssh_gateway_command\n ssh_gateway_config['ssh_gateway_command'] = config.get_cloud_config_value(\n 'ssh_gateway_command', vm_, __opts__, default=None,\n search_global=False\n )\n\n # Check if private key exists\n key_filename = ssh_gateway_config['ssh_gateway_key']\n if key_filename is not None and not os.path.isfile(key_filename):\n raise SaltCloudConfigError(\n 'The defined ssh_gateway_private_key \\'{0}\\' does not exist'\n .format(key_filename)\n )\n elif (\n key_filename is None and\n not ssh_gateway_config['ssh_gateway_password']\n ):\n raise SaltCloudConfigError(\n 'No authentication method. Please define: '\n ' ssh_gateway_password or ssh_gateway_private_key'\n )\n\n return ssh_gateway_config\n\n\ndef get_location(vm_=None):\n '''\n Return the EC2 region to use, in this order:\n - CLI parameter\n - VM parameter\n - Cloud profile setting\n '''\n return __opts__.get(\n 'location',\n config.get_cloud_config_value(\n 'location',\n vm_ or get_configured_provider(),\n __opts__,\n default=DEFAULT_LOCATION,\n search_global=False\n )\n )\n\n\ndef avail_locations(call=None):\n '''\n List all available locations\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The avail_locations function must be called with '\n '-f or --function, or with the --list-locations option'\n )\n\n ret = {}\n\n params = {'Action': 'DescribeRegions'}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for region in result:\n ret[region['regionName']] = {\n 'name': region['regionName'],\n 'endpoint': region['regionEndpoint'],\n }\n\n return ret\n\n\ndef get_availability_zone(vm_):\n '''\n Return the availability zone to use\n '''\n avz = config.get_cloud_config_value(\n 'availability_zone', vm_, __opts__, search_global=False\n )\n\n if avz is None:\n return None\n\n zones = _list_availability_zones(vm_)\n\n # Validate user-specified AZ\n if avz not in zones:\n raise SaltCloudException(\n 'The specified availability zone isn\\'t valid in this region: '\n '{0}\\n'.format(\n avz\n )\n )\n\n # check specified AZ is available\n elif zones[avz] != 'available':\n raise SaltCloudException(\n 'The specified availability zone isn\\'t currently available: '\n '{0}\\n'.format(\n avz\n )\n )\n\n return avz\n\n\ndef get_tenancy(vm_):\n '''\n Returns the Tenancy to use.\n\n Can be \"dedicated\" or \"default\". Cannot be present for spot instances.\n '''\n return config.get_cloud_config_value(\n 'tenancy', vm_, __opts__, search_global=False\n )\n\n\ndef get_imageid(vm_):\n '''\n Returns the ImageId to use\n '''\n image = config.get_cloud_config_value(\n 'image', vm_, __opts__, search_global=False\n )\n if image.startswith('ami-'):\n return image\n # a poor man's cache\n if not hasattr(get_imageid, 'images'):\n get_imageid.images = {}\n elif image in get_imageid.images:\n return get_imageid.images[image]\n params = {'Action': 'DescribeImages',\n 'Filter.0.Name': 'name',\n 'Filter.0.Value.0': image}\n # Query AWS, sort by 'creationDate' and get the last imageId\n _t = lambda x: datetime.datetime.strptime(x['creationDate'], '%Y-%m-%dT%H:%M:%S.%fZ')\n image_id = sorted(aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'),\n lambda i, j: salt.utils.compat.cmp(_t(i), _t(j))\n )[-1]['imageId']\n get_imageid.images[image] = image_id\n return image_id\n\n\ndef _get_subnetname_id(subnetname):\n '''\n Returns the SubnetId of a SubnetName to use\n '''\n params = {'Action': 'DescribeSubnets'}\n for subnet in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n tags = subnet.get('tagSet', {}).get('item', {})\n if not isinstance(tags, list):\n tags = [tags]\n for tag in tags:\n if tag['key'] == 'Name' and tag['value'] == subnetname:\n log.debug(\n 'AWS Subnet ID of %s is %s',\n subnetname, subnet['subnetId']\n )\n return subnet['subnetId']\n return None\n\n\ndef get_subnetid(vm_):\n '''\n Returns the SubnetId to use\n '''\n subnetid = config.get_cloud_config_value(\n 'subnetid', vm_, __opts__, search_global=False\n )\n if subnetid:\n return subnetid\n\n subnetname = config.get_cloud_config_value(\n 'subnetname', vm_, __opts__, search_global=False\n )\n if subnetname:\n return _get_subnetname_id(subnetname)\n return None\n\n\ndef _get_securitygroupname_id(securitygroupname_list):\n '''\n Returns the SecurityGroupId of a SecurityGroupName to use\n '''\n securitygroupid_set = set()\n if not isinstance(securitygroupname_list, list):\n securitygroupname_list = [securitygroupname_list]\n params = {'Action': 'DescribeSecurityGroups'}\n for sg in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n if sg['groupName'] in securitygroupname_list:\n log.debug(\n 'AWS SecurityGroup ID of %s is %s',\n sg['groupName'], sg['groupId']\n )\n securitygroupid_set.add(sg['groupId'])\n return list(securitygroupid_set)\n\n\ndef securitygroupid(vm_):\n '''\n Returns the SecurityGroupId\n '''\n securitygroupid_set = set()\n securitygroupid_list = config.get_cloud_config_value(\n 'securitygroupid',\n vm_,\n __opts__,\n search_global=False\n )\n # If the list is None, then the set will remain empty\n # If the list is already a set then calling 'set' on it is a no-op\n # If the list is a string, then calling 'set' generates a one-element set\n # If the list is anything else, stacktrace\n if securitygroupid_list:\n securitygroupid_set = securitygroupid_set.union(set(securitygroupid_list))\n\n securitygroupname_list = config.get_cloud_config_value(\n 'securitygroupname', vm_, __opts__, search_global=False\n )\n if securitygroupname_list:\n if not isinstance(securitygroupname_list, list):\n securitygroupname_list = [securitygroupname_list]\n params = {'Action': 'DescribeSecurityGroups'}\n for sg in aws.query(params, location=get_location(),\n provider=get_provider(), opts=__opts__, sigver='4'):\n if sg['groupName'] in securitygroupname_list:\n log.debug(\n 'AWS SecurityGroup ID of %s is %s',\n sg['groupName'], sg['groupId']\n )\n securitygroupid_set.add(sg['groupId'])\n return list(securitygroupid_set)\n\n\ndef get_placementgroup(vm_):\n '''\n Returns the PlacementGroup to use\n '''\n return config.get_cloud_config_value(\n 'placementgroup', vm_, __opts__, search_global=False\n )\n\n\ndef get_spot_config(vm_):\n '''\n Returns the spot instance configuration for the provided vm\n '''\n return config.get_cloud_config_value(\n 'spot_config', vm_, __opts__, search_global=False\n )\n\n\ndef get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_comps[0]\n return provider\n\n\ndef _list_availability_zones(vm_=None):\n '''\n List all availability zones in the current region\n '''\n ret = {}\n\n params = {'Action': 'DescribeAvailabilityZones',\n 'Filter.0.Name': 'region-name',\n 'Filter.0.Value.0': get_location(vm_)}\n result = aws.query(params,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for zone in result:\n ret[zone['zoneName']] = zone['zoneState']\n\n return ret\n\n\ndef block_device_mappings(vm_):\n '''\n Return the block device mapping:\n\n .. code-block:: python\n\n [{'DeviceName': '/dev/sdb', 'VirtualName': 'ephemeral0'},\n {'DeviceName': '/dev/sdc', 'VirtualName': 'ephemeral1'}]\n '''\n return config.get_cloud_config_value(\n 'block_device_mappings', vm_, __opts__, search_global=True\n )\n\n\ndef _request_eip(interface, vm_):\n '''\n Request and return Elastic IP\n '''\n params = {'Action': 'AllocateAddress'}\n params['Domain'] = interface.setdefault('domain', 'vpc')\n eips = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n for eip in eips:\n if 'allocationId' in eip:\n return eip['allocationId']\n return None\n\n\ndef _create_eni_if_necessary(interface, vm_):\n '''\n Create an Elastic Interface if necessary and return a Network Interface Specification\n '''\n if 'NetworkInterfaceId' in interface and interface['NetworkInterfaceId'] is not None:\n return {'DeviceIndex': interface['DeviceIndex'],\n 'NetworkInterfaceId': interface['NetworkInterfaceId']}\n\n params = {'Action': 'DescribeSubnets'}\n subnet_query = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if 'SecurityGroupId' not in interface and 'securitygroupname' in interface:\n interface['SecurityGroupId'] = _get_securitygroupname_id(interface['securitygroupname'])\n if 'SubnetId' not in interface and 'subnetname' in interface:\n interface['SubnetId'] = _get_subnetname_id(interface['subnetname'])\n\n subnet_id = _get_subnet_id_for_interface(subnet_query, interface)\n if not subnet_id:\n raise SaltCloudConfigError(\n 'No such subnet <{0}>'.format(interface.get('SubnetId'))\n )\n params = {'SubnetId': subnet_id}\n\n for k in 'Description', 'PrivateIpAddress', 'SecondaryPrivateIpAddressCount':\n if k in interface:\n params[k] = interface[k]\n\n for k in 'PrivateIpAddresses', 'SecurityGroupId':\n if k in interface:\n params.update(_param_from_config(k, interface[k]))\n\n if 'AssociatePublicIpAddress' in interface:\n # Associating a public address in a VPC only works when the interface is not\n # created beforehand, but as a part of the machine creation request.\n for k in ('DeviceIndex', 'AssociatePublicIpAddress', 'NetworkInterfaceId'):\n if k in interface:\n params[k] = interface[k]\n params['DeleteOnTermination'] = interface.get('delete_interface_on_terminate', True)\n return params\n\n params['Action'] = 'CreateNetworkInterface'\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n eni_desc = result[1]\n if not eni_desc or not eni_desc.get('networkInterfaceId'):\n raise SaltCloudException('Failed to create interface: {0}'.format(result))\n\n eni_id = eni_desc.get('networkInterfaceId')\n log.debug(\n 'Created network interface %s inst %s',\n eni_id, interface['DeviceIndex']\n )\n\n associate_public_ip = interface.get('AssociatePublicIpAddress', False)\n if isinstance(associate_public_ip, six.string_types):\n # Assume id of EIP as value\n _associate_eip_with_interface(eni_id, associate_public_ip, vm_=vm_)\n\n if interface.get('associate_eip'):\n _associate_eip_with_interface(eni_id, interface.get('associate_eip'), vm_=vm_)\n elif interface.get('allocate_new_eip'):\n _new_eip = _request_eip(interface, vm_)\n _associate_eip_with_interface(eni_id, _new_eip, vm_=vm_)\n elif interface.get('allocate_new_eips'):\n addr_list = _list_interface_private_addrs(eni_desc)\n eip_list = []\n for idx, addr in enumerate(addr_list):\n eip_list.append(_request_eip(interface, vm_))\n for idx, addr in enumerate(addr_list):\n _associate_eip_with_interface(eni_id, eip_list[idx], addr, vm_=vm_)\n\n if 'Name' in interface:\n tag_params = {'Action': 'CreateTags',\n 'ResourceId.0': eni_id,\n 'Tag.0.Key': 'Name',\n 'Tag.0.Value': interface['Name']}\n tag_response = aws.query(tag_params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in tag_response:\n log.error('Failed to set name of interface {0}')\n\n return {'DeviceIndex': interface['DeviceIndex'],\n 'NetworkInterfaceId': eni_id}\n\n\ndef _get_subnet_id_for_interface(subnet_query, interface):\n for subnet_query_result in subnet_query:\n if 'item' in subnet_query_result:\n if isinstance(subnet_query_result['item'], dict):\n subnet_id = _get_subnet_from_subnet_query(subnet_query_result['item'],\n interface)\n if subnet_id is not None:\n return subnet_id\n\n else:\n for subnet in subnet_query_result['item']:\n subnet_id = _get_subnet_from_subnet_query(subnet, interface)\n if subnet_id is not None:\n return subnet_id\n\n\ndef _get_subnet_from_subnet_query(subnet_query, interface):\n if 'subnetId' in subnet_query:\n if interface.get('SubnetId'):\n if subnet_query['subnetId'] == interface['SubnetId']:\n return subnet_query['subnetId']\n else:\n return subnet_query['subnetId']\n\n\ndef _list_interface_private_addrs(eni_desc):\n '''\n Returns a list of all of the private IP addresses attached to a\n network interface. The 'primary' address will be listed first.\n '''\n primary = eni_desc.get('privateIpAddress')\n if not primary:\n return None\n\n addresses = [primary]\n\n lst = eni_desc.get('privateIpAddressesSet', {}).get('item', [])\n if not isinstance(lst, list):\n return addresses\n\n for entry in lst:\n if entry.get('primary') == 'true':\n continue\n if entry.get('privateIpAddress'):\n addresses.append(entry.get('privateIpAddress'))\n\n return addresses\n\n\ndef _modify_eni_properties(eni_id, properties=None, vm_=None):\n '''\n Change properties of the interface\n with id eni_id to the values in properties dict\n '''\n if not isinstance(properties, dict):\n raise SaltCloudException(\n 'ENI properties must be a dictionary'\n )\n\n params = {'Action': 'ModifyNetworkInterfaceAttribute',\n 'NetworkInterfaceId': eni_id}\n for k, v in six.iteritems(properties):\n params[k] = v\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if isinstance(result, dict) and result.get('error'):\n raise SaltCloudException(\n 'Could not change interface <{0}> attributes <\\'{1}\\'>'.format(\n eni_id, properties\n )\n )\n else:\n return result\n\n\ndef _associate_eip_with_interface(eni_id, eip_id, private_ip=None, vm_=None):\n '''\n Accept the id of a network interface, and the id of an elastic ip\n address, and associate the two of them, such that traffic sent to the\n elastic ip address will be forwarded (NATted) to this network interface.\n\n Optionally specify the private (10.x.x.x) IP address that traffic should\n be NATted to - useful if you have multiple IP addresses assigned to an\n interface.\n '''\n params = {'Action': 'AssociateAddress',\n 'NetworkInterfaceId': eni_id,\n 'AllocationId': eip_id}\n\n if private_ip:\n params['PrivateIpAddress'] = private_ip\n\n result = aws.query(params,\n return_root=True,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if not result[2].get('associationId'):\n raise SaltCloudException(\n 'Could not associate elastic ip address '\n '<{0}> with network interface <{1}>'.format(\n eip_id, eni_id\n )\n )\n\n log.debug(\n 'Associated ElasticIP address %s with interface %s',\n eip_id, eni_id\n )\n\n return result[2].get('associationId')\n\n\ndef _update_enis(interfaces, instance, vm_=None):\n config_enis = {}\n instance_enis = []\n for interface in interfaces:\n if 'DeviceIndex' in interface:\n if interface['DeviceIndex'] in config_enis:\n log.error(\n 'Duplicate DeviceIndex in profile. Cannot update ENIs.'\n )\n return None\n config_enis[six.text_type(interface['DeviceIndex'])] = interface\n query_enis = instance[0]['instancesSet']['item']['networkInterfaceSet']['item']\n if isinstance(query_enis, list):\n for query_eni in query_enis:\n instance_enis.append((query_eni['networkInterfaceId'], query_eni['attachment']))\n else:\n instance_enis.append((query_enis['networkInterfaceId'], query_enis['attachment']))\n\n for eni_id, eni_data in instance_enis:\n delete_on_terminate = True\n if 'DeleteOnTermination' in config_enis[eni_data['deviceIndex']]:\n delete_on_terminate = config_enis[eni_data['deviceIndex']]['DeleteOnTermination']\n elif 'delete_interface_on_terminate' in config_enis[eni_data['deviceIndex']]:\n delete_on_terminate = config_enis[eni_data['deviceIndex']]['delete_interface_on_terminate']\n\n params_attachment = {'Attachment.AttachmentId': eni_data['attachmentId'],\n 'Attachment.DeleteOnTermination': delete_on_terminate}\n set_eni_attachment_attributes = _modify_eni_properties(eni_id, params_attachment, vm_=vm_)\n\n if 'SourceDestCheck' in config_enis[eni_data['deviceIndex']]:\n params_sourcedest = {'SourceDestCheck.Value': config_enis[eni_data['deviceIndex']]['SourceDestCheck']}\n set_eni_sourcedest_property = _modify_eni_properties(eni_id, params_sourcedest, vm_=vm_)\n\n return None\n\n\ndef _param_from_config(key, data):\n '''\n Return EC2 API parameters based on the given config data.\n\n Examples:\n 1. List of dictionaries\n >>> data = [\n ... {'DeviceIndex': 0, 'SubnetId': 'subid0',\n ... 'AssociatePublicIpAddress': True},\n ... {'DeviceIndex': 1,\n ... 'SubnetId': 'subid1',\n ... 'PrivateIpAddress': '192.168.1.128'}\n ... ]\n >>> _param_from_config('NetworkInterface', data)\n ... {'NetworkInterface.0.SubnetId': 'subid0',\n ... 'NetworkInterface.0.DeviceIndex': 0,\n ... 'NetworkInterface.1.SubnetId': 'subid1',\n ... 'NetworkInterface.1.PrivateIpAddress': '192.168.1.128',\n ... 'NetworkInterface.0.AssociatePublicIpAddress': 'true',\n ... 'NetworkInterface.1.DeviceIndex': 1}\n\n 2. List of nested dictionaries\n >>> data = [\n ... {'DeviceName': '/dev/sdf',\n ... 'Ebs': {\n ... 'SnapshotId': 'dummy0',\n ... 'VolumeSize': 200,\n ... 'VolumeType': 'standard'}},\n ... {'DeviceName': '/dev/sdg',\n ... 'Ebs': {\n ... 'SnapshotId': 'dummy1',\n ... 'VolumeSize': 100,\n ... 'VolumeType': 'standard'}}\n ... ]\n >>> _param_from_config('BlockDeviceMapping', data)\n ... {'BlockDeviceMapping.0.Ebs.VolumeType': 'standard',\n ... 'BlockDeviceMapping.1.Ebs.SnapshotId': 'dummy1',\n ... 'BlockDeviceMapping.0.Ebs.VolumeSize': 200,\n ... 'BlockDeviceMapping.0.Ebs.SnapshotId': 'dummy0',\n ... 'BlockDeviceMapping.1.Ebs.VolumeType': 'standard',\n ... 'BlockDeviceMapping.1.DeviceName': '/dev/sdg',\n ... 'BlockDeviceMapping.1.Ebs.VolumeSize': 100,\n ... 'BlockDeviceMapping.0.DeviceName': '/dev/sdf'}\n\n 3. Dictionary of dictionaries\n >>> data = { 'Arn': 'dummyarn', 'Name': 'Tester' }\n >>> _param_from_config('IamInstanceProfile', data)\n {'IamInstanceProfile.Arn': 'dummyarn', 'IamInstanceProfile.Name': 'Tester'}\n\n '''\n\n param = {}\n\n if isinstance(data, dict):\n for k, v in six.iteritems(data):\n param.update(_param_from_config('{0}.{1}'.format(key, k), v))\n\n elif isinstance(data, list) or isinstance(data, tuple):\n for idx, conf_item in enumerate(data):\n prefix = '{0}.{1}'.format(key, idx)\n param.update(_param_from_config(prefix, conf_item))\n\n else:\n if isinstance(data, bool):\n # convert boolean True/False to 'true'/'false'\n param.update({key: six.text_type(data).lower()})\n else:\n param.update({key: data})\n\n return param\n\n\ndef request_instance(vm_=None, call=None):\n '''\n Put together all of the information necessary to request an instance on EC2,\n and then fire off the request the instance.\n\n Returns data about the instance\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The request_instance action must be called with -a or --action.'\n )\n\n location = vm_.get('location', get_location(vm_))\n\n # do we launch a regular vm or a spot instance?\n # see http://goo.gl/hYZ13f for more information on EC2 API\n spot_config = get_spot_config(vm_)\n if spot_config is not None:\n if 'spot_price' not in spot_config:\n raise SaltCloudSystemExit(\n 'Spot instance config for {0} requires a spot_price '\n 'attribute.'.format(vm_['name'])\n )\n\n params = {'Action': 'RequestSpotInstances',\n 'InstanceCount': '1',\n 'Type': spot_config['type']\n if 'type' in spot_config else 'one-time',\n 'SpotPrice': spot_config['spot_price']}\n\n # All of the necessary launch parameters for a VM when using\n # spot instances are the same except for the prefix below\n # being tacked on.\n spot_prefix = 'LaunchSpecification.'\n\n # regular EC2 instance\n else:\n # WARNING! EXPERIMENTAL!\n # This allows more than one instance to be spun up in a single call.\n # The first instance will be called by the name provided, but all other\n # instances will be nameless (or more specifically, they will use the\n # InstanceId as the name). This interface is expected to change, so\n # use at your own risk.\n min_instance = config.get_cloud_config_value(\n 'min_instance', vm_, __opts__, search_global=False, default=1\n )\n max_instance = config.get_cloud_config_value(\n 'max_instance', vm_, __opts__, search_global=False, default=1\n )\n params = {'Action': 'RunInstances',\n 'MinCount': min_instance,\n 'MaxCount': max_instance}\n\n # Normal instances should have no prefix.\n spot_prefix = ''\n\n image_id = get_imageid(vm_)\n params[spot_prefix + 'ImageId'] = image_id\n\n userdata = None\n userdata_file = config.get_cloud_config_value(\n 'userdata_file', vm_, __opts__, search_global=False, default=None\n )\n if userdata_file is None:\n userdata = config.get_cloud_config_value(\n 'userdata', vm_, __opts__, search_global=False, default=None\n )\n else:\n log.trace('userdata_file: %s', userdata_file)\n if os.path.exists(userdata_file):\n with salt.utils.files.fopen(userdata_file, 'r') as fh_:\n userdata = salt.utils.stringutils.to_unicode(fh_.read())\n\n userdata = salt.utils.cloud.userdata_template(__opts__, vm_, userdata)\n\n if userdata is not None:\n try:\n params[spot_prefix + 'UserData'] = base64.b64encode(\n salt.utils.stringutils.to_bytes(userdata)\n )\n except Exception as exc:\n log.exception('Failed to encode userdata: %s', exc)\n\n vm_size = config.get_cloud_config_value(\n 'size', vm_, __opts__, search_global=False\n )\n params[spot_prefix + 'InstanceType'] = vm_size\n\n ex_keyname = keyname(vm_)\n if ex_keyname:\n params[spot_prefix + 'KeyName'] = ex_keyname\n\n ex_securitygroup = securitygroup(vm_)\n if ex_securitygroup:\n if not isinstance(ex_securitygroup, list):\n params[spot_prefix + 'SecurityGroup.1'] = ex_securitygroup\n else:\n for counter, sg_ in enumerate(ex_securitygroup):\n params[spot_prefix + 'SecurityGroup.{0}'.format(counter)] = sg_\n\n ex_iam_profile = iam_profile(vm_)\n if ex_iam_profile:\n try:\n if ex_iam_profile.startswith('arn:aws:iam:'):\n params[\n spot_prefix + 'IamInstanceProfile.Arn'\n ] = ex_iam_profile\n else:\n params[\n spot_prefix + 'IamInstanceProfile.Name'\n ] = ex_iam_profile\n except AttributeError:\n raise SaltCloudConfigError(\n '\\'iam_profile\\' should be a string value.'\n )\n\n az_ = get_availability_zone(vm_)\n if az_ is not None:\n params[spot_prefix + 'Placement.AvailabilityZone'] = az_\n\n tenancy_ = get_tenancy(vm_)\n if tenancy_ is not None:\n if spot_config is not None:\n raise SaltCloudConfigError(\n 'Spot instance config for {0} does not support '\n 'specifying tenancy.'.format(vm_['name'])\n )\n params['Placement.Tenancy'] = tenancy_\n\n subnetid_ = get_subnetid(vm_)\n if subnetid_ is not None:\n params[spot_prefix + 'SubnetId'] = subnetid_\n\n ex_securitygroupid = securitygroupid(vm_)\n if ex_securitygroupid:\n if not isinstance(ex_securitygroupid, list):\n params[spot_prefix + 'SecurityGroupId.1'] = ex_securitygroupid\n else:\n for counter, sg_ in enumerate(ex_securitygroupid):\n params[\n spot_prefix + 'SecurityGroupId.{0}'.format(counter)\n ] = sg_\n\n placementgroup_ = get_placementgroup(vm_)\n if placementgroup_ is not None:\n params[spot_prefix + 'Placement.GroupName'] = placementgroup_\n\n blockdevicemappings_holder = block_device_mappings(vm_)\n if blockdevicemappings_holder:\n for _bd in blockdevicemappings_holder:\n if 'tag' in _bd:\n _bd.pop('tag')\n\n ex_blockdevicemappings = blockdevicemappings_holder\n if ex_blockdevicemappings:\n params.update(_param_from_config(spot_prefix + 'BlockDeviceMapping',\n ex_blockdevicemappings))\n\n network_interfaces = config.get_cloud_config_value(\n 'network_interfaces',\n vm_,\n __opts__,\n search_global=False\n )\n\n if network_interfaces:\n eni_devices = []\n for interface in network_interfaces:\n log.debug('Create network interface: %s', interface)\n _new_eni = _create_eni_if_necessary(interface, vm_)\n eni_devices.append(_new_eni)\n params.update(_param_from_config(spot_prefix + 'NetworkInterface',\n eni_devices))\n\n set_ebs_optimized = config.get_cloud_config_value(\n 'ebs_optimized', vm_, __opts__, search_global=False\n )\n\n if set_ebs_optimized is not None:\n if not isinstance(set_ebs_optimized, bool):\n raise SaltCloudConfigError(\n '\\'ebs_optimized\\' should be a boolean value.'\n )\n params[spot_prefix + 'EbsOptimized'] = set_ebs_optimized\n\n set_del_root_vol_on_destroy = config.get_cloud_config_value(\n 'del_root_vol_on_destroy', vm_, __opts__, search_global=False\n )\n\n set_termination_protection = config.get_cloud_config_value(\n 'termination_protection', vm_, __opts__, search_global=False\n )\n\n if set_termination_protection is not None:\n if not isinstance(set_termination_protection, bool):\n raise SaltCloudConfigError(\n '\\'termination_protection\\' should be a boolean value.'\n )\n params.update(_param_from_config(spot_prefix + 'DisableApiTermination',\n set_termination_protection))\n\n if set_del_root_vol_on_destroy and not isinstance(set_del_root_vol_on_destroy, bool):\n raise SaltCloudConfigError(\n '\\'del_root_vol_on_destroy\\' should be a boolean value.'\n )\n\n vm_['set_del_root_vol_on_destroy'] = set_del_root_vol_on_destroy\n\n if set_del_root_vol_on_destroy:\n # first make sure to look up the root device name\n # as Ubuntu and CentOS (and most likely other OSs)\n # use different device identifiers\n\n log.info('Attempting to look up root device name for image id %s on '\n 'VM %s', image_id, vm_['name'])\n\n rd_params = {\n 'Action': 'DescribeImages',\n 'ImageId.1': image_id\n }\n try:\n rd_data = aws.query(rd_params,\n location=get_location(vm_),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in rd_data:\n return rd_data['error']\n log.debug('EC2 Response: \\'%s\\'', rd_data)\n except Exception as exc:\n log.error(\n 'Error getting root device name for image id %s for '\n 'VM %s: \\n%s', image_id, vm_['name'], exc,\n # Show the traceback if the debug logging level is enabled\n exc_info_on_loglevel=logging.DEBUG\n )\n raise\n\n # make sure we have a response\n if not rd_data:\n err_msg = 'There was an error querying EC2 for the root device ' \\\n 'of image id {0}. Empty response.'.format(image_id)\n raise SaltCloudSystemExit(err_msg)\n\n # pull the root device name from the result and use it when\n # launching the new VM\n rd_name = None\n rd_type = None\n if 'blockDeviceMapping' in rd_data[0]:\n # Some ami instances do not have a root volume. Ignore such cases\n if rd_data[0]['blockDeviceMapping'] is not None:\n item = rd_data[0]['blockDeviceMapping']['item']\n if isinstance(item, list):\n item = item[0]\n rd_name = item['deviceName']\n # Grab the volume type\n rd_type = item['ebs'].get('volumeType', None)\n\n log.info('Found root device name: %s', rd_name)\n\n if rd_name is not None:\n if ex_blockdevicemappings:\n dev_list = [\n dev['DeviceName'] for dev in ex_blockdevicemappings\n ]\n else:\n dev_list = []\n\n if rd_name in dev_list:\n # Device already listed, just grab the index\n dev_index = dev_list.index(rd_name)\n else:\n dev_index = len(dev_list)\n # Add the device name in since it wasn't already there\n params[\n '{0}BlockDeviceMapping.{1}.DeviceName'.format(\n spot_prefix, dev_index\n )\n ] = rd_name\n\n # Set the termination value\n termination_key = '{0}BlockDeviceMapping.{1}.Ebs.DeleteOnTermination'.format(spot_prefix, dev_index)\n params[termination_key] = six.text_type(set_del_root_vol_on_destroy).lower()\n\n # Use default volume type if not specified\n if ex_blockdevicemappings and dev_index < len(ex_blockdevicemappings) and \\\n 'Ebs.VolumeType' not in ex_blockdevicemappings[dev_index]:\n type_key = '{0}BlockDeviceMapping.{1}.Ebs.VolumeType'.format(spot_prefix, dev_index)\n params[type_key] = rd_type\n\n set_del_all_vols_on_destroy = config.get_cloud_config_value(\n 'del_all_vols_on_destroy', vm_, __opts__, search_global=False, default=False\n )\n\n if set_del_all_vols_on_destroy and not isinstance(set_del_all_vols_on_destroy, bool):\n raise SaltCloudConfigError(\n '\\'del_all_vols_on_destroy\\' should be a boolean value.'\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'requesting instance',\n 'salt/cloud/{0}/requesting'.format(vm_['name']),\n args={\n 'kwargs': __utils__['cloud.filter_event'](\n 'requesting', params, list(params)\n ),\n 'location': location,\n },\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n provider = get_provider(vm_)\n\n try:\n data = aws.query(params,\n 'instancesSet',\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if 'error' in data:\n return data['error']\n except Exception as exc:\n log.error(\n 'Error creating %s on EC2 when trying to run the initial '\n 'deployment: \\n%s', vm_['name'], exc,\n # Show the traceback if the debug logging level is enabled\n exc_info_on_loglevel=logging.DEBUG\n )\n raise\n\n # if we're using spot instances, we need to wait for the spot request\n # to become active before we continue\n if spot_config:\n sir_id = data[0]['spotInstanceRequestId']\n\n vm_['spotRequestId'] = sir_id\n\n def __query_spot_instance_request(sir_id, location):\n params = {'Action': 'DescribeSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if not data:\n log.error(\n 'There was an error while querying EC2. Empty response'\n )\n # Trigger a failure in the wait for spot instance method\n return False\n\n if isinstance(data, dict) and 'error' in data:\n log.warning('There was an error in the query. %s', data['error'])\n # Trigger a failure in the wait for spot instance method\n return False\n\n log.debug('Returned query data: %s', data)\n\n state = data[0].get('state')\n\n if state == 'active':\n return data\n\n if state == 'open':\n # Still waiting for an active state\n log.info('Spot instance status: %s', data[0]['status']['message'])\n return None\n\n if state in ['cancelled', 'failed', 'closed']:\n # Request will never be active, fail\n log.error('Spot instance request resulted in state \\'{0}\\'. '\n 'Nothing else we can do here.')\n return False\n\n __utils__['cloud.fire_event'](\n 'event',\n 'waiting for spot instance',\n 'salt/cloud/{0}/waiting_for_spot'.format(vm_['name']),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n try:\n data = _wait_for_spot_instance(\n __query_spot_instance_request,\n update_args=(sir_id, location),\n timeout=config.get_cloud_config_value(\n 'wait_for_spot_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_spot_interval', vm_, __opts__, default=30),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_spot_interval_multiplier',\n vm_,\n __opts__,\n default=1),\n max_failures=config.get_cloud_config_value(\n 'wait_for_spot_max_failures',\n vm_,\n __opts__,\n default=10),\n )\n log.debug('wait_for_spot_instance data %s', data)\n\n except (SaltCloudExecutionTimeout, SaltCloudExecutionFailure) as exc:\n try:\n # Cancel the existing spot instance request\n params = {'Action': 'CancelSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n\n log.debug('Canceled spot instance request %s. Data '\n 'returned: %s', sir_id, data)\n\n except SaltCloudSystemExit:\n pass\n finally:\n raise SaltCloudSystemExit(six.text_type(exc))\n\n return data, vm_\n\n\ndef query_instance(vm_=None, call=None):\n '''\n Query an instance upon creation from the EC2 API\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The query_instance action must be called with -a or --action.'\n )\n\n instance_id = vm_['instance_id']\n location = vm_.get('location', get_location(vm_))\n __utils__['cloud.fire_event'](\n 'event',\n 'querying instance',\n 'salt/cloud/{0}/querying'.format(vm_['name']),\n args={'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n log.debug('The new VM instance_id is %s', instance_id)\n\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n\n provider = get_provider(vm_)\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n data, requesturl = aws.query(params, # pylint: disable=unbalanced-tuple-unpacking\n location=location,\n provider=provider,\n opts=__opts__,\n return_url=True,\n sigver='4')\n log.debug('The query returned: %s', data)\n\n if isinstance(data, dict) and 'error' in data:\n log.warning(\n 'There was an error in the query. %s attempts '\n 'remaining: %s', attempts, data['error']\n )\n elif isinstance(data, list) and not data:\n log.warning(\n 'Query returned an empty list. %s attempts '\n 'remaining.', attempts\n )\n else:\n break\n\n aws.sleep_exponential_backoff(attempts)\n attempts += 1\n continue\n else:\n raise SaltCloudSystemExit(\n 'An error occurred while creating VM: {0}'.format(data['error'])\n )\n\n def __query_ip_address(params, url): # pylint: disable=W0613\n data = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if not data:\n log.error(\n 'There was an error while querying EC2. Empty response'\n )\n # Trigger a failure in the wait for IP function\n return False\n\n if isinstance(data, dict) and 'error' in data:\n log.warning('There was an error in the query. %s', data['error'])\n # Trigger a failure in the wait for IP function\n return False\n\n log.debug('Returned query data: %s', data)\n\n if ssh_interface(vm_) == 'public_ips':\n if 'ipAddress' in data[0]['instancesSet']['item']:\n return data\n else:\n log.error(\n 'Public IP not detected.'\n )\n\n if ssh_interface(vm_) == 'private_ips':\n if 'privateIpAddress' in data[0]['instancesSet']['item']:\n return data\n else:\n log.error(\n 'Private IP not detected.'\n )\n\n try:\n data = salt.utils.cloud.wait_for_ip(\n __query_ip_address,\n update_args=(params, requesturl),\n timeout=config.get_cloud_config_value(\n 'wait_for_ip_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_ip_interval', vm_, __opts__, default=10),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_ip_interval_multiplier', vm_, __opts__, default=1),\n )\n except (SaltCloudExecutionTimeout, SaltCloudExecutionFailure) as exc:\n try:\n # It might be already up, let's destroy it!\n destroy(vm_['name'])\n except SaltCloudSystemExit:\n pass\n finally:\n raise SaltCloudSystemExit(six.text_type(exc))\n\n if 'reactor' in vm_ and vm_['reactor'] is True:\n __utils__['cloud.fire_event'](\n 'event',\n 'instance queried',\n 'salt/cloud/{0}/query_reactor'.format(vm_['name']),\n args={'data': data},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n return data\n\n\ndef wait_for_instance(\n vm_=None,\n data=None,\n ip_address=None,\n display_ssh_output=True,\n call=None,\n ):\n '''\n Wait for an instance upon creation from the EC2 API, to become available\n '''\n if call == 'function':\n # Technically this function may be called other ways too, but it\n # definitely cannot be called with --function.\n raise SaltCloudSystemExit(\n 'The wait_for_instance action must be called with -a or --action.'\n )\n\n if vm_ is None:\n vm_ = {}\n\n if data is None:\n data = {}\n\n ssh_gateway_config = vm_.get(\n 'gateway', get_ssh_gateway_config(vm_)\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'waiting for ssh',\n 'salt/cloud/{0}/waiting_for_ssh'.format(vm_['name']),\n args={'ip_address': ip_address},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n ssh_connect_timeout = config.get_cloud_config_value(\n 'ssh_connect_timeout', vm_, __opts__, 900 # 15 minutes\n )\n ssh_port = config.get_cloud_config_value(\n 'ssh_port', vm_, __opts__, 22\n )\n\n if config.get_cloud_config_value('win_installer', vm_, __opts__):\n username = config.get_cloud_config_value(\n 'win_username', vm_, __opts__, default='Administrator'\n )\n win_passwd = config.get_cloud_config_value(\n 'win_password', vm_, __opts__, default=''\n )\n win_deploy_auth_retries = config.get_cloud_config_value(\n 'win_deploy_auth_retries', vm_, __opts__, default=10\n )\n win_deploy_auth_retry_delay = config.get_cloud_config_value(\n 'win_deploy_auth_retry_delay', vm_, __opts__, default=1\n )\n use_winrm = config.get_cloud_config_value(\n 'use_winrm', vm_, __opts__, default=False\n )\n winrm_verify_ssl = config.get_cloud_config_value(\n 'winrm_verify_ssl', vm_, __opts__, default=True\n )\n\n if win_passwd and win_passwd == 'auto':\n log.debug('Waiting for auto-generated Windows EC2 password')\n while True:\n password_data = get_password_data(\n name=vm_['name'],\n kwargs={\n 'key_file': vm_['private_key'],\n },\n call='action',\n )\n win_passwd = password_data.get('password', None)\n if win_passwd is None:\n log.debug(password_data)\n # This wait is so high, because the password is unlikely to\n # be generated for at least 4 minutes\n time.sleep(60)\n else:\n logging_data = password_data\n\n logging_data['password'] = 'XXX-REDACTED-XXX'\n logging_data['passwordData'] = 'XXX-REDACTED-XXX'\n log.debug(logging_data)\n\n vm_['win_password'] = win_passwd\n break\n\n # SMB used whether psexec or winrm\n if not salt.utils.cloud.wait_for_port(ip_address,\n port=445,\n timeout=ssh_connect_timeout):\n raise SaltCloudSystemExit(\n 'Failed to connect to remote windows host'\n )\n\n # If not using winrm keep same psexec behavior\n if not use_winrm:\n\n log.debug('Trying to authenticate via SMB using psexec')\n\n if not salt.utils.cloud.validate_windows_cred(ip_address,\n username,\n win_passwd,\n retries=win_deploy_auth_retries,\n retry_delay=win_deploy_auth_retry_delay):\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote windows host (smb)'\n )\n\n # If using winrm\n else:\n\n # Default HTTPS port can be changed in cloud configuration\n winrm_port = config.get_cloud_config_value(\n 'winrm_port', vm_, __opts__, default=5986\n )\n\n # Wait for winrm port to be available\n if not salt.utils.cloud.wait_for_port(ip_address,\n port=winrm_port,\n timeout=ssh_connect_timeout):\n raise SaltCloudSystemExit(\n 'Failed to connect to remote windows host (winrm)'\n )\n\n log.debug('Trying to authenticate via Winrm using pywinrm')\n\n if not salt.utils.cloud.wait_for_winrm(ip_address,\n winrm_port,\n username,\n win_passwd,\n timeout=ssh_connect_timeout,\n verify=winrm_verify_ssl):\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote windows host'\n )\n\n elif salt.utils.cloud.wait_for_port(ip_address,\n port=ssh_port,\n timeout=ssh_connect_timeout,\n gateway=ssh_gateway_config\n ):\n # If a known_hosts_file is configured, this instance will not be\n # accessible until it has a host key. Since this is provided on\n # supported instances by cloud-init, and viewable to us only from the\n # console output (which may take several minutes to become available,\n # we have some more waiting to do here.\n known_hosts_file = config.get_cloud_config_value(\n 'known_hosts_file', vm_, __opts__, default=None\n )\n if known_hosts_file:\n console = {}\n while 'output_decoded' not in console:\n console = get_console_output(\n instance_id=vm_['instance_id'],\n call='action',\n location=get_location(vm_)\n )\n pprint.pprint(console)\n time.sleep(5)\n output = salt.utils.stringutils.to_unicode(console['output_decoded'])\n comps = output.split('-----BEGIN SSH HOST KEY KEYS-----')\n if len(comps) < 2:\n # Fail; there are no host keys\n return False\n\n comps = comps[1].split('-----END SSH HOST KEY KEYS-----')\n keys = ''\n for line in comps[0].splitlines():\n if not line:\n continue\n keys += '\\n{0} {1}'.format(ip_address, line)\n\n with salt.utils.files.fopen(known_hosts_file, 'a') as fp_:\n fp_.write(salt.utils.stringutils.to_str(keys))\n fp_.close()\n\n for user in vm_['usernames']:\n if salt.utils.cloud.wait_for_passwd(\n host=ip_address,\n port=ssh_port,\n username=user,\n ssh_timeout=config.get_cloud_config_value(\n 'wait_for_passwd_timeout', vm_, __opts__, default=1 * 60\n ),\n key_filename=vm_['key_filename'],\n display_ssh_output=display_ssh_output,\n gateway=ssh_gateway_config,\n maxtries=config.get_cloud_config_value(\n 'wait_for_passwd_maxtries', vm_, __opts__, default=15\n ),\n known_hosts_file=config.get_cloud_config_value(\n 'known_hosts_file', vm_, __opts__,\n default='/dev/null'\n ),\n ):\n __opts__['ssh_username'] = user\n vm_['ssh_username'] = user\n break\n else:\n raise SaltCloudSystemExit(\n 'Failed to authenticate against remote ssh'\n )\n else:\n raise SaltCloudSystemExit(\n 'Failed to connect to remote ssh'\n )\n\n if 'reactor' in vm_ and vm_['reactor'] is True:\n __utils__['cloud.fire_event'](\n 'event',\n 'ssh is available',\n 'salt/cloud/{0}/ssh_ready_reactor'.format(vm_['name']),\n args={'ip_address': ip_address},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n return vm_\n\n\ndef _validate_key_path_and_mode(key_filename):\n if key_filename is None:\n raise SaltCloudSystemExit(\n 'The required \\'private_key\\' configuration setting is missing from the '\n '\\'ec2\\' driver.'\n )\n\n if not os.path.exists(key_filename):\n raise SaltCloudSystemExit(\n 'The EC2 key file \\'{0}\\' does not exist.\\n'.format(\n key_filename\n )\n )\n\n key_mode = stat.S_IMODE(os.stat(key_filename).st_mode)\n if key_mode not in (0o400, 0o600):\n raise SaltCloudSystemExit(\n 'The EC2 key file \\'{0}\\' needs to be set to mode 0400 or 0600.\\n'.format(\n key_filename\n )\n )\n\n return True\n\n\ndef create(vm_=None, call=None):\n '''\n Create a single VM from a data dict\n '''\n if call:\n raise SaltCloudSystemExit(\n 'You cannot create an instance with -a or -f.'\n )\n\n try:\n # Check for required profile parameters before sending any API calls.\n if vm_['profile'] and config.is_profile_configured(__opts__,\n __active_provider_name__ or 'ec2',\n vm_['profile'],\n vm_=vm_) is False:\n return False\n except AttributeError:\n pass\n\n # Check for private_key and keyfile name for bootstrapping new instances\n deploy = config.get_cloud_config_value(\n 'deploy', vm_, __opts__, default=True\n )\n win_password = config.get_cloud_config_value(\n 'win_password', vm_, __opts__, default=''\n )\n key_filename = config.get_cloud_config_value(\n 'private_key', vm_, __opts__, search_global=False, default=None\n )\n if deploy:\n # The private_key and keyname settings are only needed for bootstrapping\n # new instances when deploy is True\n _validate_key_path_and_mode(key_filename)\n\n __utils__['cloud.fire_event'](\n 'event',\n 'starting create',\n 'salt/cloud/{0}/creating'.format(vm_['name']),\n args=__utils__['cloud.filter_event']('creating', vm_, ['name', 'profile', 'provider', 'driver']),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n __utils__['cloud.cachedir_index_add'](\n vm_['name'], vm_['profile'], 'ec2', vm_['driver']\n )\n\n vm_['key_filename'] = key_filename\n # wait_for_instance requires private_key\n vm_['private_key'] = key_filename\n\n # Get SSH Gateway config early to verify the private_key,\n # if used, exists or not. We don't want to deploy an instance\n # and not be able to access it via the gateway.\n vm_['gateway'] = get_ssh_gateway_config(vm_)\n\n location = get_location(vm_)\n vm_['location'] = location\n\n log.info('Creating Cloud VM %s in %s', vm_['name'], location)\n vm_['usernames'] = salt.utils.cloud.ssh_usernames(\n vm_,\n __opts__,\n default_users=(\n 'ec2-user', # Amazon Linux, Fedora, RHEL; FreeBSD\n 'centos', # CentOS AMIs from AWS Marketplace\n 'ubuntu', # Ubuntu\n 'admin', # Debian GNU/Linux\n 'bitnami', # BitNami AMIs\n 'root' # Last resort, default user on RHEL 5, SUSE\n )\n )\n\n if 'instance_id' in vm_:\n # This was probably created via another process, and doesn't have\n # things like salt keys created yet, so let's create them now.\n if 'pub_key' not in vm_ and 'priv_key' not in vm_:\n log.debug('Generating minion keys for \\'%s\\'', vm_['name'])\n vm_['priv_key'], vm_['pub_key'] = salt.utils.cloud.gen_keys(\n salt.config.get_cloud_config_value(\n 'keysize',\n vm_,\n __opts__\n )\n )\n else:\n # Put together all of the information required to request the instance,\n # and then fire off the request for it\n if keyname(vm_) is None:\n raise SaltCloudSystemExit(\n 'The required \\'keyname\\' configuration setting is missing from the '\n '\\'ec2\\' driver.'\n )\n\n data, vm_ = request_instance(vm_, location)\n\n # If data is a str, it's an error\n if isinstance(data, six.string_types):\n log.error('Error requesting instance: %s', data)\n return {}\n\n # Pull the instance ID, valid for both spot and normal instances\n\n # Multiple instances may have been spun up, get all their IDs\n vm_['instance_id_list'] = []\n for instance in data:\n vm_['instance_id_list'].append(instance['instanceId'])\n\n vm_['instance_id'] = vm_['instance_id_list'].pop()\n if vm_['instance_id_list']:\n # Multiple instances were spun up, get one now, and queue the rest\n queue_instances(vm_['instance_id_list'])\n\n # Wait for vital information, such as IP addresses, to be available\n # for the new instance\n data = query_instance(vm_)\n\n # Now that the instance is available, tag it appropriately. Should\n # mitigate race conditions with tags\n tags = config.get_cloud_config_value('tag',\n vm_,\n __opts__,\n {},\n search_global=False)\n if not isinstance(tags, dict):\n raise SaltCloudConfigError(\n '\\'tag\\' should be a dict.'\n )\n\n for value in six.itervalues(tags):\n if not isinstance(value, six.string_types):\n raise SaltCloudConfigError(\n '\\'tag\\' values must be strings. Try quoting the values. '\n 'e.g. \"2013-09-19T20:09:46Z\".'\n )\n\n tags['Name'] = vm_['name']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/{0}/tagging'.format(vm_['name']),\n args={'tags': tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n salt.utils.cloud.wait_for_fun(\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=tags,\n instance_id=vm_['instance_id'],\n call='action',\n location=location\n )\n\n # Once instance tags are set, tag the spot request if configured\n if 'spot_config' in vm_ and 'tag' in vm_['spot_config']:\n\n if not isinstance(vm_['spot_config']['tag'], dict):\n raise SaltCloudConfigError(\n '\\'tag\\' should be a dict.'\n )\n\n for value in six.itervalues(vm_['spot_config']['tag']):\n if not isinstance(value, str):\n raise SaltCloudConfigError(\n '\\'tag\\' values must be strings. Try quoting the values. '\n 'e.g. \"2013-09-19T20:09:46Z\".'\n )\n\n spot_request_tags = {}\n\n if 'spotRequestId' not in vm_:\n raise SaltCloudConfigError('Failed to find spotRequestId')\n\n sir_id = vm_['spotRequestId']\n\n spot_request_tags['Name'] = vm_['name']\n\n for k, v in six.iteritems(vm_['spot_config']['tag']):\n spot_request_tags[k] = v\n\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/spot_request_{0}/tagging'.format(sir_id),\n args={'tags': spot_request_tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n salt.utils.cloud.wait_for_fun(\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=spot_request_tags,\n instance_id=sir_id,\n call='action',\n location=location\n )\n\n network_interfaces = config.get_cloud_config_value(\n 'network_interfaces',\n vm_,\n __opts__,\n search_global=False\n )\n\n if network_interfaces:\n _update_enis(network_interfaces, data, vm_)\n\n # At this point, the node is created and tagged, and now needs to be\n # bootstrapped, once the necessary port is available.\n log.info('Created node %s', vm_['name'])\n\n instance = data[0]['instancesSet']['item']\n\n # Wait for the necessary port to become available to bootstrap\n if ssh_interface(vm_) == 'private_ips':\n ip_address = instance['privateIpAddress']\n log.info('Salt node data. Private_ip: %s', ip_address)\n else:\n ip_address = instance['ipAddress']\n log.info('Salt node data. Public_ip: %s', ip_address)\n vm_['ssh_host'] = ip_address\n\n if salt.utils.cloud.get_salt_interface(vm_, __opts__) == 'private_ips':\n salt_ip_address = instance['privateIpAddress']\n log.info('Salt interface set to: %s', salt_ip_address)\n else:\n salt_ip_address = instance['ipAddress']\n log.debug('Salt interface set to: %s', salt_ip_address)\n vm_['salt_host'] = salt_ip_address\n\n if deploy:\n display_ssh_output = config.get_cloud_config_value(\n 'display_ssh_output', vm_, __opts__, default=True\n )\n\n vm_ = wait_for_instance(\n vm_, data, ip_address, display_ssh_output\n )\n\n # The instance is booted and accessible, let's Salt it!\n ret = instance.copy()\n\n # Get ANY defined volumes settings, merging data, in the following order\n # 1. VM config\n # 2. Profile config\n # 3. Global configuration\n volumes = config.get_cloud_config_value(\n 'volumes', vm_, __opts__, search_global=True\n )\n if volumes:\n __utils__['cloud.fire_event'](\n 'event',\n 'attaching volumes',\n 'salt/cloud/{0}/attaching_volumes'.format(vm_['name']),\n args={'volumes': volumes},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n log.info('Create and attach volumes to node %s', vm_['name'])\n created = create_attach_volumes(\n vm_['name'],\n {\n 'volumes': volumes,\n 'zone': ret['placement']['availabilityZone'],\n 'instance_id': ret['instanceId'],\n 'del_all_vols_on_destroy': vm_.get('del_all_vols_on_destroy', False)\n },\n call='action'\n )\n ret['Attached Volumes'] = created\n\n # Associate instance with a ssm document, if present\n ssm_document = config.get_cloud_config_value(\n 'ssm_document', vm_, __opts__, None, search_global=False\n )\n if ssm_document:\n log.debug('Associating with ssm document: %s', ssm_document)\n assoc = ssm_create_association(\n vm_['name'],\n {'ssm_document': ssm_document},\n instance_id=vm_['instance_id'],\n call='action'\n )\n if isinstance(assoc, dict) and assoc.get('error', None):\n log.error(\n 'Failed to associate instance %s with ssm document %s',\n vm_['instance_id'], ssm_document\n )\n return {}\n\n for key, value in six.iteritems(__utils__['cloud.bootstrap'](vm_, __opts__)):\n ret.setdefault(key, value)\n\n log.info('Created Cloud VM \\'%s\\'', vm_['name'])\n log.debug(\n '\\'%s\\' VM creation details:\\n%s',\n vm_['name'], pprint.pformat(instance)\n )\n\n event_data = {\n 'name': vm_['name'],\n 'profile': vm_['profile'],\n 'provider': vm_['driver'],\n 'instance_id': vm_['instance_id'],\n }\n if volumes:\n event_data['volumes'] = volumes\n if ssm_document:\n event_data['ssm_document'] = ssm_document\n\n __utils__['cloud.fire_event'](\n 'event',\n 'created instance',\n 'salt/cloud/{0}/created'.format(vm_['name']),\n args=__utils__['cloud.filter_event']('created', event_data, list(event_data)),\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n # Ensure that the latest node data is returned\n node = _get_node(instance_id=vm_['instance_id'])\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n ret.update(node)\n\n # Add any block device tags specified\n ex_blockdevicetags = {}\n blockdevicemappings_holder = block_device_mappings(vm_)\n if blockdevicemappings_holder:\n for _bd in blockdevicemappings_holder:\n if 'tag' in _bd:\n ex_blockdevicetags[_bd['DeviceName']] = _bd['tag']\n\n block_device_volume_id_map = {}\n\n if ex_blockdevicetags:\n for _device, _map in six.iteritems(ret['blockDeviceMapping']):\n bd_items = []\n if isinstance(_map, dict):\n bd_items.append(_map)\n else:\n for mapitem in _map:\n bd_items.append(mapitem)\n\n for blockitem in bd_items:\n if blockitem['deviceName'] in ex_blockdevicetags and 'Name' not in ex_blockdevicetags[blockitem['deviceName']]:\n ex_blockdevicetags[blockitem['deviceName']]['Name'] = vm_['name']\n if blockitem['deviceName'] in ex_blockdevicetags:\n block_device_volume_id_map[blockitem[ret['rootDeviceType']]['volumeId']] = ex_blockdevicetags[blockitem['deviceName']]\n\n if block_device_volume_id_map:\n\n for volid, tags in six.iteritems(block_device_volume_id_map):\n __utils__['cloud.fire_event'](\n 'event',\n 'setting tags',\n 'salt/cloud/block_volume_{0}/tagging'.format(str(volid)),\n args={'tags': tags},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n __utils__['cloud.wait_for_fun'](\n set_tags,\n timeout=30,\n name=vm_['name'],\n tags=tags,\n resource_id=volid,\n call='action',\n location=location\n )\n\n return ret\n\n\ndef queue_instances(instances):\n '''\n Queue a set of instances to be provisioned later. Expects a list.\n\n Currently this only queries node data, and then places it in the cloud\n cache (if configured). If the salt-cloud-reactor is being used, these\n instances will be automatically provisioned using that.\n\n For more information about the salt-cloud-reactor, see:\n\n https://github.com/saltstack-formulas/salt-cloud-reactor\n '''\n for instance_id in instances:\n node = _get_node(instance_id=instance_id)\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n\n\ndef create_attach_volumes(name, kwargs, call=None, wait_to_finish=True):\n '''\n Create and attach volumes to created node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The create_attach_volumes action must be called with '\n '-a or --action.'\n )\n\n if 'instance_id' not in kwargs:\n kwargs['instance_id'] = _get_node(name)['instanceId']\n\n if isinstance(kwargs['volumes'], six.string_types):\n volumes = salt.utils.yaml.safe_load(kwargs['volumes'])\n else:\n volumes = kwargs['volumes']\n\n ret = []\n for volume in volumes:\n created = False\n volume_name = '{0} on {1}'.format(volume['device'], name)\n\n volume_dict = {\n 'volume_name': volume_name,\n 'zone': kwargs['zone']\n }\n if 'volume_id' in volume:\n volume_dict['volume_id'] = volume['volume_id']\n elif 'snapshot' in volume:\n volume_dict['snapshot'] = volume['snapshot']\n elif 'size' in volume:\n volume_dict['size'] = volume['size']\n else:\n raise SaltCloudConfigError(\n 'Cannot create volume. Please define one of \\'volume_id\\', '\n '\\'snapshot\\', or \\'size\\''\n )\n\n if 'tags' in volume:\n volume_dict['tags'] = volume['tags']\n if 'type' in volume:\n volume_dict['type'] = volume['type']\n if 'iops' in volume:\n volume_dict['iops'] = volume['iops']\n if 'encrypted' in volume:\n volume_dict['encrypted'] = volume['encrypted']\n if 'kmskeyid' in volume:\n volume_dict['kmskeyid'] = volume['kmskeyid']\n\n if 'volume_id' not in volume_dict:\n created_volume = create_volume(volume_dict, call='function', wait_to_finish=wait_to_finish)\n created = True\n if 'volumeId' in created_volume:\n volume_dict['volume_id'] = created_volume['volumeId']\n\n attach = attach_volume(\n name,\n {'volume_id': volume_dict['volume_id'],\n 'device': volume['device']},\n instance_id=kwargs['instance_id'],\n call='action'\n )\n\n # Update the delvol parameter for this volume\n delvols_on_destroy = kwargs.get('del_all_vols_on_destroy', None)\n\n if attach and created and delvols_on_destroy is not None:\n _toggle_delvol(instance_id=kwargs['instance_id'],\n device=volume['device'],\n value=delvols_on_destroy)\n\n if attach:\n msg = (\n '{0} attached to {1} (aka {2}) as device {3}'.format(\n volume_dict['volume_id'],\n kwargs['instance_id'],\n name,\n volume['device']\n )\n )\n log.info(msg)\n ret.append(msg)\n return ret\n\n\ndef stop(name, call=None):\n '''\n Stop a node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The stop action must be called with -a or --action.'\n )\n\n log.info('Stopping node %s', name)\n\n instance_id = _get_node(name)['instanceId']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'stopping instance',\n 'salt/cloud/{0}/stopping'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n params = {'Action': 'StopInstances',\n 'InstanceId.1': instance_id}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n return result\n\n\ndef start(name, call=None):\n '''\n Start a node\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The start action must be called with -a or --action.'\n )\n\n log.info('Starting node %s', name)\n\n instance_id = _get_node(name)['instanceId']\n\n __utils__['cloud.fire_event'](\n 'event',\n 'starting instance',\n 'salt/cloud/{0}/starting'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n params = {'Action': 'StartInstances',\n 'InstanceId.1': instance_id}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n return result\n\n\ndef set_tags(name=None,\n tags=None,\n call=None,\n location=None,\n instance_id=None,\n resource_id=None,\n kwargs=None): # pylint: disable=W0613\n '''\n Set tags for a resource. Normally a VM name or instance_id is passed in,\n but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a set_tags mymachine tag1=somestuff tag2='Other stuff'\n salt-cloud -a set_tags resource_id=vol-3267ab32 tag=somestuff\n '''\n if kwargs is None:\n kwargs = {}\n\n if location is None:\n location = get_location()\n\n if instance_id is None:\n if 'resource_id' in kwargs:\n resource_id = kwargs['resource_id']\n del kwargs['resource_id']\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n if resource_id is None:\n if instance_id is None:\n instance_id = _get_node(name=name, instance_id=None, location=location)['instanceId']\n else:\n instance_id = resource_id\n\n # This second check is a safety, in case the above still failed to produce\n # a usable ID\n if instance_id is None:\n return {\n 'Error': 'A valid instance_id or resource_id was not specified.'\n }\n\n params = {'Action': 'CreateTags',\n 'ResourceId.1': instance_id}\n\n log.debug('Tags to set for %s: %s', name, tags)\n\n if kwargs and not tags:\n tags = kwargs\n\n for idx, (tag_k, tag_v) in enumerate(six.iteritems(tags)):\n params['Tag.{0}.Key'.format(idx)] = tag_k\n params['Tag.{0}.Value'.format(idx)] = tag_v\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n aws.query(params,\n setname='tagSet',\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n settags = get_tags(\n instance_id=instance_id, call='action', location=location\n )\n\n log.debug('Setting the tags returned: %s', settags)\n\n failed_to_set_tags = False\n for tag in settags:\n if tag['key'] not in tags:\n # We were not setting this tag\n continue\n\n if tag.get('value') is None and tags.get(tag['key']) == '':\n # This is a correctly set tag with no value\n continue\n\n if six.text_type(tags.get(tag['key'])) != six.text_type(tag['value']):\n # Not set to the proper value!?\n log.debug(\n 'Setting the tag %s returned %s instead of %s',\n tag['key'], tags.get(tag['key']), tag['value']\n )\n failed_to_set_tags = True\n break\n\n if failed_to_set_tags:\n log.warning('Failed to set tags. Remaining attempts %s', attempts)\n attempts += 1\n aws.sleep_exponential_backoff(attempts)\n continue\n\n return settags\n\n raise SaltCloudSystemExit(\n 'Failed to set tags on {0}!'.format(name)\n )\n\n\ndef get_tags(name=None,\n instance_id=None,\n call=None,\n location=None,\n kwargs=None,\n resource_id=None): # pylint: disable=W0613\n '''\n Retrieve tags for a resource. Normally a VM name or instance_id is passed\n in, but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a get_tags mymachine\n salt-cloud -a get_tags resource_id=vol-3267ab32\n '''\n if location is None:\n location = get_location()\n\n if instance_id is None:\n if resource_id is None:\n if name:\n instance_id = _get_node(name)['instanceId']\n elif 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n elif 'resource_id' in kwargs:\n instance_id = kwargs['resource_id']\n else:\n instance_id = resource_id\n\n params = {'Action': 'DescribeTags',\n 'Filter.1.Name': 'resource-id',\n 'Filter.1.Value': instance_id}\n\n return aws.query(params,\n setname='tagSet',\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n\ndef del_tags(name=None,\n kwargs=None,\n call=None,\n instance_id=None,\n resource_id=None): # pylint: disable=W0613\n '''\n Delete tags for a resource. Normally a VM name or instance_id is passed in,\n but a resource_id may be passed instead. If both are passed in, the\n instance_id will be used.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a del_tags mymachine tags=mytag,\n salt-cloud -a del_tags mymachine tags=tag1,tag2,tag3\n salt-cloud -a del_tags resource_id=vol-3267ab32 tags=tag1,tag2,tag3\n '''\n if kwargs is None:\n kwargs = {}\n\n if 'tags' not in kwargs:\n raise SaltCloudSystemExit(\n 'A tag or tags must be specified using tags=list,of,tags'\n )\n\n if not name and 'resource_id' in kwargs:\n instance_id = kwargs['resource_id']\n del kwargs['resource_id']\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n params = {'Action': 'DeleteTags',\n 'ResourceId.1': instance_id}\n\n for idx, tag in enumerate(kwargs['tags'].split(',')):\n params['Tag.{0}.Key'.format(idx)] = tag\n\n aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if resource_id:\n return get_tags(resource_id=resource_id)\n else:\n return get_tags(instance_id=instance_id)\n\n\ndef rename(name, kwargs, call=None):\n '''\n Properly rename a node. Pass in the new name as \"new name\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a rename mymachine newname=yourmachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The rename action must be called with -a or --action.'\n )\n\n log.info('Renaming %s to %s', name, kwargs['newname'])\n\n set_tags(name, {'Name': kwargs['newname']}, call='action')\n\n salt.utils.cloud.rename_key(\n __opts__['pki_dir'], name, kwargs['newname']\n )\n\n\ndef destroy(name, call=None):\n '''\n Destroy a node. Will check termination protection and warn if enabled.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud --destroy mymachine\n '''\n if call == 'function':\n raise SaltCloudSystemExit(\n 'The destroy action must be called with -d, --destroy, '\n '-a or --action.'\n )\n\n node_metadata = _get_node(name)\n instance_id = node_metadata['instanceId']\n sir_id = node_metadata.get('spotInstanceRequestId')\n protected = show_term_protect(\n name=name,\n instance_id=instance_id,\n call='action',\n quiet=True\n )\n\n __utils__['cloud.fire_event'](\n 'event',\n 'destroying instance',\n 'salt/cloud/{0}/destroying'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n if protected == 'true':\n raise SaltCloudSystemExit(\n 'This instance has been protected from being destroyed. '\n 'Use the following command to disable protection:\\n\\n'\n 'salt-cloud -a disable_term_protect {0}'.format(\n name\n )\n )\n\n ret = {}\n\n # Default behavior is to rename EC2 VMs when destroyed\n # via salt-cloud, unless explicitly set to False.\n rename_on_destroy = config.get_cloud_config_value('rename_on_destroy',\n get_configured_provider(),\n __opts__,\n search_global=False)\n if rename_on_destroy is not False:\n newname = '{0}-DEL{1}'.format(name, uuid.uuid4().hex)\n rename(name, kwargs={'newname': newname}, call='action')\n log.info(\n 'Machine will be identified as %s until it has been '\n 'cleaned up.', newname\n )\n ret['newname'] = newname\n\n params = {'Action': 'TerminateInstances',\n 'InstanceId.1': instance_id}\n\n location = get_location()\n provider = get_provider()\n result = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n\n log.info(result)\n ret.update(result[0])\n\n # If this instance is part of a spot instance request, we\n # need to cancel it as well\n if sir_id is not None:\n params = {'Action': 'CancelSpotInstanceRequests',\n 'SpotInstanceRequestId.1': sir_id}\n result = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n ret['spotInstance'] = result[0]\n\n __utils__['cloud.fire_event'](\n 'event',\n 'destroyed instance',\n 'salt/cloud/{0}/destroyed'.format(name),\n args={'name': name, 'instance_id': instance_id},\n sock_dir=__opts__['sock_dir'],\n transport=__opts__['transport']\n )\n\n __utils__['cloud.cachedir_index_del'](name)\n\n if __opts__.get('update_cachedir', False) is True:\n __utils__['cloud.delete_minion_cachedir'](name, __active_provider_name__.split(':')[0], __opts__)\n\n return ret\n\n\ndef reboot(name, call=None):\n '''\n Reboot a node.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a reboot mymachine\n '''\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'RebootInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n if result == []:\n log.info('Complete')\n\n return {'Reboot': 'Complete'}\n\n\ndef show_image(kwargs, call=None):\n '''\n Show the details from EC2 concerning an AMI\n '''\n if call != 'function':\n raise SaltCloudSystemExit(\n 'The show_image action must be called with -f or --function.'\n )\n\n params = {'ImageId.1': kwargs['image'],\n 'Action': 'DescribeImages'}\n result = aws.query(params,\n setname='tagSet',\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n log.info(result)\n\n return result\n\n\ndef show_instance(name=None, instance_id=None, call=None, kwargs=None):\n '''\n Show the details from EC2 concerning an AMI.\n\n Can be called as an action (which requires a name):\n\n .. code-block:: bash\n\n salt-cloud -a show_instance myinstance\n\n ...or as a function (which requires either a name or instance_id):\n\n .. code-block:: bash\n\n salt-cloud -f show_instance my-ec2 name=myinstance\n salt-cloud -f show_instance my-ec2 instance_id=i-d34db33f\n '''\n if not name and call == 'action':\n raise SaltCloudSystemExit(\n 'The show_instance action requires a name.'\n )\n\n if call == 'function':\n name = kwargs.get('name', None)\n instance_id = kwargs.get('instance_id', None)\n\n if not name and not instance_id:\n raise SaltCloudSystemExit(\n 'The show_instance function requires '\n 'either a name or an instance_id'\n )\n\n node = _get_node(name=name, instance_id=instance_id)\n __utils__['cloud.cache_node'](node, __active_provider_name__, __opts__)\n return node\n\n\ndef _get_node(name=None, instance_id=None, location=None):\n if location is None:\n location = get_location()\n\n params = {'Action': 'DescribeInstances'}\n\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if instance_id:\n params['InstanceId.1'] = instance_id\n else:\n params['Filter.1.Name'] = 'tag:Name'\n params['Filter.1.Value.1'] = name\n\n log.trace(params)\n\n provider = get_provider()\n\n attempts = 0\n while attempts < aws.AWS_MAX_RETRIES:\n try:\n instances = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n instance_info = _extract_instance_info(instances).values()\n return next(iter(instance_info))\n except IndexError:\n attempts += 1\n log.debug(\n 'Failed to get the data for node \\'%s\\'. Remaining '\n 'attempts: %s', instance_id or name, attempts\n )\n aws.sleep_exponential_backoff(attempts)\n return {}\n\n\ndef list_nodes_full(location=None, call=None):\n '''\n Return a list of the VMs that are on the provider\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes_full function must be called with -f '\n 'or --function.'\n )\n\n return _list_nodes_full(location or get_location())\n\n\ndef _extract_name_tag(item):\n if 'tagSet' in item and item['tagSet'] is not None:\n tagset = item['tagSet']\n if isinstance(tagset['item'], list):\n for tag in tagset['item']:\n if tag['key'] == 'Name':\n return tag['value']\n return item['instanceId']\n return item['tagSet']['item']['value']\n return item['instanceId']\n\n\ndef _extract_instance_info(instances):\n '''\n Given an instance query, return a dict of all instance data\n '''\n ret = {}\n for instance in instances:\n # items could be type dict or list (for stopped EC2 instances)\n if isinstance(instance['instancesSet']['item'], list):\n for item in instance['instancesSet']['item']:\n name = _extract_name_tag(item)\n ret[name] = item\n ret[name]['name'] = name\n ret[name].update(\n dict(\n id=item['instanceId'],\n image=item['imageId'],\n size=item['instanceType'],\n state=item['instanceState']['name'],\n private_ips=item.get('privateIpAddress', []),\n public_ips=item.get('ipAddress', [])\n )\n )\n else:\n item = instance['instancesSet']['item']\n name = _extract_name_tag(item)\n ret[name] = item\n ret[name]['name'] = name\n ret[name].update(\n dict(\n id=item['instanceId'],\n image=item['imageId'],\n size=item['instanceType'],\n state=item['instanceState']['name'],\n private_ips=item.get('privateIpAddress', []),\n public_ips=item.get('ipAddress', [])\n )\n )\n\n return ret\n\n\ndef _list_nodes_full(location=None):\n '''\n Return a list of the VMs that in this location\n '''\n provider = __active_provider_name__ or 'ec2'\n if ':' in provider:\n comps = provider.split(':')\n provider = comps[0]\n\n params = {'Action': 'DescribeInstances'}\n instances = aws.query(params,\n location=location,\n provider=provider,\n opts=__opts__,\n sigver='4')\n if 'error' in instances:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n instances['error']['Errors']['Error']['Message']\n )\n )\n\n ret = _extract_instance_info(instances)\n\n __utils__['cloud.cache_node_list'](ret, provider, __opts__)\n return ret\n\n\ndef list_nodes_min(location=None, call=None):\n '''\n Return a list of the VMs that are on the provider. Only a list of VM names,\n and their state, is returned. This is the minimum amount of information\n needed to check for existing VMs.\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes_min function must be called with -f or --function.'\n )\n\n ret = {}\n params = {'Action': 'DescribeInstances'}\n instances = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if 'error' in instances:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n instances['error']['Errors']['Error']['Message']\n )\n )\n\n for instance in instances:\n if isinstance(instance['instancesSet']['item'], list):\n items = instance['instancesSet']['item']\n else:\n items = [instance['instancesSet']['item']]\n\n for item in items:\n state = item['instanceState']['name']\n name = _extract_name_tag(item)\n id = item['instanceId']\n ret[name] = {'state': state, 'id': id}\n return ret\n\n\ndef list_nodes(call=None):\n '''\n Return a list of the VMs that are on the provider\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes function must be called with -f or --function.'\n )\n\n ret = {}\n nodes = list_nodes_full(get_location())\n if 'error' in nodes:\n raise SaltCloudSystemExit(\n 'An error occurred while listing nodes: {0}'.format(\n nodes['error']['Errors']['Error']['Message']\n )\n )\n for node in nodes:\n ret[node] = {\n 'id': nodes[node]['id'],\n 'image': nodes[node]['image'],\n 'name': nodes[node]['name'],\n 'size': nodes[node]['size'],\n 'state': nodes[node]['state'],\n 'private_ips': nodes[node]['private_ips'],\n 'public_ips': nodes[node]['public_ips'],\n }\n return ret\n\n\ndef list_nodes_select(call=None):\n '''\n Return a list of the VMs that are on the provider, with select fields\n '''\n return salt.utils.cloud.list_nodes_select(\n list_nodes_full(get_location()), __opts__['query.selection'], call,\n )\n\n\ndef show_term_protect(name=None, instance_id=None, call=None, quiet=False):\n '''\n Show the details from EC2 concerning an instance's termination protection state\n\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_term_protect action must be called with -a or --action.'\n )\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'DescribeInstanceAttribute',\n 'InstanceId': instance_id,\n 'Attribute': 'disableApiTermination'}\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n disable_protect = False\n for item in result:\n if 'value' in item:\n disable_protect = item['value']\n break\n\n log.log(\n logging.DEBUG if quiet is True else logging.INFO,\n 'Termination Protection is %s for %s',\n disable_protect == 'true' and 'enabled' or 'disabled', name\n )\n\n return disable_protect\n\n\ndef show_detailed_monitoring(name=None, instance_id=None, call=None, quiet=False):\n '''\n Show the details from EC2 regarding cloudwatch detailed monitoring.\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_detailed_monitoring action must be called with -a or --action.'\n )\n location = get_location()\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if not name and not instance_id:\n raise SaltCloudSystemExit(\n 'The show_detailed_monitoring action must be provided with a name or instance\\\n ID'\n )\n matched = _get_node(name=name, instance_id=instance_id, location=location)\n log.log(\n logging.DEBUG if quiet is True else logging.INFO,\n 'Detailed Monitoring is %s for %s', matched['monitoring'], name\n )\n return matched['monitoring']\n\n\ndef _toggle_term_protect(name, value):\n '''\n Enable or Disable termination protection on a node\n\n '''\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'ModifyInstanceAttribute',\n 'InstanceId': instance_id,\n 'DisableApiTermination.Value': value}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_term_protect(name=name, instance_id=instance_id, call='action')\n\n\ndef enable_term_protect(name, call=None):\n '''\n Enable termination protection on a node\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a enable_term_protect mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n return _toggle_term_protect(name, 'true')\n\n\ndef disable_term_protect(name, call=None):\n '''\n Disable termination protection on a node\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a disable_term_protect mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n return _toggle_term_protect(name, 'false')\n\n\ndef disable_detailed_monitoring(name, call=None):\n '''\n Enable/disable detailed monitoring on a node\n\n CLI Example:\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'UnmonitorInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_detailed_monitoring(name=name, instance_id=instance_id, call='action')\n\n\ndef enable_detailed_monitoring(name, call=None):\n '''\n Enable/disable detailed monitoring on a node\n\n CLI Example:\n\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The enable_term_protect action must be called with '\n '-a or --action.'\n )\n\n instance_id = _get_node(name)['instanceId']\n params = {'Action': 'MonitorInstances',\n 'InstanceId.1': instance_id}\n\n result = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n return_root=True,\n opts=__opts__,\n sigver='4')\n\n return show_detailed_monitoring(name=name, instance_id=instance_id, call='action')\n\n\ndef show_delvol_on_destroy(name, kwargs=None, call=None):\n '''\n Do not delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a show_delvol_on_destroy mymachine\n '''\n\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The show_delvol_on_destroy action must be called '\n 'with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n instance_id = kwargs.get('instance_id', None)\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n if instance_id is None:\n instance_id = _get_node(name)['instanceId']\n\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n\n data = aws.query(params,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n blockmap = data[0]['instancesSet']['item']['blockDeviceMapping']\n\n if not isinstance(blockmap['item'], list):\n blockmap['item'] = [blockmap['item']]\n\n items = []\n\n for idx, item in enumerate(blockmap['item']):\n device_name = item['deviceName']\n\n if device is not None and device != device_name:\n continue\n\n if volume_id is not None and volume_id != item['ebs']['volumeId']:\n continue\n\n info = {\n 'device_name': device_name,\n 'volume_id': item['ebs']['volumeId'],\n 'deleteOnTermination': item['ebs']['deleteOnTermination']\n }\n\n items.append(info)\n\n return items\n\n\ndef keepvol_on_destroy(name, kwargs=None, call=None):\n '''\n Do not delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a keepvol_on_destroy mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The keepvol_on_destroy action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n return _toggle_delvol(name=name, device=device,\n volume_id=volume_id, value='false')\n\n\ndef delvol_on_destroy(name, kwargs=None, call=None):\n '''\n Delete all/specified EBS volumes upon instance termination\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a delvol_on_destroy mymachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The delvol_on_destroy action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n device = kwargs.get('device', None)\n volume_id = kwargs.get('volume_id', None)\n\n return _toggle_delvol(name=name, device=device,\n volume_id=volume_id, value='true')\n\n\ndef _toggle_delvol(name=None, instance_id=None, device=None, volume_id=None,\n value=None, requesturl=None):\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if requesturl:\n data = aws.query(requesturl=requesturl,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n else:\n params = {'Action': 'DescribeInstances',\n 'InstanceId.1': instance_id}\n data, requesturl = aws.query(params, # pylint: disable=unbalanced-tuple-unpacking\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n blockmap = data[0]['instancesSet']['item']['blockDeviceMapping']\n\n params = {'Action': 'ModifyInstanceAttribute',\n 'InstanceId': instance_id}\n\n if not isinstance(blockmap['item'], list):\n blockmap['item'] = [blockmap['item']]\n\n for idx, item in enumerate(blockmap['item']):\n device_name = item['deviceName']\n\n if device is not None and device != device_name:\n continue\n if volume_id is not None and volume_id != item['ebs']['volumeId']:\n continue\n\n params['BlockDeviceMapping.{0}.DeviceName'.format(idx)] = device_name\n params['BlockDeviceMapping.{0}.Ebs.DeleteOnTermination'.format(idx)] = value\n\n aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n kwargs = {'instance_id': instance_id,\n 'device': device,\n 'volume_id': volume_id}\n return show_delvol_on_destroy(name, kwargs, call='action')\n\n\ndef register_image(kwargs=None, call=None):\n '''\n Create an ami from a snapshot\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -f register_image my-ec2-config ami_name=my_ami description=\"my description\"\n root_device_name=/dev/xvda snapshot_id=snap-xxxxxxxx\n '''\n\n if call != 'function':\n log.error(\n 'The create_volume function must be called with -f or --function.'\n )\n return False\n\n if 'ami_name' not in kwargs:\n log.error('ami_name must be specified to register an image.')\n return False\n\n block_device_mapping = kwargs.get('block_device_mapping', None)\n if not block_device_mapping:\n if 'snapshot_id' not in kwargs:\n log.error('snapshot_id or block_device_mapping must be specified to register an image.')\n return False\n if 'root_device_name' not in kwargs:\n log.error('root_device_name or block_device_mapping must be specified to register an image.')\n return False\n block_device_mapping = [{\n 'DeviceName': kwargs['root_device_name'],\n 'Ebs': {\n 'VolumeType': kwargs.get('volume_type', 'gp2'),\n 'SnapshotId': kwargs['snapshot_id'],\n }\n }]\n\n if not isinstance(block_device_mapping, list):\n block_device_mapping = [block_device_mapping]\n\n params = {'Action': 'RegisterImage',\n 'Name': kwargs['ami_name']}\n\n params.update(_param_from_config('BlockDeviceMapping', block_device_mapping))\n\n if 'root_device_name' in kwargs:\n params['RootDeviceName'] = kwargs['root_device_name']\n\n if 'description' in kwargs:\n params['Description'] = kwargs['description']\n\n if 'virtualization_type' in kwargs:\n params['VirtualizationType'] = kwargs['virtualization_type']\n\n if 'architecture' in kwargs:\n params['Architecture'] = kwargs['architecture']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n r_data = {}\n for d in data[0]:\n for k, v in d.items():\n r_data[k] = v\n\n return r_data\n\n\ndef volume_create(**kwargs):\n '''\n Wrapper around create_volume.\n Here just to ensure the compatibility with the cloud module.\n '''\n return create_volume(kwargs, 'function')\n\n\ndef create_volume(kwargs=None, call=None, wait_to_finish=False):\n '''\n Create a volume.\n\n zone\n The availability zone used to create the volume. Required. String.\n\n size\n The size of the volume, in GiBs. Defaults to ``10``. Integer.\n\n snapshot\n The snapshot-id from which to create the volume. Integer.\n\n type\n The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned\n IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for\n Magnetic volumes. String.\n\n iops\n The number of I/O operations per second (IOPS) to provision for the volume,\n with a maximum ratio of 50 IOPS/GiB. Only valid for Provisioned IOPS SSD\n volumes. Integer.\n\n This option will only be set if ``type`` is also specified as ``io1``.\n\n encrypted\n Specifies whether the volume will be encrypted. Boolean.\n\n If ``snapshot`` is also given in the list of kwargs, then this value is ignored\n since volumes that are created from encrypted snapshots are also automatically\n encrypted.\n\n tags\n The tags to apply to the volume during creation. Dictionary.\n\n call\n The ``create_volume`` function must be called with ``-f`` or ``--function``.\n String.\n\n wait_to_finish\n Whether or not to wait for the volume to be available. Boolean. Defaults to\n ``False``.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f create_volume my-ec2-config zone=us-east-1b\n salt-cloud -f create_volume my-ec2-config zone=us-east-1b tags='{\"tag1\": \"val1\", \"tag2\", \"val2\"}'\n '''\n if call != 'function':\n log.error(\n 'The create_volume function must be called with -f or --function.'\n )\n return False\n\n if 'zone' not in kwargs:\n log.error('An availability zone must be specified to create a volume.')\n return False\n\n if 'size' not in kwargs and 'snapshot' not in kwargs:\n # This number represents GiB\n kwargs['size'] = '10'\n\n params = {'Action': 'CreateVolume',\n 'AvailabilityZone': kwargs['zone']}\n\n if 'size' in kwargs:\n params['Size'] = kwargs['size']\n\n if 'snapshot' in kwargs:\n params['SnapshotId'] = kwargs['snapshot']\n\n if 'type' in kwargs:\n params['VolumeType'] = kwargs['type']\n\n if 'iops' in kwargs and kwargs.get('type', 'standard') == 'io1':\n params['Iops'] = kwargs['iops']\n\n # You can't set `encrypted` if you pass a snapshot\n if 'encrypted' in kwargs and 'snapshot' not in kwargs:\n params['Encrypted'] = kwargs['encrypted']\n if 'kmskeyid' in kwargs:\n params['KmsKeyId'] = kwargs['kmskeyid']\n if 'kmskeyid' in kwargs and 'encrypted' not in kwargs:\n log.error(\n 'If a KMS Key ID is specified, encryption must be enabled'\n )\n return False\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n r_data = {}\n for d in data[0]:\n for k, v in six.iteritems(d):\n r_data[k] = v\n volume_id = r_data['volumeId']\n\n # Allow tags to be set upon creation\n if 'tags' in kwargs:\n if isinstance(kwargs['tags'], six.string_types):\n tags = salt.utils.yaml.safe_load(kwargs['tags'])\n else:\n tags = kwargs['tags']\n\n if isinstance(tags, dict):\n new_tags = set_tags(tags=tags,\n resource_id=volume_id,\n call='action',\n location=get_location())\n r_data['tags'] = new_tags\n\n # Waits till volume is available\n if wait_to_finish:\n salt.utils.cloud.run_func_until_ret_arg(fun=describe_volumes,\n kwargs={'volume_id': volume_id},\n fun_call=call,\n argument_being_watched='status',\n required_argument_response='available')\n\n return r_data\n\n\ndef __attach_vol_to_instance(params, kws, instance_id):\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n if data[0]:\n log.warning(\n 'Error attaching volume %s to instance %s. Retrying!',\n kws['volume_id'], instance_id\n )\n return False\n\n return data\n\n\ndef attach_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Attach a volume to an instance\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The attach_volume action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n if 'device' not in kwargs:\n log.error('A device is required (ex. /dev/sdb1).')\n return False\n\n params = {'Action': 'AttachVolume',\n 'VolumeId': kwargs['volume_id'],\n 'InstanceId': instance_id,\n 'Device': kwargs['device']}\n\n log.debug(params)\n\n vm_ = get_configured_provider()\n\n data = salt.utils.cloud.wait_for_ip(\n __attach_vol_to_instance,\n update_args=(params, kwargs, instance_id),\n timeout=config.get_cloud_config_value(\n 'wait_for_ip_timeout', vm_, __opts__, default=10 * 60),\n interval=config.get_cloud_config_value(\n 'wait_for_ip_interval', vm_, __opts__, default=10),\n interval_multiplier=config.get_cloud_config_value(\n 'wait_for_ip_interval_multiplier', vm_, __opts__, default=1),\n )\n\n return data\n\n\ndef show_volume(kwargs=None, call=None):\n '''\n Wrapper around describe_volumes.\n Here just to keep functionality.\n Might be depreciated later.\n '''\n if not kwargs:\n kwargs = {}\n\n return describe_volumes(kwargs, call)\n\n\ndef detach_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Detach a volume from an instance\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The detach_volume action must be called with -a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n params = {'Action': 'DetachVolume',\n 'VolumeId': kwargs['volume_id']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef delete_volume(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Delete a volume\n '''\n if not kwargs:\n kwargs = {}\n\n if 'volume_id' not in kwargs:\n log.error('A volume_id is required.')\n return False\n\n params = {'Action': 'DeleteVolume',\n 'VolumeId': kwargs['volume_id']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef volume_list(**kwargs):\n '''\n Wrapper around describe_volumes.\n Here just to ensure the compatibility with the cloud module.\n '''\n return describe_volumes(kwargs, 'function')\n\n\ndef describe_volumes(kwargs=None, call=None):\n '''\n Describe a volume (or volumes)\n\n volume_id\n One or more volume IDs. Multiple IDs must be separated by \",\".\n\n TODO: Add all of the filters.\n '''\n if call != 'function':\n log.error(\n 'The describe_volumes function must be called with -f '\n 'or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n params = {'Action': 'DescribeVolumes'}\n\n if 'volume_id' in kwargs:\n volume_id = kwargs['volume_id'].split(',')\n for volume_index, volume_id in enumerate(volume_id):\n params['VolumeId.{0}'.format(volume_index)] = volume_id\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef create_keypair(kwargs=None, call=None):\n '''\n Create an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The create_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'CreateKeyPair',\n 'KeyName': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n keys = [x for x in data[0] if 'requestId' not in x]\n\n return (keys, data[1])\n\n\ndef import_keypair(kwargs=None, call=None):\n '''\n Import an SSH public key.\n\n .. versionadded:: 2015.8.3\n '''\n if call != 'function':\n log.error(\n 'The import_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n if 'file' not in kwargs:\n log.error('A public key file is required.')\n return False\n\n params = {'Action': 'ImportKeyPair',\n 'KeyName': kwargs['keyname']}\n\n public_key_file = kwargs['file']\n\n if os.path.exists(public_key_file):\n with salt.utils.files.fopen(public_key_file, 'r') as fh_:\n public_key = salt.utils.stringutils.to_unicode(fh_.read())\n\n if public_key is not None:\n params['PublicKeyMaterial'] = base64.b64encode(public_key)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef show_keypair(kwargs=None, call=None):\n '''\n Show the details of an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The show_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'DescribeKeyPairs',\n 'KeyName.1': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef delete_keypair(kwargs=None, call=None):\n '''\n Delete an SSH keypair\n '''\n if call != 'function':\n log.error(\n 'The delete_keypair function must be called with -f or --function.'\n )\n return False\n\n if not kwargs:\n kwargs = {}\n\n if 'keyname' not in kwargs:\n log.error('A keyname is required.')\n return False\n\n params = {'Action': 'DeleteKeyPair',\n 'KeyName': kwargs['keyname']}\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef create_snapshot(kwargs=None, call=None, wait_to_finish=False):\n '''\n Create a snapshot.\n\n volume_id\n The ID of the Volume from which to create a snapshot.\n\n description\n The optional description of the snapshot.\n\n CLI Exampe:\n\n .. code-block:: bash\n\n salt-cloud -f create_snapshot my-ec2-config volume_id=vol-351d8826\n salt-cloud -f create_snapshot my-ec2-config volume_id=vol-351d8826 \\\\\n description=\"My Snapshot Description\"\n '''\n if call != 'function':\n raise SaltCloudSystemExit(\n 'The create_snapshot function must be called with -f '\n 'or --function.'\n )\n\n if kwargs is None:\n kwargs = {}\n\n volume_id = kwargs.get('volume_id', None)\n description = kwargs.get('description', '')\n\n if volume_id is None:\n raise SaltCloudSystemExit(\n 'A volume_id must be specified to create a snapshot.'\n )\n\n params = {'Action': 'CreateSnapshot',\n 'VolumeId': volume_id,\n 'Description': description}\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')[0]\n\n r_data = {}\n for d in data:\n for k, v in six.iteritems(d):\n r_data[k] = v\n\n if 'snapshotId' in r_data:\n snapshot_id = r_data['snapshotId']\n\n # Waits till volume is available\n if wait_to_finish:\n salt.utils.cloud.run_func_until_ret_arg(fun=describe_snapshots,\n kwargs={'snapshot_id': snapshot_id},\n fun_call=call,\n argument_being_watched='status',\n required_argument_response='completed')\n\n return r_data\n\n\ndef delete_snapshot(kwargs=None, call=None):\n '''\n Delete a snapshot\n '''\n if call != 'function':\n log.error(\n 'The delete_snapshot function must be called with -f '\n 'or --function.'\n )\n return False\n\n if 'snapshot_id' not in kwargs:\n log.error('A snapshot_id must be specified to delete a snapshot.')\n return False\n\n params = {'Action': 'DeleteSnapshot'}\n\n if 'snapshot_id' in kwargs:\n params['SnapshotId'] = kwargs['snapshot_id']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef copy_snapshot(kwargs=None, call=None):\n '''\n Copy a snapshot\n '''\n if call != 'function':\n log.error(\n 'The copy_snapshot function must be called with -f or --function.'\n )\n return False\n\n if 'source_region' not in kwargs:\n log.error('A source_region must be specified to copy a snapshot.')\n return False\n\n if 'source_snapshot_id' not in kwargs:\n log.error('A source_snapshot_id must be specified to copy a snapshot.')\n return False\n\n if 'description' not in kwargs:\n kwargs['description'] = ''\n\n params = {'Action': 'CopySnapshot'}\n\n if 'source_region' in kwargs:\n params['SourceRegion'] = kwargs['source_region']\n\n if 'source_snapshot_id' in kwargs:\n params['SourceSnapshotId'] = kwargs['source_snapshot_id']\n\n if 'description' in kwargs:\n params['Description'] = kwargs['description']\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef describe_snapshots(kwargs=None, call=None):\n '''\n Describe a snapshot (or snapshots)\n\n snapshot_id\n One or more snapshot IDs. Multiple IDs must be separated by \",\".\n\n owner\n Return the snapshots owned by the specified owner. Valid values\n include: self, amazon, <AWS Account ID>. Multiple values must be\n separated by \",\".\n\n restorable_by\n One or more AWS accounts IDs that can create volumes from the snapshot.\n Multiple aws account IDs must be separated by \",\".\n\n TODO: Add all of the filters.\n '''\n if call != 'function':\n log.error(\n 'The describe_snapshot function must be called with -f '\n 'or --function.'\n )\n return False\n\n params = {'Action': 'DescribeSnapshots'}\n\n # The AWS correct way is to use non-plurals like snapshot_id INSTEAD of snapshot_ids.\n if 'snapshot_ids' in kwargs:\n kwargs['snapshot_id'] = kwargs['snapshot_ids']\n\n if 'snapshot_id' in kwargs:\n snapshot_ids = kwargs['snapshot_id'].split(',')\n for snapshot_index, snapshot_id in enumerate(snapshot_ids):\n params['SnapshotId.{0}'.format(snapshot_index)] = snapshot_id\n\n if 'owner' in kwargs:\n owners = kwargs['owner'].split(',')\n for owner_index, owner in enumerate(owners):\n params['Owner.{0}'.format(owner_index)] = owner\n\n if 'restorable_by' in kwargs:\n restorable_bys = kwargs['restorable_by'].split(',')\n for restorable_by_index, restorable_by in enumerate(restorable_bys):\n params[\n 'RestorableBy.{0}'.format(restorable_by_index)\n ] = restorable_by\n\n log.debug(params)\n\n data = aws.query(params,\n return_url=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n return data\n\n\ndef get_console_output(\n name=None,\n location=None,\n instance_id=None,\n call=None,\n kwargs=None,\n ):\n '''\n Show the console output from the instance.\n\n By default, returns decoded data, not the Base64-encoded data that is\n actually returned from the EC2 API.\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The get_console_output action must be called with '\n '-a or --action.'\n )\n\n if location is None:\n location = get_location()\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if kwargs is None:\n kwargs = {}\n\n if instance_id is None:\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n params = {'Action': 'GetConsoleOutput',\n 'InstanceId': instance_id}\n\n ret = {}\n data = aws.query(params,\n return_root=True,\n location=location,\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for item in data:\n if next(six.iterkeys(item)) == 'output':\n ret['output_decoded'] = binascii.a2b_base64(next(six.itervalues(item)))\n else:\n ret[next(six.iterkeys(item))] = next(six.itervalues(item))\n\n return ret\n\n\ndef get_password_data(\n name=None,\n kwargs=None,\n instance_id=None,\n call=None,\n ):\n '''\n Return password data for a Windows instance.\n\n By default only the encrypted password data will be returned. However, if a\n key_file is passed in, then a decrypted password will also be returned.\n\n Note that the key_file references the private key that was used to generate\n the keypair associated with this instance. This private key will _not_ be\n transmitted to Amazon; it is only used internally inside of Salt Cloud to\n decrypt data _after_ it has been received from Amazon.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a get_password_data mymachine\n salt-cloud -a get_password_data mymachine key_file=/root/ec2key.pem\n\n Note: PKCS1_v1_5 was added in PyCrypto 2.5\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The get_password_data action must be called with '\n '-a or --action.'\n )\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if kwargs is None:\n kwargs = {}\n\n if instance_id is None:\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n del kwargs['instance_id']\n\n params = {'Action': 'GetPasswordData',\n 'InstanceId': instance_id}\n\n ret = {}\n data = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n opts=__opts__,\n sigver='4')\n\n for item in data:\n ret[next(six.iterkeys(item))] = next(six.itervalues(item))\n\n if not HAS_M2 and not HAS_PYCRYPTO:\n return ret\n\n if 'key' not in kwargs:\n if 'key_file' in kwargs:\n with salt.utils.files.fopen(kwargs['key_file'], 'r') as kf_:\n kwargs['key'] = salt.utils.stringutils.to_unicode(kf_.read())\n\n if 'key' in kwargs:\n pwdata = ret.get('passwordData', None)\n if pwdata is not None:\n rsa_key = kwargs['key']\n pwdata = base64.b64decode(pwdata)\n if HAS_M2:\n key = RSA.load_key_string(rsa_key.encode('ascii'))\n password = key.private_decrypt(pwdata, RSA.pkcs1_padding)\n else:\n dsize = Crypto.Hash.SHA.digest_size\n sentinel = Crypto.Random.new().read(15 + dsize)\n key_obj = Crypto.PublicKey.RSA.importKey(rsa_key)\n key_obj = PKCS1_v1_5.new(key_obj)\n password = key_obj.decrypt(pwdata, sentinel)\n ret['password'] = salt.utils.stringutils.to_unicode(password)\n\n return ret\n\n\ndef update_pricing(kwargs=None, call=None):\n '''\n Download most recent pricing information from AWS and convert to a local\n JSON file.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f update_pricing my-ec2-config\n salt-cloud -f update_pricing my-ec2-config type=linux\n\n .. versionadded:: 2015.8.0\n '''\n sources = {\n 'linux': 'https://a0.awsstatic.com/pricing/1/ec2/linux-od.min.js',\n 'rhel': 'https://a0.awsstatic.com/pricing/1/ec2/rhel-od.min.js',\n 'sles': 'https://a0.awsstatic.com/pricing/1/ec2/sles-od.min.js',\n 'mswin': 'https://a0.awsstatic.com/pricing/1/ec2/mswin-od.min.js',\n 'mswinsql': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQL-od.min.js',\n 'mswinsqlweb': 'https://a0.awsstatic.com/pricing/1/ec2/mswinSQLWeb-od.min.js',\n }\n\n if kwargs is None:\n kwargs = {}\n\n if 'type' not in kwargs:\n for source in sources:\n _parse_pricing(sources[source], source)\n else:\n _parse_pricing(sources[kwargs['type']], kwargs['type'])\n\n\ndef _parse_pricing(url, name):\n '''\n Download and parse an individual pricing file from AWS\n\n .. versionadded:: 2015.8.0\n '''\n price_js = http.query(url, text=True)\n\n items = []\n current_item = ''\n\n price_js = re.sub(JS_COMMENT_RE, '', price_js['text'])\n price_js = price_js.strip().rstrip(');').lstrip('callback(')\n for keyword in (\n 'vers',\n 'config',\n 'rate',\n 'valueColumns',\n 'currencies',\n 'instanceTypes',\n 'type',\n 'ECU',\n 'storageGB',\n 'name',\n 'vCPU',\n 'memoryGiB',\n 'storageGiB',\n 'USD',\n ):\n price_js = price_js.replace(keyword, '\"{0}\"'.format(keyword))\n\n for keyword in ('region', 'price', 'size'):\n price_js = price_js.replace(keyword, '\"{0}\"'.format(keyword))\n price_js = price_js.replace('\"{0}\"s'.format(keyword), '\"{0}s\"'.format(keyword))\n\n price_js = price_js.replace('\"\"', '\"')\n\n # Turn the data into something that's easier/faster to process\n regions = {}\n price_json = salt.utils.json.loads(price_js)\n for region in price_json['config']['regions']:\n sizes = {}\n for itype in region['instanceTypes']:\n for size in itype['sizes']:\n sizes[size['size']] = size\n regions[region['region']] = sizes\n\n outfile = os.path.join(\n __opts__['cachedir'], 'ec2-pricing-{0}.p'.format(name)\n )\n with salt.utils.files.fopen(outfile, 'w') as fho:\n salt.utils.msgpack.dump(regions, fho)\n\n return True\n\n\ndef show_pricing(kwargs=None, call=None):\n '''\n Show pricing for a particular profile. This is only an estimate, based on\n unofficial pricing sources.\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -f show_pricing my-ec2-config profile=my-profile\n\n If pricing sources have not been cached, they will be downloaded. Once they\n have been cached, they will not be updated automatically. To manually update\n all prices, use the following command:\n\n .. code-block:: bash\n\n salt-cloud -f update_pricing <provider>\n\n .. versionadded:: 2015.8.0\n '''\n profile = __opts__['profiles'].get(kwargs['profile'], {})\n if not profile:\n return {'Error': 'The requested profile was not found'}\n\n # Make sure the profile belongs to ec2\n provider = profile.get('provider', '0:0')\n comps = provider.split(':')\n if len(comps) < 2 or comps[1] != 'ec2':\n return {'Error': 'The requested profile does not belong to EC2'}\n\n image_id = profile.get('image', None)\n image_dict = show_image({'image': image_id}, 'function')\n image_info = image_dict[0]\n\n # Find out what platform it is\n if image_info.get('imageOwnerAlias', '') == 'amazon':\n if image_info.get('platform', '') == 'windows':\n image_description = image_info.get('description', '')\n if 'sql' in image_description.lower():\n if 'web' in image_description.lower():\n name = 'mswinsqlweb'\n else:\n name = 'mswinsql'\n else:\n name = 'mswin'\n elif image_info.get('imageLocation', '').strip().startswith('amazon/suse'):\n name = 'sles'\n else:\n name = 'linux'\n elif image_info.get('imageOwnerId', '') == '309956199498':\n name = 'rhel'\n else:\n name = 'linux'\n\n pricefile = os.path.join(\n __opts__['cachedir'], 'ec2-pricing-{0}.p'.format(name)\n )\n\n if not os.path.isfile(pricefile):\n update_pricing({'type': name}, 'function')\n\n with salt.utils.files.fopen(pricefile, 'r') as fhi:\n ec2_price = salt.utils.stringutils.to_unicode(\n salt.utils.msgpack.load(fhi))\n\n region = get_location(profile)\n size = profile.get('size', None)\n if size is None:\n return {'Error': 'The requested profile does not contain a size'}\n\n try:\n raw = ec2_price[region][size]\n except KeyError:\n return {'Error': 'The size ({0}) in the requested profile does not have '\n 'a price associated with it for the {1} region'.format(size, region)}\n\n ret = {}\n if kwargs.get('raw', False):\n ret['_raw'] = raw\n\n ret['per_hour'] = 0\n for col in raw.get('valueColumns', []):\n ret['per_hour'] += decimal.Decimal(col['prices'].get('USD', 0))\n\n ret['per_hour'] = decimal.Decimal(ret['per_hour'])\n ret['per_day'] = ret['per_hour'] * 24\n ret['per_week'] = ret['per_day'] * 7\n ret['per_month'] = ret['per_day'] * 30\n ret['per_year'] = ret['per_week'] * 52\n\n return {profile['profile']: ret}\n\n\n\ndef ssm_describe_association(name=None, kwargs=None, instance_id=None, call=None):\n '''\n Describes the associations for the specified SSM document or instance.\n\n http://docs.aws.amazon.com/ssm/latest/APIReference/API_DescribeAssociation.html\n\n CLI Examples:\n\n .. code-block:: bash\n\n salt-cloud -a ssm_describe_association ec2-instance-name ssm_document=ssm-document-name\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The ssm_describe_association action must be called with '\n '-a or --action.'\n )\n\n if not kwargs:\n kwargs = {}\n\n if 'instance_id' in kwargs:\n instance_id = kwargs['instance_id']\n\n if name and not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if not name and not instance_id:\n log.error('Either a name or an instance_id is required.')\n return False\n\n if 'ssm_document' not in kwargs:\n log.error('A ssm_document is required.')\n return False\n\n params = {'Action': 'DescribeAssociation',\n 'InstanceId': instance_id,\n 'Name': kwargs['ssm_document']}\n\n result = aws.query(params,\n return_root=True,\n location=get_location(),\n provider=get_provider(),\n product='ssm',\n opts=__opts__,\n sigver='4')\n log.info(result)\n return result\n"}}},{"rowIdx":359,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/vagrant.py"},"func_name":{"kind":"string","value":"_build_machine_uri"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)"},"func_documentation_string":{"kind":"string","value":"returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L70-L79"},"called_functions":{"kind":"list like","value":["def _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n"],"string":"[\n \"def _build_sdb_uri(key):\\n '''\\n returns string used to fetch data for \\\"key\\\" from the sdb store.\\n\\n Salt node id's are used as the key for vm_ dicts.\\n\\n '''\\n return '{}{}'.format(VAGRANT_SDB_URL, key)\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nWork with virtual machines managed by Vagrant.\n\n.. versionadded:: 2018.3.0\n\nMapping between a Salt node id and the Vagrant machine name\n(and the path to the Vagrantfile where it is defined)\nis stored in a Salt sdb database on the Vagrant host (minion) machine.\nIn order to use this module, sdb must be configured. An SQLite\ndatabase is the recommended storage method. The URI used for\nthe sdb lookup is \"sdb://vagrant_sdb_data\".\n\nrequirements:\n - the VM host machine must have salt-minion, Vagrant and a vm provider installed.\n - the VM host must have a valid definition for `sdb://vagrant_sdb_data`\n\n Configuration example:\n\n .. code-block:: yaml\n\n # file /etc/salt/minion.d/vagrant_sdb.conf\n vagrant_sdb_data:\n driver: sqlite3\n database: /var/cache/salt/vagrant.sqlite\n table: sdb\n create_table: True\n\n'''\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\nimport os\n\n# Import salt libs\nimport salt.utils.files\nimport salt.utils.path\nimport salt.utils.stringutils\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\nimport salt.ext.six as six\nfrom salt._compat import ipaddress\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'vagrant'\n\nVAGRANT_SDB_URL = 'sdb://vagrant_sdb_data/'\n\n\ndef __virtual__():\n '''\n run Vagrant commands if possible\n '''\n if salt.utils.path.which('vagrant') is None:\n return False, 'The vagrant module could not be loaded: vagrant command not found'\n return __virtualname__\n\n\ndef _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n\n\n\ndef _update_vm_info(name, vm_):\n ''' store the vm_ information keyed by name '''\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\n\n # store machine-to-name mapping, too\n if vm_['machine']:\n __utils__['sdb.sdb_set'](\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\n name,\n __opts__)\n\n\ndef get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n\n\ndef get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n\n\ndef _erase_vm_info(name):\n '''\n erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry.\n '''\n try:\n # delete the machine record\n vm_ = get_vm_info(name)\n if vm_['machine']:\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\n try:\n __utils__['sdb.sdb_delete'](key, __opts__)\n except KeyError:\n # no delete method found -- load a blank value\n __utils__['sdb.sdb_set'](key, None, __opts__)\n except Exception:\n pass\n\n uri = _build_sdb_uri(name)\n try:\n # delete the name record\n __utils__['sdb.sdb_delete'](uri, __opts__)\n except KeyError:\n # no delete method found -- load an empty dictionary\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\n except Exception:\n pass\n\n\ndef _vagrant_ssh_config(vm_):\n '''\n get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff\n '''\n machine = vm_['machine']\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\n cmd = 'vagrant ssh-config {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n ignore_retcode=True)\n ssh_config = {}\n for line in reply.split('\\n'): # build a dictionary of the text reply\n tokens = line.strip().split()\n if len(tokens) == 2: # each two-token line becomes a key:value pair\n ssh_config[tokens[0]] = tokens[1]\n log.debug('ssh_config=%s', repr(ssh_config))\n return ssh_config\n\n\ndef version():\n '''\n Return the version of Vagrant on the minion\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.version\n '''\n cmd = 'vagrant -v'\n return __salt__['cmd.shell'](cmd)\n\n\ndef list_domains():\n '''\n Return a list of the salt_id names of all available Vagrant VMs on\n this host without regard to the path where they are defined.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_domains --log-level=info\n\n The log shows information about all known Vagrant environments\n on this machine. This data is cached and may not be completely\n up-to-date.\n '''\n vms = []\n cmd = 'vagrant global-status'\n reply = __salt__['cmd.shell'](cmd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n try:\n _ = int(tokens[0], 16) # valid id numbers are hexadecimal\n except (ValueError, IndexError):\n continue # skip lines without valid id numbers\n machine = tokens[1]\n cwd = tokens[-1]\n name = get_machine_id(machine, cwd)\n if name:\n vms.append(name)\n return vms\n\n\ndef list_active_vms(cwd=None):\n '''\n Return a list of machine names for active virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_active_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1:\n if tokens[1] == 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef list_inactive_vms(cwd=None):\n '''\n Return a list of machine names for inactive virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' virt.list_inactive_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n if tokens[1] != 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef vm_state(name='', cwd=None):\n '''\n Return list of information for all the vms indicating their state.\n\n If you pass a VM name in as an argument then it will return info\n for just the named VM, otherwise it will return all VMs defined by\n the Vagrantfile in the `cwd` directory.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.vm_state <name> cwd=/projects/project_1\n\n returns a list of dictionaries with machine name, state, provider,\n and salt_id name.\n\n .. code-block:: python\n\n datum = {'machine': _, # Vagrant machine name,\n 'state': _, # string indicating machine state, like 'running'\n 'provider': _, # the Vagrant VM provider\n 'name': _} # salt_id name\n\n Known bug: if there are multiple machines in your Vagrantfile, and you request\n the status of the ``primary`` machine, which you defined by leaving the ``machine``\n parameter blank, then you may receive the status of all of them.\n Please specify the actual machine name for each VM if there are more than one.\n\n '''\n\n if name:\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n cwd = vm_['cwd'] or cwd # usually ignore passed-in cwd\n else:\n if not cwd:\n raise SaltInvocationError(\n 'Path to Vagranfile must be defined, but cwd={}'.format(cwd))\n machine = ''\n\n info = []\n cmd = 'vagrant status {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd, cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n try:\n datum = {'machine': tokens[0],\n 'state': ' '.join(tokens[1:-1]),\n 'provider': tokens[-1].lstrip('(').rstrip(')'),\n 'name': get_machine_id(tokens[0], cwd)\n }\n info.append(datum)\n except IndexError:\n pass\n return info\n\n\ndef init(name, # Salt_id for created VM\n cwd=None, # path to find Vagrantfile\n machine='', # name of machine in Vagrantfile\n runas=None, # username who owns Vagrant box\n start=False, # start the machine when initialized\n vagrant_provider='', # vagrant provider (default=virtualbox)\n vm=None, # a dictionary of VM configuration settings\n ):\n '''\n Initialize a new Vagrant VM.\n\n This inputs all the information needed to start a Vagrant VM. These settings are stored in\n a Salt sdb database on the Vagrant host minion and used to start, control, and query the\n guest VMs. The salt_id assigned here is the key field for that database and must be unique.\n\n :param name: The salt_id name you will use to control this VM\n :param cwd: The path to the directory where the Vagrantfile is located\n :param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.\n :param runas: The username on the host who owns the Vagrant work files.\n :param start: (default: False) Start the virtual machine now.\n :param vagrant_provider: The name of a Vagrant VM provider (if not the default).\n :param vm: Optionally, all the above information may be supplied in this dictionary.\n :return: A string indicating success, or False.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.init <salt_id> /path/to/Vagrantfile\n salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1\n '''\n vm_ = {} if vm is None else vm.copy() # passed configuration data\n vm_['name'] = name\n # passed-in keyword arguments overwrite vm dictionary values\n vm_['cwd'] = cwd or vm_.get('cwd')\n if not vm_['cwd']:\n raise SaltInvocationError('Path to Vagrantfile must be defined by \"cwd\" argument')\n vm_['machine'] = machine or vm_.get('machine', machine)\n vm_['runas'] = runas or vm_.get('runas', runas)\n vm_['vagrant_provider'] = vagrant_provider or vm_.get('vagrant_provider', '')\n _update_vm_info(name, vm_)\n\n if start:\n log.debug('Starting VM %s', name)\n ret = _start(name, vm_)\n else:\n ret = 'Name {} defined using VM {}'.format(name, vm_['machine'] or '(default)')\n return ret\n\n\ndef start(name):\n '''\n Start (vagrant up) a virtual machine defined by salt_id name.\n The machine must have been previously defined using \"vagrant.init\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.start <salt_id>\n '''\n vm_ = get_vm_info(name)\n return _start(name, vm_)\n\n\ndef _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider', '')\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\n cmd = 'vagrant up {} {}'.format(machine, provider_)\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\n\n if machine == '': # we were called using the default machine\n for line in ret['stdout'].split('\\n'): # find its actual Vagrant name\n if line.startswith('==>'):\n machine = line.split()[1].rstrip(':')\n vm_['machine'] = machine\n _update_vm_info(name, vm_) # and remember the true name\n break\n\n if ret['retcode'] == 0:\n return 'Started \"{}\" using Vagrant machine \"{}\".'.format(name, machine)\n return False\n\n\ndef shutdown(name):\n '''\n Send a soft shutdown (vagrant halt) signal to the named vm.\n\n This does the same thing as vagrant.stop. Other-VM control\n modules use \"stop\" and \"shutdown\" to differentiate between\n hard and soft shutdowns.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.shutdown <salt_id>\n '''\n return stop(name)\n\n\ndef stop(name):\n '''\n Hard shutdown the virtual machine. (vagrant halt)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.stop <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant halt {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef pause(name):\n '''\n Pause (vagrant suspend) the named VM.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.pause <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant suspend {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef reboot(name, provision=False):\n '''\n Reboot a VM. (vagrant reload)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.reboot <salt_id> provision=True\n\n :param name: The salt_id name you will use to control this VM\n :param provision: (False) also re-run the Vagrant provisioning scripts.\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n prov = '--provision' if provision else ''\n\n cmd = 'vagrant reload {} {}'.format(machine, prov)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef destroy(name):\n '''\n Destroy and delete a virtual machine. (vagrant destroy -f)\n\n This also removes the salt_id name defined by vagrant.init.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.destroy <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant destroy -f {}'.format(machine)\n\n ret = __salt__['cmd.run_all'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n output_loglevel='info')\n if ret['retcode'] == 0:\n _erase_vm_info(name)\n return 'Destroyed VM {0}'.format(name)\n return False\n\n\ndef get_ssh_config(name, network_mask='', get_private_key=False):\n r'''\n Retrieve hints of how you might connect to a Vagrant VM.\n\n :param name: the salt_id of the machine\n :param network_mask: a CIDR mask to search for the VM's address\n :param get_private_key: (default: False) return the key used for ssh login\n :return: a dict of ssh login information for the VM\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.get_ssh_config <salt_id>\n salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True\n\n The returned dictionary contains:\n\n - key_filename: the name of the private key file on the VM host computer\n - ssh_username: the username to be used to log in to the VM\n - ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)\n - ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)\n - \\[ip_address:\\] (if `network_mask` is defined. see below)\n - \\[private_key:\\] (if `get_private_key` is True) the private key for ssh_username\n\n About `network_mask`:\n\n Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.\n This redirected port and its IP address are \"ssh_port\" and \"ssh_host\". The ssh_host is\n usually the localhost (127.0.0.1).\n This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM\n unless the VM has another network interface defined. You will usually want a bridged network\n defined by having a `config.vm.network \"public_network\"` statement in your `Vagrantfile`.\n\n The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,\n but you should be able to determine what IP network the address will be chosen from.\n If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.\n The host machine will send an \"ifconfig\" command to the VM (using ssh to `ssh_host`:`ssh_port`)\n and return the IP address of the first interface it can find which matches your mask.\n '''\n vm_ = get_vm_info(name)\n\n ssh_config = _vagrant_ssh_config(vm_)\n\n try:\n ans = {'key_filename': ssh_config['IdentityFile'],\n 'ssh_username': ssh_config['User'],\n 'ssh_host': ssh_config['HostName'],\n 'ssh_port': ssh_config['Port'],\n }\n\n except KeyError:\n raise CommandExecutionError(\n 'Insufficient SSH information to contact VM {}. '\n 'Is it running?'.format(vm_.get('machine', '(default)')))\n\n if network_mask:\n # ask the new VM to report its network address\n command = 'ssh -i {IdentityFile} -p {Port} ' \\\n '-oStrictHostKeyChecking={StrictHostKeyChecking} ' \\\n '-oUserKnownHostsFile={UserKnownHostsFile} ' \\\n '-oControlPath=none ' \\\n '{User}@{HostName} ifconfig'.format(**ssh_config)\n\n log.info(\n 'Trying ssh -p %s %s@%s ifconfig',\n ssh_config['Port'], ssh_config['User'], ssh_config['HostName']\n )\n reply = __salt__['cmd.shell'](command)\n log.info('--->\\n%s', reply)\n target_network_range = ipaddress.ip_network(network_mask, strict=False)\n\n for line in reply.split('\\n'):\n try: # try to find a bridged network address\n # the lines we are looking for appear like:\n # \"inet addr:10.124.31.185 Bcast:10.124.31.255 Mask:255.255.248.0\"\n # or \"inet6 addr: fe80::a00:27ff:fe04:7aac/64 Scope:Link\"\n tokens = line.replace('addr:', '', 1).split() # remove \"addr:\" if it exists, then split\n found_address = None\n if \"inet\" in tokens:\n nxt = tokens.index(\"inet\") + 1\n found_address = ipaddress.ip_address(tokens[nxt])\n elif \"inet6\" in tokens:\n nxt = tokens.index(\"inet6\") + 1\n found_address = ipaddress.ip_address(tokens[nxt].split('/')[0])\n if found_address in target_network_range:\n ans['ip_address'] = six.text_type(found_address)\n break # we have located a good matching address\n except (IndexError, AttributeError, TypeError):\n pass # all syntax and type errors loop here\n # falling out if the loop leaves us remembering the last candidate\n log.info('Network IP address in %s detected as: %s',\n target_network_range, ans.get('ip_address', '(not found)'))\n\n if get_private_key:\n # retrieve the Vagrant private key from the host\n try:\n with salt.utils.files.fopen(ssh_config['IdentityFile']) as pks:\n ans['private_key'] = salt.utils.stringutils.to_unicode(pks.read())\n except (OSError, IOError) as e:\n raise CommandExecutionError(\"Error processing Vagrant private key file: {}\".format(e))\n return ans\n"}}},{"rowIdx":360,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/vagrant.py"},"func_name":{"kind":"string","value":"_update_vm_info"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def _update_vm_info(name, vm_):\n ''' store the vm_ information keyed by name '''\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\n\n # store machine-to-name mapping, too\n if vm_['machine']:\n __utils__['sdb.sdb_set'](\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\n name,\n __opts__)"},"func_documentation_string":{"kind":"string","value":"store the vm_ information keyed by name"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L82-L91"},"called_functions":{"kind":"null"},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nWork with virtual machines managed by Vagrant.\n\n.. versionadded:: 2018.3.0\n\nMapping between a Salt node id and the Vagrant machine name\n(and the path to the Vagrantfile where it is defined)\nis stored in a Salt sdb database on the Vagrant host (minion) machine.\nIn order to use this module, sdb must be configured. An SQLite\ndatabase is the recommended storage method. The URI used for\nthe sdb lookup is \"sdb://vagrant_sdb_data\".\n\nrequirements:\n - the VM host machine must have salt-minion, Vagrant and a vm provider installed.\n - the VM host must have a valid definition for `sdb://vagrant_sdb_data`\n\n Configuration example:\n\n .. code-block:: yaml\n\n # file /etc/salt/minion.d/vagrant_sdb.conf\n vagrant_sdb_data:\n driver: sqlite3\n database: /var/cache/salt/vagrant.sqlite\n table: sdb\n create_table: True\n\n'''\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\nimport os\n\n# Import salt libs\nimport salt.utils.files\nimport salt.utils.path\nimport salt.utils.stringutils\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\nimport salt.ext.six as six\nfrom salt._compat import ipaddress\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'vagrant'\n\nVAGRANT_SDB_URL = 'sdb://vagrant_sdb_data/'\n\n\ndef __virtual__():\n '''\n run Vagrant commands if possible\n '''\n if salt.utils.path.which('vagrant') is None:\n return False, 'The vagrant module could not be loaded: vagrant command not found'\n return __virtualname__\n\n\ndef _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n\n\ndef _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)\n\n\n\ndef get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n\n\ndef get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n\n\ndef _erase_vm_info(name):\n '''\n erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry.\n '''\n try:\n # delete the machine record\n vm_ = get_vm_info(name)\n if vm_['machine']:\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\n try:\n __utils__['sdb.sdb_delete'](key, __opts__)\n except KeyError:\n # no delete method found -- load a blank value\n __utils__['sdb.sdb_set'](key, None, __opts__)\n except Exception:\n pass\n\n uri = _build_sdb_uri(name)\n try:\n # delete the name record\n __utils__['sdb.sdb_delete'](uri, __opts__)\n except KeyError:\n # no delete method found -- load an empty dictionary\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\n except Exception:\n pass\n\n\ndef _vagrant_ssh_config(vm_):\n '''\n get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff\n '''\n machine = vm_['machine']\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\n cmd = 'vagrant ssh-config {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n ignore_retcode=True)\n ssh_config = {}\n for line in reply.split('\\n'): # build a dictionary of the text reply\n tokens = line.strip().split()\n if len(tokens) == 2: # each two-token line becomes a key:value pair\n ssh_config[tokens[0]] = tokens[1]\n log.debug('ssh_config=%s', repr(ssh_config))\n return ssh_config\n\n\ndef version():\n '''\n Return the version of Vagrant on the minion\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.version\n '''\n cmd = 'vagrant -v'\n return __salt__['cmd.shell'](cmd)\n\n\ndef list_domains():\n '''\n Return a list of the salt_id names of all available Vagrant VMs on\n this host without regard to the path where they are defined.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_domains --log-level=info\n\n The log shows information about all known Vagrant environments\n on this machine. This data is cached and may not be completely\n up-to-date.\n '''\n vms = []\n cmd = 'vagrant global-status'\n reply = __salt__['cmd.shell'](cmd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n try:\n _ = int(tokens[0], 16) # valid id numbers are hexadecimal\n except (ValueError, IndexError):\n continue # skip lines without valid id numbers\n machine = tokens[1]\n cwd = tokens[-1]\n name = get_machine_id(machine, cwd)\n if name:\n vms.append(name)\n return vms\n\n\ndef list_active_vms(cwd=None):\n '''\n Return a list of machine names for active virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_active_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1:\n if tokens[1] == 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef list_inactive_vms(cwd=None):\n '''\n Return a list of machine names for inactive virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' virt.list_inactive_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n if tokens[1] != 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef vm_state(name='', cwd=None):\n '''\n Return list of information for all the vms indicating their state.\n\n If you pass a VM name in as an argument then it will return info\n for just the named VM, otherwise it will return all VMs defined by\n the Vagrantfile in the `cwd` directory.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.vm_state <name> cwd=/projects/project_1\n\n returns a list of dictionaries with machine name, state, provider,\n and salt_id name.\n\n .. code-block:: python\n\n datum = {'machine': _, # Vagrant machine name,\n 'state': _, # string indicating machine state, like 'running'\n 'provider': _, # the Vagrant VM provider\n 'name': _} # salt_id name\n\n Known bug: if there are multiple machines in your Vagrantfile, and you request\n the status of the ``primary`` machine, which you defined by leaving the ``machine``\n parameter blank, then you may receive the status of all of them.\n Please specify the actual machine name for each VM if there are more than one.\n\n '''\n\n if name:\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n cwd = vm_['cwd'] or cwd # usually ignore passed-in cwd\n else:\n if not cwd:\n raise SaltInvocationError(\n 'Path to Vagranfile must be defined, but cwd={}'.format(cwd))\n machine = ''\n\n info = []\n cmd = 'vagrant status {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd, cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n try:\n datum = {'machine': tokens[0],\n 'state': ' '.join(tokens[1:-1]),\n 'provider': tokens[-1].lstrip('(').rstrip(')'),\n 'name': get_machine_id(tokens[0], cwd)\n }\n info.append(datum)\n except IndexError:\n pass\n return info\n\n\ndef init(name, # Salt_id for created VM\n cwd=None, # path to find Vagrantfile\n machine='', # name of machine in Vagrantfile\n runas=None, # username who owns Vagrant box\n start=False, # start the machine when initialized\n vagrant_provider='', # vagrant provider (default=virtualbox)\n vm=None, # a dictionary of VM configuration settings\n ):\n '''\n Initialize a new Vagrant VM.\n\n This inputs all the information needed to start a Vagrant VM. These settings are stored in\n a Salt sdb database on the Vagrant host minion and used to start, control, and query the\n guest VMs. The salt_id assigned here is the key field for that database and must be unique.\n\n :param name: The salt_id name you will use to control this VM\n :param cwd: The path to the directory where the Vagrantfile is located\n :param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.\n :param runas: The username on the host who owns the Vagrant work files.\n :param start: (default: False) Start the virtual machine now.\n :param vagrant_provider: The name of a Vagrant VM provider (if not the default).\n :param vm: Optionally, all the above information may be supplied in this dictionary.\n :return: A string indicating success, or False.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.init <salt_id> /path/to/Vagrantfile\n salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1\n '''\n vm_ = {} if vm is None else vm.copy() # passed configuration data\n vm_['name'] = name\n # passed-in keyword arguments overwrite vm dictionary values\n vm_['cwd'] = cwd or vm_.get('cwd')\n if not vm_['cwd']:\n raise SaltInvocationError('Path to Vagrantfile must be defined by \"cwd\" argument')\n vm_['machine'] = machine or vm_.get('machine', machine)\n vm_['runas'] = runas or vm_.get('runas', runas)\n vm_['vagrant_provider'] = vagrant_provider or vm_.get('vagrant_provider', '')\n _update_vm_info(name, vm_)\n\n if start:\n log.debug('Starting VM %s', name)\n ret = _start(name, vm_)\n else:\n ret = 'Name {} defined using VM {}'.format(name, vm_['machine'] or '(default)')\n return ret\n\n\ndef start(name):\n '''\n Start (vagrant up) a virtual machine defined by salt_id name.\n The machine must have been previously defined using \"vagrant.init\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.start <salt_id>\n '''\n vm_ = get_vm_info(name)\n return _start(name, vm_)\n\n\ndef _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider', '')\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\n cmd = 'vagrant up {} {}'.format(machine, provider_)\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\n\n if machine == '': # we were called using the default machine\n for line in ret['stdout'].split('\\n'): # find its actual Vagrant name\n if line.startswith('==>'):\n machine = line.split()[1].rstrip(':')\n vm_['machine'] = machine\n _update_vm_info(name, vm_) # and remember the true name\n break\n\n if ret['retcode'] == 0:\n return 'Started \"{}\" using Vagrant machine \"{}\".'.format(name, machine)\n return False\n\n\ndef shutdown(name):\n '''\n Send a soft shutdown (vagrant halt) signal to the named vm.\n\n This does the same thing as vagrant.stop. Other-VM control\n modules use \"stop\" and \"shutdown\" to differentiate between\n hard and soft shutdowns.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.shutdown <salt_id>\n '''\n return stop(name)\n\n\ndef stop(name):\n '''\n Hard shutdown the virtual machine. (vagrant halt)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.stop <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant halt {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef pause(name):\n '''\n Pause (vagrant suspend) the named VM.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.pause <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant suspend {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef reboot(name, provision=False):\n '''\n Reboot a VM. (vagrant reload)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.reboot <salt_id> provision=True\n\n :param name: The salt_id name you will use to control this VM\n :param provision: (False) also re-run the Vagrant provisioning scripts.\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n prov = '--provision' if provision else ''\n\n cmd = 'vagrant reload {} {}'.format(machine, prov)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef destroy(name):\n '''\n Destroy and delete a virtual machine. (vagrant destroy -f)\n\n This also removes the salt_id name defined by vagrant.init.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.destroy <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant destroy -f {}'.format(machine)\n\n ret = __salt__['cmd.run_all'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n output_loglevel='info')\n if ret['retcode'] == 0:\n _erase_vm_info(name)\n return 'Destroyed VM {0}'.format(name)\n return False\n\n\ndef get_ssh_config(name, network_mask='', get_private_key=False):\n r'''\n Retrieve hints of how you might connect to a Vagrant VM.\n\n :param name: the salt_id of the machine\n :param network_mask: a CIDR mask to search for the VM's address\n :param get_private_key: (default: False) return the key used for ssh login\n :return: a dict of ssh login information for the VM\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.get_ssh_config <salt_id>\n salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True\n\n The returned dictionary contains:\n\n - key_filename: the name of the private key file on the VM host computer\n - ssh_username: the username to be used to log in to the VM\n - ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)\n - ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)\n - \\[ip_address:\\] (if `network_mask` is defined. see below)\n - \\[private_key:\\] (if `get_private_key` is True) the private key for ssh_username\n\n About `network_mask`:\n\n Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.\n This redirected port and its IP address are \"ssh_port\" and \"ssh_host\". The ssh_host is\n usually the localhost (127.0.0.1).\n This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM\n unless the VM has another network interface defined. You will usually want a bridged network\n defined by having a `config.vm.network \"public_network\"` statement in your `Vagrantfile`.\n\n The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,\n but you should be able to determine what IP network the address will be chosen from.\n If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.\n The host machine will send an \"ifconfig\" command to the VM (using ssh to `ssh_host`:`ssh_port`)\n and return the IP address of the first interface it can find which matches your mask.\n '''\n vm_ = get_vm_info(name)\n\n ssh_config = _vagrant_ssh_config(vm_)\n\n try:\n ans = {'key_filename': ssh_config['IdentityFile'],\n 'ssh_username': ssh_config['User'],\n 'ssh_host': ssh_config['HostName'],\n 'ssh_port': ssh_config['Port'],\n }\n\n except KeyError:\n raise CommandExecutionError(\n 'Insufficient SSH information to contact VM {}. '\n 'Is it running?'.format(vm_.get('machine', '(default)')))\n\n if network_mask:\n # ask the new VM to report its network address\n command = 'ssh -i {IdentityFile} -p {Port} ' \\\n '-oStrictHostKeyChecking={StrictHostKeyChecking} ' \\\n '-oUserKnownHostsFile={UserKnownHostsFile} ' \\\n '-oControlPath=none ' \\\n '{User}@{HostName} ifconfig'.format(**ssh_config)\n\n log.info(\n 'Trying ssh -p %s %s@%s ifconfig',\n ssh_config['Port'], ssh_config['User'], ssh_config['HostName']\n )\n reply = __salt__['cmd.shell'](command)\n log.info('--->\\n%s', reply)\n target_network_range = ipaddress.ip_network(network_mask, strict=False)\n\n for line in reply.split('\\n'):\n try: # try to find a bridged network address\n # the lines we are looking for appear like:\n # \"inet addr:10.124.31.185 Bcast:10.124.31.255 Mask:255.255.248.0\"\n # or \"inet6 addr: fe80::a00:27ff:fe04:7aac/64 Scope:Link\"\n tokens = line.replace('addr:', '', 1).split() # remove \"addr:\" if it exists, then split\n found_address = None\n if \"inet\" in tokens:\n nxt = tokens.index(\"inet\") + 1\n found_address = ipaddress.ip_address(tokens[nxt])\n elif \"inet6\" in tokens:\n nxt = tokens.index(\"inet6\") + 1\n found_address = ipaddress.ip_address(tokens[nxt].split('/')[0])\n if found_address in target_network_range:\n ans['ip_address'] = six.text_type(found_address)\n break # we have located a good matching address\n except (IndexError, AttributeError, TypeError):\n pass # all syntax and type errors loop here\n # falling out if the loop leaves us remembering the last candidate\n log.info('Network IP address in %s detected as: %s',\n target_network_range, ans.get('ip_address', '(not found)'))\n\n if get_private_key:\n # retrieve the Vagrant private key from the host\n try:\n with salt.utils.files.fopen(ssh_config['IdentityFile']) as pks:\n ans['private_key'] = salt.utils.stringutils.to_unicode(pks.read())\n except (OSError, IOError) as e:\n raise CommandExecutionError(\"Error processing Vagrant private key file: {}\".format(e))\n return ans\n"}}},{"rowIdx":361,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/vagrant.py"},"func_name":{"kind":"string","value":"get_vm_info"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_"},"func_documentation_string":{"kind":"string","value":"get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L94-L109"},"called_functions":{"kind":"list like","value":["def _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n"],"string":"[\n \"def _build_sdb_uri(key):\\n '''\\n returns string used to fetch data for \\\"key\\\" from the sdb store.\\n\\n Salt node id's are used as the key for vm_ dicts.\\n\\n '''\\n return '{}{}'.format(VAGRANT_SDB_URL, key)\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nWork with virtual machines managed by Vagrant.\n\n.. versionadded:: 2018.3.0\n\nMapping between a Salt node id and the Vagrant machine name\n(and the path to the Vagrantfile where it is defined)\nis stored in a Salt sdb database on the Vagrant host (minion) machine.\nIn order to use this module, sdb must be configured. An SQLite\ndatabase is the recommended storage method. The URI used for\nthe sdb lookup is \"sdb://vagrant_sdb_data\".\n\nrequirements:\n - the VM host machine must have salt-minion, Vagrant and a vm provider installed.\n - the VM host must have a valid definition for `sdb://vagrant_sdb_data`\n\n Configuration example:\n\n .. code-block:: yaml\n\n # file /etc/salt/minion.d/vagrant_sdb.conf\n vagrant_sdb_data:\n driver: sqlite3\n database: /var/cache/salt/vagrant.sqlite\n table: sdb\n create_table: True\n\n'''\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\nimport os\n\n# Import salt libs\nimport salt.utils.files\nimport salt.utils.path\nimport salt.utils.stringutils\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\nimport salt.ext.six as six\nfrom salt._compat import ipaddress\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'vagrant'\n\nVAGRANT_SDB_URL = 'sdb://vagrant_sdb_data/'\n\n\ndef __virtual__():\n '''\n run Vagrant commands if possible\n '''\n if salt.utils.path.which('vagrant') is None:\n return False, 'The vagrant module could not be loaded: vagrant command not found'\n return __virtualname__\n\n\ndef _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n\n\ndef _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)\n\n\ndef _update_vm_info(name, vm_):\n ''' store the vm_ information keyed by name '''\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\n\n # store machine-to-name mapping, too\n if vm_['machine']:\n __utils__['sdb.sdb_set'](\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\n name,\n __opts__)\n\n\n\ndef get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n\n\ndef _erase_vm_info(name):\n '''\n erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry.\n '''\n try:\n # delete the machine record\n vm_ = get_vm_info(name)\n if vm_['machine']:\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\n try:\n __utils__['sdb.sdb_delete'](key, __opts__)\n except KeyError:\n # no delete method found -- load a blank value\n __utils__['sdb.sdb_set'](key, None, __opts__)\n except Exception:\n pass\n\n uri = _build_sdb_uri(name)\n try:\n # delete the name record\n __utils__['sdb.sdb_delete'](uri, __opts__)\n except KeyError:\n # no delete method found -- load an empty dictionary\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\n except Exception:\n pass\n\n\ndef _vagrant_ssh_config(vm_):\n '''\n get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff\n '''\n machine = vm_['machine']\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\n cmd = 'vagrant ssh-config {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n ignore_retcode=True)\n ssh_config = {}\n for line in reply.split('\\n'): # build a dictionary of the text reply\n tokens = line.strip().split()\n if len(tokens) == 2: # each two-token line becomes a key:value pair\n ssh_config[tokens[0]] = tokens[1]\n log.debug('ssh_config=%s', repr(ssh_config))\n return ssh_config\n\n\ndef version():\n '''\n Return the version of Vagrant on the minion\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.version\n '''\n cmd = 'vagrant -v'\n return __salt__['cmd.shell'](cmd)\n\n\ndef list_domains():\n '''\n Return a list of the salt_id names of all available Vagrant VMs on\n this host without regard to the path where they are defined.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_domains --log-level=info\n\n The log shows information about all known Vagrant environments\n on this machine. This data is cached and may not be completely\n up-to-date.\n '''\n vms = []\n cmd = 'vagrant global-status'\n reply = __salt__['cmd.shell'](cmd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n try:\n _ = int(tokens[0], 16) # valid id numbers are hexadecimal\n except (ValueError, IndexError):\n continue # skip lines without valid id numbers\n machine = tokens[1]\n cwd = tokens[-1]\n name = get_machine_id(machine, cwd)\n if name:\n vms.append(name)\n return vms\n\n\ndef list_active_vms(cwd=None):\n '''\n Return a list of machine names for active virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_active_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1:\n if tokens[1] == 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef list_inactive_vms(cwd=None):\n '''\n Return a list of machine names for inactive virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' virt.list_inactive_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n if tokens[1] != 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef vm_state(name='', cwd=None):\n '''\n Return list of information for all the vms indicating their state.\n\n If you pass a VM name in as an argument then it will return info\n for just the named VM, otherwise it will return all VMs defined by\n the Vagrantfile in the `cwd` directory.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.vm_state <name> cwd=/projects/project_1\n\n returns a list of dictionaries with machine name, state, provider,\n and salt_id name.\n\n .. code-block:: python\n\n datum = {'machine': _, # Vagrant machine name,\n 'state': _, # string indicating machine state, like 'running'\n 'provider': _, # the Vagrant VM provider\n 'name': _} # salt_id name\n\n Known bug: if there are multiple machines in your Vagrantfile, and you request\n the status of the ``primary`` machine, which you defined by leaving the ``machine``\n parameter blank, then you may receive the status of all of them.\n Please specify the actual machine name for each VM if there are more than one.\n\n '''\n\n if name:\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n cwd = vm_['cwd'] or cwd # usually ignore passed-in cwd\n else:\n if not cwd:\n raise SaltInvocationError(\n 'Path to Vagranfile must be defined, but cwd={}'.format(cwd))\n machine = ''\n\n info = []\n cmd = 'vagrant status {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd, cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n try:\n datum = {'machine': tokens[0],\n 'state': ' '.join(tokens[1:-1]),\n 'provider': tokens[-1].lstrip('(').rstrip(')'),\n 'name': get_machine_id(tokens[0], cwd)\n }\n info.append(datum)\n except IndexError:\n pass\n return info\n\n\ndef init(name, # Salt_id for created VM\n cwd=None, # path to find Vagrantfile\n machine='', # name of machine in Vagrantfile\n runas=None, # username who owns Vagrant box\n start=False, # start the machine when initialized\n vagrant_provider='', # vagrant provider (default=virtualbox)\n vm=None, # a dictionary of VM configuration settings\n ):\n '''\n Initialize a new Vagrant VM.\n\n This inputs all the information needed to start a Vagrant VM. These settings are stored in\n a Salt sdb database on the Vagrant host minion and used to start, control, and query the\n guest VMs. The salt_id assigned here is the key field for that database and must be unique.\n\n :param name: The salt_id name you will use to control this VM\n :param cwd: The path to the directory where the Vagrantfile is located\n :param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.\n :param runas: The username on the host who owns the Vagrant work files.\n :param start: (default: False) Start the virtual machine now.\n :param vagrant_provider: The name of a Vagrant VM provider (if not the default).\n :param vm: Optionally, all the above information may be supplied in this dictionary.\n :return: A string indicating success, or False.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.init <salt_id> /path/to/Vagrantfile\n salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1\n '''\n vm_ = {} if vm is None else vm.copy() # passed configuration data\n vm_['name'] = name\n # passed-in keyword arguments overwrite vm dictionary values\n vm_['cwd'] = cwd or vm_.get('cwd')\n if not vm_['cwd']:\n raise SaltInvocationError('Path to Vagrantfile must be defined by \"cwd\" argument')\n vm_['machine'] = machine or vm_.get('machine', machine)\n vm_['runas'] = runas or vm_.get('runas', runas)\n vm_['vagrant_provider'] = vagrant_provider or vm_.get('vagrant_provider', '')\n _update_vm_info(name, vm_)\n\n if start:\n log.debug('Starting VM %s', name)\n ret = _start(name, vm_)\n else:\n ret = 'Name {} defined using VM {}'.format(name, vm_['machine'] or '(default)')\n return ret\n\n\ndef start(name):\n '''\n Start (vagrant up) a virtual machine defined by salt_id name.\n The machine must have been previously defined using \"vagrant.init\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.start <salt_id>\n '''\n vm_ = get_vm_info(name)\n return _start(name, vm_)\n\n\ndef _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider', '')\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\n cmd = 'vagrant up {} {}'.format(machine, provider_)\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\n\n if machine == '': # we were called using the default machine\n for line in ret['stdout'].split('\\n'): # find its actual Vagrant name\n if line.startswith('==>'):\n machine = line.split()[1].rstrip(':')\n vm_['machine'] = machine\n _update_vm_info(name, vm_) # and remember the true name\n break\n\n if ret['retcode'] == 0:\n return 'Started \"{}\" using Vagrant machine \"{}\".'.format(name, machine)\n return False\n\n\ndef shutdown(name):\n '''\n Send a soft shutdown (vagrant halt) signal to the named vm.\n\n This does the same thing as vagrant.stop. Other-VM control\n modules use \"stop\" and \"shutdown\" to differentiate between\n hard and soft shutdowns.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.shutdown <salt_id>\n '''\n return stop(name)\n\n\ndef stop(name):\n '''\n Hard shutdown the virtual machine. (vagrant halt)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.stop <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant halt {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef pause(name):\n '''\n Pause (vagrant suspend) the named VM.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.pause <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant suspend {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef reboot(name, provision=False):\n '''\n Reboot a VM. (vagrant reload)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.reboot <salt_id> provision=True\n\n :param name: The salt_id name you will use to control this VM\n :param provision: (False) also re-run the Vagrant provisioning scripts.\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n prov = '--provision' if provision else ''\n\n cmd = 'vagrant reload {} {}'.format(machine, prov)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef destroy(name):\n '''\n Destroy and delete a virtual machine. (vagrant destroy -f)\n\n This also removes the salt_id name defined by vagrant.init.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.destroy <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant destroy -f {}'.format(machine)\n\n ret = __salt__['cmd.run_all'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n output_loglevel='info')\n if ret['retcode'] == 0:\n _erase_vm_info(name)\n return 'Destroyed VM {0}'.format(name)\n return False\n\n\ndef get_ssh_config(name, network_mask='', get_private_key=False):\n r'''\n Retrieve hints of how you might connect to a Vagrant VM.\n\n :param name: the salt_id of the machine\n :param network_mask: a CIDR mask to search for the VM's address\n :param get_private_key: (default: False) return the key used for ssh login\n :return: a dict of ssh login information for the VM\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.get_ssh_config <salt_id>\n salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True\n\n The returned dictionary contains:\n\n - key_filename: the name of the private key file on the VM host computer\n - ssh_username: the username to be used to log in to the VM\n - ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)\n - ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)\n - \\[ip_address:\\] (if `network_mask` is defined. see below)\n - \\[private_key:\\] (if `get_private_key` is True) the private key for ssh_username\n\n About `network_mask`:\n\n Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.\n This redirected port and its IP address are \"ssh_port\" and \"ssh_host\". The ssh_host is\n usually the localhost (127.0.0.1).\n This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM\n unless the VM has another network interface defined. You will usually want a bridged network\n defined by having a `config.vm.network \"public_network\"` statement in your `Vagrantfile`.\n\n The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,\n but you should be able to determine what IP network the address will be chosen from.\n If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.\n The host machine will send an \"ifconfig\" command to the VM (using ssh to `ssh_host`:`ssh_port`)\n and return the IP address of the first interface it can find which matches your mask.\n '''\n vm_ = get_vm_info(name)\n\n ssh_config = _vagrant_ssh_config(vm_)\n\n try:\n ans = {'key_filename': ssh_config['IdentityFile'],\n 'ssh_username': ssh_config['User'],\n 'ssh_host': ssh_config['HostName'],\n 'ssh_port': ssh_config['Port'],\n }\n\n except KeyError:\n raise CommandExecutionError(\n 'Insufficient SSH information to contact VM {}. '\n 'Is it running?'.format(vm_.get('machine', '(default)')))\n\n if network_mask:\n # ask the new VM to report its network address\n command = 'ssh -i {IdentityFile} -p {Port} ' \\\n '-oStrictHostKeyChecking={StrictHostKeyChecking} ' \\\n '-oUserKnownHostsFile={UserKnownHostsFile} ' \\\n '-oControlPath=none ' \\\n '{User}@{HostName} ifconfig'.format(**ssh_config)\n\n log.info(\n 'Trying ssh -p %s %s@%s ifconfig',\n ssh_config['Port'], ssh_config['User'], ssh_config['HostName']\n )\n reply = __salt__['cmd.shell'](command)\n log.info('--->\\n%s', reply)\n target_network_range = ipaddress.ip_network(network_mask, strict=False)\n\n for line in reply.split('\\n'):\n try: # try to find a bridged network address\n # the lines we are looking for appear like:\n # \"inet addr:10.124.31.185 Bcast:10.124.31.255 Mask:255.255.248.0\"\n # or \"inet6 addr: fe80::a00:27ff:fe04:7aac/64 Scope:Link\"\n tokens = line.replace('addr:', '', 1).split() # remove \"addr:\" if it exists, then split\n found_address = None\n if \"inet\" in tokens:\n nxt = tokens.index(\"inet\") + 1\n found_address = ipaddress.ip_address(tokens[nxt])\n elif \"inet6\" in tokens:\n nxt = tokens.index(\"inet6\") + 1\n found_address = ipaddress.ip_address(tokens[nxt].split('/')[0])\n if found_address in target_network_range:\n ans['ip_address'] = six.text_type(found_address)\n break # we have located a good matching address\n except (IndexError, AttributeError, TypeError):\n pass # all syntax and type errors loop here\n # falling out if the loop leaves us remembering the last candidate\n log.info('Network IP address in %s detected as: %s',\n target_network_range, ans.get('ip_address', '(not found)'))\n\n if get_private_key:\n # retrieve the Vagrant private key from the host\n try:\n with salt.utils.files.fopen(ssh_config['IdentityFile']) as pks:\n ans['private_key'] = salt.utils.stringutils.to_unicode(pks.read())\n except (OSError, IOError) as e:\n raise CommandExecutionError(\"Error processing Vagrant private key file: {}\".format(e))\n return ans\n"}}},{"rowIdx":362,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/vagrant.py"},"func_name":{"kind":"string","value":"get_machine_id"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name"},"func_documentation_string":{"kind":"string","value":"returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L112-L121"},"called_functions":{"kind":"list like","value":["def _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)\n"],"string":"[\n \"def _build_machine_uri(machine, cwd):\\n '''\\n returns string used to fetch id names from the sdb store.\\n\\n the cwd and machine name are concatenated with '?' which should\\n never collide with a Salt node id -- which is important since we\\n will be storing both in the same table.\\n '''\\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\\n return _build_sdb_uri(key)\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nWork with virtual machines managed by Vagrant.\n\n.. versionadded:: 2018.3.0\n\nMapping between a Salt node id and the Vagrant machine name\n(and the path to the Vagrantfile where it is defined)\nis stored in a Salt sdb database on the Vagrant host (minion) machine.\nIn order to use this module, sdb must be configured. An SQLite\ndatabase is the recommended storage method. The URI used for\nthe sdb lookup is \"sdb://vagrant_sdb_data\".\n\nrequirements:\n - the VM host machine must have salt-minion, Vagrant and a vm provider installed.\n - the VM host must have a valid definition for `sdb://vagrant_sdb_data`\n\n Configuration example:\n\n .. code-block:: yaml\n\n # file /etc/salt/minion.d/vagrant_sdb.conf\n vagrant_sdb_data:\n driver: sqlite3\n database: /var/cache/salt/vagrant.sqlite\n table: sdb\n create_table: True\n\n'''\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\nimport os\n\n# Import salt libs\nimport salt.utils.files\nimport salt.utils.path\nimport salt.utils.stringutils\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\nimport salt.ext.six as six\nfrom salt._compat import ipaddress\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'vagrant'\n\nVAGRANT_SDB_URL = 'sdb://vagrant_sdb_data/'\n\n\ndef __virtual__():\n '''\n run Vagrant commands if possible\n '''\n if salt.utils.path.which('vagrant') is None:\n return False, 'The vagrant module could not be loaded: vagrant command not found'\n return __virtualname__\n\n\ndef _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n\n\ndef _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)\n\n\ndef _update_vm_info(name, vm_):\n ''' store the vm_ information keyed by name '''\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\n\n # store machine-to-name mapping, too\n if vm_['machine']:\n __utils__['sdb.sdb_set'](\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\n name,\n __opts__)\n\n\ndef get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n\n\n\ndef _erase_vm_info(name):\n '''\n erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry.\n '''\n try:\n # delete the machine record\n vm_ = get_vm_info(name)\n if vm_['machine']:\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\n try:\n __utils__['sdb.sdb_delete'](key, __opts__)\n except KeyError:\n # no delete method found -- load a blank value\n __utils__['sdb.sdb_set'](key, None, __opts__)\n except Exception:\n pass\n\n uri = _build_sdb_uri(name)\n try:\n # delete the name record\n __utils__['sdb.sdb_delete'](uri, __opts__)\n except KeyError:\n # no delete method found -- load an empty dictionary\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\n except Exception:\n pass\n\n\ndef _vagrant_ssh_config(vm_):\n '''\n get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff\n '''\n machine = vm_['machine']\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\n cmd = 'vagrant ssh-config {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n ignore_retcode=True)\n ssh_config = {}\n for line in reply.split('\\n'): # build a dictionary of the text reply\n tokens = line.strip().split()\n if len(tokens) == 2: # each two-token line becomes a key:value pair\n ssh_config[tokens[0]] = tokens[1]\n log.debug('ssh_config=%s', repr(ssh_config))\n return ssh_config\n\n\ndef version():\n '''\n Return the version of Vagrant on the minion\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.version\n '''\n cmd = 'vagrant -v'\n return __salt__['cmd.shell'](cmd)\n\n\ndef list_domains():\n '''\n Return a list of the salt_id names of all available Vagrant VMs on\n this host without regard to the path where they are defined.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_domains --log-level=info\n\n The log shows information about all known Vagrant environments\n on this machine. This data is cached and may not be completely\n up-to-date.\n '''\n vms = []\n cmd = 'vagrant global-status'\n reply = __salt__['cmd.shell'](cmd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n try:\n _ = int(tokens[0], 16) # valid id numbers are hexadecimal\n except (ValueError, IndexError):\n continue # skip lines without valid id numbers\n machine = tokens[1]\n cwd = tokens[-1]\n name = get_machine_id(machine, cwd)\n if name:\n vms.append(name)\n return vms\n\n\ndef list_active_vms(cwd=None):\n '''\n Return a list of machine names for active virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_active_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1:\n if tokens[1] == 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef list_inactive_vms(cwd=None):\n '''\n Return a list of machine names for inactive virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' virt.list_inactive_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n if tokens[1] != 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef vm_state(name='', cwd=None):\n '''\n Return list of information for all the vms indicating their state.\n\n If you pass a VM name in as an argument then it will return info\n for just the named VM, otherwise it will return all VMs defined by\n the Vagrantfile in the `cwd` directory.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.vm_state <name> cwd=/projects/project_1\n\n returns a list of dictionaries with machine name, state, provider,\n and salt_id name.\n\n .. code-block:: python\n\n datum = {'machine': _, # Vagrant machine name,\n 'state': _, # string indicating machine state, like 'running'\n 'provider': _, # the Vagrant VM provider\n 'name': _} # salt_id name\n\n Known bug: if there are multiple machines in your Vagrantfile, and you request\n the status of the ``primary`` machine, which you defined by leaving the ``machine``\n parameter blank, then you may receive the status of all of them.\n Please specify the actual machine name for each VM if there are more than one.\n\n '''\n\n if name:\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n cwd = vm_['cwd'] or cwd # usually ignore passed-in cwd\n else:\n if not cwd:\n raise SaltInvocationError(\n 'Path to Vagranfile must be defined, but cwd={}'.format(cwd))\n machine = ''\n\n info = []\n cmd = 'vagrant status {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd, cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n try:\n datum = {'machine': tokens[0],\n 'state': ' '.join(tokens[1:-1]),\n 'provider': tokens[-1].lstrip('(').rstrip(')'),\n 'name': get_machine_id(tokens[0], cwd)\n }\n info.append(datum)\n except IndexError:\n pass\n return info\n\n\ndef init(name, # Salt_id for created VM\n cwd=None, # path to find Vagrantfile\n machine='', # name of machine in Vagrantfile\n runas=None, # username who owns Vagrant box\n start=False, # start the machine when initialized\n vagrant_provider='', # vagrant provider (default=virtualbox)\n vm=None, # a dictionary of VM configuration settings\n ):\n '''\n Initialize a new Vagrant VM.\n\n This inputs all the information needed to start a Vagrant VM. These settings are stored in\n a Salt sdb database on the Vagrant host minion and used to start, control, and query the\n guest VMs. The salt_id assigned here is the key field for that database and must be unique.\n\n :param name: The salt_id name you will use to control this VM\n :param cwd: The path to the directory where the Vagrantfile is located\n :param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.\n :param runas: The username on the host who owns the Vagrant work files.\n :param start: (default: False) Start the virtual machine now.\n :param vagrant_provider: The name of a Vagrant VM provider (if not the default).\n :param vm: Optionally, all the above information may be supplied in this dictionary.\n :return: A string indicating success, or False.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.init <salt_id> /path/to/Vagrantfile\n salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1\n '''\n vm_ = {} if vm is None else vm.copy() # passed configuration data\n vm_['name'] = name\n # passed-in keyword arguments overwrite vm dictionary values\n vm_['cwd'] = cwd or vm_.get('cwd')\n if not vm_['cwd']:\n raise SaltInvocationError('Path to Vagrantfile must be defined by \"cwd\" argument')\n vm_['machine'] = machine or vm_.get('machine', machine)\n vm_['runas'] = runas or vm_.get('runas', runas)\n vm_['vagrant_provider'] = vagrant_provider or vm_.get('vagrant_provider', '')\n _update_vm_info(name, vm_)\n\n if start:\n log.debug('Starting VM %s', name)\n ret = _start(name, vm_)\n else:\n ret = 'Name {} defined using VM {}'.format(name, vm_['machine'] or '(default)')\n return ret\n\n\ndef start(name):\n '''\n Start (vagrant up) a virtual machine defined by salt_id name.\n The machine must have been previously defined using \"vagrant.init\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.start <salt_id>\n '''\n vm_ = get_vm_info(name)\n return _start(name, vm_)\n\n\ndef _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider', '')\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\n cmd = 'vagrant up {} {}'.format(machine, provider_)\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\n\n if machine == '': # we were called using the default machine\n for line in ret['stdout'].split('\\n'): # find its actual Vagrant name\n if line.startswith('==>'):\n machine = line.split()[1].rstrip(':')\n vm_['machine'] = machine\n _update_vm_info(name, vm_) # and remember the true name\n break\n\n if ret['retcode'] == 0:\n return 'Started \"{}\" using Vagrant machine \"{}\".'.format(name, machine)\n return False\n\n\ndef shutdown(name):\n '''\n Send a soft shutdown (vagrant halt) signal to the named vm.\n\n This does the same thing as vagrant.stop. Other-VM control\n modules use \"stop\" and \"shutdown\" to differentiate between\n hard and soft shutdowns.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.shutdown <salt_id>\n '''\n return stop(name)\n\n\ndef stop(name):\n '''\n Hard shutdown the virtual machine. (vagrant halt)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.stop <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant halt {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef pause(name):\n '''\n Pause (vagrant suspend) the named VM.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.pause <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant suspend {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef reboot(name, provision=False):\n '''\n Reboot a VM. (vagrant reload)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.reboot <salt_id> provision=True\n\n :param name: The salt_id name you will use to control this VM\n :param provision: (False) also re-run the Vagrant provisioning scripts.\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n prov = '--provision' if provision else ''\n\n cmd = 'vagrant reload {} {}'.format(machine, prov)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef destroy(name):\n '''\n Destroy and delete a virtual machine. (vagrant destroy -f)\n\n This also removes the salt_id name defined by vagrant.init.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.destroy <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant destroy -f {}'.format(machine)\n\n ret = __salt__['cmd.run_all'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n output_loglevel='info')\n if ret['retcode'] == 0:\n _erase_vm_info(name)\n return 'Destroyed VM {0}'.format(name)\n return False\n\n\ndef get_ssh_config(name, network_mask='', get_private_key=False):\n r'''\n Retrieve hints of how you might connect to a Vagrant VM.\n\n :param name: the salt_id of the machine\n :param network_mask: a CIDR mask to search for the VM's address\n :param get_private_key: (default: False) return the key used for ssh login\n :return: a dict of ssh login information for the VM\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.get_ssh_config <salt_id>\n salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True\n\n The returned dictionary contains:\n\n - key_filename: the name of the private key file on the VM host computer\n - ssh_username: the username to be used to log in to the VM\n - ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)\n - ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)\n - \\[ip_address:\\] (if `network_mask` is defined. see below)\n - \\[private_key:\\] (if `get_private_key` is True) the private key for ssh_username\n\n About `network_mask`:\n\n Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.\n This redirected port and its IP address are \"ssh_port\" and \"ssh_host\". The ssh_host is\n usually the localhost (127.0.0.1).\n This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM\n unless the VM has another network interface defined. You will usually want a bridged network\n defined by having a `config.vm.network \"public_network\"` statement in your `Vagrantfile`.\n\n The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,\n but you should be able to determine what IP network the address will be chosen from.\n If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.\n The host machine will send an \"ifconfig\" command to the VM (using ssh to `ssh_host`:`ssh_port`)\n and return the IP address of the first interface it can find which matches your mask.\n '''\n vm_ = get_vm_info(name)\n\n ssh_config = _vagrant_ssh_config(vm_)\n\n try:\n ans = {'key_filename': ssh_config['IdentityFile'],\n 'ssh_username': ssh_config['User'],\n 'ssh_host': ssh_config['HostName'],\n 'ssh_port': ssh_config['Port'],\n }\n\n except KeyError:\n raise CommandExecutionError(\n 'Insufficient SSH information to contact VM {}. '\n 'Is it running?'.format(vm_.get('machine', '(default)')))\n\n if network_mask:\n # ask the new VM to report its network address\n command = 'ssh -i {IdentityFile} -p {Port} ' \\\n '-oStrictHostKeyChecking={StrictHostKeyChecking} ' \\\n '-oUserKnownHostsFile={UserKnownHostsFile} ' \\\n '-oControlPath=none ' \\\n '{User}@{HostName} ifconfig'.format(**ssh_config)\n\n log.info(\n 'Trying ssh -p %s %s@%s ifconfig',\n ssh_config['Port'], ssh_config['User'], ssh_config['HostName']\n )\n reply = __salt__['cmd.shell'](command)\n log.info('--->\\n%s', reply)\n target_network_range = ipaddress.ip_network(network_mask, strict=False)\n\n for line in reply.split('\\n'):\n try: # try to find a bridged network address\n # the lines we are looking for appear like:\n # \"inet addr:10.124.31.185 Bcast:10.124.31.255 Mask:255.255.248.0\"\n # or \"inet6 addr: fe80::a00:27ff:fe04:7aac/64 Scope:Link\"\n tokens = line.replace('addr:', '', 1).split() # remove \"addr:\" if it exists, then split\n found_address = None\n if \"inet\" in tokens:\n nxt = tokens.index(\"inet\") + 1\n found_address = ipaddress.ip_address(tokens[nxt])\n elif \"inet6\" in tokens:\n nxt = tokens.index(\"inet6\") + 1\n found_address = ipaddress.ip_address(tokens[nxt].split('/')[0])\n if found_address in target_network_range:\n ans['ip_address'] = six.text_type(found_address)\n break # we have located a good matching address\n except (IndexError, AttributeError, TypeError):\n pass # all syntax and type errors loop here\n # falling out if the loop leaves us remembering the last candidate\n log.info('Network IP address in %s detected as: %s',\n target_network_range, ans.get('ip_address', '(not found)'))\n\n if get_private_key:\n # retrieve the Vagrant private key from the host\n try:\n with salt.utils.files.fopen(ssh_config['IdentityFile']) as pks:\n ans['private_key'] = salt.utils.stringutils.to_unicode(pks.read())\n except (OSError, IOError) as e:\n raise CommandExecutionError(\"Error processing Vagrant private key file: {}\".format(e))\n return ans\n"}}},{"rowIdx":363,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/vagrant.py"},"func_name":{"kind":"string","value":"_erase_vm_info"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def _erase_vm_info(name):\n '''\n erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry.\n '''\n try:\n # delete the machine record\n vm_ = get_vm_info(name)\n if vm_['machine']:\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\n try:\n __utils__['sdb.sdb_delete'](key, __opts__)\n except KeyError:\n # no delete method found -- load a blank value\n __utils__['sdb.sdb_set'](key, None, __opts__)\n except Exception:\n pass\n\n uri = _build_sdb_uri(name)\n try:\n # delete the name record\n __utils__['sdb.sdb_delete'](uri, __opts__)\n except KeyError:\n # no delete method found -- load an empty dictionary\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\n except Exception:\n pass"},"func_documentation_string":{"kind":"string","value":"erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L124-L153"},"called_functions":{"kind":"list like","value":["def get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n","def _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n","def _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)\n"],"string":"[\n \"def get_vm_info(name):\\n '''\\n get the information for a VM.\\n\\n :param name: salt_id name\\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\\n '''\\n try:\\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\\n except KeyError:\\n raise SaltInvocationError(\\n 'Probable sdb driver not found. Check your configuration.')\\n if vm_ is None or 'machine' not in vm_:\\n raise SaltInvocationError(\\n 'No Vagrant machine defined for Salt_id {}'.format(name))\\n return vm_\\n\",\n \"def _build_sdb_uri(key):\\n '''\\n returns string used to fetch data for \\\"key\\\" from the sdb store.\\n\\n Salt node id's are used as the key for vm_ dicts.\\n\\n '''\\n return '{}{}'.format(VAGRANT_SDB_URL, key)\\n\",\n \"def _build_machine_uri(machine, cwd):\\n '''\\n returns string used to fetch id names from the sdb store.\\n\\n the cwd and machine name are concatenated with '?' which should\\n never collide with a Salt node id -- which is important since we\\n will be storing both in the same table.\\n '''\\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\\n return _build_sdb_uri(key)\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nWork with virtual machines managed by Vagrant.\n\n.. versionadded:: 2018.3.0\n\nMapping between a Salt node id and the Vagrant machine name\n(and the path to the Vagrantfile where it is defined)\nis stored in a Salt sdb database on the Vagrant host (minion) machine.\nIn order to use this module, sdb must be configured. An SQLite\ndatabase is the recommended storage method. The URI used for\nthe sdb lookup is \"sdb://vagrant_sdb_data\".\n\nrequirements:\n - the VM host machine must have salt-minion, Vagrant and a vm provider installed.\n - the VM host must have a valid definition for `sdb://vagrant_sdb_data`\n\n Configuration example:\n\n .. code-block:: yaml\n\n # file /etc/salt/minion.d/vagrant_sdb.conf\n vagrant_sdb_data:\n driver: sqlite3\n database: /var/cache/salt/vagrant.sqlite\n table: sdb\n create_table: True\n\n'''\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\nimport os\n\n# Import salt libs\nimport salt.utils.files\nimport salt.utils.path\nimport salt.utils.stringutils\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\nimport salt.ext.six as six\nfrom salt._compat import ipaddress\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'vagrant'\n\nVAGRANT_SDB_URL = 'sdb://vagrant_sdb_data/'\n\n\ndef __virtual__():\n '''\n run Vagrant commands if possible\n '''\n if salt.utils.path.which('vagrant') is None:\n return False, 'The vagrant module could not be loaded: vagrant command not found'\n return __virtualname__\n\n\ndef _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n\n\ndef _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)\n\n\ndef _update_vm_info(name, vm_):\n ''' store the vm_ information keyed by name '''\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\n\n # store machine-to-name mapping, too\n if vm_['machine']:\n __utils__['sdb.sdb_set'](\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\n name,\n __opts__)\n\n\ndef get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n\n\ndef get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n\n\n\ndef _vagrant_ssh_config(vm_):\n '''\n get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff\n '''\n machine = vm_['machine']\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\n cmd = 'vagrant ssh-config {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n ignore_retcode=True)\n ssh_config = {}\n for line in reply.split('\\n'): # build a dictionary of the text reply\n tokens = line.strip().split()\n if len(tokens) == 2: # each two-token line becomes a key:value pair\n ssh_config[tokens[0]] = tokens[1]\n log.debug('ssh_config=%s', repr(ssh_config))\n return ssh_config\n\n\ndef version():\n '''\n Return the version of Vagrant on the minion\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.version\n '''\n cmd = 'vagrant -v'\n return __salt__['cmd.shell'](cmd)\n\n\ndef list_domains():\n '''\n Return a list of the salt_id names of all available Vagrant VMs on\n this host without regard to the path where they are defined.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_domains --log-level=info\n\n The log shows information about all known Vagrant environments\n on this machine. This data is cached and may not be completely\n up-to-date.\n '''\n vms = []\n cmd = 'vagrant global-status'\n reply = __salt__['cmd.shell'](cmd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n try:\n _ = int(tokens[0], 16) # valid id numbers are hexadecimal\n except (ValueError, IndexError):\n continue # skip lines without valid id numbers\n machine = tokens[1]\n cwd = tokens[-1]\n name = get_machine_id(machine, cwd)\n if name:\n vms.append(name)\n return vms\n\n\ndef list_active_vms(cwd=None):\n '''\n Return a list of machine names for active virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_active_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1:\n if tokens[1] == 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef list_inactive_vms(cwd=None):\n '''\n Return a list of machine names for inactive virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' virt.list_inactive_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n if tokens[1] != 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef vm_state(name='', cwd=None):\n '''\n Return list of information for all the vms indicating their state.\n\n If you pass a VM name in as an argument then it will return info\n for just the named VM, otherwise it will return all VMs defined by\n the Vagrantfile in the `cwd` directory.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.vm_state <name> cwd=/projects/project_1\n\n returns a list of dictionaries with machine name, state, provider,\n and salt_id name.\n\n .. code-block:: python\n\n datum = {'machine': _, # Vagrant machine name,\n 'state': _, # string indicating machine state, like 'running'\n 'provider': _, # the Vagrant VM provider\n 'name': _} # salt_id name\n\n Known bug: if there are multiple machines in your Vagrantfile, and you request\n the status of the ``primary`` machine, which you defined by leaving the ``machine``\n parameter blank, then you may receive the status of all of them.\n Please specify the actual machine name for each VM if there are more than one.\n\n '''\n\n if name:\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n cwd = vm_['cwd'] or cwd # usually ignore passed-in cwd\n else:\n if not cwd:\n raise SaltInvocationError(\n 'Path to Vagranfile must be defined, but cwd={}'.format(cwd))\n machine = ''\n\n info = []\n cmd = 'vagrant status {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd, cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n try:\n datum = {'machine': tokens[0],\n 'state': ' '.join(tokens[1:-1]),\n 'provider': tokens[-1].lstrip('(').rstrip(')'),\n 'name': get_machine_id(tokens[0], cwd)\n }\n info.append(datum)\n except IndexError:\n pass\n return info\n\n\ndef init(name, # Salt_id for created VM\n cwd=None, # path to find Vagrantfile\n machine='', # name of machine in Vagrantfile\n runas=None, # username who owns Vagrant box\n start=False, # start the machine when initialized\n vagrant_provider='', # vagrant provider (default=virtualbox)\n vm=None, # a dictionary of VM configuration settings\n ):\n '''\n Initialize a new Vagrant VM.\n\n This inputs all the information needed to start a Vagrant VM. These settings are stored in\n a Salt sdb database on the Vagrant host minion and used to start, control, and query the\n guest VMs. The salt_id assigned here is the key field for that database and must be unique.\n\n :param name: The salt_id name you will use to control this VM\n :param cwd: The path to the directory where the Vagrantfile is located\n :param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.\n :param runas: The username on the host who owns the Vagrant work files.\n :param start: (default: False) Start the virtual machine now.\n :param vagrant_provider: The name of a Vagrant VM provider (if not the default).\n :param vm: Optionally, all the above information may be supplied in this dictionary.\n :return: A string indicating success, or False.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.init <salt_id> /path/to/Vagrantfile\n salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1\n '''\n vm_ = {} if vm is None else vm.copy() # passed configuration data\n vm_['name'] = name\n # passed-in keyword arguments overwrite vm dictionary values\n vm_['cwd'] = cwd or vm_.get('cwd')\n if not vm_['cwd']:\n raise SaltInvocationError('Path to Vagrantfile must be defined by \"cwd\" argument')\n vm_['machine'] = machine or vm_.get('machine', machine)\n vm_['runas'] = runas or vm_.get('runas', runas)\n vm_['vagrant_provider'] = vagrant_provider or vm_.get('vagrant_provider', '')\n _update_vm_info(name, vm_)\n\n if start:\n log.debug('Starting VM %s', name)\n ret = _start(name, vm_)\n else:\n ret = 'Name {} defined using VM {}'.format(name, vm_['machine'] or '(default)')\n return ret\n\n\ndef start(name):\n '''\n Start (vagrant up) a virtual machine defined by salt_id name.\n The machine must have been previously defined using \"vagrant.init\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.start <salt_id>\n '''\n vm_ = get_vm_info(name)\n return _start(name, vm_)\n\n\ndef _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider', '')\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\n cmd = 'vagrant up {} {}'.format(machine, provider_)\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\n\n if machine == '': # we were called using the default machine\n for line in ret['stdout'].split('\\n'): # find its actual Vagrant name\n if line.startswith('==>'):\n machine = line.split()[1].rstrip(':')\n vm_['machine'] = machine\n _update_vm_info(name, vm_) # and remember the true name\n break\n\n if ret['retcode'] == 0:\n return 'Started \"{}\" using Vagrant machine \"{}\".'.format(name, machine)\n return False\n\n\ndef shutdown(name):\n '''\n Send a soft shutdown (vagrant halt) signal to the named vm.\n\n This does the same thing as vagrant.stop. Other-VM control\n modules use \"stop\" and \"shutdown\" to differentiate between\n hard and soft shutdowns.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.shutdown <salt_id>\n '''\n return stop(name)\n\n\ndef stop(name):\n '''\n Hard shutdown the virtual machine. (vagrant halt)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.stop <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant halt {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef pause(name):\n '''\n Pause (vagrant suspend) the named VM.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.pause <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant suspend {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef reboot(name, provision=False):\n '''\n Reboot a VM. (vagrant reload)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.reboot <salt_id> provision=True\n\n :param name: The salt_id name you will use to control this VM\n :param provision: (False) also re-run the Vagrant provisioning scripts.\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n prov = '--provision' if provision else ''\n\n cmd = 'vagrant reload {} {}'.format(machine, prov)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef destroy(name):\n '''\n Destroy and delete a virtual machine. (vagrant destroy -f)\n\n This also removes the salt_id name defined by vagrant.init.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.destroy <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant destroy -f {}'.format(machine)\n\n ret = __salt__['cmd.run_all'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n output_loglevel='info')\n if ret['retcode'] == 0:\n _erase_vm_info(name)\n return 'Destroyed VM {0}'.format(name)\n return False\n\n\ndef get_ssh_config(name, network_mask='', get_private_key=False):\n r'''\n Retrieve hints of how you might connect to a Vagrant VM.\n\n :param name: the salt_id of the machine\n :param network_mask: a CIDR mask to search for the VM's address\n :param get_private_key: (default: False) return the key used for ssh login\n :return: a dict of ssh login information for the VM\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.get_ssh_config <salt_id>\n salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True\n\n The returned dictionary contains:\n\n - key_filename: the name of the private key file on the VM host computer\n - ssh_username: the username to be used to log in to the VM\n - ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)\n - ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)\n - \\[ip_address:\\] (if `network_mask` is defined. see below)\n - \\[private_key:\\] (if `get_private_key` is True) the private key for ssh_username\n\n About `network_mask`:\n\n Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.\n This redirected port and its IP address are \"ssh_port\" and \"ssh_host\". The ssh_host is\n usually the localhost (127.0.0.1).\n This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM\n unless the VM has another network interface defined. You will usually want a bridged network\n defined by having a `config.vm.network \"public_network\"` statement in your `Vagrantfile`.\n\n The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,\n but you should be able to determine what IP network the address will be chosen from.\n If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.\n The host machine will send an \"ifconfig\" command to the VM (using ssh to `ssh_host`:`ssh_port`)\n and return the IP address of the first interface it can find which matches your mask.\n '''\n vm_ = get_vm_info(name)\n\n ssh_config = _vagrant_ssh_config(vm_)\n\n try:\n ans = {'key_filename': ssh_config['IdentityFile'],\n 'ssh_username': ssh_config['User'],\n 'ssh_host': ssh_config['HostName'],\n 'ssh_port': ssh_config['Port'],\n }\n\n except KeyError:\n raise CommandExecutionError(\n 'Insufficient SSH information to contact VM {}. '\n 'Is it running?'.format(vm_.get('machine', '(default)')))\n\n if network_mask:\n # ask the new VM to report its network address\n command = 'ssh -i {IdentityFile} -p {Port} ' \\\n '-oStrictHostKeyChecking={StrictHostKeyChecking} ' \\\n '-oUserKnownHostsFile={UserKnownHostsFile} ' \\\n '-oControlPath=none ' \\\n '{User}@{HostName} ifconfig'.format(**ssh_config)\n\n log.info(\n 'Trying ssh -p %s %s@%s ifconfig',\n ssh_config['Port'], ssh_config['User'], ssh_config['HostName']\n )\n reply = __salt__['cmd.shell'](command)\n log.info('--->\\n%s', reply)\n target_network_range = ipaddress.ip_network(network_mask, strict=False)\n\n for line in reply.split('\\n'):\n try: # try to find a bridged network address\n # the lines we are looking for appear like:\n # \"inet addr:10.124.31.185 Bcast:10.124.31.255 Mask:255.255.248.0\"\n # or \"inet6 addr: fe80::a00:27ff:fe04:7aac/64 Scope:Link\"\n tokens = line.replace('addr:', '', 1).split() # remove \"addr:\" if it exists, then split\n found_address = None\n if \"inet\" in tokens:\n nxt = tokens.index(\"inet\") + 1\n found_address = ipaddress.ip_address(tokens[nxt])\n elif \"inet6\" in tokens:\n nxt = tokens.index(\"inet6\") + 1\n found_address = ipaddress.ip_address(tokens[nxt].split('/')[0])\n if found_address in target_network_range:\n ans['ip_address'] = six.text_type(found_address)\n break # we have located a good matching address\n except (IndexError, AttributeError, TypeError):\n pass # all syntax and type errors loop here\n # falling out if the loop leaves us remembering the last candidate\n log.info('Network IP address in %s detected as: %s',\n target_network_range, ans.get('ip_address', '(not found)'))\n\n if get_private_key:\n # retrieve the Vagrant private key from the host\n try:\n with salt.utils.files.fopen(ssh_config['IdentityFile']) as pks:\n ans['private_key'] = salt.utils.stringutils.to_unicode(pks.read())\n except (OSError, IOError) as e:\n raise CommandExecutionError(\"Error processing Vagrant private key file: {}\".format(e))\n return ans\n"}}},{"rowIdx":364,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/vagrant.py"},"func_name":{"kind":"string","value":"_vagrant_ssh_config"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def _vagrant_ssh_config(vm_):\n '''\n get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff\n '''\n machine = vm_['machine']\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\n cmd = 'vagrant ssh-config {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n ignore_retcode=True)\n ssh_config = {}\n for line in reply.split('\\n'): # build a dictionary of the text reply\n tokens = line.strip().split()\n if len(tokens) == 2: # each two-token line becomes a key:value pair\n ssh_config[tokens[0]] = tokens[1]\n log.debug('ssh_config=%s', repr(ssh_config))\n return ssh_config"},"func_documentation_string":{"kind":"string","value":"get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L156-L176"},"called_functions":{"kind":"null"},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nWork with virtual machines managed by Vagrant.\n\n.. versionadded:: 2018.3.0\n\nMapping between a Salt node id and the Vagrant machine name\n(and the path to the Vagrantfile where it is defined)\nis stored in a Salt sdb database on the Vagrant host (minion) machine.\nIn order to use this module, sdb must be configured. An SQLite\ndatabase is the recommended storage method. The URI used for\nthe sdb lookup is \"sdb://vagrant_sdb_data\".\n\nrequirements:\n - the VM host machine must have salt-minion, Vagrant and a vm provider installed.\n - the VM host must have a valid definition for `sdb://vagrant_sdb_data`\n\n Configuration example:\n\n .. code-block:: yaml\n\n # file /etc/salt/minion.d/vagrant_sdb.conf\n vagrant_sdb_data:\n driver: sqlite3\n database: /var/cache/salt/vagrant.sqlite\n table: sdb\n create_table: True\n\n'''\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\nimport os\n\n# Import salt libs\nimport salt.utils.files\nimport salt.utils.path\nimport salt.utils.stringutils\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\nimport salt.ext.six as six\nfrom salt._compat import ipaddress\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'vagrant'\n\nVAGRANT_SDB_URL = 'sdb://vagrant_sdb_data/'\n\n\ndef __virtual__():\n '''\n run Vagrant commands if possible\n '''\n if salt.utils.path.which('vagrant') is None:\n return False, 'The vagrant module could not be loaded: vagrant command not found'\n return __virtualname__\n\n\ndef _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n\n\ndef _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)\n\n\ndef _update_vm_info(name, vm_):\n ''' store the vm_ information keyed by name '''\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\n\n # store machine-to-name mapping, too\n if vm_['machine']:\n __utils__['sdb.sdb_set'](\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\n name,\n __opts__)\n\n\ndef get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n\n\ndef get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n\n\ndef _erase_vm_info(name):\n '''\n erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry.\n '''\n try:\n # delete the machine record\n vm_ = get_vm_info(name)\n if vm_['machine']:\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\n try:\n __utils__['sdb.sdb_delete'](key, __opts__)\n except KeyError:\n # no delete method found -- load a blank value\n __utils__['sdb.sdb_set'](key, None, __opts__)\n except Exception:\n pass\n\n uri = _build_sdb_uri(name)\n try:\n # delete the name record\n __utils__['sdb.sdb_delete'](uri, __opts__)\n except KeyError:\n # no delete method found -- load an empty dictionary\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\n except Exception:\n pass\n\n\n\ndef version():\n '''\n Return the version of Vagrant on the minion\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.version\n '''\n cmd = 'vagrant -v'\n return __salt__['cmd.shell'](cmd)\n\n\ndef list_domains():\n '''\n Return a list of the salt_id names of all available Vagrant VMs on\n this host without regard to the path where they are defined.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_domains --log-level=info\n\n The log shows information about all known Vagrant environments\n on this machine. This data is cached and may not be completely\n up-to-date.\n '''\n vms = []\n cmd = 'vagrant global-status'\n reply = __salt__['cmd.shell'](cmd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n try:\n _ = int(tokens[0], 16) # valid id numbers are hexadecimal\n except (ValueError, IndexError):\n continue # skip lines without valid id numbers\n machine = tokens[1]\n cwd = tokens[-1]\n name = get_machine_id(machine, cwd)\n if name:\n vms.append(name)\n return vms\n\n\ndef list_active_vms(cwd=None):\n '''\n Return a list of machine names for active virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_active_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1:\n if tokens[1] == 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef list_inactive_vms(cwd=None):\n '''\n Return a list of machine names for inactive virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' virt.list_inactive_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n if tokens[1] != 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef vm_state(name='', cwd=None):\n '''\n Return list of information for all the vms indicating their state.\n\n If you pass a VM name in as an argument then it will return info\n for just the named VM, otherwise it will return all VMs defined by\n the Vagrantfile in the `cwd` directory.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.vm_state <name> cwd=/projects/project_1\n\n returns a list of dictionaries with machine name, state, provider,\n and salt_id name.\n\n .. code-block:: python\n\n datum = {'machine': _, # Vagrant machine name,\n 'state': _, # string indicating machine state, like 'running'\n 'provider': _, # the Vagrant VM provider\n 'name': _} # salt_id name\n\n Known bug: if there are multiple machines in your Vagrantfile, and you request\n the status of the ``primary`` machine, which you defined by leaving the ``machine``\n parameter blank, then you may receive the status of all of them.\n Please specify the actual machine name for each VM if there are more than one.\n\n '''\n\n if name:\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n cwd = vm_['cwd'] or cwd # usually ignore passed-in cwd\n else:\n if not cwd:\n raise SaltInvocationError(\n 'Path to Vagranfile must be defined, but cwd={}'.format(cwd))\n machine = ''\n\n info = []\n cmd = 'vagrant status {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd, cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n try:\n datum = {'machine': tokens[0],\n 'state': ' '.join(tokens[1:-1]),\n 'provider': tokens[-1].lstrip('(').rstrip(')'),\n 'name': get_machine_id(tokens[0], cwd)\n }\n info.append(datum)\n except IndexError:\n pass\n return info\n\n\ndef init(name, # Salt_id for created VM\n cwd=None, # path to find Vagrantfile\n machine='', # name of machine in Vagrantfile\n runas=None, # username who owns Vagrant box\n start=False, # start the machine when initialized\n vagrant_provider='', # vagrant provider (default=virtualbox)\n vm=None, # a dictionary of VM configuration settings\n ):\n '''\n Initialize a new Vagrant VM.\n\n This inputs all the information needed to start a Vagrant VM. These settings are stored in\n a Salt sdb database on the Vagrant host minion and used to start, control, and query the\n guest VMs. The salt_id assigned here is the key field for that database and must be unique.\n\n :param name: The salt_id name you will use to control this VM\n :param cwd: The path to the directory where the Vagrantfile is located\n :param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.\n :param runas: The username on the host who owns the Vagrant work files.\n :param start: (default: False) Start the virtual machine now.\n :param vagrant_provider: The name of a Vagrant VM provider (if not the default).\n :param vm: Optionally, all the above information may be supplied in this dictionary.\n :return: A string indicating success, or False.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.init <salt_id> /path/to/Vagrantfile\n salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1\n '''\n vm_ = {} if vm is None else vm.copy() # passed configuration data\n vm_['name'] = name\n # passed-in keyword arguments overwrite vm dictionary values\n vm_['cwd'] = cwd or vm_.get('cwd')\n if not vm_['cwd']:\n raise SaltInvocationError('Path to Vagrantfile must be defined by \"cwd\" argument')\n vm_['machine'] = machine or vm_.get('machine', machine)\n vm_['runas'] = runas or vm_.get('runas', runas)\n vm_['vagrant_provider'] = vagrant_provider or vm_.get('vagrant_provider', '')\n _update_vm_info(name, vm_)\n\n if start:\n log.debug('Starting VM %s', name)\n ret = _start(name, vm_)\n else:\n ret = 'Name {} defined using VM {}'.format(name, vm_['machine'] or '(default)')\n return ret\n\n\ndef start(name):\n '''\n Start (vagrant up) a virtual machine defined by salt_id name.\n The machine must have been previously defined using \"vagrant.init\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.start <salt_id>\n '''\n vm_ = get_vm_info(name)\n return _start(name, vm_)\n\n\ndef _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider', '')\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\n cmd = 'vagrant up {} {}'.format(machine, provider_)\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\n\n if machine == '': # we were called using the default machine\n for line in ret['stdout'].split('\\n'): # find its actual Vagrant name\n if line.startswith('==>'):\n machine = line.split()[1].rstrip(':')\n vm_['machine'] = machine\n _update_vm_info(name, vm_) # and remember the true name\n break\n\n if ret['retcode'] == 0:\n return 'Started \"{}\" using Vagrant machine \"{}\".'.format(name, machine)\n return False\n\n\ndef shutdown(name):\n '''\n Send a soft shutdown (vagrant halt) signal to the named vm.\n\n This does the same thing as vagrant.stop. Other-VM control\n modules use \"stop\" and \"shutdown\" to differentiate between\n hard and soft shutdowns.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.shutdown <salt_id>\n '''\n return stop(name)\n\n\ndef stop(name):\n '''\n Hard shutdown the virtual machine. (vagrant halt)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.stop <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant halt {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef pause(name):\n '''\n Pause (vagrant suspend) the named VM.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.pause <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant suspend {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef reboot(name, provision=False):\n '''\n Reboot a VM. (vagrant reload)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.reboot <salt_id> provision=True\n\n :param name: The salt_id name you will use to control this VM\n :param provision: (False) also re-run the Vagrant provisioning scripts.\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n prov = '--provision' if provision else ''\n\n cmd = 'vagrant reload {} {}'.format(machine, prov)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef destroy(name):\n '''\n Destroy and delete a virtual machine. (vagrant destroy -f)\n\n This also removes the salt_id name defined by vagrant.init.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.destroy <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant destroy -f {}'.format(machine)\n\n ret = __salt__['cmd.run_all'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n output_loglevel='info')\n if ret['retcode'] == 0:\n _erase_vm_info(name)\n return 'Destroyed VM {0}'.format(name)\n return False\n\n\ndef get_ssh_config(name, network_mask='', get_private_key=False):\n r'''\n Retrieve hints of how you might connect to a Vagrant VM.\n\n :param name: the salt_id of the machine\n :param network_mask: a CIDR mask to search for the VM's address\n :param get_private_key: (default: False) return the key used for ssh login\n :return: a dict of ssh login information for the VM\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.get_ssh_config <salt_id>\n salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True\n\n The returned dictionary contains:\n\n - key_filename: the name of the private key file on the VM host computer\n - ssh_username: the username to be used to log in to the VM\n - ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)\n - ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)\n - \\[ip_address:\\] (if `network_mask` is defined. see below)\n - \\[private_key:\\] (if `get_private_key` is True) the private key for ssh_username\n\n About `network_mask`:\n\n Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.\n This redirected port and its IP address are \"ssh_port\" and \"ssh_host\". The ssh_host is\n usually the localhost (127.0.0.1).\n This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM\n unless the VM has another network interface defined. You will usually want a bridged network\n defined by having a `config.vm.network \"public_network\"` statement in your `Vagrantfile`.\n\n The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,\n but you should be able to determine what IP network the address will be chosen from.\n If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.\n The host machine will send an \"ifconfig\" command to the VM (using ssh to `ssh_host`:`ssh_port`)\n and return the IP address of the first interface it can find which matches your mask.\n '''\n vm_ = get_vm_info(name)\n\n ssh_config = _vagrant_ssh_config(vm_)\n\n try:\n ans = {'key_filename': ssh_config['IdentityFile'],\n 'ssh_username': ssh_config['User'],\n 'ssh_host': ssh_config['HostName'],\n 'ssh_port': ssh_config['Port'],\n }\n\n except KeyError:\n raise CommandExecutionError(\n 'Insufficient SSH information to contact VM {}. '\n 'Is it running?'.format(vm_.get('machine', '(default)')))\n\n if network_mask:\n # ask the new VM to report its network address\n command = 'ssh -i {IdentityFile} -p {Port} ' \\\n '-oStrictHostKeyChecking={StrictHostKeyChecking} ' \\\n '-oUserKnownHostsFile={UserKnownHostsFile} ' \\\n '-oControlPath=none ' \\\n '{User}@{HostName} ifconfig'.format(**ssh_config)\n\n log.info(\n 'Trying ssh -p %s %s@%s ifconfig',\n ssh_config['Port'], ssh_config['User'], ssh_config['HostName']\n )\n reply = __salt__['cmd.shell'](command)\n log.info('--->\\n%s', reply)\n target_network_range = ipaddress.ip_network(network_mask, strict=False)\n\n for line in reply.split('\\n'):\n try: # try to find a bridged network address\n # the lines we are looking for appear like:\n # \"inet addr:10.124.31.185 Bcast:10.124.31.255 Mask:255.255.248.0\"\n # or \"inet6 addr: fe80::a00:27ff:fe04:7aac/64 Scope:Link\"\n tokens = line.replace('addr:', '', 1).split() # remove \"addr:\" if it exists, then split\n found_address = None\n if \"inet\" in tokens:\n nxt = tokens.index(\"inet\") + 1\n found_address = ipaddress.ip_address(tokens[nxt])\n elif \"inet6\" in tokens:\n nxt = tokens.index(\"inet6\") + 1\n found_address = ipaddress.ip_address(tokens[nxt].split('/')[0])\n if found_address in target_network_range:\n ans['ip_address'] = six.text_type(found_address)\n break # we have located a good matching address\n except (IndexError, AttributeError, TypeError):\n pass # all syntax and type errors loop here\n # falling out if the loop leaves us remembering the last candidate\n log.info('Network IP address in %s detected as: %s',\n target_network_range, ans.get('ip_address', '(not found)'))\n\n if get_private_key:\n # retrieve the Vagrant private key from the host\n try:\n with salt.utils.files.fopen(ssh_config['IdentityFile']) as pks:\n ans['private_key'] = salt.utils.stringutils.to_unicode(pks.read())\n except (OSError, IOError) as e:\n raise CommandExecutionError(\"Error processing Vagrant private key file: {}\".format(e))\n return ans\n"}}},{"rowIdx":365,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/vagrant.py"},"func_name":{"kind":"string","value":"list_domains"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def list_domains():\n '''\n Return a list of the salt_id names of all available Vagrant VMs on\n this host without regard to the path where they are defined.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_domains --log-level=info\n\n The log shows information about all known Vagrant environments\n on this machine. This data is cached and may not be completely\n up-to-date.\n '''\n vms = []\n cmd = 'vagrant global-status'\n reply = __salt__['cmd.shell'](cmd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n try:\n _ = int(tokens[0], 16) # valid id numbers are hexadecimal\n except (ValueError, IndexError):\n continue # skip lines without valid id numbers\n machine = tokens[1]\n cwd = tokens[-1]\n name = get_machine_id(machine, cwd)\n if name:\n vms.append(name)\n return vms"},"func_documentation_string":{"kind":"string","value":"Return a list of the salt_id names of all available Vagrant VMs on\n this host without regard to the path where they are defined.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_domains --log-level=info\n\n The log shows information about all known Vagrant environments\n on this machine. This data is cached and may not be completely\n up-to-date."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L193-L223"},"called_functions":{"kind":"list like","value":["def get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n"],"string":"[\n \"def get_machine_id(machine, cwd):\\n '''\\n returns the salt_id name of the Vagrant VM\\n\\n :param machine: the Vagrant machine name\\n :param cwd: the path to Vagrantfile\\n :return: salt_id name\\n '''\\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\\n return name\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nWork with virtual machines managed by Vagrant.\n\n.. versionadded:: 2018.3.0\n\nMapping between a Salt node id and the Vagrant machine name\n(and the path to the Vagrantfile where it is defined)\nis stored in a Salt sdb database on the Vagrant host (minion) machine.\nIn order to use this module, sdb must be configured. An SQLite\ndatabase is the recommended storage method. The URI used for\nthe sdb lookup is \"sdb://vagrant_sdb_data\".\n\nrequirements:\n - the VM host machine must have salt-minion, Vagrant and a vm provider installed.\n - the VM host must have a valid definition for `sdb://vagrant_sdb_data`\n\n Configuration example:\n\n .. code-block:: yaml\n\n # file /etc/salt/minion.d/vagrant_sdb.conf\n vagrant_sdb_data:\n driver: sqlite3\n database: /var/cache/salt/vagrant.sqlite\n table: sdb\n create_table: True\n\n'''\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\nimport os\n\n# Import salt libs\nimport salt.utils.files\nimport salt.utils.path\nimport salt.utils.stringutils\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\nimport salt.ext.six as six\nfrom salt._compat import ipaddress\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'vagrant'\n\nVAGRANT_SDB_URL = 'sdb://vagrant_sdb_data/'\n\n\ndef __virtual__():\n '''\n run Vagrant commands if possible\n '''\n if salt.utils.path.which('vagrant') is None:\n return False, 'The vagrant module could not be loaded: vagrant command not found'\n return __virtualname__\n\n\ndef _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n\n\ndef _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)\n\n\ndef _update_vm_info(name, vm_):\n ''' store the vm_ information keyed by name '''\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\n\n # store machine-to-name mapping, too\n if vm_['machine']:\n __utils__['sdb.sdb_set'](\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\n name,\n __opts__)\n\n\ndef get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n\n\ndef get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n\n\ndef _erase_vm_info(name):\n '''\n erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry.\n '''\n try:\n # delete the machine record\n vm_ = get_vm_info(name)\n if vm_['machine']:\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\n try:\n __utils__['sdb.sdb_delete'](key, __opts__)\n except KeyError:\n # no delete method found -- load a blank value\n __utils__['sdb.sdb_set'](key, None, __opts__)\n except Exception:\n pass\n\n uri = _build_sdb_uri(name)\n try:\n # delete the name record\n __utils__['sdb.sdb_delete'](uri, __opts__)\n except KeyError:\n # no delete method found -- load an empty dictionary\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\n except Exception:\n pass\n\n\ndef _vagrant_ssh_config(vm_):\n '''\n get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff\n '''\n machine = vm_['machine']\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\n cmd = 'vagrant ssh-config {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n ignore_retcode=True)\n ssh_config = {}\n for line in reply.split('\\n'): # build a dictionary of the text reply\n tokens = line.strip().split()\n if len(tokens) == 2: # each two-token line becomes a key:value pair\n ssh_config[tokens[0]] = tokens[1]\n log.debug('ssh_config=%s', repr(ssh_config))\n return ssh_config\n\n\ndef version():\n '''\n Return the version of Vagrant on the minion\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.version\n '''\n cmd = 'vagrant -v'\n return __salt__['cmd.shell'](cmd)\n\n\n\ndef list_active_vms(cwd=None):\n '''\n Return a list of machine names for active virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_active_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1:\n if tokens[1] == 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef list_inactive_vms(cwd=None):\n '''\n Return a list of machine names for inactive virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' virt.list_inactive_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n if tokens[1] != 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef vm_state(name='', cwd=None):\n '''\n Return list of information for all the vms indicating their state.\n\n If you pass a VM name in as an argument then it will return info\n for just the named VM, otherwise it will return all VMs defined by\n the Vagrantfile in the `cwd` directory.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.vm_state <name> cwd=/projects/project_1\n\n returns a list of dictionaries with machine name, state, provider,\n and salt_id name.\n\n .. code-block:: python\n\n datum = {'machine': _, # Vagrant machine name,\n 'state': _, # string indicating machine state, like 'running'\n 'provider': _, # the Vagrant VM provider\n 'name': _} # salt_id name\n\n Known bug: if there are multiple machines in your Vagrantfile, and you request\n the status of the ``primary`` machine, which you defined by leaving the ``machine``\n parameter blank, then you may receive the status of all of them.\n Please specify the actual machine name for each VM if there are more than one.\n\n '''\n\n if name:\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n cwd = vm_['cwd'] or cwd # usually ignore passed-in cwd\n else:\n if not cwd:\n raise SaltInvocationError(\n 'Path to Vagranfile must be defined, but cwd={}'.format(cwd))\n machine = ''\n\n info = []\n cmd = 'vagrant status {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd, cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n try:\n datum = {'machine': tokens[0],\n 'state': ' '.join(tokens[1:-1]),\n 'provider': tokens[-1].lstrip('(').rstrip(')'),\n 'name': get_machine_id(tokens[0], cwd)\n }\n info.append(datum)\n except IndexError:\n pass\n return info\n\n\ndef init(name, # Salt_id for created VM\n cwd=None, # path to find Vagrantfile\n machine='', # name of machine in Vagrantfile\n runas=None, # username who owns Vagrant box\n start=False, # start the machine when initialized\n vagrant_provider='', # vagrant provider (default=virtualbox)\n vm=None, # a dictionary of VM configuration settings\n ):\n '''\n Initialize a new Vagrant VM.\n\n This inputs all the information needed to start a Vagrant VM. These settings are stored in\n a Salt sdb database on the Vagrant host minion and used to start, control, and query the\n guest VMs. The salt_id assigned here is the key field for that database and must be unique.\n\n :param name: The salt_id name you will use to control this VM\n :param cwd: The path to the directory where the Vagrantfile is located\n :param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.\n :param runas: The username on the host who owns the Vagrant work files.\n :param start: (default: False) Start the virtual machine now.\n :param vagrant_provider: The name of a Vagrant VM provider (if not the default).\n :param vm: Optionally, all the above information may be supplied in this dictionary.\n :return: A string indicating success, or False.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.init <salt_id> /path/to/Vagrantfile\n salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1\n '''\n vm_ = {} if vm is None else vm.copy() # passed configuration data\n vm_['name'] = name\n # passed-in keyword arguments overwrite vm dictionary values\n vm_['cwd'] = cwd or vm_.get('cwd')\n if not vm_['cwd']:\n raise SaltInvocationError('Path to Vagrantfile must be defined by \"cwd\" argument')\n vm_['machine'] = machine or vm_.get('machine', machine)\n vm_['runas'] = runas or vm_.get('runas', runas)\n vm_['vagrant_provider'] = vagrant_provider or vm_.get('vagrant_provider', '')\n _update_vm_info(name, vm_)\n\n if start:\n log.debug('Starting VM %s', name)\n ret = _start(name, vm_)\n else:\n ret = 'Name {} defined using VM {}'.format(name, vm_['machine'] or '(default)')\n return ret\n\n\ndef start(name):\n '''\n Start (vagrant up) a virtual machine defined by salt_id name.\n The machine must have been previously defined using \"vagrant.init\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.start <salt_id>\n '''\n vm_ = get_vm_info(name)\n return _start(name, vm_)\n\n\ndef _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider', '')\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\n cmd = 'vagrant up {} {}'.format(machine, provider_)\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\n\n if machine == '': # we were called using the default machine\n for line in ret['stdout'].split('\\n'): # find its actual Vagrant name\n if line.startswith('==>'):\n machine = line.split()[1].rstrip(':')\n vm_['machine'] = machine\n _update_vm_info(name, vm_) # and remember the true name\n break\n\n if ret['retcode'] == 0:\n return 'Started \"{}\" using Vagrant machine \"{}\".'.format(name, machine)\n return False\n\n\ndef shutdown(name):\n '''\n Send a soft shutdown (vagrant halt) signal to the named vm.\n\n This does the same thing as vagrant.stop. Other-VM control\n modules use \"stop\" and \"shutdown\" to differentiate between\n hard and soft shutdowns.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.shutdown <salt_id>\n '''\n return stop(name)\n\n\ndef stop(name):\n '''\n Hard shutdown the virtual machine. (vagrant halt)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.stop <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant halt {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef pause(name):\n '''\n Pause (vagrant suspend) the named VM.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.pause <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant suspend {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef reboot(name, provision=False):\n '''\n Reboot a VM. (vagrant reload)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.reboot <salt_id> provision=True\n\n :param name: The salt_id name you will use to control this VM\n :param provision: (False) also re-run the Vagrant provisioning scripts.\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n prov = '--provision' if provision else ''\n\n cmd = 'vagrant reload {} {}'.format(machine, prov)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef destroy(name):\n '''\n Destroy and delete a virtual machine. (vagrant destroy -f)\n\n This also removes the salt_id name defined by vagrant.init.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.destroy <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant destroy -f {}'.format(machine)\n\n ret = __salt__['cmd.run_all'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n output_loglevel='info')\n if ret['retcode'] == 0:\n _erase_vm_info(name)\n return 'Destroyed VM {0}'.format(name)\n return False\n\n\ndef get_ssh_config(name, network_mask='', get_private_key=False):\n r'''\n Retrieve hints of how you might connect to a Vagrant VM.\n\n :param name: the salt_id of the machine\n :param network_mask: a CIDR mask to search for the VM's address\n :param get_private_key: (default: False) return the key used for ssh login\n :return: a dict of ssh login information for the VM\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.get_ssh_config <salt_id>\n salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True\n\n The returned dictionary contains:\n\n - key_filename: the name of the private key file on the VM host computer\n - ssh_username: the username to be used to log in to the VM\n - ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)\n - ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)\n - \\[ip_address:\\] (if `network_mask` is defined. see below)\n - \\[private_key:\\] (if `get_private_key` is True) the private key for ssh_username\n\n About `network_mask`:\n\n Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.\n This redirected port and its IP address are \"ssh_port\" and \"ssh_host\". The ssh_host is\n usually the localhost (127.0.0.1).\n This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM\n unless the VM has another network interface defined. You will usually want a bridged network\n defined by having a `config.vm.network \"public_network\"` statement in your `Vagrantfile`.\n\n The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,\n but you should be able to determine what IP network the address will be chosen from.\n If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.\n The host machine will send an \"ifconfig\" command to the VM (using ssh to `ssh_host`:`ssh_port`)\n and return the IP address of the first interface it can find which matches your mask.\n '''\n vm_ = get_vm_info(name)\n\n ssh_config = _vagrant_ssh_config(vm_)\n\n try:\n ans = {'key_filename': ssh_config['IdentityFile'],\n 'ssh_username': ssh_config['User'],\n 'ssh_host': ssh_config['HostName'],\n 'ssh_port': ssh_config['Port'],\n }\n\n except KeyError:\n raise CommandExecutionError(\n 'Insufficient SSH information to contact VM {}. '\n 'Is it running?'.format(vm_.get('machine', '(default)')))\n\n if network_mask:\n # ask the new VM to report its network address\n command = 'ssh -i {IdentityFile} -p {Port} ' \\\n '-oStrictHostKeyChecking={StrictHostKeyChecking} ' \\\n '-oUserKnownHostsFile={UserKnownHostsFile} ' \\\n '-oControlPath=none ' \\\n '{User}@{HostName} ifconfig'.format(**ssh_config)\n\n log.info(\n 'Trying ssh -p %s %s@%s ifconfig',\n ssh_config['Port'], ssh_config['User'], ssh_config['HostName']\n )\n reply = __salt__['cmd.shell'](command)\n log.info('--->\\n%s', reply)\n target_network_range = ipaddress.ip_network(network_mask, strict=False)\n\n for line in reply.split('\\n'):\n try: # try to find a bridged network address\n # the lines we are looking for appear like:\n # \"inet addr:10.124.31.185 Bcast:10.124.31.255 Mask:255.255.248.0\"\n # or \"inet6 addr: fe80::a00:27ff:fe04:7aac/64 Scope:Link\"\n tokens = line.replace('addr:', '', 1).split() # remove \"addr:\" if it exists, then split\n found_address = None\n if \"inet\" in tokens:\n nxt = tokens.index(\"inet\") + 1\n found_address = ipaddress.ip_address(tokens[nxt])\n elif \"inet6\" in tokens:\n nxt = tokens.index(\"inet6\") + 1\n found_address = ipaddress.ip_address(tokens[nxt].split('/')[0])\n if found_address in target_network_range:\n ans['ip_address'] = six.text_type(found_address)\n break # we have located a good matching address\n except (IndexError, AttributeError, TypeError):\n pass # all syntax and type errors loop here\n # falling out if the loop leaves us remembering the last candidate\n log.info('Network IP address in %s detected as: %s',\n target_network_range, ans.get('ip_address', '(not found)'))\n\n if get_private_key:\n # retrieve the Vagrant private key from the host\n try:\n with salt.utils.files.fopen(ssh_config['IdentityFile']) as pks:\n ans['private_key'] = salt.utils.stringutils.to_unicode(pks.read())\n except (OSError, IOError) as e:\n raise CommandExecutionError(\"Error processing Vagrant private key file: {}\".format(e))\n return ans\n"}}},{"rowIdx":366,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/vagrant.py"},"func_name":{"kind":"string","value":"list_active_vms"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def list_active_vms(cwd=None):\n '''\n Return a list of machine names for active virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_active_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1:\n if tokens[1] == 'running':\n vms.append(tokens[0])\n return vms"},"func_documentation_string":{"kind":"string","value":"Return a list of machine names for active virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_active_vms cwd=/projects/project_1"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L226-L246"},"called_functions":{"kind":"null"},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nWork with virtual machines managed by Vagrant.\n\n.. versionadded:: 2018.3.0\n\nMapping between a Salt node id and the Vagrant machine name\n(and the path to the Vagrantfile where it is defined)\nis stored in a Salt sdb database on the Vagrant host (minion) machine.\nIn order to use this module, sdb must be configured. An SQLite\ndatabase is the recommended storage method. The URI used for\nthe sdb lookup is \"sdb://vagrant_sdb_data\".\n\nrequirements:\n - the VM host machine must have salt-minion, Vagrant and a vm provider installed.\n - the VM host must have a valid definition for `sdb://vagrant_sdb_data`\n\n Configuration example:\n\n .. code-block:: yaml\n\n # file /etc/salt/minion.d/vagrant_sdb.conf\n vagrant_sdb_data:\n driver: sqlite3\n database: /var/cache/salt/vagrant.sqlite\n table: sdb\n create_table: True\n\n'''\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\nimport os\n\n# Import salt libs\nimport salt.utils.files\nimport salt.utils.path\nimport salt.utils.stringutils\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\nimport salt.ext.six as six\nfrom salt._compat import ipaddress\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'vagrant'\n\nVAGRANT_SDB_URL = 'sdb://vagrant_sdb_data/'\n\n\ndef __virtual__():\n '''\n run Vagrant commands if possible\n '''\n if salt.utils.path.which('vagrant') is None:\n return False, 'The vagrant module could not be loaded: vagrant command not found'\n return __virtualname__\n\n\ndef _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n\n\ndef _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)\n\n\ndef _update_vm_info(name, vm_):\n ''' store the vm_ information keyed by name '''\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\n\n # store machine-to-name mapping, too\n if vm_['machine']:\n __utils__['sdb.sdb_set'](\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\n name,\n __opts__)\n\n\ndef get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n\n\ndef get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n\n\ndef _erase_vm_info(name):\n '''\n erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry.\n '''\n try:\n # delete the machine record\n vm_ = get_vm_info(name)\n if vm_['machine']:\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\n try:\n __utils__['sdb.sdb_delete'](key, __opts__)\n except KeyError:\n # no delete method found -- load a blank value\n __utils__['sdb.sdb_set'](key, None, __opts__)\n except Exception:\n pass\n\n uri = _build_sdb_uri(name)\n try:\n # delete the name record\n __utils__['sdb.sdb_delete'](uri, __opts__)\n except KeyError:\n # no delete method found -- load an empty dictionary\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\n except Exception:\n pass\n\n\ndef _vagrant_ssh_config(vm_):\n '''\n get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff\n '''\n machine = vm_['machine']\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\n cmd = 'vagrant ssh-config {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n ignore_retcode=True)\n ssh_config = {}\n for line in reply.split('\\n'): # build a dictionary of the text reply\n tokens = line.strip().split()\n if len(tokens) == 2: # each two-token line becomes a key:value pair\n ssh_config[tokens[0]] = tokens[1]\n log.debug('ssh_config=%s', repr(ssh_config))\n return ssh_config\n\n\ndef version():\n '''\n Return the version of Vagrant on the minion\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.version\n '''\n cmd = 'vagrant -v'\n return __salt__['cmd.shell'](cmd)\n\n\ndef list_domains():\n '''\n Return a list of the salt_id names of all available Vagrant VMs on\n this host without regard to the path where they are defined.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_domains --log-level=info\n\n The log shows information about all known Vagrant environments\n on this machine. This data is cached and may not be completely\n up-to-date.\n '''\n vms = []\n cmd = 'vagrant global-status'\n reply = __salt__['cmd.shell'](cmd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n try:\n _ = int(tokens[0], 16) # valid id numbers are hexadecimal\n except (ValueError, IndexError):\n continue # skip lines without valid id numbers\n machine = tokens[1]\n cwd = tokens[-1]\n name = get_machine_id(machine, cwd)\n if name:\n vms.append(name)\n return vms\n\n\n\ndef list_inactive_vms(cwd=None):\n '''\n Return a list of machine names for inactive virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' virt.list_inactive_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n if tokens[1] != 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef vm_state(name='', cwd=None):\n '''\n Return list of information for all the vms indicating their state.\n\n If you pass a VM name in as an argument then it will return info\n for just the named VM, otherwise it will return all VMs defined by\n the Vagrantfile in the `cwd` directory.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.vm_state <name> cwd=/projects/project_1\n\n returns a list of dictionaries with machine name, state, provider,\n and salt_id name.\n\n .. code-block:: python\n\n datum = {'machine': _, # Vagrant machine name,\n 'state': _, # string indicating machine state, like 'running'\n 'provider': _, # the Vagrant VM provider\n 'name': _} # salt_id name\n\n Known bug: if there are multiple machines in your Vagrantfile, and you request\n the status of the ``primary`` machine, which you defined by leaving the ``machine``\n parameter blank, then you may receive the status of all of them.\n Please specify the actual machine name for each VM if there are more than one.\n\n '''\n\n if name:\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n cwd = vm_['cwd'] or cwd # usually ignore passed-in cwd\n else:\n if not cwd:\n raise SaltInvocationError(\n 'Path to Vagranfile must be defined, but cwd={}'.format(cwd))\n machine = ''\n\n info = []\n cmd = 'vagrant status {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd, cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n try:\n datum = {'machine': tokens[0],\n 'state': ' '.join(tokens[1:-1]),\n 'provider': tokens[-1].lstrip('(').rstrip(')'),\n 'name': get_machine_id(tokens[0], cwd)\n }\n info.append(datum)\n except IndexError:\n pass\n return info\n\n\ndef init(name, # Salt_id for created VM\n cwd=None, # path to find Vagrantfile\n machine='', # name of machine in Vagrantfile\n runas=None, # username who owns Vagrant box\n start=False, # start the machine when initialized\n vagrant_provider='', # vagrant provider (default=virtualbox)\n vm=None, # a dictionary of VM configuration settings\n ):\n '''\n Initialize a new Vagrant VM.\n\n This inputs all the information needed to start a Vagrant VM. These settings are stored in\n a Salt sdb database on the Vagrant host minion and used to start, control, and query the\n guest VMs. The salt_id assigned here is the key field for that database and must be unique.\n\n :param name: The salt_id name you will use to control this VM\n :param cwd: The path to the directory where the Vagrantfile is located\n :param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.\n :param runas: The username on the host who owns the Vagrant work files.\n :param start: (default: False) Start the virtual machine now.\n :param vagrant_provider: The name of a Vagrant VM provider (if not the default).\n :param vm: Optionally, all the above information may be supplied in this dictionary.\n :return: A string indicating success, or False.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.init <salt_id> /path/to/Vagrantfile\n salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1\n '''\n vm_ = {} if vm is None else vm.copy() # passed configuration data\n vm_['name'] = name\n # passed-in keyword arguments overwrite vm dictionary values\n vm_['cwd'] = cwd or vm_.get('cwd')\n if not vm_['cwd']:\n raise SaltInvocationError('Path to Vagrantfile must be defined by \"cwd\" argument')\n vm_['machine'] = machine or vm_.get('machine', machine)\n vm_['runas'] = runas or vm_.get('runas', runas)\n vm_['vagrant_provider'] = vagrant_provider or vm_.get('vagrant_provider', '')\n _update_vm_info(name, vm_)\n\n if start:\n log.debug('Starting VM %s', name)\n ret = _start(name, vm_)\n else:\n ret = 'Name {} defined using VM {}'.format(name, vm_['machine'] or '(default)')\n return ret\n\n\ndef start(name):\n '''\n Start (vagrant up) a virtual machine defined by salt_id name.\n The machine must have been previously defined using \"vagrant.init\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.start <salt_id>\n '''\n vm_ = get_vm_info(name)\n return _start(name, vm_)\n\n\ndef _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider', '')\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\n cmd = 'vagrant up {} {}'.format(machine, provider_)\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\n\n if machine == '': # we were called using the default machine\n for line in ret['stdout'].split('\\n'): # find its actual Vagrant name\n if line.startswith('==>'):\n machine = line.split()[1].rstrip(':')\n vm_['machine'] = machine\n _update_vm_info(name, vm_) # and remember the true name\n break\n\n if ret['retcode'] == 0:\n return 'Started \"{}\" using Vagrant machine \"{}\".'.format(name, machine)\n return False\n\n\ndef shutdown(name):\n '''\n Send a soft shutdown (vagrant halt) signal to the named vm.\n\n This does the same thing as vagrant.stop. Other-VM control\n modules use \"stop\" and \"shutdown\" to differentiate between\n hard and soft shutdowns.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.shutdown <salt_id>\n '''\n return stop(name)\n\n\ndef stop(name):\n '''\n Hard shutdown the virtual machine. (vagrant halt)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.stop <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant halt {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef pause(name):\n '''\n Pause (vagrant suspend) the named VM.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.pause <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant suspend {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef reboot(name, provision=False):\n '''\n Reboot a VM. (vagrant reload)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.reboot <salt_id> provision=True\n\n :param name: The salt_id name you will use to control this VM\n :param provision: (False) also re-run the Vagrant provisioning scripts.\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n prov = '--provision' if provision else ''\n\n cmd = 'vagrant reload {} {}'.format(machine, prov)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef destroy(name):\n '''\n Destroy and delete a virtual machine. (vagrant destroy -f)\n\n This also removes the salt_id name defined by vagrant.init.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.destroy <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant destroy -f {}'.format(machine)\n\n ret = __salt__['cmd.run_all'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n output_loglevel='info')\n if ret['retcode'] == 0:\n _erase_vm_info(name)\n return 'Destroyed VM {0}'.format(name)\n return False\n\n\ndef get_ssh_config(name, network_mask='', get_private_key=False):\n r'''\n Retrieve hints of how you might connect to a Vagrant VM.\n\n :param name: the salt_id of the machine\n :param network_mask: a CIDR mask to search for the VM's address\n :param get_private_key: (default: False) return the key used for ssh login\n :return: a dict of ssh login information for the VM\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.get_ssh_config <salt_id>\n salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True\n\n The returned dictionary contains:\n\n - key_filename: the name of the private key file on the VM host computer\n - ssh_username: the username to be used to log in to the VM\n - ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)\n - ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)\n - \\[ip_address:\\] (if `network_mask` is defined. see below)\n - \\[private_key:\\] (if `get_private_key` is True) the private key for ssh_username\n\n About `network_mask`:\n\n Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.\n This redirected port and its IP address are \"ssh_port\" and \"ssh_host\". The ssh_host is\n usually the localhost (127.0.0.1).\n This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM\n unless the VM has another network interface defined. You will usually want a bridged network\n defined by having a `config.vm.network \"public_network\"` statement in your `Vagrantfile`.\n\n The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,\n but you should be able to determine what IP network the address will be chosen from.\n If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.\n The host machine will send an \"ifconfig\" command to the VM (using ssh to `ssh_host`:`ssh_port`)\n and return the IP address of the first interface it can find which matches your mask.\n '''\n vm_ = get_vm_info(name)\n\n ssh_config = _vagrant_ssh_config(vm_)\n\n try:\n ans = {'key_filename': ssh_config['IdentityFile'],\n 'ssh_username': ssh_config['User'],\n 'ssh_host': ssh_config['HostName'],\n 'ssh_port': ssh_config['Port'],\n }\n\n except KeyError:\n raise CommandExecutionError(\n 'Insufficient SSH information to contact VM {}. '\n 'Is it running?'.format(vm_.get('machine', '(default)')))\n\n if network_mask:\n # ask the new VM to report its network address\n command = 'ssh -i {IdentityFile} -p {Port} ' \\\n '-oStrictHostKeyChecking={StrictHostKeyChecking} ' \\\n '-oUserKnownHostsFile={UserKnownHostsFile} ' \\\n '-oControlPath=none ' \\\n '{User}@{HostName} ifconfig'.format(**ssh_config)\n\n log.info(\n 'Trying ssh -p %s %s@%s ifconfig',\n ssh_config['Port'], ssh_config['User'], ssh_config['HostName']\n )\n reply = __salt__['cmd.shell'](command)\n log.info('--->\\n%s', reply)\n target_network_range = ipaddress.ip_network(network_mask, strict=False)\n\n for line in reply.split('\\n'):\n try: # try to find a bridged network address\n # the lines we are looking for appear like:\n # \"inet addr:10.124.31.185 Bcast:10.124.31.255 Mask:255.255.248.0\"\n # or \"inet6 addr: fe80::a00:27ff:fe04:7aac/64 Scope:Link\"\n tokens = line.replace('addr:', '', 1).split() # remove \"addr:\" if it exists, then split\n found_address = None\n if \"inet\" in tokens:\n nxt = tokens.index(\"inet\") + 1\n found_address = ipaddress.ip_address(tokens[nxt])\n elif \"inet6\" in tokens:\n nxt = tokens.index(\"inet6\") + 1\n found_address = ipaddress.ip_address(tokens[nxt].split('/')[0])\n if found_address in target_network_range:\n ans['ip_address'] = six.text_type(found_address)\n break # we have located a good matching address\n except (IndexError, AttributeError, TypeError):\n pass # all syntax and type errors loop here\n # falling out if the loop leaves us remembering the last candidate\n log.info('Network IP address in %s detected as: %s',\n target_network_range, ans.get('ip_address', '(not found)'))\n\n if get_private_key:\n # retrieve the Vagrant private key from the host\n try:\n with salt.utils.files.fopen(ssh_config['IdentityFile']) as pks:\n ans['private_key'] = salt.utils.stringutils.to_unicode(pks.read())\n except (OSError, IOError) as e:\n raise CommandExecutionError(\"Error processing Vagrant private key file: {}\".format(e))\n return ans\n"}}},{"rowIdx":367,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/vagrant.py"},"func_name":{"kind":"string","value":"vm_state"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def vm_state(name='', cwd=None):\n '''\n Return list of information for all the vms indicating their state.\n\n If you pass a VM name in as an argument then it will return info\n for just the named VM, otherwise it will return all VMs defined by\n the Vagrantfile in the `cwd` directory.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.vm_state <name> cwd=/projects/project_1\n\n returns a list of dictionaries with machine name, state, provider,\n and salt_id name.\n\n .. code-block:: python\n\n datum = {'machine': _, # Vagrant machine name,\n 'state': _, # string indicating machine state, like 'running'\n 'provider': _, # the Vagrant VM provider\n 'name': _} # salt_id name\n\n Known bug: if there are multiple machines in your Vagrantfile, and you request\n the status of the ``primary`` machine, which you defined by leaving the ``machine``\n parameter blank, then you may receive the status of all of them.\n Please specify the actual machine name for each VM if there are more than one.\n\n '''\n\n if name:\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n cwd = vm_['cwd'] or cwd # usually ignore passed-in cwd\n else:\n if not cwd:\n raise SaltInvocationError(\n 'Path to Vagranfile must be defined, but cwd={}'.format(cwd))\n machine = ''\n\n info = []\n cmd = 'vagrant status {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd, cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n try:\n datum = {'machine': tokens[0],\n 'state': ' '.join(tokens[1:-1]),\n 'provider': tokens[-1].lstrip('(').rstrip(')'),\n 'name': get_machine_id(tokens[0], cwd)\n }\n info.append(datum)\n except IndexError:\n pass\n return info"},"func_documentation_string":{"kind":"string","value":"Return list of information for all the vms indicating their state.\n\n If you pass a VM name in as an argument then it will return info\n for just the named VM, otherwise it will return all VMs defined by\n the Vagrantfile in the `cwd` directory.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.vm_state <name> cwd=/projects/project_1\n\n returns a list of dictionaries with machine name, state, provider,\n and salt_id name.\n\n .. code-block:: python\n\n datum = {'machine': _, # Vagrant machine name,\n 'state': _, # string indicating machine state, like 'running'\n 'provider': _, # the Vagrant VM provider\n 'name': _} # salt_id name\n\n Known bug: if there are multiple machines in your Vagrantfile, and you request\n the status of the ``primary`` machine, which you defined by leaving the ``machine``\n parameter blank, then you may receive the status of all of them.\n Please specify the actual machine name for each VM if there are more than one."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L273-L330"},"called_functions":{"kind":"list like","value":["def get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n","def get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n"],"string":"[\n \"def get_machine_id(machine, cwd):\\n '''\\n returns the salt_id name of the Vagrant VM\\n\\n :param machine: the Vagrant machine name\\n :param cwd: the path to Vagrantfile\\n :return: salt_id name\\n '''\\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\\n return name\\n\",\n \"def get_vm_info(name):\\n '''\\n get the information for a VM.\\n\\n :param name: salt_id name\\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\\n '''\\n try:\\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\\n except KeyError:\\n raise SaltInvocationError(\\n 'Probable sdb driver not found. Check your configuration.')\\n if vm_ is None or 'machine' not in vm_:\\n raise SaltInvocationError(\\n 'No Vagrant machine defined for Salt_id {}'.format(name))\\n return vm_\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nWork with virtual machines managed by Vagrant.\n\n.. versionadded:: 2018.3.0\n\nMapping between a Salt node id and the Vagrant machine name\n(and the path to the Vagrantfile where it is defined)\nis stored in a Salt sdb database on the Vagrant host (minion) machine.\nIn order to use this module, sdb must be configured. An SQLite\ndatabase is the recommended storage method. The URI used for\nthe sdb lookup is \"sdb://vagrant_sdb_data\".\n\nrequirements:\n - the VM host machine must have salt-minion, Vagrant and a vm provider installed.\n - the VM host must have a valid definition for `sdb://vagrant_sdb_data`\n\n Configuration example:\n\n .. code-block:: yaml\n\n # file /etc/salt/minion.d/vagrant_sdb.conf\n vagrant_sdb_data:\n driver: sqlite3\n database: /var/cache/salt/vagrant.sqlite\n table: sdb\n create_table: True\n\n'''\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\nimport os\n\n# Import salt libs\nimport salt.utils.files\nimport salt.utils.path\nimport salt.utils.stringutils\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\nimport salt.ext.six as six\nfrom salt._compat import ipaddress\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'vagrant'\n\nVAGRANT_SDB_URL = 'sdb://vagrant_sdb_data/'\n\n\ndef __virtual__():\n '''\n run Vagrant commands if possible\n '''\n if salt.utils.path.which('vagrant') is None:\n return False, 'The vagrant module could not be loaded: vagrant command not found'\n return __virtualname__\n\n\ndef _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n\n\ndef _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)\n\n\ndef _update_vm_info(name, vm_):\n ''' store the vm_ information keyed by name '''\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\n\n # store machine-to-name mapping, too\n if vm_['machine']:\n __utils__['sdb.sdb_set'](\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\n name,\n __opts__)\n\n\ndef get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n\n\ndef get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n\n\ndef _erase_vm_info(name):\n '''\n erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry.\n '''\n try:\n # delete the machine record\n vm_ = get_vm_info(name)\n if vm_['machine']:\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\n try:\n __utils__['sdb.sdb_delete'](key, __opts__)\n except KeyError:\n # no delete method found -- load a blank value\n __utils__['sdb.sdb_set'](key, None, __opts__)\n except Exception:\n pass\n\n uri = _build_sdb_uri(name)\n try:\n # delete the name record\n __utils__['sdb.sdb_delete'](uri, __opts__)\n except KeyError:\n # no delete method found -- load an empty dictionary\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\n except Exception:\n pass\n\n\ndef _vagrant_ssh_config(vm_):\n '''\n get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff\n '''\n machine = vm_['machine']\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\n cmd = 'vagrant ssh-config {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n ignore_retcode=True)\n ssh_config = {}\n for line in reply.split('\\n'): # build a dictionary of the text reply\n tokens = line.strip().split()\n if len(tokens) == 2: # each two-token line becomes a key:value pair\n ssh_config[tokens[0]] = tokens[1]\n log.debug('ssh_config=%s', repr(ssh_config))\n return ssh_config\n\n\ndef version():\n '''\n Return the version of Vagrant on the minion\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.version\n '''\n cmd = 'vagrant -v'\n return __salt__['cmd.shell'](cmd)\n\n\ndef list_domains():\n '''\n Return a list of the salt_id names of all available Vagrant VMs on\n this host without regard to the path where they are defined.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_domains --log-level=info\n\n The log shows information about all known Vagrant environments\n on this machine. This data is cached and may not be completely\n up-to-date.\n '''\n vms = []\n cmd = 'vagrant global-status'\n reply = __salt__['cmd.shell'](cmd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n try:\n _ = int(tokens[0], 16) # valid id numbers are hexadecimal\n except (ValueError, IndexError):\n continue # skip lines without valid id numbers\n machine = tokens[1]\n cwd = tokens[-1]\n name = get_machine_id(machine, cwd)\n if name:\n vms.append(name)\n return vms\n\n\ndef list_active_vms(cwd=None):\n '''\n Return a list of machine names for active virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_active_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1:\n if tokens[1] == 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef list_inactive_vms(cwd=None):\n '''\n Return a list of machine names for inactive virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' virt.list_inactive_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n if tokens[1] != 'running':\n vms.append(tokens[0])\n return vms\n\n\n\ndef init(name, # Salt_id for created VM\n cwd=None, # path to find Vagrantfile\n machine='', # name of machine in Vagrantfile\n runas=None, # username who owns Vagrant box\n start=False, # start the machine when initialized\n vagrant_provider='', # vagrant provider (default=virtualbox)\n vm=None, # a dictionary of VM configuration settings\n ):\n '''\n Initialize a new Vagrant VM.\n\n This inputs all the information needed to start a Vagrant VM. These settings are stored in\n a Salt sdb database on the Vagrant host minion and used to start, control, and query the\n guest VMs. The salt_id assigned here is the key field for that database and must be unique.\n\n :param name: The salt_id name you will use to control this VM\n :param cwd: The path to the directory where the Vagrantfile is located\n :param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.\n :param runas: The username on the host who owns the Vagrant work files.\n :param start: (default: False) Start the virtual machine now.\n :param vagrant_provider: The name of a Vagrant VM provider (if not the default).\n :param vm: Optionally, all the above information may be supplied in this dictionary.\n :return: A string indicating success, or False.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.init <salt_id> /path/to/Vagrantfile\n salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1\n '''\n vm_ = {} if vm is None else vm.copy() # passed configuration data\n vm_['name'] = name\n # passed-in keyword arguments overwrite vm dictionary values\n vm_['cwd'] = cwd or vm_.get('cwd')\n if not vm_['cwd']:\n raise SaltInvocationError('Path to Vagrantfile must be defined by \"cwd\" argument')\n vm_['machine'] = machine or vm_.get('machine', machine)\n vm_['runas'] = runas or vm_.get('runas', runas)\n vm_['vagrant_provider'] = vagrant_provider or vm_.get('vagrant_provider', '')\n _update_vm_info(name, vm_)\n\n if start:\n log.debug('Starting VM %s', name)\n ret = _start(name, vm_)\n else:\n ret = 'Name {} defined using VM {}'.format(name, vm_['machine'] or '(default)')\n return ret\n\n\ndef start(name):\n '''\n Start (vagrant up) a virtual machine defined by salt_id name.\n The machine must have been previously defined using \"vagrant.init\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.start <salt_id>\n '''\n vm_ = get_vm_info(name)\n return _start(name, vm_)\n\n\ndef _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider', '')\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\n cmd = 'vagrant up {} {}'.format(machine, provider_)\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\n\n if machine == '': # we were called using the default machine\n for line in ret['stdout'].split('\\n'): # find its actual Vagrant name\n if line.startswith('==>'):\n machine = line.split()[1].rstrip(':')\n vm_['machine'] = machine\n _update_vm_info(name, vm_) # and remember the true name\n break\n\n if ret['retcode'] == 0:\n return 'Started \"{}\" using Vagrant machine \"{}\".'.format(name, machine)\n return False\n\n\ndef shutdown(name):\n '''\n Send a soft shutdown (vagrant halt) signal to the named vm.\n\n This does the same thing as vagrant.stop. Other-VM control\n modules use \"stop\" and \"shutdown\" to differentiate between\n hard and soft shutdowns.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.shutdown <salt_id>\n '''\n return stop(name)\n\n\ndef stop(name):\n '''\n Hard shutdown the virtual machine. (vagrant halt)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.stop <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant halt {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef pause(name):\n '''\n Pause (vagrant suspend) the named VM.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.pause <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant suspend {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef reboot(name, provision=False):\n '''\n Reboot a VM. (vagrant reload)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.reboot <salt_id> provision=True\n\n :param name: The salt_id name you will use to control this VM\n :param provision: (False) also re-run the Vagrant provisioning scripts.\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n prov = '--provision' if provision else ''\n\n cmd = 'vagrant reload {} {}'.format(machine, prov)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef destroy(name):\n '''\n Destroy and delete a virtual machine. (vagrant destroy -f)\n\n This also removes the salt_id name defined by vagrant.init.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.destroy <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant destroy -f {}'.format(machine)\n\n ret = __salt__['cmd.run_all'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n output_loglevel='info')\n if ret['retcode'] == 0:\n _erase_vm_info(name)\n return 'Destroyed VM {0}'.format(name)\n return False\n\n\ndef get_ssh_config(name, network_mask='', get_private_key=False):\n r'''\n Retrieve hints of how you might connect to a Vagrant VM.\n\n :param name: the salt_id of the machine\n :param network_mask: a CIDR mask to search for the VM's address\n :param get_private_key: (default: False) return the key used for ssh login\n :return: a dict of ssh login information for the VM\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.get_ssh_config <salt_id>\n salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True\n\n The returned dictionary contains:\n\n - key_filename: the name of the private key file on the VM host computer\n - ssh_username: the username to be used to log in to the VM\n - ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)\n - ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)\n - \\[ip_address:\\] (if `network_mask` is defined. see below)\n - \\[private_key:\\] (if `get_private_key` is True) the private key for ssh_username\n\n About `network_mask`:\n\n Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.\n This redirected port and its IP address are \"ssh_port\" and \"ssh_host\". The ssh_host is\n usually the localhost (127.0.0.1).\n This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM\n unless the VM has another network interface defined. You will usually want a bridged network\n defined by having a `config.vm.network \"public_network\"` statement in your `Vagrantfile`.\n\n The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,\n but you should be able to determine what IP network the address will be chosen from.\n If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.\n The host machine will send an \"ifconfig\" command to the VM (using ssh to `ssh_host`:`ssh_port`)\n and return the IP address of the first interface it can find which matches your mask.\n '''\n vm_ = get_vm_info(name)\n\n ssh_config = _vagrant_ssh_config(vm_)\n\n try:\n ans = {'key_filename': ssh_config['IdentityFile'],\n 'ssh_username': ssh_config['User'],\n 'ssh_host': ssh_config['HostName'],\n 'ssh_port': ssh_config['Port'],\n }\n\n except KeyError:\n raise CommandExecutionError(\n 'Insufficient SSH information to contact VM {}. '\n 'Is it running?'.format(vm_.get('machine', '(default)')))\n\n if network_mask:\n # ask the new VM to report its network address\n command = 'ssh -i {IdentityFile} -p {Port} ' \\\n '-oStrictHostKeyChecking={StrictHostKeyChecking} ' \\\n '-oUserKnownHostsFile={UserKnownHostsFile} ' \\\n '-oControlPath=none ' \\\n '{User}@{HostName} ifconfig'.format(**ssh_config)\n\n log.info(\n 'Trying ssh -p %s %s@%s ifconfig',\n ssh_config['Port'], ssh_config['User'], ssh_config['HostName']\n )\n reply = __salt__['cmd.shell'](command)\n log.info('--->\\n%s', reply)\n target_network_range = ipaddress.ip_network(network_mask, strict=False)\n\n for line in reply.split('\\n'):\n try: # try to find a bridged network address\n # the lines we are looking for appear like:\n # \"inet addr:10.124.31.185 Bcast:10.124.31.255 Mask:255.255.248.0\"\n # or \"inet6 addr: fe80::a00:27ff:fe04:7aac/64 Scope:Link\"\n tokens = line.replace('addr:', '', 1).split() # remove \"addr:\" if it exists, then split\n found_address = None\n if \"inet\" in tokens:\n nxt = tokens.index(\"inet\") + 1\n found_address = ipaddress.ip_address(tokens[nxt])\n elif \"inet6\" in tokens:\n nxt = tokens.index(\"inet6\") + 1\n found_address = ipaddress.ip_address(tokens[nxt].split('/')[0])\n if found_address in target_network_range:\n ans['ip_address'] = six.text_type(found_address)\n break # we have located a good matching address\n except (IndexError, AttributeError, TypeError):\n pass # all syntax and type errors loop here\n # falling out if the loop leaves us remembering the last candidate\n log.info('Network IP address in %s detected as: %s',\n target_network_range, ans.get('ip_address', '(not found)'))\n\n if get_private_key:\n # retrieve the Vagrant private key from the host\n try:\n with salt.utils.files.fopen(ssh_config['IdentityFile']) as pks:\n ans['private_key'] = salt.utils.stringutils.to_unicode(pks.read())\n except (OSError, IOError) as e:\n raise CommandExecutionError(\"Error processing Vagrant private key file: {}\".format(e))\n return ans\n"}}},{"rowIdx":368,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/vagrant.py"},"func_name":{"kind":"string","value":"init"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def init(name, # Salt_id for created VM\n cwd=None, # path to find Vagrantfile\n machine='', # name of machine in Vagrantfile\n runas=None, # username who owns Vagrant box\n start=False, # start the machine when initialized\n vagrant_provider='', # vagrant provider (default=virtualbox)\n vm=None, # a dictionary of VM configuration settings\n ):\n '''\n Initialize a new Vagrant VM.\n\n This inputs all the information needed to start a Vagrant VM. These settings are stored in\n a Salt sdb database on the Vagrant host minion and used to start, control, and query the\n guest VMs. The salt_id assigned here is the key field for that database and must be unique.\n\n :param name: The salt_id name you will use to control this VM\n :param cwd: The path to the directory where the Vagrantfile is located\n :param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.\n :param runas: The username on the host who owns the Vagrant work files.\n :param start: (default: False) Start the virtual machine now.\n :param vagrant_provider: The name of a Vagrant VM provider (if not the default).\n :param vm: Optionally, all the above information may be supplied in this dictionary.\n :return: A string indicating success, or False.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.init <salt_id> /path/to/Vagrantfile\n salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1\n '''\n vm_ = {} if vm is None else vm.copy() # passed configuration data\n vm_['name'] = name\n # passed-in keyword arguments overwrite vm dictionary values\n vm_['cwd'] = cwd or vm_.get('cwd')\n if not vm_['cwd']:\n raise SaltInvocationError('Path to Vagrantfile must be defined by \"cwd\" argument')\n vm_['machine'] = machine or vm_.get('machine', machine)\n vm_['runas'] = runas or vm_.get('runas', runas)\n vm_['vagrant_provider'] = vagrant_provider or vm_.get('vagrant_provider', '')\n _update_vm_info(name, vm_)\n\n if start:\n log.debug('Starting VM %s', name)\n ret = _start(name, vm_)\n else:\n ret = 'Name {} defined using VM {}'.format(name, vm_['machine'] or '(default)')\n return ret"},"func_documentation_string":{"kind":"string","value":"Initialize a new Vagrant VM.\n\n This inputs all the information needed to start a Vagrant VM. These settings are stored in\n a Salt sdb database on the Vagrant host minion and used to start, control, and query the\n guest VMs. The salt_id assigned here is the key field for that database and must be unique.\n\n :param name: The salt_id name you will use to control this VM\n :param cwd: The path to the directory where the Vagrantfile is located\n :param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.\n :param runas: The username on the host who owns the Vagrant work files.\n :param start: (default: False) Start the virtual machine now.\n :param vagrant_provider: The name of a Vagrant VM provider (if not the default).\n :param vm: Optionally, all the above information may be supplied in this dictionary.\n :return: A string indicating success, or False.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.init <salt_id> /path/to/Vagrantfile\n salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L333-L380"},"called_functions":{"kind":"list like","value":["def _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider', '')\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\n cmd = 'vagrant up {} {}'.format(machine, provider_)\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\n\n if machine == '': # we were called using the default machine\n for line in ret['stdout'].split('\\n'): # find its actual Vagrant name\n if line.startswith('==>'):\n machine = line.split()[1].rstrip(':')\n vm_['machine'] = machine\n _update_vm_info(name, vm_) # and remember the true name\n break\n\n if ret['retcode'] == 0:\n return 'Started \"{}\" using Vagrant machine \"{}\".'.format(name, machine)\n return False\n","def _update_vm_info(name, vm_):\n ''' store the vm_ information keyed by name '''\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\n\n # store machine-to-name mapping, too\n if vm_['machine']:\n __utils__['sdb.sdb_set'](\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\n name,\n __opts__)\n"],"string":"[\n \"def _start(name, vm_): # internal call name, because \\\"start\\\" is a keyword argument to vagrant.init\\n\\n try:\\n machine = vm_['machine']\\n except KeyError:\\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\\n\\n vagrant_provider = vm_.get('vagrant_provider', '')\\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\\n cmd = 'vagrant up {} {}'.format(machine, provider_)\\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\\n\\n if machine == '': # we were called using the default machine\\n for line in ret['stdout'].split('\\\\n'): # find its actual Vagrant name\\n if line.startswith('==>'):\\n machine = line.split()[1].rstrip(':')\\n vm_['machine'] = machine\\n _update_vm_info(name, vm_) # and remember the true name\\n break\\n\\n if ret['retcode'] == 0:\\n return 'Started \\\"{}\\\" using Vagrant machine \\\"{}\\\".'.format(name, machine)\\n return False\\n\",\n \"def _update_vm_info(name, vm_):\\n ''' store the vm_ information keyed by name '''\\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\\n\\n # store machine-to-name mapping, too\\n if vm_['machine']:\\n __utils__['sdb.sdb_set'](\\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\\n name,\\n __opts__)\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nWork with virtual machines managed by Vagrant.\n\n.. versionadded:: 2018.3.0\n\nMapping between a Salt node id and the Vagrant machine name\n(and the path to the Vagrantfile where it is defined)\nis stored in a Salt sdb database on the Vagrant host (minion) machine.\nIn order to use this module, sdb must be configured. An SQLite\ndatabase is the recommended storage method. The URI used for\nthe sdb lookup is \"sdb://vagrant_sdb_data\".\n\nrequirements:\n - the VM host machine must have salt-minion, Vagrant and a vm provider installed.\n - the VM host must have a valid definition for `sdb://vagrant_sdb_data`\n\n Configuration example:\n\n .. code-block:: yaml\n\n # file /etc/salt/minion.d/vagrant_sdb.conf\n vagrant_sdb_data:\n driver: sqlite3\n database: /var/cache/salt/vagrant.sqlite\n table: sdb\n create_table: True\n\n'''\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\nimport os\n\n# Import salt libs\nimport salt.utils.files\nimport salt.utils.path\nimport salt.utils.stringutils\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\nimport salt.ext.six as six\nfrom salt._compat import ipaddress\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'vagrant'\n\nVAGRANT_SDB_URL = 'sdb://vagrant_sdb_data/'\n\n\ndef __virtual__():\n '''\n run Vagrant commands if possible\n '''\n if salt.utils.path.which('vagrant') is None:\n return False, 'The vagrant module could not be loaded: vagrant command not found'\n return __virtualname__\n\n\ndef _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n\n\ndef _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)\n\n\ndef _update_vm_info(name, vm_):\n ''' store the vm_ information keyed by name '''\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\n\n # store machine-to-name mapping, too\n if vm_['machine']:\n __utils__['sdb.sdb_set'](\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\n name,\n __opts__)\n\n\ndef get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n\n\ndef get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n\n\ndef _erase_vm_info(name):\n '''\n erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry.\n '''\n try:\n # delete the machine record\n vm_ = get_vm_info(name)\n if vm_['machine']:\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\n try:\n __utils__['sdb.sdb_delete'](key, __opts__)\n except KeyError:\n # no delete method found -- load a blank value\n __utils__['sdb.sdb_set'](key, None, __opts__)\n except Exception:\n pass\n\n uri = _build_sdb_uri(name)\n try:\n # delete the name record\n __utils__['sdb.sdb_delete'](uri, __opts__)\n except KeyError:\n # no delete method found -- load an empty dictionary\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\n except Exception:\n pass\n\n\ndef _vagrant_ssh_config(vm_):\n '''\n get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff\n '''\n machine = vm_['machine']\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\n cmd = 'vagrant ssh-config {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n ignore_retcode=True)\n ssh_config = {}\n for line in reply.split('\\n'): # build a dictionary of the text reply\n tokens = line.strip().split()\n if len(tokens) == 2: # each two-token line becomes a key:value pair\n ssh_config[tokens[0]] = tokens[1]\n log.debug('ssh_config=%s', repr(ssh_config))\n return ssh_config\n\n\ndef version():\n '''\n Return the version of Vagrant on the minion\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.version\n '''\n cmd = 'vagrant -v'\n return __salt__['cmd.shell'](cmd)\n\n\ndef list_domains():\n '''\n Return a list of the salt_id names of all available Vagrant VMs on\n this host without regard to the path where they are defined.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_domains --log-level=info\n\n The log shows information about all known Vagrant environments\n on this machine. This data is cached and may not be completely\n up-to-date.\n '''\n vms = []\n cmd = 'vagrant global-status'\n reply = __salt__['cmd.shell'](cmd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n try:\n _ = int(tokens[0], 16) # valid id numbers are hexadecimal\n except (ValueError, IndexError):\n continue # skip lines without valid id numbers\n machine = tokens[1]\n cwd = tokens[-1]\n name = get_machine_id(machine, cwd)\n if name:\n vms.append(name)\n return vms\n\n\ndef list_active_vms(cwd=None):\n '''\n Return a list of machine names for active virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_active_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1:\n if tokens[1] == 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef list_inactive_vms(cwd=None):\n '''\n Return a list of machine names for inactive virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' virt.list_inactive_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n if tokens[1] != 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef vm_state(name='', cwd=None):\n '''\n Return list of information for all the vms indicating their state.\n\n If you pass a VM name in as an argument then it will return info\n for just the named VM, otherwise it will return all VMs defined by\n the Vagrantfile in the `cwd` directory.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.vm_state <name> cwd=/projects/project_1\n\n returns a list of dictionaries with machine name, state, provider,\n and salt_id name.\n\n .. code-block:: python\n\n datum = {'machine': _, # Vagrant machine name,\n 'state': _, # string indicating machine state, like 'running'\n 'provider': _, # the Vagrant VM provider\n 'name': _} # salt_id name\n\n Known bug: if there are multiple machines in your Vagrantfile, and you request\n the status of the ``primary`` machine, which you defined by leaving the ``machine``\n parameter blank, then you may receive the status of all of them.\n Please specify the actual machine name for each VM if there are more than one.\n\n '''\n\n if name:\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n cwd = vm_['cwd'] or cwd # usually ignore passed-in cwd\n else:\n if not cwd:\n raise SaltInvocationError(\n 'Path to Vagranfile must be defined, but cwd={}'.format(cwd))\n machine = ''\n\n info = []\n cmd = 'vagrant status {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd, cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n try:\n datum = {'machine': tokens[0],\n 'state': ' '.join(tokens[1:-1]),\n 'provider': tokens[-1].lstrip('(').rstrip(')'),\n 'name': get_machine_id(tokens[0], cwd)\n }\n info.append(datum)\n except IndexError:\n pass\n return info\n\n\n\ndef start(name):\n '''\n Start (vagrant up) a virtual machine defined by salt_id name.\n The machine must have been previously defined using \"vagrant.init\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.start <salt_id>\n '''\n vm_ = get_vm_info(name)\n return _start(name, vm_)\n\n\ndef _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider', '')\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\n cmd = 'vagrant up {} {}'.format(machine, provider_)\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\n\n if machine == '': # we were called using the default machine\n for line in ret['stdout'].split('\\n'): # find its actual Vagrant name\n if line.startswith('==>'):\n machine = line.split()[1].rstrip(':')\n vm_['machine'] = machine\n _update_vm_info(name, vm_) # and remember the true name\n break\n\n if ret['retcode'] == 0:\n return 'Started \"{}\" using Vagrant machine \"{}\".'.format(name, machine)\n return False\n\n\ndef shutdown(name):\n '''\n Send a soft shutdown (vagrant halt) signal to the named vm.\n\n This does the same thing as vagrant.stop. Other-VM control\n modules use \"stop\" and \"shutdown\" to differentiate between\n hard and soft shutdowns.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.shutdown <salt_id>\n '''\n return stop(name)\n\n\ndef stop(name):\n '''\n Hard shutdown the virtual machine. (vagrant halt)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.stop <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant halt {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef pause(name):\n '''\n Pause (vagrant suspend) the named VM.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.pause <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant suspend {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef reboot(name, provision=False):\n '''\n Reboot a VM. (vagrant reload)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.reboot <salt_id> provision=True\n\n :param name: The salt_id name you will use to control this VM\n :param provision: (False) also re-run the Vagrant provisioning scripts.\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n prov = '--provision' if provision else ''\n\n cmd = 'vagrant reload {} {}'.format(machine, prov)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef destroy(name):\n '''\n Destroy and delete a virtual machine. (vagrant destroy -f)\n\n This also removes the salt_id name defined by vagrant.init.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.destroy <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant destroy -f {}'.format(machine)\n\n ret = __salt__['cmd.run_all'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n output_loglevel='info')\n if ret['retcode'] == 0:\n _erase_vm_info(name)\n return 'Destroyed VM {0}'.format(name)\n return False\n\n\ndef get_ssh_config(name, network_mask='', get_private_key=False):\n r'''\n Retrieve hints of how you might connect to a Vagrant VM.\n\n :param name: the salt_id of the machine\n :param network_mask: a CIDR mask to search for the VM's address\n :param get_private_key: (default: False) return the key used for ssh login\n :return: a dict of ssh login information for the VM\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.get_ssh_config <salt_id>\n salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True\n\n The returned dictionary contains:\n\n - key_filename: the name of the private key file on the VM host computer\n - ssh_username: the username to be used to log in to the VM\n - ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)\n - ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)\n - \\[ip_address:\\] (if `network_mask` is defined. see below)\n - \\[private_key:\\] (if `get_private_key` is True) the private key for ssh_username\n\n About `network_mask`:\n\n Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.\n This redirected port and its IP address are \"ssh_port\" and \"ssh_host\". The ssh_host is\n usually the localhost (127.0.0.1).\n This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM\n unless the VM has another network interface defined. You will usually want a bridged network\n defined by having a `config.vm.network \"public_network\"` statement in your `Vagrantfile`.\n\n The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,\n but you should be able to determine what IP network the address will be chosen from.\n If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.\n The host machine will send an \"ifconfig\" command to the VM (using ssh to `ssh_host`:`ssh_port`)\n and return the IP address of the first interface it can find which matches your mask.\n '''\n vm_ = get_vm_info(name)\n\n ssh_config = _vagrant_ssh_config(vm_)\n\n try:\n ans = {'key_filename': ssh_config['IdentityFile'],\n 'ssh_username': ssh_config['User'],\n 'ssh_host': ssh_config['HostName'],\n 'ssh_port': ssh_config['Port'],\n }\n\n except KeyError:\n raise CommandExecutionError(\n 'Insufficient SSH information to contact VM {}. '\n 'Is it running?'.format(vm_.get('machine', '(default)')))\n\n if network_mask:\n # ask the new VM to report its network address\n command = 'ssh -i {IdentityFile} -p {Port} ' \\\n '-oStrictHostKeyChecking={StrictHostKeyChecking} ' \\\n '-oUserKnownHostsFile={UserKnownHostsFile} ' \\\n '-oControlPath=none ' \\\n '{User}@{HostName} ifconfig'.format(**ssh_config)\n\n log.info(\n 'Trying ssh -p %s %s@%s ifconfig',\n ssh_config['Port'], ssh_config['User'], ssh_config['HostName']\n )\n reply = __salt__['cmd.shell'](command)\n log.info('--->\\n%s', reply)\n target_network_range = ipaddress.ip_network(network_mask, strict=False)\n\n for line in reply.split('\\n'):\n try: # try to find a bridged network address\n # the lines we are looking for appear like:\n # \"inet addr:10.124.31.185 Bcast:10.124.31.255 Mask:255.255.248.0\"\n # or \"inet6 addr: fe80::a00:27ff:fe04:7aac/64 Scope:Link\"\n tokens = line.replace('addr:', '', 1).split() # remove \"addr:\" if it exists, then split\n found_address = None\n if \"inet\" in tokens:\n nxt = tokens.index(\"inet\") + 1\n found_address = ipaddress.ip_address(tokens[nxt])\n elif \"inet6\" in tokens:\n nxt = tokens.index(\"inet6\") + 1\n found_address = ipaddress.ip_address(tokens[nxt].split('/')[0])\n if found_address in target_network_range:\n ans['ip_address'] = six.text_type(found_address)\n break # we have located a good matching address\n except (IndexError, AttributeError, TypeError):\n pass # all syntax and type errors loop here\n # falling out if the loop leaves us remembering the last candidate\n log.info('Network IP address in %s detected as: %s',\n target_network_range, ans.get('ip_address', '(not found)'))\n\n if get_private_key:\n # retrieve the Vagrant private key from the host\n try:\n with salt.utils.files.fopen(ssh_config['IdentityFile']) as pks:\n ans['private_key'] = salt.utils.stringutils.to_unicode(pks.read())\n except (OSError, IOError) as e:\n raise CommandExecutionError(\"Error processing Vagrant private key file: {}\".format(e))\n return ans\n"}}},{"rowIdx":369,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/vagrant.py"},"func_name":{"kind":"string","value":"stop"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def stop(name):\n '''\n Hard shutdown the virtual machine. (vagrant halt)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.stop <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant halt {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0"},"func_documentation_string":{"kind":"string","value":"Hard shutdown the virtual machine. (vagrant halt)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.stop <salt_id>"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L440-L457"},"called_functions":{"kind":"list like","value":["def get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n"],"string":"[\n \"def get_vm_info(name):\\n '''\\n get the information for a VM.\\n\\n :param name: salt_id name\\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\\n '''\\n try:\\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\\n except KeyError:\\n raise SaltInvocationError(\\n 'Probable sdb driver not found. Check your configuration.')\\n if vm_ is None or 'machine' not in vm_:\\n raise SaltInvocationError(\\n 'No Vagrant machine defined for Salt_id {}'.format(name))\\n return vm_\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nWork with virtual machines managed by Vagrant.\n\n.. versionadded:: 2018.3.0\n\nMapping between a Salt node id and the Vagrant machine name\n(and the path to the Vagrantfile where it is defined)\nis stored in a Salt sdb database on the Vagrant host (minion) machine.\nIn order to use this module, sdb must be configured. An SQLite\ndatabase is the recommended storage method. The URI used for\nthe sdb lookup is \"sdb://vagrant_sdb_data\".\n\nrequirements:\n - the VM host machine must have salt-minion, Vagrant and a vm provider installed.\n - the VM host must have a valid definition for `sdb://vagrant_sdb_data`\n\n Configuration example:\n\n .. code-block:: yaml\n\n # file /etc/salt/minion.d/vagrant_sdb.conf\n vagrant_sdb_data:\n driver: sqlite3\n database: /var/cache/salt/vagrant.sqlite\n table: sdb\n create_table: True\n\n'''\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\nimport os\n\n# Import salt libs\nimport salt.utils.files\nimport salt.utils.path\nimport salt.utils.stringutils\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\nimport salt.ext.six as six\nfrom salt._compat import ipaddress\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'vagrant'\n\nVAGRANT_SDB_URL = 'sdb://vagrant_sdb_data/'\n\n\ndef __virtual__():\n '''\n run Vagrant commands if possible\n '''\n if salt.utils.path.which('vagrant') is None:\n return False, 'The vagrant module could not be loaded: vagrant command not found'\n return __virtualname__\n\n\ndef _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n\n\ndef _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)\n\n\ndef _update_vm_info(name, vm_):\n ''' store the vm_ information keyed by name '''\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\n\n # store machine-to-name mapping, too\n if vm_['machine']:\n __utils__['sdb.sdb_set'](\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\n name,\n __opts__)\n\n\ndef get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n\n\ndef get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n\n\ndef _erase_vm_info(name):\n '''\n erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry.\n '''\n try:\n # delete the machine record\n vm_ = get_vm_info(name)\n if vm_['machine']:\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\n try:\n __utils__['sdb.sdb_delete'](key, __opts__)\n except KeyError:\n # no delete method found -- load a blank value\n __utils__['sdb.sdb_set'](key, None, __opts__)\n except Exception:\n pass\n\n uri = _build_sdb_uri(name)\n try:\n # delete the name record\n __utils__['sdb.sdb_delete'](uri, __opts__)\n except KeyError:\n # no delete method found -- load an empty dictionary\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\n except Exception:\n pass\n\n\ndef _vagrant_ssh_config(vm_):\n '''\n get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff\n '''\n machine = vm_['machine']\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\n cmd = 'vagrant ssh-config {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n ignore_retcode=True)\n ssh_config = {}\n for line in reply.split('\\n'): # build a dictionary of the text reply\n tokens = line.strip().split()\n if len(tokens) == 2: # each two-token line becomes a key:value pair\n ssh_config[tokens[0]] = tokens[1]\n log.debug('ssh_config=%s', repr(ssh_config))\n return ssh_config\n\n\ndef version():\n '''\n Return the version of Vagrant on the minion\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.version\n '''\n cmd = 'vagrant -v'\n return __salt__['cmd.shell'](cmd)\n\n\ndef list_domains():\n '''\n Return a list of the salt_id names of all available Vagrant VMs on\n this host without regard to the path where they are defined.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_domains --log-level=info\n\n The log shows information about all known Vagrant environments\n on this machine. This data is cached and may not be completely\n up-to-date.\n '''\n vms = []\n cmd = 'vagrant global-status'\n reply = __salt__['cmd.shell'](cmd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n try:\n _ = int(tokens[0], 16) # valid id numbers are hexadecimal\n except (ValueError, IndexError):\n continue # skip lines without valid id numbers\n machine = tokens[1]\n cwd = tokens[-1]\n name = get_machine_id(machine, cwd)\n if name:\n vms.append(name)\n return vms\n\n\ndef list_active_vms(cwd=None):\n '''\n Return a list of machine names for active virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_active_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1:\n if tokens[1] == 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef list_inactive_vms(cwd=None):\n '''\n Return a list of machine names for inactive virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' virt.list_inactive_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n if tokens[1] != 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef vm_state(name='', cwd=None):\n '''\n Return list of information for all the vms indicating their state.\n\n If you pass a VM name in as an argument then it will return info\n for just the named VM, otherwise it will return all VMs defined by\n the Vagrantfile in the `cwd` directory.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.vm_state <name> cwd=/projects/project_1\n\n returns a list of dictionaries with machine name, state, provider,\n and salt_id name.\n\n .. code-block:: python\n\n datum = {'machine': _, # Vagrant machine name,\n 'state': _, # string indicating machine state, like 'running'\n 'provider': _, # the Vagrant VM provider\n 'name': _} # salt_id name\n\n Known bug: if there are multiple machines in your Vagrantfile, and you request\n the status of the ``primary`` machine, which you defined by leaving the ``machine``\n parameter blank, then you may receive the status of all of them.\n Please specify the actual machine name for each VM if there are more than one.\n\n '''\n\n if name:\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n cwd = vm_['cwd'] or cwd # usually ignore passed-in cwd\n else:\n if not cwd:\n raise SaltInvocationError(\n 'Path to Vagranfile must be defined, but cwd={}'.format(cwd))\n machine = ''\n\n info = []\n cmd = 'vagrant status {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd, cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n try:\n datum = {'machine': tokens[0],\n 'state': ' '.join(tokens[1:-1]),\n 'provider': tokens[-1].lstrip('(').rstrip(')'),\n 'name': get_machine_id(tokens[0], cwd)\n }\n info.append(datum)\n except IndexError:\n pass\n return info\n\n\ndef init(name, # Salt_id for created VM\n cwd=None, # path to find Vagrantfile\n machine='', # name of machine in Vagrantfile\n runas=None, # username who owns Vagrant box\n start=False, # start the machine when initialized\n vagrant_provider='', # vagrant provider (default=virtualbox)\n vm=None, # a dictionary of VM configuration settings\n ):\n '''\n Initialize a new Vagrant VM.\n\n This inputs all the information needed to start a Vagrant VM. These settings are stored in\n a Salt sdb database on the Vagrant host minion and used to start, control, and query the\n guest VMs. The salt_id assigned here is the key field for that database and must be unique.\n\n :param name: The salt_id name you will use to control this VM\n :param cwd: The path to the directory where the Vagrantfile is located\n :param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.\n :param runas: The username on the host who owns the Vagrant work files.\n :param start: (default: False) Start the virtual machine now.\n :param vagrant_provider: The name of a Vagrant VM provider (if not the default).\n :param vm: Optionally, all the above information may be supplied in this dictionary.\n :return: A string indicating success, or False.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.init <salt_id> /path/to/Vagrantfile\n salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1\n '''\n vm_ = {} if vm is None else vm.copy() # passed configuration data\n vm_['name'] = name\n # passed-in keyword arguments overwrite vm dictionary values\n vm_['cwd'] = cwd or vm_.get('cwd')\n if not vm_['cwd']:\n raise SaltInvocationError('Path to Vagrantfile must be defined by \"cwd\" argument')\n vm_['machine'] = machine or vm_.get('machine', machine)\n vm_['runas'] = runas or vm_.get('runas', runas)\n vm_['vagrant_provider'] = vagrant_provider or vm_.get('vagrant_provider', '')\n _update_vm_info(name, vm_)\n\n if start:\n log.debug('Starting VM %s', name)\n ret = _start(name, vm_)\n else:\n ret = 'Name {} defined using VM {}'.format(name, vm_['machine'] or '(default)')\n return ret\n\n\ndef start(name):\n '''\n Start (vagrant up) a virtual machine defined by salt_id name.\n The machine must have been previously defined using \"vagrant.init\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.start <salt_id>\n '''\n vm_ = get_vm_info(name)\n return _start(name, vm_)\n\n\ndef _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider', '')\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\n cmd = 'vagrant up {} {}'.format(machine, provider_)\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\n\n if machine == '': # we were called using the default machine\n for line in ret['stdout'].split('\\n'): # find its actual Vagrant name\n if line.startswith('==>'):\n machine = line.split()[1].rstrip(':')\n vm_['machine'] = machine\n _update_vm_info(name, vm_) # and remember the true name\n break\n\n if ret['retcode'] == 0:\n return 'Started \"{}\" using Vagrant machine \"{}\".'.format(name, machine)\n return False\n\n\ndef shutdown(name):\n '''\n Send a soft shutdown (vagrant halt) signal to the named vm.\n\n This does the same thing as vagrant.stop. Other-VM control\n modules use \"stop\" and \"shutdown\" to differentiate between\n hard and soft shutdowns.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.shutdown <salt_id>\n '''\n return stop(name)\n\n\n\ndef pause(name):\n '''\n Pause (vagrant suspend) the named VM.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.pause <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant suspend {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef reboot(name, provision=False):\n '''\n Reboot a VM. (vagrant reload)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.reboot <salt_id> provision=True\n\n :param name: The salt_id name you will use to control this VM\n :param provision: (False) also re-run the Vagrant provisioning scripts.\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n prov = '--provision' if provision else ''\n\n cmd = 'vagrant reload {} {}'.format(machine, prov)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef destroy(name):\n '''\n Destroy and delete a virtual machine. (vagrant destroy -f)\n\n This also removes the salt_id name defined by vagrant.init.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.destroy <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant destroy -f {}'.format(machine)\n\n ret = __salt__['cmd.run_all'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n output_loglevel='info')\n if ret['retcode'] == 0:\n _erase_vm_info(name)\n return 'Destroyed VM {0}'.format(name)\n return False\n\n\ndef get_ssh_config(name, network_mask='', get_private_key=False):\n r'''\n Retrieve hints of how you might connect to a Vagrant VM.\n\n :param name: the salt_id of the machine\n :param network_mask: a CIDR mask to search for the VM's address\n :param get_private_key: (default: False) return the key used for ssh login\n :return: a dict of ssh login information for the VM\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.get_ssh_config <salt_id>\n salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True\n\n The returned dictionary contains:\n\n - key_filename: the name of the private key file on the VM host computer\n - ssh_username: the username to be used to log in to the VM\n - ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)\n - ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)\n - \\[ip_address:\\] (if `network_mask` is defined. see below)\n - \\[private_key:\\] (if `get_private_key` is True) the private key for ssh_username\n\n About `network_mask`:\n\n Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.\n This redirected port and its IP address are \"ssh_port\" and \"ssh_host\". The ssh_host is\n usually the localhost (127.0.0.1).\n This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM\n unless the VM has another network interface defined. You will usually want a bridged network\n defined by having a `config.vm.network \"public_network\"` statement in your `Vagrantfile`.\n\n The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,\n but you should be able to determine what IP network the address will be chosen from.\n If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.\n The host machine will send an \"ifconfig\" command to the VM (using ssh to `ssh_host`:`ssh_port`)\n and return the IP address of the first interface it can find which matches your mask.\n '''\n vm_ = get_vm_info(name)\n\n ssh_config = _vagrant_ssh_config(vm_)\n\n try:\n ans = {'key_filename': ssh_config['IdentityFile'],\n 'ssh_username': ssh_config['User'],\n 'ssh_host': ssh_config['HostName'],\n 'ssh_port': ssh_config['Port'],\n }\n\n except KeyError:\n raise CommandExecutionError(\n 'Insufficient SSH information to contact VM {}. '\n 'Is it running?'.format(vm_.get('machine', '(default)')))\n\n if network_mask:\n # ask the new VM to report its network address\n command = 'ssh -i {IdentityFile} -p {Port} ' \\\n '-oStrictHostKeyChecking={StrictHostKeyChecking} ' \\\n '-oUserKnownHostsFile={UserKnownHostsFile} ' \\\n '-oControlPath=none ' \\\n '{User}@{HostName} ifconfig'.format(**ssh_config)\n\n log.info(\n 'Trying ssh -p %s %s@%s ifconfig',\n ssh_config['Port'], ssh_config['User'], ssh_config['HostName']\n )\n reply = __salt__['cmd.shell'](command)\n log.info('--->\\n%s', reply)\n target_network_range = ipaddress.ip_network(network_mask, strict=False)\n\n for line in reply.split('\\n'):\n try: # try to find a bridged network address\n # the lines we are looking for appear like:\n # \"inet addr:10.124.31.185 Bcast:10.124.31.255 Mask:255.255.248.0\"\n # or \"inet6 addr: fe80::a00:27ff:fe04:7aac/64 Scope:Link\"\n tokens = line.replace('addr:', '', 1).split() # remove \"addr:\" if it exists, then split\n found_address = None\n if \"inet\" in tokens:\n nxt = tokens.index(\"inet\") + 1\n found_address = ipaddress.ip_address(tokens[nxt])\n elif \"inet6\" in tokens:\n nxt = tokens.index(\"inet6\") + 1\n found_address = ipaddress.ip_address(tokens[nxt].split('/')[0])\n if found_address in target_network_range:\n ans['ip_address'] = six.text_type(found_address)\n break # we have located a good matching address\n except (IndexError, AttributeError, TypeError):\n pass # all syntax and type errors loop here\n # falling out if the loop leaves us remembering the last candidate\n log.info('Network IP address in %s detected as: %s',\n target_network_range, ans.get('ip_address', '(not found)'))\n\n if get_private_key:\n # retrieve the Vagrant private key from the host\n try:\n with salt.utils.files.fopen(ssh_config['IdentityFile']) as pks:\n ans['private_key'] = salt.utils.stringutils.to_unicode(pks.read())\n except (OSError, IOError) as e:\n raise CommandExecutionError(\"Error processing Vagrant private key file: {}\".format(e))\n return ans\n"}}},{"rowIdx":370,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/vagrant.py"},"func_name":{"kind":"string","value":"reboot"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def reboot(name, provision=False):\n '''\n Reboot a VM. (vagrant reload)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.reboot <salt_id> provision=True\n\n :param name: The salt_id name you will use to control this VM\n :param provision: (False) also re-run the Vagrant provisioning scripts.\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n prov = '--provision' if provision else ''\n\n cmd = 'vagrant reload {} {}'.format(machine, prov)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0"},"func_documentation_string":{"kind":"string","value":"Reboot a VM. (vagrant reload)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.reboot <salt_id> provision=True\n\n :param name: The salt_id name you will use to control this VM\n :param provision: (False) also re-run the Vagrant provisioning scripts."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L480-L501"},"called_functions":{"kind":"list like","value":["def get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n"],"string":"[\n \"def get_vm_info(name):\\n '''\\n get the information for a VM.\\n\\n :param name: salt_id name\\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\\n '''\\n try:\\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\\n except KeyError:\\n raise SaltInvocationError(\\n 'Probable sdb driver not found. Check your configuration.')\\n if vm_ is None or 'machine' not in vm_:\\n raise SaltInvocationError(\\n 'No Vagrant machine defined for Salt_id {}'.format(name))\\n return vm_\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nWork with virtual machines managed by Vagrant.\n\n.. versionadded:: 2018.3.0\n\nMapping between a Salt node id and the Vagrant machine name\n(and the path to the Vagrantfile where it is defined)\nis stored in a Salt sdb database on the Vagrant host (minion) machine.\nIn order to use this module, sdb must be configured. An SQLite\ndatabase is the recommended storage method. The URI used for\nthe sdb lookup is \"sdb://vagrant_sdb_data\".\n\nrequirements:\n - the VM host machine must have salt-minion, Vagrant and a vm provider installed.\n - the VM host must have a valid definition for `sdb://vagrant_sdb_data`\n\n Configuration example:\n\n .. code-block:: yaml\n\n # file /etc/salt/minion.d/vagrant_sdb.conf\n vagrant_sdb_data:\n driver: sqlite3\n database: /var/cache/salt/vagrant.sqlite\n table: sdb\n create_table: True\n\n'''\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\nimport os\n\n# Import salt libs\nimport salt.utils.files\nimport salt.utils.path\nimport salt.utils.stringutils\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\nimport salt.ext.six as six\nfrom salt._compat import ipaddress\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'vagrant'\n\nVAGRANT_SDB_URL = 'sdb://vagrant_sdb_data/'\n\n\ndef __virtual__():\n '''\n run Vagrant commands if possible\n '''\n if salt.utils.path.which('vagrant') is None:\n return False, 'The vagrant module could not be loaded: vagrant command not found'\n return __virtualname__\n\n\ndef _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n\n\ndef _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)\n\n\ndef _update_vm_info(name, vm_):\n ''' store the vm_ information keyed by name '''\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\n\n # store machine-to-name mapping, too\n if vm_['machine']:\n __utils__['sdb.sdb_set'](\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\n name,\n __opts__)\n\n\ndef get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n\n\ndef get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n\n\ndef _erase_vm_info(name):\n '''\n erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry.\n '''\n try:\n # delete the machine record\n vm_ = get_vm_info(name)\n if vm_['machine']:\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\n try:\n __utils__['sdb.sdb_delete'](key, __opts__)\n except KeyError:\n # no delete method found -- load a blank value\n __utils__['sdb.sdb_set'](key, None, __opts__)\n except Exception:\n pass\n\n uri = _build_sdb_uri(name)\n try:\n # delete the name record\n __utils__['sdb.sdb_delete'](uri, __opts__)\n except KeyError:\n # no delete method found -- load an empty dictionary\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\n except Exception:\n pass\n\n\ndef _vagrant_ssh_config(vm_):\n '''\n get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff\n '''\n machine = vm_['machine']\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\n cmd = 'vagrant ssh-config {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n ignore_retcode=True)\n ssh_config = {}\n for line in reply.split('\\n'): # build a dictionary of the text reply\n tokens = line.strip().split()\n if len(tokens) == 2: # each two-token line becomes a key:value pair\n ssh_config[tokens[0]] = tokens[1]\n log.debug('ssh_config=%s', repr(ssh_config))\n return ssh_config\n\n\ndef version():\n '''\n Return the version of Vagrant on the minion\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.version\n '''\n cmd = 'vagrant -v'\n return __salt__['cmd.shell'](cmd)\n\n\ndef list_domains():\n '''\n Return a list of the salt_id names of all available Vagrant VMs on\n this host without regard to the path where they are defined.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_domains --log-level=info\n\n The log shows information about all known Vagrant environments\n on this machine. This data is cached and may not be completely\n up-to-date.\n '''\n vms = []\n cmd = 'vagrant global-status'\n reply = __salt__['cmd.shell'](cmd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n try:\n _ = int(tokens[0], 16) # valid id numbers are hexadecimal\n except (ValueError, IndexError):\n continue # skip lines without valid id numbers\n machine = tokens[1]\n cwd = tokens[-1]\n name = get_machine_id(machine, cwd)\n if name:\n vms.append(name)\n return vms\n\n\ndef list_active_vms(cwd=None):\n '''\n Return a list of machine names for active virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_active_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1:\n if tokens[1] == 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef list_inactive_vms(cwd=None):\n '''\n Return a list of machine names for inactive virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' virt.list_inactive_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n if tokens[1] != 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef vm_state(name='', cwd=None):\n '''\n Return list of information for all the vms indicating their state.\n\n If you pass a VM name in as an argument then it will return info\n for just the named VM, otherwise it will return all VMs defined by\n the Vagrantfile in the `cwd` directory.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.vm_state <name> cwd=/projects/project_1\n\n returns a list of dictionaries with machine name, state, provider,\n and salt_id name.\n\n .. code-block:: python\n\n datum = {'machine': _, # Vagrant machine name,\n 'state': _, # string indicating machine state, like 'running'\n 'provider': _, # the Vagrant VM provider\n 'name': _} # salt_id name\n\n Known bug: if there are multiple machines in your Vagrantfile, and you request\n the status of the ``primary`` machine, which you defined by leaving the ``machine``\n parameter blank, then you may receive the status of all of them.\n Please specify the actual machine name for each VM if there are more than one.\n\n '''\n\n if name:\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n cwd = vm_['cwd'] or cwd # usually ignore passed-in cwd\n else:\n if not cwd:\n raise SaltInvocationError(\n 'Path to Vagranfile must be defined, but cwd={}'.format(cwd))\n machine = ''\n\n info = []\n cmd = 'vagrant status {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd, cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n try:\n datum = {'machine': tokens[0],\n 'state': ' '.join(tokens[1:-1]),\n 'provider': tokens[-1].lstrip('(').rstrip(')'),\n 'name': get_machine_id(tokens[0], cwd)\n }\n info.append(datum)\n except IndexError:\n pass\n return info\n\n\ndef init(name, # Salt_id for created VM\n cwd=None, # path to find Vagrantfile\n machine='', # name of machine in Vagrantfile\n runas=None, # username who owns Vagrant box\n start=False, # start the machine when initialized\n vagrant_provider='', # vagrant provider (default=virtualbox)\n vm=None, # a dictionary of VM configuration settings\n ):\n '''\n Initialize a new Vagrant VM.\n\n This inputs all the information needed to start a Vagrant VM. These settings are stored in\n a Salt sdb database on the Vagrant host minion and used to start, control, and query the\n guest VMs. The salt_id assigned here is the key field for that database and must be unique.\n\n :param name: The salt_id name you will use to control this VM\n :param cwd: The path to the directory where the Vagrantfile is located\n :param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.\n :param runas: The username on the host who owns the Vagrant work files.\n :param start: (default: False) Start the virtual machine now.\n :param vagrant_provider: The name of a Vagrant VM provider (if not the default).\n :param vm: Optionally, all the above information may be supplied in this dictionary.\n :return: A string indicating success, or False.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.init <salt_id> /path/to/Vagrantfile\n salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1\n '''\n vm_ = {} if vm is None else vm.copy() # passed configuration data\n vm_['name'] = name\n # passed-in keyword arguments overwrite vm dictionary values\n vm_['cwd'] = cwd or vm_.get('cwd')\n if not vm_['cwd']:\n raise SaltInvocationError('Path to Vagrantfile must be defined by \"cwd\" argument')\n vm_['machine'] = machine or vm_.get('machine', machine)\n vm_['runas'] = runas or vm_.get('runas', runas)\n vm_['vagrant_provider'] = vagrant_provider or vm_.get('vagrant_provider', '')\n _update_vm_info(name, vm_)\n\n if start:\n log.debug('Starting VM %s', name)\n ret = _start(name, vm_)\n else:\n ret = 'Name {} defined using VM {}'.format(name, vm_['machine'] or '(default)')\n return ret\n\n\ndef start(name):\n '''\n Start (vagrant up) a virtual machine defined by salt_id name.\n The machine must have been previously defined using \"vagrant.init\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.start <salt_id>\n '''\n vm_ = get_vm_info(name)\n return _start(name, vm_)\n\n\ndef _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider', '')\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\n cmd = 'vagrant up {} {}'.format(machine, provider_)\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\n\n if machine == '': # we were called using the default machine\n for line in ret['stdout'].split('\\n'): # find its actual Vagrant name\n if line.startswith('==>'):\n machine = line.split()[1].rstrip(':')\n vm_['machine'] = machine\n _update_vm_info(name, vm_) # and remember the true name\n break\n\n if ret['retcode'] == 0:\n return 'Started \"{}\" using Vagrant machine \"{}\".'.format(name, machine)\n return False\n\n\ndef shutdown(name):\n '''\n Send a soft shutdown (vagrant halt) signal to the named vm.\n\n This does the same thing as vagrant.stop. Other-VM control\n modules use \"stop\" and \"shutdown\" to differentiate between\n hard and soft shutdowns.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.shutdown <salt_id>\n '''\n return stop(name)\n\n\ndef stop(name):\n '''\n Hard shutdown the virtual machine. (vagrant halt)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.stop <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant halt {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef pause(name):\n '''\n Pause (vagrant suspend) the named VM.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.pause <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant suspend {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\n\ndef destroy(name):\n '''\n Destroy and delete a virtual machine. (vagrant destroy -f)\n\n This also removes the salt_id name defined by vagrant.init.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.destroy <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant destroy -f {}'.format(machine)\n\n ret = __salt__['cmd.run_all'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n output_loglevel='info')\n if ret['retcode'] == 0:\n _erase_vm_info(name)\n return 'Destroyed VM {0}'.format(name)\n return False\n\n\ndef get_ssh_config(name, network_mask='', get_private_key=False):\n r'''\n Retrieve hints of how you might connect to a Vagrant VM.\n\n :param name: the salt_id of the machine\n :param network_mask: a CIDR mask to search for the VM's address\n :param get_private_key: (default: False) return the key used for ssh login\n :return: a dict of ssh login information for the VM\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.get_ssh_config <salt_id>\n salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True\n\n The returned dictionary contains:\n\n - key_filename: the name of the private key file on the VM host computer\n - ssh_username: the username to be used to log in to the VM\n - ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)\n - ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)\n - \\[ip_address:\\] (if `network_mask` is defined. see below)\n - \\[private_key:\\] (if `get_private_key` is True) the private key for ssh_username\n\n About `network_mask`:\n\n Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.\n This redirected port and its IP address are \"ssh_port\" and \"ssh_host\". The ssh_host is\n usually the localhost (127.0.0.1).\n This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM\n unless the VM has another network interface defined. You will usually want a bridged network\n defined by having a `config.vm.network \"public_network\"` statement in your `Vagrantfile`.\n\n The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,\n but you should be able to determine what IP network the address will be chosen from.\n If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.\n The host machine will send an \"ifconfig\" command to the VM (using ssh to `ssh_host`:`ssh_port`)\n and return the IP address of the first interface it can find which matches your mask.\n '''\n vm_ = get_vm_info(name)\n\n ssh_config = _vagrant_ssh_config(vm_)\n\n try:\n ans = {'key_filename': ssh_config['IdentityFile'],\n 'ssh_username': ssh_config['User'],\n 'ssh_host': ssh_config['HostName'],\n 'ssh_port': ssh_config['Port'],\n }\n\n except KeyError:\n raise CommandExecutionError(\n 'Insufficient SSH information to contact VM {}. '\n 'Is it running?'.format(vm_.get('machine', '(default)')))\n\n if network_mask:\n # ask the new VM to report its network address\n command = 'ssh -i {IdentityFile} -p {Port} ' \\\n '-oStrictHostKeyChecking={StrictHostKeyChecking} ' \\\n '-oUserKnownHostsFile={UserKnownHostsFile} ' \\\n '-oControlPath=none ' \\\n '{User}@{HostName} ifconfig'.format(**ssh_config)\n\n log.info(\n 'Trying ssh -p %s %s@%s ifconfig',\n ssh_config['Port'], ssh_config['User'], ssh_config['HostName']\n )\n reply = __salt__['cmd.shell'](command)\n log.info('--->\\n%s', reply)\n target_network_range = ipaddress.ip_network(network_mask, strict=False)\n\n for line in reply.split('\\n'):\n try: # try to find a bridged network address\n # the lines we are looking for appear like:\n # \"inet addr:10.124.31.185 Bcast:10.124.31.255 Mask:255.255.248.0\"\n # or \"inet6 addr: fe80::a00:27ff:fe04:7aac/64 Scope:Link\"\n tokens = line.replace('addr:', '', 1).split() # remove \"addr:\" if it exists, then split\n found_address = None\n if \"inet\" in tokens:\n nxt = tokens.index(\"inet\") + 1\n found_address = ipaddress.ip_address(tokens[nxt])\n elif \"inet6\" in tokens:\n nxt = tokens.index(\"inet6\") + 1\n found_address = ipaddress.ip_address(tokens[nxt].split('/')[0])\n if found_address in target_network_range:\n ans['ip_address'] = six.text_type(found_address)\n break # we have located a good matching address\n except (IndexError, AttributeError, TypeError):\n pass # all syntax and type errors loop here\n # falling out if the loop leaves us remembering the last candidate\n log.info('Network IP address in %s detected as: %s',\n target_network_range, ans.get('ip_address', '(not found)'))\n\n if get_private_key:\n # retrieve the Vagrant private key from the host\n try:\n with salt.utils.files.fopen(ssh_config['IdentityFile']) as pks:\n ans['private_key'] = salt.utils.stringutils.to_unicode(pks.read())\n except (OSError, IOError) as e:\n raise CommandExecutionError(\"Error processing Vagrant private key file: {}\".format(e))\n return ans\n"}}},{"rowIdx":371,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/vagrant.py"},"func_name":{"kind":"string","value":"destroy"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def destroy(name):\n '''\n Destroy and delete a virtual machine. (vagrant destroy -f)\n\n This also removes the salt_id name defined by vagrant.init.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.destroy <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant destroy -f {}'.format(machine)\n\n ret = __salt__['cmd.run_all'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n output_loglevel='info')\n if ret['retcode'] == 0:\n _erase_vm_info(name)\n return 'Destroyed VM {0}'.format(name)\n return False"},"func_documentation_string":{"kind":"string","value":"Destroy and delete a virtual machine. (vagrant destroy -f)\n\n This also removes the salt_id name defined by vagrant.init.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.destroy <salt_id>"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L504-L528"},"called_functions":{"kind":"list like","value":["def get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n","def _erase_vm_info(name):\n '''\n erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry.\n '''\n try:\n # delete the machine record\n vm_ = get_vm_info(name)\n if vm_['machine']:\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\n try:\n __utils__['sdb.sdb_delete'](key, __opts__)\n except KeyError:\n # no delete method found -- load a blank value\n __utils__['sdb.sdb_set'](key, None, __opts__)\n except Exception:\n pass\n\n uri = _build_sdb_uri(name)\n try:\n # delete the name record\n __utils__['sdb.sdb_delete'](uri, __opts__)\n except KeyError:\n # no delete method found -- load an empty dictionary\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\n except Exception:\n pass\n"],"string":"[\n \"def get_vm_info(name):\\n '''\\n get the information for a VM.\\n\\n :param name: salt_id name\\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\\n '''\\n try:\\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\\n except KeyError:\\n raise SaltInvocationError(\\n 'Probable sdb driver not found. Check your configuration.')\\n if vm_ is None or 'machine' not in vm_:\\n raise SaltInvocationError(\\n 'No Vagrant machine defined for Salt_id {}'.format(name))\\n return vm_\\n\",\n \"def _erase_vm_info(name):\\n '''\\n erase the information for a VM the we are destroying.\\n\\n some sdb drivers (such as the SQLite driver we expect to use)\\n do not have a `delete` method, so if the delete fails, we have\\n to replace the with a blank entry.\\n '''\\n try:\\n # delete the machine record\\n vm_ = get_vm_info(name)\\n if vm_['machine']:\\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\\n try:\\n __utils__['sdb.sdb_delete'](key, __opts__)\\n except KeyError:\\n # no delete method found -- load a blank value\\n __utils__['sdb.sdb_set'](key, None, __opts__)\\n except Exception:\\n pass\\n\\n uri = _build_sdb_uri(name)\\n try:\\n # delete the name record\\n __utils__['sdb.sdb_delete'](uri, __opts__)\\n except KeyError:\\n # no delete method found -- load an empty dictionary\\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\\n except Exception:\\n pass\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nWork with virtual machines managed by Vagrant.\n\n.. versionadded:: 2018.3.0\n\nMapping between a Salt node id and the Vagrant machine name\n(and the path to the Vagrantfile where it is defined)\nis stored in a Salt sdb database on the Vagrant host (minion) machine.\nIn order to use this module, sdb must be configured. An SQLite\ndatabase is the recommended storage method. The URI used for\nthe sdb lookup is \"sdb://vagrant_sdb_data\".\n\nrequirements:\n - the VM host machine must have salt-minion, Vagrant and a vm provider installed.\n - the VM host must have a valid definition for `sdb://vagrant_sdb_data`\n\n Configuration example:\n\n .. code-block:: yaml\n\n # file /etc/salt/minion.d/vagrant_sdb.conf\n vagrant_sdb_data:\n driver: sqlite3\n database: /var/cache/salt/vagrant.sqlite\n table: sdb\n create_table: True\n\n'''\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\nimport os\n\n# Import salt libs\nimport salt.utils.files\nimport salt.utils.path\nimport salt.utils.stringutils\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\nimport salt.ext.six as six\nfrom salt._compat import ipaddress\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'vagrant'\n\nVAGRANT_SDB_URL = 'sdb://vagrant_sdb_data/'\n\n\ndef __virtual__():\n '''\n run Vagrant commands if possible\n '''\n if salt.utils.path.which('vagrant') is None:\n return False, 'The vagrant module could not be loaded: vagrant command not found'\n return __virtualname__\n\n\ndef _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n\n\ndef _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)\n\n\ndef _update_vm_info(name, vm_):\n ''' store the vm_ information keyed by name '''\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\n\n # store machine-to-name mapping, too\n if vm_['machine']:\n __utils__['sdb.sdb_set'](\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\n name,\n __opts__)\n\n\ndef get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n\n\ndef get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n\n\ndef _erase_vm_info(name):\n '''\n erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry.\n '''\n try:\n # delete the machine record\n vm_ = get_vm_info(name)\n if vm_['machine']:\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\n try:\n __utils__['sdb.sdb_delete'](key, __opts__)\n except KeyError:\n # no delete method found -- load a blank value\n __utils__['sdb.sdb_set'](key, None, __opts__)\n except Exception:\n pass\n\n uri = _build_sdb_uri(name)\n try:\n # delete the name record\n __utils__['sdb.sdb_delete'](uri, __opts__)\n except KeyError:\n # no delete method found -- load an empty dictionary\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\n except Exception:\n pass\n\n\ndef _vagrant_ssh_config(vm_):\n '''\n get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff\n '''\n machine = vm_['machine']\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\n cmd = 'vagrant ssh-config {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n ignore_retcode=True)\n ssh_config = {}\n for line in reply.split('\\n'): # build a dictionary of the text reply\n tokens = line.strip().split()\n if len(tokens) == 2: # each two-token line becomes a key:value pair\n ssh_config[tokens[0]] = tokens[1]\n log.debug('ssh_config=%s', repr(ssh_config))\n return ssh_config\n\n\ndef version():\n '''\n Return the version of Vagrant on the minion\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.version\n '''\n cmd = 'vagrant -v'\n return __salt__['cmd.shell'](cmd)\n\n\ndef list_domains():\n '''\n Return a list of the salt_id names of all available Vagrant VMs on\n this host without regard to the path where they are defined.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_domains --log-level=info\n\n The log shows information about all known Vagrant environments\n on this machine. This data is cached and may not be completely\n up-to-date.\n '''\n vms = []\n cmd = 'vagrant global-status'\n reply = __salt__['cmd.shell'](cmd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n try:\n _ = int(tokens[0], 16) # valid id numbers are hexadecimal\n except (ValueError, IndexError):\n continue # skip lines without valid id numbers\n machine = tokens[1]\n cwd = tokens[-1]\n name = get_machine_id(machine, cwd)\n if name:\n vms.append(name)\n return vms\n\n\ndef list_active_vms(cwd=None):\n '''\n Return a list of machine names for active virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_active_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1:\n if tokens[1] == 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef list_inactive_vms(cwd=None):\n '''\n Return a list of machine names for inactive virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' virt.list_inactive_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n if tokens[1] != 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef vm_state(name='', cwd=None):\n '''\n Return list of information for all the vms indicating their state.\n\n If you pass a VM name in as an argument then it will return info\n for just the named VM, otherwise it will return all VMs defined by\n the Vagrantfile in the `cwd` directory.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.vm_state <name> cwd=/projects/project_1\n\n returns a list of dictionaries with machine name, state, provider,\n and salt_id name.\n\n .. code-block:: python\n\n datum = {'machine': _, # Vagrant machine name,\n 'state': _, # string indicating machine state, like 'running'\n 'provider': _, # the Vagrant VM provider\n 'name': _} # salt_id name\n\n Known bug: if there are multiple machines in your Vagrantfile, and you request\n the status of the ``primary`` machine, which you defined by leaving the ``machine``\n parameter blank, then you may receive the status of all of them.\n Please specify the actual machine name for each VM if there are more than one.\n\n '''\n\n if name:\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n cwd = vm_['cwd'] or cwd # usually ignore passed-in cwd\n else:\n if not cwd:\n raise SaltInvocationError(\n 'Path to Vagranfile must be defined, but cwd={}'.format(cwd))\n machine = ''\n\n info = []\n cmd = 'vagrant status {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd, cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n try:\n datum = {'machine': tokens[0],\n 'state': ' '.join(tokens[1:-1]),\n 'provider': tokens[-1].lstrip('(').rstrip(')'),\n 'name': get_machine_id(tokens[0], cwd)\n }\n info.append(datum)\n except IndexError:\n pass\n return info\n\n\ndef init(name, # Salt_id for created VM\n cwd=None, # path to find Vagrantfile\n machine='', # name of machine in Vagrantfile\n runas=None, # username who owns Vagrant box\n start=False, # start the machine when initialized\n vagrant_provider='', # vagrant provider (default=virtualbox)\n vm=None, # a dictionary of VM configuration settings\n ):\n '''\n Initialize a new Vagrant VM.\n\n This inputs all the information needed to start a Vagrant VM. These settings are stored in\n a Salt sdb database on the Vagrant host minion and used to start, control, and query the\n guest VMs. The salt_id assigned here is the key field for that database and must be unique.\n\n :param name: The salt_id name you will use to control this VM\n :param cwd: The path to the directory where the Vagrantfile is located\n :param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.\n :param runas: The username on the host who owns the Vagrant work files.\n :param start: (default: False) Start the virtual machine now.\n :param vagrant_provider: The name of a Vagrant VM provider (if not the default).\n :param vm: Optionally, all the above information may be supplied in this dictionary.\n :return: A string indicating success, or False.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.init <salt_id> /path/to/Vagrantfile\n salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1\n '''\n vm_ = {} if vm is None else vm.copy() # passed configuration data\n vm_['name'] = name\n # passed-in keyword arguments overwrite vm dictionary values\n vm_['cwd'] = cwd or vm_.get('cwd')\n if not vm_['cwd']:\n raise SaltInvocationError('Path to Vagrantfile must be defined by \"cwd\" argument')\n vm_['machine'] = machine or vm_.get('machine', machine)\n vm_['runas'] = runas or vm_.get('runas', runas)\n vm_['vagrant_provider'] = vagrant_provider or vm_.get('vagrant_provider', '')\n _update_vm_info(name, vm_)\n\n if start:\n log.debug('Starting VM %s', name)\n ret = _start(name, vm_)\n else:\n ret = 'Name {} defined using VM {}'.format(name, vm_['machine'] or '(default)')\n return ret\n\n\ndef start(name):\n '''\n Start (vagrant up) a virtual machine defined by salt_id name.\n The machine must have been previously defined using \"vagrant.init\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.start <salt_id>\n '''\n vm_ = get_vm_info(name)\n return _start(name, vm_)\n\n\ndef _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider', '')\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\n cmd = 'vagrant up {} {}'.format(machine, provider_)\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\n\n if machine == '': # we were called using the default machine\n for line in ret['stdout'].split('\\n'): # find its actual Vagrant name\n if line.startswith('==>'):\n machine = line.split()[1].rstrip(':')\n vm_['machine'] = machine\n _update_vm_info(name, vm_) # and remember the true name\n break\n\n if ret['retcode'] == 0:\n return 'Started \"{}\" using Vagrant machine \"{}\".'.format(name, machine)\n return False\n\n\ndef shutdown(name):\n '''\n Send a soft shutdown (vagrant halt) signal to the named vm.\n\n This does the same thing as vagrant.stop. Other-VM control\n modules use \"stop\" and \"shutdown\" to differentiate between\n hard and soft shutdowns.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.shutdown <salt_id>\n '''\n return stop(name)\n\n\ndef stop(name):\n '''\n Hard shutdown the virtual machine. (vagrant halt)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.stop <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant halt {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef pause(name):\n '''\n Pause (vagrant suspend) the named VM.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.pause <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant suspend {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef reboot(name, provision=False):\n '''\n Reboot a VM. (vagrant reload)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.reboot <salt_id> provision=True\n\n :param name: The salt_id name you will use to control this VM\n :param provision: (False) also re-run the Vagrant provisioning scripts.\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n prov = '--provision' if provision else ''\n\n cmd = 'vagrant reload {} {}'.format(machine, prov)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\n\ndef get_ssh_config(name, network_mask='', get_private_key=False):\n r'''\n Retrieve hints of how you might connect to a Vagrant VM.\n\n :param name: the salt_id of the machine\n :param network_mask: a CIDR mask to search for the VM's address\n :param get_private_key: (default: False) return the key used for ssh login\n :return: a dict of ssh login information for the VM\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.get_ssh_config <salt_id>\n salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True\n\n The returned dictionary contains:\n\n - key_filename: the name of the private key file on the VM host computer\n - ssh_username: the username to be used to log in to the VM\n - ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)\n - ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)\n - \\[ip_address:\\] (if `network_mask` is defined. see below)\n - \\[private_key:\\] (if `get_private_key` is True) the private key for ssh_username\n\n About `network_mask`:\n\n Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.\n This redirected port and its IP address are \"ssh_port\" and \"ssh_host\". The ssh_host is\n usually the localhost (127.0.0.1).\n This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM\n unless the VM has another network interface defined. You will usually want a bridged network\n defined by having a `config.vm.network \"public_network\"` statement in your `Vagrantfile`.\n\n The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,\n but you should be able to determine what IP network the address will be chosen from.\n If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.\n The host machine will send an \"ifconfig\" command to the VM (using ssh to `ssh_host`:`ssh_port`)\n and return the IP address of the first interface it can find which matches your mask.\n '''\n vm_ = get_vm_info(name)\n\n ssh_config = _vagrant_ssh_config(vm_)\n\n try:\n ans = {'key_filename': ssh_config['IdentityFile'],\n 'ssh_username': ssh_config['User'],\n 'ssh_host': ssh_config['HostName'],\n 'ssh_port': ssh_config['Port'],\n }\n\n except KeyError:\n raise CommandExecutionError(\n 'Insufficient SSH information to contact VM {}. '\n 'Is it running?'.format(vm_.get('machine', '(default)')))\n\n if network_mask:\n # ask the new VM to report its network address\n command = 'ssh -i {IdentityFile} -p {Port} ' \\\n '-oStrictHostKeyChecking={StrictHostKeyChecking} ' \\\n '-oUserKnownHostsFile={UserKnownHostsFile} ' \\\n '-oControlPath=none ' \\\n '{User}@{HostName} ifconfig'.format(**ssh_config)\n\n log.info(\n 'Trying ssh -p %s %s@%s ifconfig',\n ssh_config['Port'], ssh_config['User'], ssh_config['HostName']\n )\n reply = __salt__['cmd.shell'](command)\n log.info('--->\\n%s', reply)\n target_network_range = ipaddress.ip_network(network_mask, strict=False)\n\n for line in reply.split('\\n'):\n try: # try to find a bridged network address\n # the lines we are looking for appear like:\n # \"inet addr:10.124.31.185 Bcast:10.124.31.255 Mask:255.255.248.0\"\n # or \"inet6 addr: fe80::a00:27ff:fe04:7aac/64 Scope:Link\"\n tokens = line.replace('addr:', '', 1).split() # remove \"addr:\" if it exists, then split\n found_address = None\n if \"inet\" in tokens:\n nxt = tokens.index(\"inet\") + 1\n found_address = ipaddress.ip_address(tokens[nxt])\n elif \"inet6\" in tokens:\n nxt = tokens.index(\"inet6\") + 1\n found_address = ipaddress.ip_address(tokens[nxt].split('/')[0])\n if found_address in target_network_range:\n ans['ip_address'] = six.text_type(found_address)\n break # we have located a good matching address\n except (IndexError, AttributeError, TypeError):\n pass # all syntax and type errors loop here\n # falling out if the loop leaves us remembering the last candidate\n log.info('Network IP address in %s detected as: %s',\n target_network_range, ans.get('ip_address', '(not found)'))\n\n if get_private_key:\n # retrieve the Vagrant private key from the host\n try:\n with salt.utils.files.fopen(ssh_config['IdentityFile']) as pks:\n ans['private_key'] = salt.utils.stringutils.to_unicode(pks.read())\n except (OSError, IOError) as e:\n raise CommandExecutionError(\"Error processing Vagrant private key file: {}\".format(e))\n return ans\n"}}},{"rowIdx":372,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/vagrant.py"},"func_name":{"kind":"string","value":"get_ssh_config"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def get_ssh_config(name, network_mask='', get_private_key=False):\n r'''\n Retrieve hints of how you might connect to a Vagrant VM.\n\n :param name: the salt_id of the machine\n :param network_mask: a CIDR mask to search for the VM's address\n :param get_private_key: (default: False) return the key used for ssh login\n :return: a dict of ssh login information for the VM\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.get_ssh_config <salt_id>\n salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True\n\n The returned dictionary contains:\n\n - key_filename: the name of the private key file on the VM host computer\n - ssh_username: the username to be used to log in to the VM\n - ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)\n - ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)\n - \\[ip_address:\\] (if `network_mask` is defined. see below)\n - \\[private_key:\\] (if `get_private_key` is True) the private key for ssh_username\n\n About `network_mask`:\n\n Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.\n This redirected port and its IP address are \"ssh_port\" and \"ssh_host\". The ssh_host is\n usually the localhost (127.0.0.1).\n This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM\n unless the VM has another network interface defined. You will usually want a bridged network\n defined by having a `config.vm.network \"public_network\"` statement in your `Vagrantfile`.\n\n The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,\n but you should be able to determine what IP network the address will be chosen from.\n If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.\n The host machine will send an \"ifconfig\" command to the VM (using ssh to `ssh_host`:`ssh_port`)\n and return the IP address of the first interface it can find which matches your mask.\n '''\n vm_ = get_vm_info(name)\n\n ssh_config = _vagrant_ssh_config(vm_)\n\n try:\n ans = {'key_filename': ssh_config['IdentityFile'],\n 'ssh_username': ssh_config['User'],\n 'ssh_host': ssh_config['HostName'],\n 'ssh_port': ssh_config['Port'],\n }\n\n except KeyError:\n raise CommandExecutionError(\n 'Insufficient SSH information to contact VM {}. '\n 'Is it running?'.format(vm_.get('machine', '(default)')))\n\n if network_mask:\n # ask the new VM to report its network address\n command = 'ssh -i {IdentityFile} -p {Port} ' \\\n '-oStrictHostKeyChecking={StrictHostKeyChecking} ' \\\n '-oUserKnownHostsFile={UserKnownHostsFile} ' \\\n '-oControlPath=none ' \\\n '{User}@{HostName} ifconfig'.format(**ssh_config)\n\n log.info(\n 'Trying ssh -p %s %s@%s ifconfig',\n ssh_config['Port'], ssh_config['User'], ssh_config['HostName']\n )\n reply = __salt__['cmd.shell'](command)\n log.info('--->\\n%s', reply)\n target_network_range = ipaddress.ip_network(network_mask, strict=False)\n\n for line in reply.split('\\n'):\n try: # try to find a bridged network address\n # the lines we are looking for appear like:\n # \"inet addr:10.124.31.185 Bcast:10.124.31.255 Mask:255.255.248.0\"\n # or \"inet6 addr: fe80::a00:27ff:fe04:7aac/64 Scope:Link\"\n tokens = line.replace('addr:', '', 1).split() # remove \"addr:\" if it exists, then split\n found_address = None\n if \"inet\" in tokens:\n nxt = tokens.index(\"inet\") + 1\n found_address = ipaddress.ip_address(tokens[nxt])\n elif \"inet6\" in tokens:\n nxt = tokens.index(\"inet6\") + 1\n found_address = ipaddress.ip_address(tokens[nxt].split('/')[0])\n if found_address in target_network_range:\n ans['ip_address'] = six.text_type(found_address)\n break # we have located a good matching address\n except (IndexError, AttributeError, TypeError):\n pass # all syntax and type errors loop here\n # falling out if the loop leaves us remembering the last candidate\n log.info('Network IP address in %s detected as: %s',\n target_network_range, ans.get('ip_address', '(not found)'))\n\n if get_private_key:\n # retrieve the Vagrant private key from the host\n try:\n with salt.utils.files.fopen(ssh_config['IdentityFile']) as pks:\n ans['private_key'] = salt.utils.stringutils.to_unicode(pks.read())\n except (OSError, IOError) as e:\n raise CommandExecutionError(\"Error processing Vagrant private key file: {}\".format(e))\n return ans"},"func_documentation_string":{"kind":"string","value":"r'''\n Retrieve hints of how you might connect to a Vagrant VM.\n\n :param name: the salt_id of the machine\n :param network_mask: a CIDR mask to search for the VM's address\n :param get_private_key: (default: False) return the key used for ssh login\n :return: a dict of ssh login information for the VM\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.get_ssh_config <salt_id>\n salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True\n\n The returned dictionary contains:\n\n - key_filename: the name of the private key file on the VM host computer\n - ssh_username: the username to be used to log in to the VM\n - ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)\n - ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)\n - \\[ip_address:\\] (if `network_mask` is defined. see below)\n - \\[private_key:\\] (if `get_private_key` is True) the private key for ssh_username\n\n About `network_mask`:\n\n Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.\n This redirected port and its IP address are \"ssh_port\" and \"ssh_host\". The ssh_host is\n usually the localhost (127.0.0.1).\n This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM\n unless the VM has another network interface defined. You will usually want a bridged network\n defined by having a `config.vm.network \"public_network\"` statement in your `Vagrantfile`.\n\n The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,\n but you should be able to determine what IP network the address will be chosen from.\n If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.\n The host machine will send an \"ifconfig\" command to the VM (using ssh to `ssh_host`:`ssh_port`)\n and return the IP address of the first interface it can find which matches your mask."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L531-L632"},"called_functions":{"kind":"list like","value":["def fopen(*args, **kwargs):\n '''\n Wrapper around open() built-in to set CLOEXEC on the fd.\n\n This flag specifies that the file descriptor should be closed when an exec\n function is invoked;\n\n When a file descriptor is allocated (as with open or dup), this bit is\n initially cleared on the new file descriptor, meaning that descriptor will\n survive into the new program after exec.\n\n NB! We still have small race condition between open and fcntl.\n '''\n if six.PY3:\n try:\n # Don't permit stdin/stdout/stderr to be opened. The boolean False\n # and True are treated by Python 3's open() as file descriptors 0\n # and 1, respectively.\n if args[0] in (0, 1, 2):\n raise TypeError(\n '{0} is not a permitted file descriptor'.format(args[0])\n )\n except IndexError:\n pass\n binary = None\n # ensure 'binary' mode is always used on Windows in Python 2\n if ((six.PY2 and salt.utils.platform.is_windows() and 'binary' not in kwargs) or\n kwargs.pop('binary', False)):\n if len(args) > 1:\n args = list(args)\n if 'b' not in args[1]:\n args[1] = args[1].replace('t', 'b')\n if 'b' not in args[1]:\n args[1] += 'b'\n elif kwargs.get('mode'):\n if 'b' not in kwargs['mode']:\n kwargs['mode'] = kwargs['mode'].replace('t', 'b')\n if 'b' not in kwargs['mode']:\n kwargs['mode'] += 'b'\n else:\n # the default is to read\n kwargs['mode'] = 'rb'\n elif six.PY3 and 'encoding' not in kwargs:\n # In Python 3, if text mode is used and the encoding\n # is not specified, set the encoding to 'utf-8'.\n binary = False\n if len(args) > 1:\n args = list(args)\n if 'b' in args[1]:\n binary = True\n if kwargs.get('mode', None):\n if 'b' in kwargs['mode']:\n binary = True\n if not binary:\n kwargs['encoding'] = __salt_system_encoding__\n\n if six.PY3 and not binary and not kwargs.get('newline', None):\n kwargs['newline'] = ''\n\n f_handle = open(*args, **kwargs) # pylint: disable=resource-leakage\n\n if is_fcntl_available():\n # modify the file descriptor on systems with fcntl\n # unix and unix-like systems only\n try:\n FD_CLOEXEC = fcntl.FD_CLOEXEC # pylint: disable=C0103\n except AttributeError:\n FD_CLOEXEC = 1 # pylint: disable=C0103\n old_flags = fcntl.fcntl(f_handle.fileno(), fcntl.F_GETFD)\n fcntl.fcntl(f_handle.fileno(), fcntl.F_SETFD, old_flags | FD_CLOEXEC)\n\n return f_handle\n","def to_unicode(s, encoding=None, errors='strict', normalize=False):\n '''\n Given str or unicode, return unicode (str for python 3)\n '''\n def _normalize(s):\n return unicodedata.normalize('NFC', s) if normalize else s\n\n if encoding is None:\n # Try utf-8 first, and fall back to detected encoding\n encoding = ('utf-8', __salt_system_encoding__)\n if not isinstance(encoding, (tuple, list)):\n encoding = (encoding,)\n\n if not encoding:\n raise ValueError('encoding cannot be empty')\n\n exc = None\n if six.PY3:\n if isinstance(s, str):\n return _normalize(s)\n elif isinstance(s, (bytes, bytearray)):\n return _normalize(to_str(s, encoding, errors))\n raise TypeError('expected str, bytes, or bytearray')\n else:\n # This needs to be str and not six.string_types, since if the string is\n # already a unicode type, it does not need to be decoded (and doing so\n # will raise an exception).\n if isinstance(s, unicode): # pylint: disable=incompatible-py3-code,undefined-variable\n return _normalize(s)\n elif isinstance(s, (str, bytearray)):\n for enc in encoding:\n try:\n return _normalize(s.decode(enc, errors))\n except UnicodeDecodeError as err:\n exc = err\n continue\n # The only way we get this far is if a UnicodeDecodeError was\n # raised, otherwise we would have already returned (or raised some\n # other exception).\n raise exc # pylint: disable=raising-bad-type\n raise TypeError('expected str or bytearray')\n","def get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n","def _vagrant_ssh_config(vm_):\n '''\n get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff\n '''\n machine = vm_['machine']\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\n cmd = 'vagrant ssh-config {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n ignore_retcode=True)\n ssh_config = {}\n for line in reply.split('\\n'): # build a dictionary of the text reply\n tokens = line.strip().split()\n if len(tokens) == 2: # each two-token line becomes a key:value pair\n ssh_config[tokens[0]] = tokens[1]\n log.debug('ssh_config=%s', repr(ssh_config))\n return ssh_config\n"],"string":"[\n \"def fopen(*args, **kwargs):\\n '''\\n Wrapper around open() built-in to set CLOEXEC on the fd.\\n\\n This flag specifies that the file descriptor should be closed when an exec\\n function is invoked;\\n\\n When a file descriptor is allocated (as with open or dup), this bit is\\n initially cleared on the new file descriptor, meaning that descriptor will\\n survive into the new program after exec.\\n\\n NB! We still have small race condition between open and fcntl.\\n '''\\n if six.PY3:\\n try:\\n # Don't permit stdin/stdout/stderr to be opened. The boolean False\\n # and True are treated by Python 3's open() as file descriptors 0\\n # and 1, respectively.\\n if args[0] in (0, 1, 2):\\n raise TypeError(\\n '{0} is not a permitted file descriptor'.format(args[0])\\n )\\n except IndexError:\\n pass\\n binary = None\\n # ensure 'binary' mode is always used on Windows in Python 2\\n if ((six.PY2 and salt.utils.platform.is_windows() and 'binary' not in kwargs) or\\n kwargs.pop('binary', False)):\\n if len(args) > 1:\\n args = list(args)\\n if 'b' not in args[1]:\\n args[1] = args[1].replace('t', 'b')\\n if 'b' not in args[1]:\\n args[1] += 'b'\\n elif kwargs.get('mode'):\\n if 'b' not in kwargs['mode']:\\n kwargs['mode'] = kwargs['mode'].replace('t', 'b')\\n if 'b' not in kwargs['mode']:\\n kwargs['mode'] += 'b'\\n else:\\n # the default is to read\\n kwargs['mode'] = 'rb'\\n elif six.PY3 and 'encoding' not in kwargs:\\n # In Python 3, if text mode is used and the encoding\\n # is not specified, set the encoding to 'utf-8'.\\n binary = False\\n if len(args) > 1:\\n args = list(args)\\n if 'b' in args[1]:\\n binary = True\\n if kwargs.get('mode', None):\\n if 'b' in kwargs['mode']:\\n binary = True\\n if not binary:\\n kwargs['encoding'] = __salt_system_encoding__\\n\\n if six.PY3 and not binary and not kwargs.get('newline', None):\\n kwargs['newline'] = ''\\n\\n f_handle = open(*args, **kwargs) # pylint: disable=resource-leakage\\n\\n if is_fcntl_available():\\n # modify the file descriptor on systems with fcntl\\n # unix and unix-like systems only\\n try:\\n FD_CLOEXEC = fcntl.FD_CLOEXEC # pylint: disable=C0103\\n except AttributeError:\\n FD_CLOEXEC = 1 # pylint: disable=C0103\\n old_flags = fcntl.fcntl(f_handle.fileno(), fcntl.F_GETFD)\\n fcntl.fcntl(f_handle.fileno(), fcntl.F_SETFD, old_flags | FD_CLOEXEC)\\n\\n return f_handle\\n\",\n \"def to_unicode(s, encoding=None, errors='strict', normalize=False):\\n '''\\n Given str or unicode, return unicode (str for python 3)\\n '''\\n def _normalize(s):\\n return unicodedata.normalize('NFC', s) if normalize else s\\n\\n if encoding is None:\\n # Try utf-8 first, and fall back to detected encoding\\n encoding = ('utf-8', __salt_system_encoding__)\\n if not isinstance(encoding, (tuple, list)):\\n encoding = (encoding,)\\n\\n if not encoding:\\n raise ValueError('encoding cannot be empty')\\n\\n exc = None\\n if six.PY3:\\n if isinstance(s, str):\\n return _normalize(s)\\n elif isinstance(s, (bytes, bytearray)):\\n return _normalize(to_str(s, encoding, errors))\\n raise TypeError('expected str, bytes, or bytearray')\\n else:\\n # This needs to be str and not six.string_types, since if the string is\\n # already a unicode type, it does not need to be decoded (and doing so\\n # will raise an exception).\\n if isinstance(s, unicode): # pylint: disable=incompatible-py3-code,undefined-variable\\n return _normalize(s)\\n elif isinstance(s, (str, bytearray)):\\n for enc in encoding:\\n try:\\n return _normalize(s.decode(enc, errors))\\n except UnicodeDecodeError as err:\\n exc = err\\n continue\\n # The only way we get this far is if a UnicodeDecodeError was\\n # raised, otherwise we would have already returned (or raised some\\n # other exception).\\n raise exc # pylint: disable=raising-bad-type\\n raise TypeError('expected str or bytearray')\\n\",\n \"def get_vm_info(name):\\n '''\\n get the information for a VM.\\n\\n :param name: salt_id name\\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\\n '''\\n try:\\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\\n except KeyError:\\n raise SaltInvocationError(\\n 'Probable sdb driver not found. Check your configuration.')\\n if vm_ is None or 'machine' not in vm_:\\n raise SaltInvocationError(\\n 'No Vagrant machine defined for Salt_id {}'.format(name))\\n return vm_\\n\",\n \"def _vagrant_ssh_config(vm_):\\n '''\\n get the information for ssh communication from the new VM\\n\\n :param vm_: the VM's info as we have it now\\n :return: dictionary of ssh stuff\\n '''\\n machine = vm_['machine']\\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\\n cmd = 'vagrant ssh-config {}'.format(machine)\\n reply = __salt__['cmd.shell'](cmd,\\n runas=vm_.get('runas'),\\n cwd=vm_.get('cwd'),\\n ignore_retcode=True)\\n ssh_config = {}\\n for line in reply.split('\\\\n'): # build a dictionary of the text reply\\n tokens = line.strip().split()\\n if len(tokens) == 2: # each two-token line becomes a key:value pair\\n ssh_config[tokens[0]] = tokens[1]\\n log.debug('ssh_config=%s', repr(ssh_config))\\n return ssh_config\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nWork with virtual machines managed by Vagrant.\n\n.. versionadded:: 2018.3.0\n\nMapping between a Salt node id and the Vagrant machine name\n(and the path to the Vagrantfile where it is defined)\nis stored in a Salt sdb database on the Vagrant host (minion) machine.\nIn order to use this module, sdb must be configured. An SQLite\ndatabase is the recommended storage method. The URI used for\nthe sdb lookup is \"sdb://vagrant_sdb_data\".\n\nrequirements:\n - the VM host machine must have salt-minion, Vagrant and a vm provider installed.\n - the VM host must have a valid definition for `sdb://vagrant_sdb_data`\n\n Configuration example:\n\n .. code-block:: yaml\n\n # file /etc/salt/minion.d/vagrant_sdb.conf\n vagrant_sdb_data:\n driver: sqlite3\n database: /var/cache/salt/vagrant.sqlite\n table: sdb\n create_table: True\n\n'''\n\n# Import python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\nimport os\n\n# Import salt libs\nimport salt.utils.files\nimport salt.utils.path\nimport salt.utils.stringutils\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\nimport salt.ext.six as six\nfrom salt._compat import ipaddress\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'vagrant'\n\nVAGRANT_SDB_URL = 'sdb://vagrant_sdb_data/'\n\n\ndef __virtual__():\n '''\n run Vagrant commands if possible\n '''\n if salt.utils.path.which('vagrant') is None:\n return False, 'The vagrant module could not be loaded: vagrant command not found'\n return __virtualname__\n\n\ndef _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n\n\ndef _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key = '{}?{}'.format(machine, os.path.abspath(cwd))\n return _build_sdb_uri(key)\n\n\ndef _update_vm_info(name, vm_):\n ''' store the vm_ information keyed by name '''\n __utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)\n\n # store machine-to-name mapping, too\n if vm_['machine']:\n __utils__['sdb.sdb_set'](\n _build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),\n name,\n __opts__)\n\n\ndef get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n 'Probable sdb driver not found. Check your configuration.')\n if vm_ is None or 'machine' not in vm_:\n raise SaltInvocationError(\n 'No Vagrant machine defined for Salt_id {}'.format(name))\n return vm_\n\n\ndef get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n\n\ndef _erase_vm_info(name):\n '''\n erase the information for a VM the we are destroying.\n\n some sdb drivers (such as the SQLite driver we expect to use)\n do not have a `delete` method, so if the delete fails, we have\n to replace the with a blank entry.\n '''\n try:\n # delete the machine record\n vm_ = get_vm_info(name)\n if vm_['machine']:\n key = _build_machine_uri(vm_['machine'], vm_.get('cwd', '.'))\n try:\n __utils__['sdb.sdb_delete'](key, __opts__)\n except KeyError:\n # no delete method found -- load a blank value\n __utils__['sdb.sdb_set'](key, None, __opts__)\n except Exception:\n pass\n\n uri = _build_sdb_uri(name)\n try:\n # delete the name record\n __utils__['sdb.sdb_delete'](uri, __opts__)\n except KeyError:\n # no delete method found -- load an empty dictionary\n __utils__['sdb.sdb_set'](uri, {}, __opts__)\n except Exception:\n pass\n\n\ndef _vagrant_ssh_config(vm_):\n '''\n get the information for ssh communication from the new VM\n\n :param vm_: the VM's info as we have it now\n :return: dictionary of ssh stuff\n '''\n machine = vm_['machine']\n log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')\n cmd = 'vagrant ssh-config {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n ignore_retcode=True)\n ssh_config = {}\n for line in reply.split('\\n'): # build a dictionary of the text reply\n tokens = line.strip().split()\n if len(tokens) == 2: # each two-token line becomes a key:value pair\n ssh_config[tokens[0]] = tokens[1]\n log.debug('ssh_config=%s', repr(ssh_config))\n return ssh_config\n\n\ndef version():\n '''\n Return the version of Vagrant on the minion\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.version\n '''\n cmd = 'vagrant -v'\n return __salt__['cmd.shell'](cmd)\n\n\ndef list_domains():\n '''\n Return a list of the salt_id names of all available Vagrant VMs on\n this host without regard to the path where they are defined.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_domains --log-level=info\n\n The log shows information about all known Vagrant environments\n on this machine. This data is cached and may not be completely\n up-to-date.\n '''\n vms = []\n cmd = 'vagrant global-status'\n reply = __salt__['cmd.shell'](cmd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n try:\n _ = int(tokens[0], 16) # valid id numbers are hexadecimal\n except (ValueError, IndexError):\n continue # skip lines without valid id numbers\n machine = tokens[1]\n cwd = tokens[-1]\n name = get_machine_id(machine, cwd)\n if name:\n vms.append(name)\n return vms\n\n\ndef list_active_vms(cwd=None):\n '''\n Return a list of machine names for active virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.list_active_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1:\n if tokens[1] == 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef list_inactive_vms(cwd=None):\n '''\n Return a list of machine names for inactive virtual machine on the host,\n which are defined in the Vagrantfile at the indicated path.\n\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' virt.list_inactive_vms cwd=/projects/project_1\n '''\n vms = []\n cmd = 'vagrant status'\n reply = __salt__['cmd.shell'](cmd, cwd=cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n if tokens[1] != 'running':\n vms.append(tokens[0])\n return vms\n\n\ndef vm_state(name='', cwd=None):\n '''\n Return list of information for all the vms indicating their state.\n\n If you pass a VM name in as an argument then it will return info\n for just the named VM, otherwise it will return all VMs defined by\n the Vagrantfile in the `cwd` directory.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' vagrant.vm_state <name> cwd=/projects/project_1\n\n returns a list of dictionaries with machine name, state, provider,\n and salt_id name.\n\n .. code-block:: python\n\n datum = {'machine': _, # Vagrant machine name,\n 'state': _, # string indicating machine state, like 'running'\n 'provider': _, # the Vagrant VM provider\n 'name': _} # salt_id name\n\n Known bug: if there are multiple machines in your Vagrantfile, and you request\n the status of the ``primary`` machine, which you defined by leaving the ``machine``\n parameter blank, then you may receive the status of all of them.\n Please specify the actual machine name for each VM if there are more than one.\n\n '''\n\n if name:\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n cwd = vm_['cwd'] or cwd # usually ignore passed-in cwd\n else:\n if not cwd:\n raise SaltInvocationError(\n 'Path to Vagranfile must be defined, but cwd={}'.format(cwd))\n machine = ''\n\n info = []\n cmd = 'vagrant status {}'.format(machine)\n reply = __salt__['cmd.shell'](cmd, cwd)\n log.info('--->\\n%s', reply)\n for line in reply.split('\\n'): # build a list of the text reply\n tokens = line.strip().split()\n if len(tokens) > 1 and tokens[-1].endswith(')'):\n try:\n datum = {'machine': tokens[0],\n 'state': ' '.join(tokens[1:-1]),\n 'provider': tokens[-1].lstrip('(').rstrip(')'),\n 'name': get_machine_id(tokens[0], cwd)\n }\n info.append(datum)\n except IndexError:\n pass\n return info\n\n\ndef init(name, # Salt_id for created VM\n cwd=None, # path to find Vagrantfile\n machine='', # name of machine in Vagrantfile\n runas=None, # username who owns Vagrant box\n start=False, # start the machine when initialized\n vagrant_provider='', # vagrant provider (default=virtualbox)\n vm=None, # a dictionary of VM configuration settings\n ):\n '''\n Initialize a new Vagrant VM.\n\n This inputs all the information needed to start a Vagrant VM. These settings are stored in\n a Salt sdb database on the Vagrant host minion and used to start, control, and query the\n guest VMs. The salt_id assigned here is the key field for that database and must be unique.\n\n :param name: The salt_id name you will use to control this VM\n :param cwd: The path to the directory where the Vagrantfile is located\n :param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.\n :param runas: The username on the host who owns the Vagrant work files.\n :param start: (default: False) Start the virtual machine now.\n :param vagrant_provider: The name of a Vagrant VM provider (if not the default).\n :param vm: Optionally, all the above information may be supplied in this dictionary.\n :return: A string indicating success, or False.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.init <salt_id> /path/to/Vagrantfile\n salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1\n '''\n vm_ = {} if vm is None else vm.copy() # passed configuration data\n vm_['name'] = name\n # passed-in keyword arguments overwrite vm dictionary values\n vm_['cwd'] = cwd or vm_.get('cwd')\n if not vm_['cwd']:\n raise SaltInvocationError('Path to Vagrantfile must be defined by \"cwd\" argument')\n vm_['machine'] = machine or vm_.get('machine', machine)\n vm_['runas'] = runas or vm_.get('runas', runas)\n vm_['vagrant_provider'] = vagrant_provider or vm_.get('vagrant_provider', '')\n _update_vm_info(name, vm_)\n\n if start:\n log.debug('Starting VM %s', name)\n ret = _start(name, vm_)\n else:\n ret = 'Name {} defined using VM {}'.format(name, vm_['machine'] or '(default)')\n return ret\n\n\ndef start(name):\n '''\n Start (vagrant up) a virtual machine defined by salt_id name.\n The machine must have been previously defined using \"vagrant.init\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.start <salt_id>\n '''\n vm_ = get_vm_info(name)\n return _start(name, vm_)\n\n\ndef _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider', '')\n provider_ = '--provider={}'.format(vagrant_provider) if vagrant_provider else ''\n cmd = 'vagrant up {} {}'.format(machine, provider_)\n ret = __salt__['cmd.run_all'](cmd, runas=vm_.get('runas'), cwd=vm_.get('cwd'), output_loglevel='info')\n\n if machine == '': # we were called using the default machine\n for line in ret['stdout'].split('\\n'): # find its actual Vagrant name\n if line.startswith('==>'):\n machine = line.split()[1].rstrip(':')\n vm_['machine'] = machine\n _update_vm_info(name, vm_) # and remember the true name\n break\n\n if ret['retcode'] == 0:\n return 'Started \"{}\" using Vagrant machine \"{}\".'.format(name, machine)\n return False\n\n\ndef shutdown(name):\n '''\n Send a soft shutdown (vagrant halt) signal to the named vm.\n\n This does the same thing as vagrant.stop. Other-VM control\n modules use \"stop\" and \"shutdown\" to differentiate between\n hard and soft shutdowns.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.shutdown <salt_id>\n '''\n return stop(name)\n\n\ndef stop(name):\n '''\n Hard shutdown the virtual machine. (vagrant halt)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.stop <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant halt {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef pause(name):\n '''\n Pause (vagrant suspend) the named VM.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.pause <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant suspend {}'.format(machine)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef reboot(name, provision=False):\n '''\n Reboot a VM. (vagrant reload)\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.reboot <salt_id> provision=True\n\n :param name: The salt_id name you will use to control this VM\n :param provision: (False) also re-run the Vagrant provisioning scripts.\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n prov = '--provision' if provision else ''\n\n cmd = 'vagrant reload {} {}'.format(machine, prov)\n ret = __salt__['cmd.retcode'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'))\n return ret == 0\n\n\ndef destroy(name):\n '''\n Destroy and delete a virtual machine. (vagrant destroy -f)\n\n This also removes the salt_id name defined by vagrant.init.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt <host> vagrant.destroy <salt_id>\n '''\n vm_ = get_vm_info(name)\n machine = vm_['machine']\n\n cmd = 'vagrant destroy -f {}'.format(machine)\n\n ret = __salt__['cmd.run_all'](cmd,\n runas=vm_.get('runas'),\n cwd=vm_.get('cwd'),\n output_loglevel='info')\n if ret['retcode'] == 0:\n _erase_vm_info(name)\n return 'Destroyed VM {0}'.format(name)\n return False\n\n"}}},{"rowIdx":373,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/esxvm.py"},"func_name":{"kind":"string","value":"vm_configured"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def vm_configured(name, vm_name, cpu, memory, image, version, interfaces,\n disks, scsi_devices, serial_ports, datacenter, datastore,\n placement, cd_dvd_drives=None, sata_controllers=None,\n advanced_configs=None, template=None, tools=True,\n power_on=False, deploy=False):\n '''\n Selects the correct operation to be executed on a virtual machine, non\n existing machines will be created, existing ones will be updated if the\n config differs.\n '''\n result = {'name': name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n log.trace('Validating virtual machine configuration')\n schema = ESXVirtualMachineConfigSchema.serialize()\n log.trace('schema = %s', schema)\n try:\n jsonschema.validate({'vm_name': vm_name,\n 'cpu': cpu,\n 'memory': memory,\n 'image': image,\n 'version': version,\n 'interfaces': interfaces,\n 'disks': disks,\n 'scsi_devices': scsi_devices,\n 'serial_ports': serial_ports,\n 'cd_dvd_drives': cd_dvd_drives,\n 'sata_controllers': sata_controllers,\n 'datacenter': datacenter,\n 'datastore': datastore,\n 'placement': placement,\n 'template': template,\n 'tools': tools,\n 'power_on': power_on,\n 'deploy': deploy}, schema)\n except jsonschema.exceptions.ValidationError as exc:\n raise salt.exceptions.InvalidConfigError(exc)\n\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n try:\n __salt__['vsphere.get_vm'](vm_name, vm_properties=['name'],\n service_instance=service_instance)\n except salt.exceptions.VMwareObjectRetrievalError:\n vm_file = __salt__['vsphere.get_vm_config_file'](\n vm_name, datacenter,\n placement, datastore,\n service_instance=service_instance)\n if vm_file:\n if __opts__['test']:\n result.update({'comment': 'The virtual machine {0}'\n ' will be registered.'.format(vm_name)})\n __salt__['vsphere.disconnect'](service_instance)\n return result\n result = vm_registered(vm_name, datacenter, placement,\n vm_file, power_on=power_on)\n return result\n else:\n if __opts__['test']:\n result.update({'comment': 'The virtual machine {0}'\n ' will be created.'.format(vm_name)})\n __salt__['vsphere.disconnect'](service_instance)\n return result\n if template:\n result = vm_cloned(name)\n else:\n result = vm_created(name, vm_name, cpu, memory, image, version,\n interfaces, disks, scsi_devices,\n serial_ports, datacenter, datastore,\n placement, cd_dvd_drives=cd_dvd_drives,\n advanced_configs=advanced_configs,\n power_on=power_on)\n return result\n\n result = vm_updated(name, vm_name, cpu, memory, image, version,\n interfaces, disks, scsi_devices,\n serial_ports, datacenter, datastore,\n cd_dvd_drives=cd_dvd_drives,\n sata_controllers=sata_controllers,\n advanced_configs=advanced_configs,\n power_on=power_on)\n __salt__['vsphere.disconnect'](service_instance)\n\n log.trace(result)\n return result"},"func_documentation_string":{"kind":"string","value":"Selects the correct operation to be executed on a virtual machine, non\n existing machines will be created, existing ones will be updated if the\n config differs."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/esxvm.py#L227-L312"},"called_functions":{"kind":"list like","value":["def vm_registered(vm_name, datacenter, placement, vm_file, power_on=False):\n '''\n Registers a virtual machine if the machine files are available on\n the main datastore.\n '''\n result = {'name': vm_name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n vmx_path = '{0}{1}'.format(vm_file.folderPath, vm_file.file[0].path)\n log.trace('Registering virtual machine with vmx file: %s', vmx_path)\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n try:\n __salt__['vsphere.register_vm'](vm_name, datacenter,\n placement, vmx_path,\n service_instance=service_instance)\n except salt.exceptions.VMwareMultipleObjectsError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({'result': False,\n 'comment': six.text_type(exc)})\n return result\n except salt.exceptions.VMwareVmRegisterError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({'result': False,\n 'comment': six.text_type(exc)})\n return result\n\n if power_on:\n try:\n __salt__['vsphere.power_on_vm'](vm_name, datacenter,\n service_instance=service_instance)\n except salt.exceptions.VMwarePowerOnError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n __salt__['vsphere.disconnect'](service_instance)\n result.update({'result': True,\n 'changes': {'name': vm_name, 'power_on': power_on},\n 'comment': 'Virtual machine '\n '{0} registered successfully'.format(vm_name)})\n\n return result\n","def vm_cloned(name):\n '''\n Clones a virtual machine from a template virtual machine if it doesn't\n exist and a template is defined.\n '''\n result = {'name': name,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n return result\n","def vm_created(name, vm_name, cpu, memory, image, version, interfaces,\n disks, scsi_devices, serial_ports, datacenter, datastore,\n placement, ide_controllers=None, sata_controllers=None,\n cd_dvd_drives=None, advanced_configs=None, power_on=False):\n '''\n Creates a virtual machine with the given properties if it doesn't exist.\n '''\n result = {'name': name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n if __opts__['test']:\n result['comment'] = 'Virtual machine {0} will be created'.format(\n vm_name)\n return result\n\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n try:\n info = __salt__['vsphere.create_vm'](vm_name, cpu, memory, image,\n version, datacenter, datastore,\n placement, interfaces, disks,\n scsi_devices,\n serial_ports=serial_ports,\n ide_controllers=ide_controllers,\n sata_controllers=sata_controllers,\n cd_drives=cd_dvd_drives,\n advanced_configs=advanced_configs,\n service_instance=service_instance)\n except salt.exceptions.CommandExecutionError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n\n if power_on:\n try:\n __salt__['vsphere.power_on_vm'](vm_name, datacenter,\n service_instance=service_instance)\n except salt.exceptions.VMwarePowerOnError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n info['power_on'] = power_on\n\n changes = {'name': vm_name, 'info': info}\n __salt__['vsphere.disconnect'](service_instance)\n result = {'name': name,\n 'result': True,\n 'changes': changes,\n 'comment': 'Virtual machine '\n '{0} created successfully'.format(vm_name)}\n\n return result\n","def vm_updated(name, vm_name, cpu, memory, image, version, interfaces,\n disks, scsi_devices, serial_ports, datacenter, datastore,\n cd_dvd_drives=None, sata_controllers=None,\n advanced_configs=None, power_on=False):\n '''\n Updates a virtual machine configuration if there is a difference between\n the given and deployed configuration.\n '''\n result = {'name': name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n current_config = __salt__['vsphere.get_vm_config'](\n vm_name,\n datacenter=datacenter,\n objects=False,\n service_instance=service_instance)\n\n diffs = __salt__['vsphere.compare_vm_configs'](\n {'name': vm_name,\n 'cpu': cpu,\n 'memory': memory,\n 'image': image,\n 'version': version,\n 'interfaces': interfaces,\n 'disks': disks,\n 'scsi_devices': scsi_devices,\n 'serial_ports': serial_ports,\n 'datacenter': datacenter,\n 'datastore': datastore,\n 'cd_drives': cd_dvd_drives,\n 'sata_controllers': sata_controllers,\n 'advanced_configs': advanced_configs},\n current_config)\n if not diffs:\n result.update({\n 'result': True,\n 'changes': {},\n 'comment': 'Virtual machine {0} is already up to date'.format(vm_name)})\n return result\n\n if __opts__['test']:\n comment = 'State vm_updated will update virtual machine \\'{0}\\' ' \\\n 'in datacenter \\'{1}\\':\\n{2}'.format(vm_name,\n datacenter,\n '\\n'.join([':\\n'.join([key, difference.changes_str])\n for key, difference in six.iteritems(diffs)]))\n result.update({'result': None,\n 'comment': comment})\n __salt__['vsphere.disconnect'](service_instance)\n return result\n\n try:\n changes = __salt__['vsphere.update_vm'](vm_name, cpu, memory, image,\n version, interfaces, disks,\n scsi_devices, serial_ports,\n datacenter, datastore,\n cd_dvd_drives=cd_dvd_drives,\n sata_controllers=sata_controllers,\n advanced_configs=advanced_configs,\n service_instance=service_instance)\n except salt.exceptions.CommandExecutionError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n\n if power_on:\n try:\n __salt__['vsphere.power_on_vm'](vm_name, datacenter)\n except salt.exceptions.VMwarePowerOnError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n changes.update({'power_on': True})\n\n __salt__['vsphere.disconnect'](service_instance)\n\n result = {'name': name,\n 'result': True,\n 'changes': changes,\n 'comment': 'Virtual machine '\n '{0} was updated successfully'.format(vm_name)}\n\n return result\n","def serialize(cls, id_=None):\n # Get the initial serialization\n serialized = super(DefinitionsSchema, cls).serialize(id_)\n complex_items = []\n # Augment the serializations with the definitions of all complex items\n aux_items = cls._items.values()\n\n # Convert dict_view object to a list on Python 3\n if six.PY3:\n aux_items = list(aux_items)\n\n while aux_items:\n item = aux_items.pop(0)\n # Add complex attributes\n if isinstance(item, ComplexSchemaItem):\n complex_items.append(item)\n aux_items.extend(item.get_complex_attrs())\n\n # Handle container items\n if isinstance(item, OneOfItem):\n aux_items.extend(item.items)\n elif isinstance(item, ArrayItem):\n aux_items.append(item.items)\n elif isinstance(item, DictItem):\n if item.properties:\n aux_items.extend(item.properties.values())\n if item.additional_properties and \\\n isinstance(item.additional_properties, SchemaItem):\n\n aux_items.append(item.additional_properties)\n\n definitions = OrderedDict()\n for config in complex_items:\n if isinstance(config, ComplexSchemaItem):\n definitions[config.definition_name] = \\\n config.get_definition()\n serialized['definitions'] = definitions\n return serialized\n"],"string":"[\n \"def vm_registered(vm_name, datacenter, placement, vm_file, power_on=False):\\n '''\\n Registers a virtual machine if the machine files are available on\\n the main datastore.\\n '''\\n result = {'name': vm_name,\\n 'result': None,\\n 'changes': {},\\n 'comment': ''}\\n\\n vmx_path = '{0}{1}'.format(vm_file.folderPath, vm_file.file[0].path)\\n log.trace('Registering virtual machine with vmx file: %s', vmx_path)\\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\\n try:\\n __salt__['vsphere.register_vm'](vm_name, datacenter,\\n placement, vmx_path,\\n service_instance=service_instance)\\n except salt.exceptions.VMwareMultipleObjectsError as exc:\\n log.error('Error: %s', exc)\\n if service_instance:\\n __salt__['vsphere.disconnect'](service_instance)\\n result.update({'result': False,\\n 'comment': six.text_type(exc)})\\n return result\\n except salt.exceptions.VMwareVmRegisterError as exc:\\n log.error('Error: %s', exc)\\n if service_instance:\\n __salt__['vsphere.disconnect'](service_instance)\\n result.update({'result': False,\\n 'comment': six.text_type(exc)})\\n return result\\n\\n if power_on:\\n try:\\n __salt__['vsphere.power_on_vm'](vm_name, datacenter,\\n service_instance=service_instance)\\n except salt.exceptions.VMwarePowerOnError as exc:\\n log.error('Error: %s', exc)\\n if service_instance:\\n __salt__['vsphere.disconnect'](service_instance)\\n result.update({\\n 'result': False,\\n 'comment': six.text_type(exc)})\\n return result\\n __salt__['vsphere.disconnect'](service_instance)\\n result.update({'result': True,\\n 'changes': {'name': vm_name, 'power_on': power_on},\\n 'comment': 'Virtual machine '\\n '{0} registered successfully'.format(vm_name)})\\n\\n return result\\n\",\n \"def vm_cloned(name):\\n '''\\n Clones a virtual machine from a template virtual machine if it doesn't\\n exist and a template is defined.\\n '''\\n result = {'name': name,\\n 'result': True,\\n 'changes': {},\\n 'comment': ''}\\n\\n return result\\n\",\n \"def vm_created(name, vm_name, cpu, memory, image, version, interfaces,\\n disks, scsi_devices, serial_ports, datacenter, datastore,\\n placement, ide_controllers=None, sata_controllers=None,\\n cd_dvd_drives=None, advanced_configs=None, power_on=False):\\n '''\\n Creates a virtual machine with the given properties if it doesn't exist.\\n '''\\n result = {'name': name,\\n 'result': None,\\n 'changes': {},\\n 'comment': ''}\\n\\n if __opts__['test']:\\n result['comment'] = 'Virtual machine {0} will be created'.format(\\n vm_name)\\n return result\\n\\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\\n try:\\n info = __salt__['vsphere.create_vm'](vm_name, cpu, memory, image,\\n version, datacenter, datastore,\\n placement, interfaces, disks,\\n scsi_devices,\\n serial_ports=serial_ports,\\n ide_controllers=ide_controllers,\\n sata_controllers=sata_controllers,\\n cd_drives=cd_dvd_drives,\\n advanced_configs=advanced_configs,\\n service_instance=service_instance)\\n except salt.exceptions.CommandExecutionError as exc:\\n log.error('Error: %s', exc)\\n if service_instance:\\n __salt__['vsphere.disconnect'](service_instance)\\n result.update({\\n 'result': False,\\n 'comment': six.text_type(exc)})\\n return result\\n\\n if power_on:\\n try:\\n __salt__['vsphere.power_on_vm'](vm_name, datacenter,\\n service_instance=service_instance)\\n except salt.exceptions.VMwarePowerOnError as exc:\\n log.error('Error: %s', exc)\\n if service_instance:\\n __salt__['vsphere.disconnect'](service_instance)\\n result.update({\\n 'result': False,\\n 'comment': six.text_type(exc)})\\n return result\\n info['power_on'] = power_on\\n\\n changes = {'name': vm_name, 'info': info}\\n __salt__['vsphere.disconnect'](service_instance)\\n result = {'name': name,\\n 'result': True,\\n 'changes': changes,\\n 'comment': 'Virtual machine '\\n '{0} created successfully'.format(vm_name)}\\n\\n return result\\n\",\n \"def vm_updated(name, vm_name, cpu, memory, image, version, interfaces,\\n disks, scsi_devices, serial_ports, datacenter, datastore,\\n cd_dvd_drives=None, sata_controllers=None,\\n advanced_configs=None, power_on=False):\\n '''\\n Updates a virtual machine configuration if there is a difference between\\n the given and deployed configuration.\\n '''\\n result = {'name': name,\\n 'result': None,\\n 'changes': {},\\n 'comment': ''}\\n\\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\\n current_config = __salt__['vsphere.get_vm_config'](\\n vm_name,\\n datacenter=datacenter,\\n objects=False,\\n service_instance=service_instance)\\n\\n diffs = __salt__['vsphere.compare_vm_configs'](\\n {'name': vm_name,\\n 'cpu': cpu,\\n 'memory': memory,\\n 'image': image,\\n 'version': version,\\n 'interfaces': interfaces,\\n 'disks': disks,\\n 'scsi_devices': scsi_devices,\\n 'serial_ports': serial_ports,\\n 'datacenter': datacenter,\\n 'datastore': datastore,\\n 'cd_drives': cd_dvd_drives,\\n 'sata_controllers': sata_controllers,\\n 'advanced_configs': advanced_configs},\\n current_config)\\n if not diffs:\\n result.update({\\n 'result': True,\\n 'changes': {},\\n 'comment': 'Virtual machine {0} is already up to date'.format(vm_name)})\\n return result\\n\\n if __opts__['test']:\\n comment = 'State vm_updated will update virtual machine \\\\'{0}\\\\' ' \\\\\\n 'in datacenter \\\\'{1}\\\\':\\\\n{2}'.format(vm_name,\\n datacenter,\\n '\\\\n'.join([':\\\\n'.join([key, difference.changes_str])\\n for key, difference in six.iteritems(diffs)]))\\n result.update({'result': None,\\n 'comment': comment})\\n __salt__['vsphere.disconnect'](service_instance)\\n return result\\n\\n try:\\n changes = __salt__['vsphere.update_vm'](vm_name, cpu, memory, image,\\n version, interfaces, disks,\\n scsi_devices, serial_ports,\\n datacenter, datastore,\\n cd_dvd_drives=cd_dvd_drives,\\n sata_controllers=sata_controllers,\\n advanced_configs=advanced_configs,\\n service_instance=service_instance)\\n except salt.exceptions.CommandExecutionError as exc:\\n log.error('Error: %s', exc)\\n if service_instance:\\n __salt__['vsphere.disconnect'](service_instance)\\n result.update({\\n 'result': False,\\n 'comment': six.text_type(exc)})\\n return result\\n\\n if power_on:\\n try:\\n __salt__['vsphere.power_on_vm'](vm_name, datacenter)\\n except salt.exceptions.VMwarePowerOnError as exc:\\n log.error('Error: %s', exc)\\n if service_instance:\\n __salt__['vsphere.disconnect'](service_instance)\\n result.update({\\n 'result': False,\\n 'comment': six.text_type(exc)})\\n return result\\n changes.update({'power_on': True})\\n\\n __salt__['vsphere.disconnect'](service_instance)\\n\\n result = {'name': name,\\n 'result': True,\\n 'changes': changes,\\n 'comment': 'Virtual machine '\\n '{0} was updated successfully'.format(vm_name)}\\n\\n return result\\n\",\n \"def serialize(cls, id_=None):\\n # Get the initial serialization\\n serialized = super(DefinitionsSchema, cls).serialize(id_)\\n complex_items = []\\n # Augment the serializations with the definitions of all complex items\\n aux_items = cls._items.values()\\n\\n # Convert dict_view object to a list on Python 3\\n if six.PY3:\\n aux_items = list(aux_items)\\n\\n while aux_items:\\n item = aux_items.pop(0)\\n # Add complex attributes\\n if isinstance(item, ComplexSchemaItem):\\n complex_items.append(item)\\n aux_items.extend(item.get_complex_attrs())\\n\\n # Handle container items\\n if isinstance(item, OneOfItem):\\n aux_items.extend(item.items)\\n elif isinstance(item, ArrayItem):\\n aux_items.append(item.items)\\n elif isinstance(item, DictItem):\\n if item.properties:\\n aux_items.extend(item.properties.values())\\n if item.additional_properties and \\\\\\n isinstance(item.additional_properties, SchemaItem):\\n\\n aux_items.append(item.additional_properties)\\n\\n definitions = OrderedDict()\\n for config in complex_items:\\n if isinstance(config, ComplexSchemaItem):\\n definitions[config.definition_name] = \\\\\\n config.get_definition()\\n serialized['definitions'] = definitions\\n return serialized\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nSalt state to create, update VMware ESXi Virtual Machines.\n\nDependencies\n============\n\n- pyVmomi\n- jsonschema\n\nStates\n======\n\nvm_configured\n-------------\n\nEnforces correct virtual machine configuration. Creates, updates and registers\na virtual machine.\n\nThis state identifies the action which should be taken for the virtual machine\nand applies that action via the create, update, register state functions.\n\nSupported proxies: esxvm\n\n\nExample:\n\n1. Get the virtual machine ``my_vm`` status with an ``esxvm`` proxy:\n\nProxy minion configuration for ``esxvm`` proxy:\n\n.. code-block:: yaml\n\n proxy:\n proxytype: esxvm\n datacenter: my_dc\n vcenter: vcenter.fake.com\n mechanism: sspi\n domain: fake.com\n principal: host\n\nState configuration:\n\n.. code-block:: yaml\n\n myvm_state:\n esxvm.vm_configured:\n - vm_name: my_vm\n - cpu: {{ {'count': 4, 'cores_per_socket': 2} }}\n - memory: {{ {'size': 16384, 'unit': 'MB'} }}\n - image: rhel7_64Guest\n - version: vmx-12\n - interfaces: {{ [{\n 'adapter': 'Network adapter 1',\n 'name': 'my_pg1',\n 'switch_type': 'distributed',\n 'adapter_type': 'vmxnet3',\n 'mac': '00:50:56:00:01:02,\n 'connectable': { 'start_connected': true,\n 'allow_guest_control': true,\n 'connected': true}},\n {\n 'adapter': 'Network adapter 2',\n 'name': 'my_pg2',\n 'switch_type': 'distributed',\n 'adapter_type': 'vmxnet3',\n 'mac': '00:50:56:00:01:03',\n 'connectable': { 'start_connected': true,\n 'allow_guest_control': true,\n 'connected': true}}\n ] }}\n - disks: {{ [{\n 'adapter': 'Hard disk 1',\n 'unit': 'MB',\n 'size': 51200,\n 'filename': 'my_vm/sda.vmdk',\n 'datastore': 'my_datastore',\n 'address': '0:0',\n 'thin_provision': true,\n 'eagerly_scrub': false,\n 'controller': 'SCSI controller 0'},\n {\n 'adapter': 'Hard disk 2',\n 'unit': 'MB',\n 'size': 10240,\n 'filename': 'my_vm/sdb.vmdk',\n 'datastore': 'my_datastore',\n 'address': '0:1',\n 'thin_provision': true,\n 'eagerly_scrub': false,\n 'controller': 'SCSI controller 0'}\n ] }}\n - scsi_devices: {{ [{\n 'adapter': 'SCSI controller 0',\n 'type': 'paravirtual',\n 'bus_sharing': 'no_sharing',\n 'bus_number': 0}\n ] }}\n - serial_ports: {{ [{\n 'adapter': 'Serial port 1',\n 'type': 'network',\n 'yield': false,\n 'backing': {\n 'uri': 'my_uri',\n 'direction': 'server',\n 'filename': 'my_file'},\n 'connectable': {\n 'start_connected': true,\n 'allow_guest_control': true,\n 'connected': true}}\n ] }}\n - datacenter: {{ 'my_dc' }}\n - datastore: 'my_datastore'\n - placement: {{ {'cluster': 'my_cluster'} }}\n - cd_dvd_drives: {{ [] }}\n - advanced_configs: {{ {'my_param': '1'} }}\n - template: false\n - tools: false\n - power_on: false\n - deploy: false\n\n\nvm_updated\n----------\n\nUpdates a virtual machine to a given configuration.\n\nvm_created\n----------\n\nCreates a virtual machine with a given configuration.\n\nvm_registered\n-------------\n\nRegisters a virtual machine with it's configuration file path.\n\nDependencies\n============\n\npyVmomi\n-------\n\nPyVmomi can be installed via pip:\n\n.. code-block:: bash\n\n pip install pyVmomi\n\n.. note::\n\n Version 6.0 of pyVmomi has some problems with SSL error handling on\n certain versions of Python. If using version 6.0 of pyVmomi, Python 2.6,\n Python 2.7.9, or newer must be present. This is due to an upstream\n dependency in pyVmomi 6.0 that is not supported in Python versions\n 2.7 to 2.7.8. If the version of Python is not in the supported range,\n you will need to install an earlier version of pyVmomi.\n See `Issue #29537`_ for more information.\n\n.. _Issue #29537: https://github.com/saltstack/salt/issues/29537\n\nBased on the note above, to install an earlier version of pyVmomi than the\nversion currently listed in PyPi, run the following:\n\n.. code-block:: bash\n\n pip install pyVmomi==6.0.0.2016.4\n\nThe 5.5.0.2014.1.1 is a known stable version that this original ESXi State\nModule was developed against. To be able to connect through SSPI you must\nuse pyvmomi 6.0.0.2016.4 or above. The ESXVM State Module was tested with\nthis version.\n\nAbout\n-----\n\nThis state module was written to be used in conjunction with Salt's\n:mod:`ESXi Proxy Minion <salt.proxy.esxi>` For a tutorial on how to use Salt's\nESXi Proxy Minion, please refer to the\n:ref:`ESXi Proxy Minion Tutorial <tutorial-esxi-proxy>` for\nconfiguration examples, dependency installation instructions, how to run remote\nexecution functions against ESXi hosts via a Salt Proxy Minion, and a larger state\nexample.\n'''\n\n# Import Python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport sys\nimport logging\n\n# Import Salt libs\nimport salt.exceptions\nimport salt.ext.six as six\nfrom salt.config.schemas.esxvm import ESXVirtualMachineConfigSchema\n\n# External libraries\ntry:\n import jsonschema\n HAS_JSONSCHEMA = True\nexcept ImportError:\n HAS_JSONSCHEMA = False\n\ntry:\n from pyVmomi import VmomiSupport\n HAS_PYVMOMI = True\nexcept ImportError:\n HAS_PYVMOMI = False\n\nlog = logging.getLogger(__name__)\n\n\ndef __virtual__():\n if not HAS_JSONSCHEMA:\n return False, 'State module did not load: jsonschema not found'\n if not HAS_PYVMOMI:\n return False, 'State module did not load: pyVmomi not found'\n\n # We check the supported vim versions to infer the pyVmomi version\n if 'vim25/6.0' in VmomiSupport.versionMap and \\\n sys.version_info > (2, 7) and sys.version_info < (2, 7, 9):\n\n return False, ('State module did not load: Incompatible versions '\n 'of Python and pyVmomi present. See Issue #29537.')\n return True\n\n\n\ndef vm_cloned(name):\n '''\n Clones a virtual machine from a template virtual machine if it doesn't\n exist and a template is defined.\n '''\n result = {'name': name,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n return result\n\n\ndef vm_updated(name, vm_name, cpu, memory, image, version, interfaces,\n disks, scsi_devices, serial_ports, datacenter, datastore,\n cd_dvd_drives=None, sata_controllers=None,\n advanced_configs=None, power_on=False):\n '''\n Updates a virtual machine configuration if there is a difference between\n the given and deployed configuration.\n '''\n result = {'name': name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n current_config = __salt__['vsphere.get_vm_config'](\n vm_name,\n datacenter=datacenter,\n objects=False,\n service_instance=service_instance)\n\n diffs = __salt__['vsphere.compare_vm_configs'](\n {'name': vm_name,\n 'cpu': cpu,\n 'memory': memory,\n 'image': image,\n 'version': version,\n 'interfaces': interfaces,\n 'disks': disks,\n 'scsi_devices': scsi_devices,\n 'serial_ports': serial_ports,\n 'datacenter': datacenter,\n 'datastore': datastore,\n 'cd_drives': cd_dvd_drives,\n 'sata_controllers': sata_controllers,\n 'advanced_configs': advanced_configs},\n current_config)\n if not diffs:\n result.update({\n 'result': True,\n 'changes': {},\n 'comment': 'Virtual machine {0} is already up to date'.format(vm_name)})\n return result\n\n if __opts__['test']:\n comment = 'State vm_updated will update virtual machine \\'{0}\\' ' \\\n 'in datacenter \\'{1}\\':\\n{2}'.format(vm_name,\n datacenter,\n '\\n'.join([':\\n'.join([key, difference.changes_str])\n for key, difference in six.iteritems(diffs)]))\n result.update({'result': None,\n 'comment': comment})\n __salt__['vsphere.disconnect'](service_instance)\n return result\n\n try:\n changes = __salt__['vsphere.update_vm'](vm_name, cpu, memory, image,\n version, interfaces, disks,\n scsi_devices, serial_ports,\n datacenter, datastore,\n cd_dvd_drives=cd_dvd_drives,\n sata_controllers=sata_controllers,\n advanced_configs=advanced_configs,\n service_instance=service_instance)\n except salt.exceptions.CommandExecutionError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n\n if power_on:\n try:\n __salt__['vsphere.power_on_vm'](vm_name, datacenter)\n except salt.exceptions.VMwarePowerOnError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n changes.update({'power_on': True})\n\n __salt__['vsphere.disconnect'](service_instance)\n\n result = {'name': name,\n 'result': True,\n 'changes': changes,\n 'comment': 'Virtual machine '\n '{0} was updated successfully'.format(vm_name)}\n\n return result\n\n\ndef vm_created(name, vm_name, cpu, memory, image, version, interfaces,\n disks, scsi_devices, serial_ports, datacenter, datastore,\n placement, ide_controllers=None, sata_controllers=None,\n cd_dvd_drives=None, advanced_configs=None, power_on=False):\n '''\n Creates a virtual machine with the given properties if it doesn't exist.\n '''\n result = {'name': name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n if __opts__['test']:\n result['comment'] = 'Virtual machine {0} will be created'.format(\n vm_name)\n return result\n\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n try:\n info = __salt__['vsphere.create_vm'](vm_name, cpu, memory, image,\n version, datacenter, datastore,\n placement, interfaces, disks,\n scsi_devices,\n serial_ports=serial_ports,\n ide_controllers=ide_controllers,\n sata_controllers=sata_controllers,\n cd_drives=cd_dvd_drives,\n advanced_configs=advanced_configs,\n service_instance=service_instance)\n except salt.exceptions.CommandExecutionError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n\n if power_on:\n try:\n __salt__['vsphere.power_on_vm'](vm_name, datacenter,\n service_instance=service_instance)\n except salt.exceptions.VMwarePowerOnError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n info['power_on'] = power_on\n\n changes = {'name': vm_name, 'info': info}\n __salt__['vsphere.disconnect'](service_instance)\n result = {'name': name,\n 'result': True,\n 'changes': changes,\n 'comment': 'Virtual machine '\n '{0} created successfully'.format(vm_name)}\n\n return result\n\n\ndef vm_registered(vm_name, datacenter, placement, vm_file, power_on=False):\n '''\n Registers a virtual machine if the machine files are available on\n the main datastore.\n '''\n result = {'name': vm_name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n vmx_path = '{0}{1}'.format(vm_file.folderPath, vm_file.file[0].path)\n log.trace('Registering virtual machine with vmx file: %s', vmx_path)\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n try:\n __salt__['vsphere.register_vm'](vm_name, datacenter,\n placement, vmx_path,\n service_instance=service_instance)\n except salt.exceptions.VMwareMultipleObjectsError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({'result': False,\n 'comment': six.text_type(exc)})\n return result\n except salt.exceptions.VMwareVmRegisterError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({'result': False,\n 'comment': six.text_type(exc)})\n return result\n\n if power_on:\n try:\n __salt__['vsphere.power_on_vm'](vm_name, datacenter,\n service_instance=service_instance)\n except salt.exceptions.VMwarePowerOnError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n __salt__['vsphere.disconnect'](service_instance)\n result.update({'result': True,\n 'changes': {'name': vm_name, 'power_on': power_on},\n 'comment': 'Virtual machine '\n '{0} registered successfully'.format(vm_name)})\n\n return result\n"}}},{"rowIdx":374,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/esxvm.py"},"func_name":{"kind":"string","value":"vm_updated"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def vm_updated(name, vm_name, cpu, memory, image, version, interfaces,\n disks, scsi_devices, serial_ports, datacenter, datastore,\n cd_dvd_drives=None, sata_controllers=None,\n advanced_configs=None, power_on=False):\n '''\n Updates a virtual machine configuration if there is a difference between\n the given and deployed configuration.\n '''\n result = {'name': name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n current_config = __salt__['vsphere.get_vm_config'](\n vm_name,\n datacenter=datacenter,\n objects=False,\n service_instance=service_instance)\n\n diffs = __salt__['vsphere.compare_vm_configs'](\n {'name': vm_name,\n 'cpu': cpu,\n 'memory': memory,\n 'image': image,\n 'version': version,\n 'interfaces': interfaces,\n 'disks': disks,\n 'scsi_devices': scsi_devices,\n 'serial_ports': serial_ports,\n 'datacenter': datacenter,\n 'datastore': datastore,\n 'cd_drives': cd_dvd_drives,\n 'sata_controllers': sata_controllers,\n 'advanced_configs': advanced_configs},\n current_config)\n if not diffs:\n result.update({\n 'result': True,\n 'changes': {},\n 'comment': 'Virtual machine {0} is already up to date'.format(vm_name)})\n return result\n\n if __opts__['test']:\n comment = 'State vm_updated will update virtual machine \\'{0}\\' ' \\\n 'in datacenter \\'{1}\\':\\n{2}'.format(vm_name,\n datacenter,\n '\\n'.join([':\\n'.join([key, difference.changes_str])\n for key, difference in six.iteritems(diffs)]))\n result.update({'result': None,\n 'comment': comment})\n __salt__['vsphere.disconnect'](service_instance)\n return result\n\n try:\n changes = __salt__['vsphere.update_vm'](vm_name, cpu, memory, image,\n version, interfaces, disks,\n scsi_devices, serial_ports,\n datacenter, datastore,\n cd_dvd_drives=cd_dvd_drives,\n sata_controllers=sata_controllers,\n advanced_configs=advanced_configs,\n service_instance=service_instance)\n except salt.exceptions.CommandExecutionError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n\n if power_on:\n try:\n __salt__['vsphere.power_on_vm'](vm_name, datacenter)\n except salt.exceptions.VMwarePowerOnError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n changes.update({'power_on': True})\n\n __salt__['vsphere.disconnect'](service_instance)\n\n result = {'name': name,\n 'result': True,\n 'changes': changes,\n 'comment': 'Virtual machine '\n '{0} was updated successfully'.format(vm_name)}\n\n return result"},"func_documentation_string":{"kind":"string","value":"Updates a virtual machine configuration if there is a difference between\n the given and deployed configuration."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/esxvm.py#L328-L421"},"called_functions":{"kind":"list like","value":["def iteritems(d, **kw):\n return d.iteritems(**kw)\n"],"string":"[\n \"def iteritems(d, **kw):\\n return d.iteritems(**kw)\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nSalt state to create, update VMware ESXi Virtual Machines.\n\nDependencies\n============\n\n- pyVmomi\n- jsonschema\n\nStates\n======\n\nvm_configured\n-------------\n\nEnforces correct virtual machine configuration. Creates, updates and registers\na virtual machine.\n\nThis state identifies the action which should be taken for the virtual machine\nand applies that action via the create, update, register state functions.\n\nSupported proxies: esxvm\n\n\nExample:\n\n1. Get the virtual machine ``my_vm`` status with an ``esxvm`` proxy:\n\nProxy minion configuration for ``esxvm`` proxy:\n\n.. code-block:: yaml\n\n proxy:\n proxytype: esxvm\n datacenter: my_dc\n vcenter: vcenter.fake.com\n mechanism: sspi\n domain: fake.com\n principal: host\n\nState configuration:\n\n.. code-block:: yaml\n\n myvm_state:\n esxvm.vm_configured:\n - vm_name: my_vm\n - cpu: {{ {'count': 4, 'cores_per_socket': 2} }}\n - memory: {{ {'size': 16384, 'unit': 'MB'} }}\n - image: rhel7_64Guest\n - version: vmx-12\n - interfaces: {{ [{\n 'adapter': 'Network adapter 1',\n 'name': 'my_pg1',\n 'switch_type': 'distributed',\n 'adapter_type': 'vmxnet3',\n 'mac': '00:50:56:00:01:02,\n 'connectable': { 'start_connected': true,\n 'allow_guest_control': true,\n 'connected': true}},\n {\n 'adapter': 'Network adapter 2',\n 'name': 'my_pg2',\n 'switch_type': 'distributed',\n 'adapter_type': 'vmxnet3',\n 'mac': '00:50:56:00:01:03',\n 'connectable': { 'start_connected': true,\n 'allow_guest_control': true,\n 'connected': true}}\n ] }}\n - disks: {{ [{\n 'adapter': 'Hard disk 1',\n 'unit': 'MB',\n 'size': 51200,\n 'filename': 'my_vm/sda.vmdk',\n 'datastore': 'my_datastore',\n 'address': '0:0',\n 'thin_provision': true,\n 'eagerly_scrub': false,\n 'controller': 'SCSI controller 0'},\n {\n 'adapter': 'Hard disk 2',\n 'unit': 'MB',\n 'size': 10240,\n 'filename': 'my_vm/sdb.vmdk',\n 'datastore': 'my_datastore',\n 'address': '0:1',\n 'thin_provision': true,\n 'eagerly_scrub': false,\n 'controller': 'SCSI controller 0'}\n ] }}\n - scsi_devices: {{ [{\n 'adapter': 'SCSI controller 0',\n 'type': 'paravirtual',\n 'bus_sharing': 'no_sharing',\n 'bus_number': 0}\n ] }}\n - serial_ports: {{ [{\n 'adapter': 'Serial port 1',\n 'type': 'network',\n 'yield': false,\n 'backing': {\n 'uri': 'my_uri',\n 'direction': 'server',\n 'filename': 'my_file'},\n 'connectable': {\n 'start_connected': true,\n 'allow_guest_control': true,\n 'connected': true}}\n ] }}\n - datacenter: {{ 'my_dc' }}\n - datastore: 'my_datastore'\n - placement: {{ {'cluster': 'my_cluster'} }}\n - cd_dvd_drives: {{ [] }}\n - advanced_configs: {{ {'my_param': '1'} }}\n - template: false\n - tools: false\n - power_on: false\n - deploy: false\n\n\nvm_updated\n----------\n\nUpdates a virtual machine to a given configuration.\n\nvm_created\n----------\n\nCreates a virtual machine with a given configuration.\n\nvm_registered\n-------------\n\nRegisters a virtual machine with it's configuration file path.\n\nDependencies\n============\n\npyVmomi\n-------\n\nPyVmomi can be installed via pip:\n\n.. code-block:: bash\n\n pip install pyVmomi\n\n.. note::\n\n Version 6.0 of pyVmomi has some problems with SSL error handling on\n certain versions of Python. If using version 6.0 of pyVmomi, Python 2.6,\n Python 2.7.9, or newer must be present. This is due to an upstream\n dependency in pyVmomi 6.0 that is not supported in Python versions\n 2.7 to 2.7.8. If the version of Python is not in the supported range,\n you will need to install an earlier version of pyVmomi.\n See `Issue #29537`_ for more information.\n\n.. _Issue #29537: https://github.com/saltstack/salt/issues/29537\n\nBased on the note above, to install an earlier version of pyVmomi than the\nversion currently listed in PyPi, run the following:\n\n.. code-block:: bash\n\n pip install pyVmomi==6.0.0.2016.4\n\nThe 5.5.0.2014.1.1 is a known stable version that this original ESXi State\nModule was developed against. To be able to connect through SSPI you must\nuse pyvmomi 6.0.0.2016.4 or above. The ESXVM State Module was tested with\nthis version.\n\nAbout\n-----\n\nThis state module was written to be used in conjunction with Salt's\n:mod:`ESXi Proxy Minion <salt.proxy.esxi>` For a tutorial on how to use Salt's\nESXi Proxy Minion, please refer to the\n:ref:`ESXi Proxy Minion Tutorial <tutorial-esxi-proxy>` for\nconfiguration examples, dependency installation instructions, how to run remote\nexecution functions against ESXi hosts via a Salt Proxy Minion, and a larger state\nexample.\n'''\n\n# Import Python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport sys\nimport logging\n\n# Import Salt libs\nimport salt.exceptions\nimport salt.ext.six as six\nfrom salt.config.schemas.esxvm import ESXVirtualMachineConfigSchema\n\n# External libraries\ntry:\n import jsonschema\n HAS_JSONSCHEMA = True\nexcept ImportError:\n HAS_JSONSCHEMA = False\n\ntry:\n from pyVmomi import VmomiSupport\n HAS_PYVMOMI = True\nexcept ImportError:\n HAS_PYVMOMI = False\n\nlog = logging.getLogger(__name__)\n\n\ndef __virtual__():\n if not HAS_JSONSCHEMA:\n return False, 'State module did not load: jsonschema not found'\n if not HAS_PYVMOMI:\n return False, 'State module did not load: pyVmomi not found'\n\n # We check the supported vim versions to infer the pyVmomi version\n if 'vim25/6.0' in VmomiSupport.versionMap and \\\n sys.version_info > (2, 7) and sys.version_info < (2, 7, 9):\n\n return False, ('State module did not load: Incompatible versions '\n 'of Python and pyVmomi present. See Issue #29537.')\n return True\n\n\ndef vm_configured(name, vm_name, cpu, memory, image, version, interfaces,\n disks, scsi_devices, serial_ports, datacenter, datastore,\n placement, cd_dvd_drives=None, sata_controllers=None,\n advanced_configs=None, template=None, tools=True,\n power_on=False, deploy=False):\n '''\n Selects the correct operation to be executed on a virtual machine, non\n existing machines will be created, existing ones will be updated if the\n config differs.\n '''\n result = {'name': name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n log.trace('Validating virtual machine configuration')\n schema = ESXVirtualMachineConfigSchema.serialize()\n log.trace('schema = %s', schema)\n try:\n jsonschema.validate({'vm_name': vm_name,\n 'cpu': cpu,\n 'memory': memory,\n 'image': image,\n 'version': version,\n 'interfaces': interfaces,\n 'disks': disks,\n 'scsi_devices': scsi_devices,\n 'serial_ports': serial_ports,\n 'cd_dvd_drives': cd_dvd_drives,\n 'sata_controllers': sata_controllers,\n 'datacenter': datacenter,\n 'datastore': datastore,\n 'placement': placement,\n 'template': template,\n 'tools': tools,\n 'power_on': power_on,\n 'deploy': deploy}, schema)\n except jsonschema.exceptions.ValidationError as exc:\n raise salt.exceptions.InvalidConfigError(exc)\n\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n try:\n __salt__['vsphere.get_vm'](vm_name, vm_properties=['name'],\n service_instance=service_instance)\n except salt.exceptions.VMwareObjectRetrievalError:\n vm_file = __salt__['vsphere.get_vm_config_file'](\n vm_name, datacenter,\n placement, datastore,\n service_instance=service_instance)\n if vm_file:\n if __opts__['test']:\n result.update({'comment': 'The virtual machine {0}'\n ' will be registered.'.format(vm_name)})\n __salt__['vsphere.disconnect'](service_instance)\n return result\n result = vm_registered(vm_name, datacenter, placement,\n vm_file, power_on=power_on)\n return result\n else:\n if __opts__['test']:\n result.update({'comment': 'The virtual machine {0}'\n ' will be created.'.format(vm_name)})\n __salt__['vsphere.disconnect'](service_instance)\n return result\n if template:\n result = vm_cloned(name)\n else:\n result = vm_created(name, vm_name, cpu, memory, image, version,\n interfaces, disks, scsi_devices,\n serial_ports, datacenter, datastore,\n placement, cd_dvd_drives=cd_dvd_drives,\n advanced_configs=advanced_configs,\n power_on=power_on)\n return result\n\n result = vm_updated(name, vm_name, cpu, memory, image, version,\n interfaces, disks, scsi_devices,\n serial_ports, datacenter, datastore,\n cd_dvd_drives=cd_dvd_drives,\n sata_controllers=sata_controllers,\n advanced_configs=advanced_configs,\n power_on=power_on)\n __salt__['vsphere.disconnect'](service_instance)\n\n log.trace(result)\n return result\n\n\ndef vm_cloned(name):\n '''\n Clones a virtual machine from a template virtual machine if it doesn't\n exist and a template is defined.\n '''\n result = {'name': name,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n return result\n\n\n\ndef vm_created(name, vm_name, cpu, memory, image, version, interfaces,\n disks, scsi_devices, serial_ports, datacenter, datastore,\n placement, ide_controllers=None, sata_controllers=None,\n cd_dvd_drives=None, advanced_configs=None, power_on=False):\n '''\n Creates a virtual machine with the given properties if it doesn't exist.\n '''\n result = {'name': name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n if __opts__['test']:\n result['comment'] = 'Virtual machine {0} will be created'.format(\n vm_name)\n return result\n\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n try:\n info = __salt__['vsphere.create_vm'](vm_name, cpu, memory, image,\n version, datacenter, datastore,\n placement, interfaces, disks,\n scsi_devices,\n serial_ports=serial_ports,\n ide_controllers=ide_controllers,\n sata_controllers=sata_controllers,\n cd_drives=cd_dvd_drives,\n advanced_configs=advanced_configs,\n service_instance=service_instance)\n except salt.exceptions.CommandExecutionError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n\n if power_on:\n try:\n __salt__['vsphere.power_on_vm'](vm_name, datacenter,\n service_instance=service_instance)\n except salt.exceptions.VMwarePowerOnError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n info['power_on'] = power_on\n\n changes = {'name': vm_name, 'info': info}\n __salt__['vsphere.disconnect'](service_instance)\n result = {'name': name,\n 'result': True,\n 'changes': changes,\n 'comment': 'Virtual machine '\n '{0} created successfully'.format(vm_name)}\n\n return result\n\n\ndef vm_registered(vm_name, datacenter, placement, vm_file, power_on=False):\n '''\n Registers a virtual machine if the machine files are available on\n the main datastore.\n '''\n result = {'name': vm_name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n vmx_path = '{0}{1}'.format(vm_file.folderPath, vm_file.file[0].path)\n log.trace('Registering virtual machine with vmx file: %s', vmx_path)\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n try:\n __salt__['vsphere.register_vm'](vm_name, datacenter,\n placement, vmx_path,\n service_instance=service_instance)\n except salt.exceptions.VMwareMultipleObjectsError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({'result': False,\n 'comment': six.text_type(exc)})\n return result\n except salt.exceptions.VMwareVmRegisterError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({'result': False,\n 'comment': six.text_type(exc)})\n return result\n\n if power_on:\n try:\n __salt__['vsphere.power_on_vm'](vm_name, datacenter,\n service_instance=service_instance)\n except salt.exceptions.VMwarePowerOnError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n __salt__['vsphere.disconnect'](service_instance)\n result.update({'result': True,\n 'changes': {'name': vm_name, 'power_on': power_on},\n 'comment': 'Virtual machine '\n '{0} registered successfully'.format(vm_name)})\n\n return result\n"}}},{"rowIdx":375,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/esxvm.py"},"func_name":{"kind":"string","value":"vm_created"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def vm_created(name, vm_name, cpu, memory, image, version, interfaces,\n disks, scsi_devices, serial_ports, datacenter, datastore,\n placement, ide_controllers=None, sata_controllers=None,\n cd_dvd_drives=None, advanced_configs=None, power_on=False):\n '''\n Creates a virtual machine with the given properties if it doesn't exist.\n '''\n result = {'name': name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n if __opts__['test']:\n result['comment'] = 'Virtual machine {0} will be created'.format(\n vm_name)\n return result\n\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n try:\n info = __salt__['vsphere.create_vm'](vm_name, cpu, memory, image,\n version, datacenter, datastore,\n placement, interfaces, disks,\n scsi_devices,\n serial_ports=serial_ports,\n ide_controllers=ide_controllers,\n sata_controllers=sata_controllers,\n cd_drives=cd_dvd_drives,\n advanced_configs=advanced_configs,\n service_instance=service_instance)\n except salt.exceptions.CommandExecutionError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n\n if power_on:\n try:\n __salt__['vsphere.power_on_vm'](vm_name, datacenter,\n service_instance=service_instance)\n except salt.exceptions.VMwarePowerOnError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n info['power_on'] = power_on\n\n changes = {'name': vm_name, 'info': info}\n __salt__['vsphere.disconnect'](service_instance)\n result = {'name': name,\n 'result': True,\n 'changes': changes,\n 'comment': 'Virtual machine '\n '{0} created successfully'.format(vm_name)}\n\n return result"},"func_documentation_string":{"kind":"string","value":"Creates a virtual machine with the given properties if it doesn't exist."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/esxvm.py#L424-L484"},"called_functions":{"kind":"null"},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nSalt state to create, update VMware ESXi Virtual Machines.\n\nDependencies\n============\n\n- pyVmomi\n- jsonschema\n\nStates\n======\n\nvm_configured\n-------------\n\nEnforces correct virtual machine configuration. Creates, updates and registers\na virtual machine.\n\nThis state identifies the action which should be taken for the virtual machine\nand applies that action via the create, update, register state functions.\n\nSupported proxies: esxvm\n\n\nExample:\n\n1. Get the virtual machine ``my_vm`` status with an ``esxvm`` proxy:\n\nProxy minion configuration for ``esxvm`` proxy:\n\n.. code-block:: yaml\n\n proxy:\n proxytype: esxvm\n datacenter: my_dc\n vcenter: vcenter.fake.com\n mechanism: sspi\n domain: fake.com\n principal: host\n\nState configuration:\n\n.. code-block:: yaml\n\n myvm_state:\n esxvm.vm_configured:\n - vm_name: my_vm\n - cpu: {{ {'count': 4, 'cores_per_socket': 2} }}\n - memory: {{ {'size': 16384, 'unit': 'MB'} }}\n - image: rhel7_64Guest\n - version: vmx-12\n - interfaces: {{ [{\n 'adapter': 'Network adapter 1',\n 'name': 'my_pg1',\n 'switch_type': 'distributed',\n 'adapter_type': 'vmxnet3',\n 'mac': '00:50:56:00:01:02,\n 'connectable': { 'start_connected': true,\n 'allow_guest_control': true,\n 'connected': true}},\n {\n 'adapter': 'Network adapter 2',\n 'name': 'my_pg2',\n 'switch_type': 'distributed',\n 'adapter_type': 'vmxnet3',\n 'mac': '00:50:56:00:01:03',\n 'connectable': { 'start_connected': true,\n 'allow_guest_control': true,\n 'connected': true}}\n ] }}\n - disks: {{ [{\n 'adapter': 'Hard disk 1',\n 'unit': 'MB',\n 'size': 51200,\n 'filename': 'my_vm/sda.vmdk',\n 'datastore': 'my_datastore',\n 'address': '0:0',\n 'thin_provision': true,\n 'eagerly_scrub': false,\n 'controller': 'SCSI controller 0'},\n {\n 'adapter': 'Hard disk 2',\n 'unit': 'MB',\n 'size': 10240,\n 'filename': 'my_vm/sdb.vmdk',\n 'datastore': 'my_datastore',\n 'address': '0:1',\n 'thin_provision': true,\n 'eagerly_scrub': false,\n 'controller': 'SCSI controller 0'}\n ] }}\n - scsi_devices: {{ [{\n 'adapter': 'SCSI controller 0',\n 'type': 'paravirtual',\n 'bus_sharing': 'no_sharing',\n 'bus_number': 0}\n ] }}\n - serial_ports: {{ [{\n 'adapter': 'Serial port 1',\n 'type': 'network',\n 'yield': false,\n 'backing': {\n 'uri': 'my_uri',\n 'direction': 'server',\n 'filename': 'my_file'},\n 'connectable': {\n 'start_connected': true,\n 'allow_guest_control': true,\n 'connected': true}}\n ] }}\n - datacenter: {{ 'my_dc' }}\n - datastore: 'my_datastore'\n - placement: {{ {'cluster': 'my_cluster'} }}\n - cd_dvd_drives: {{ [] }}\n - advanced_configs: {{ {'my_param': '1'} }}\n - template: false\n - tools: false\n - power_on: false\n - deploy: false\n\n\nvm_updated\n----------\n\nUpdates a virtual machine to a given configuration.\n\nvm_created\n----------\n\nCreates a virtual machine with a given configuration.\n\nvm_registered\n-------------\n\nRegisters a virtual machine with it's configuration file path.\n\nDependencies\n============\n\npyVmomi\n-------\n\nPyVmomi can be installed via pip:\n\n.. code-block:: bash\n\n pip install pyVmomi\n\n.. note::\n\n Version 6.0 of pyVmomi has some problems with SSL error handling on\n certain versions of Python. If using version 6.0 of pyVmomi, Python 2.6,\n Python 2.7.9, or newer must be present. This is due to an upstream\n dependency in pyVmomi 6.0 that is not supported in Python versions\n 2.7 to 2.7.8. If the version of Python is not in the supported range,\n you will need to install an earlier version of pyVmomi.\n See `Issue #29537`_ for more information.\n\n.. _Issue #29537: https://github.com/saltstack/salt/issues/29537\n\nBased on the note above, to install an earlier version of pyVmomi than the\nversion currently listed in PyPi, run the following:\n\n.. code-block:: bash\n\n pip install pyVmomi==6.0.0.2016.4\n\nThe 5.5.0.2014.1.1 is a known stable version that this original ESXi State\nModule was developed against. To be able to connect through SSPI you must\nuse pyvmomi 6.0.0.2016.4 or above. The ESXVM State Module was tested with\nthis version.\n\nAbout\n-----\n\nThis state module was written to be used in conjunction with Salt's\n:mod:`ESXi Proxy Minion <salt.proxy.esxi>` For a tutorial on how to use Salt's\nESXi Proxy Minion, please refer to the\n:ref:`ESXi Proxy Minion Tutorial <tutorial-esxi-proxy>` for\nconfiguration examples, dependency installation instructions, how to run remote\nexecution functions against ESXi hosts via a Salt Proxy Minion, and a larger state\nexample.\n'''\n\n# Import Python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport sys\nimport logging\n\n# Import Salt libs\nimport salt.exceptions\nimport salt.ext.six as six\nfrom salt.config.schemas.esxvm import ESXVirtualMachineConfigSchema\n\n# External libraries\ntry:\n import jsonschema\n HAS_JSONSCHEMA = True\nexcept ImportError:\n HAS_JSONSCHEMA = False\n\ntry:\n from pyVmomi import VmomiSupport\n HAS_PYVMOMI = True\nexcept ImportError:\n HAS_PYVMOMI = False\n\nlog = logging.getLogger(__name__)\n\n\ndef __virtual__():\n if not HAS_JSONSCHEMA:\n return False, 'State module did not load: jsonschema not found'\n if not HAS_PYVMOMI:\n return False, 'State module did not load: pyVmomi not found'\n\n # We check the supported vim versions to infer the pyVmomi version\n if 'vim25/6.0' in VmomiSupport.versionMap and \\\n sys.version_info > (2, 7) and sys.version_info < (2, 7, 9):\n\n return False, ('State module did not load: Incompatible versions '\n 'of Python and pyVmomi present. See Issue #29537.')\n return True\n\n\ndef vm_configured(name, vm_name, cpu, memory, image, version, interfaces,\n disks, scsi_devices, serial_ports, datacenter, datastore,\n placement, cd_dvd_drives=None, sata_controllers=None,\n advanced_configs=None, template=None, tools=True,\n power_on=False, deploy=False):\n '''\n Selects the correct operation to be executed on a virtual machine, non\n existing machines will be created, existing ones will be updated if the\n config differs.\n '''\n result = {'name': name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n log.trace('Validating virtual machine configuration')\n schema = ESXVirtualMachineConfigSchema.serialize()\n log.trace('schema = %s', schema)\n try:\n jsonschema.validate({'vm_name': vm_name,\n 'cpu': cpu,\n 'memory': memory,\n 'image': image,\n 'version': version,\n 'interfaces': interfaces,\n 'disks': disks,\n 'scsi_devices': scsi_devices,\n 'serial_ports': serial_ports,\n 'cd_dvd_drives': cd_dvd_drives,\n 'sata_controllers': sata_controllers,\n 'datacenter': datacenter,\n 'datastore': datastore,\n 'placement': placement,\n 'template': template,\n 'tools': tools,\n 'power_on': power_on,\n 'deploy': deploy}, schema)\n except jsonschema.exceptions.ValidationError as exc:\n raise salt.exceptions.InvalidConfigError(exc)\n\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n try:\n __salt__['vsphere.get_vm'](vm_name, vm_properties=['name'],\n service_instance=service_instance)\n except salt.exceptions.VMwareObjectRetrievalError:\n vm_file = __salt__['vsphere.get_vm_config_file'](\n vm_name, datacenter,\n placement, datastore,\n service_instance=service_instance)\n if vm_file:\n if __opts__['test']:\n result.update({'comment': 'The virtual machine {0}'\n ' will be registered.'.format(vm_name)})\n __salt__['vsphere.disconnect'](service_instance)\n return result\n result = vm_registered(vm_name, datacenter, placement,\n vm_file, power_on=power_on)\n return result\n else:\n if __opts__['test']:\n result.update({'comment': 'The virtual machine {0}'\n ' will be created.'.format(vm_name)})\n __salt__['vsphere.disconnect'](service_instance)\n return result\n if template:\n result = vm_cloned(name)\n else:\n result = vm_created(name, vm_name, cpu, memory, image, version,\n interfaces, disks, scsi_devices,\n serial_ports, datacenter, datastore,\n placement, cd_dvd_drives=cd_dvd_drives,\n advanced_configs=advanced_configs,\n power_on=power_on)\n return result\n\n result = vm_updated(name, vm_name, cpu, memory, image, version,\n interfaces, disks, scsi_devices,\n serial_ports, datacenter, datastore,\n cd_dvd_drives=cd_dvd_drives,\n sata_controllers=sata_controllers,\n advanced_configs=advanced_configs,\n power_on=power_on)\n __salt__['vsphere.disconnect'](service_instance)\n\n log.trace(result)\n return result\n\n\ndef vm_cloned(name):\n '''\n Clones a virtual machine from a template virtual machine if it doesn't\n exist and a template is defined.\n '''\n result = {'name': name,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n return result\n\n\ndef vm_updated(name, vm_name, cpu, memory, image, version, interfaces,\n disks, scsi_devices, serial_ports, datacenter, datastore,\n cd_dvd_drives=None, sata_controllers=None,\n advanced_configs=None, power_on=False):\n '''\n Updates a virtual machine configuration if there is a difference between\n the given and deployed configuration.\n '''\n result = {'name': name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n current_config = __salt__['vsphere.get_vm_config'](\n vm_name,\n datacenter=datacenter,\n objects=False,\n service_instance=service_instance)\n\n diffs = __salt__['vsphere.compare_vm_configs'](\n {'name': vm_name,\n 'cpu': cpu,\n 'memory': memory,\n 'image': image,\n 'version': version,\n 'interfaces': interfaces,\n 'disks': disks,\n 'scsi_devices': scsi_devices,\n 'serial_ports': serial_ports,\n 'datacenter': datacenter,\n 'datastore': datastore,\n 'cd_drives': cd_dvd_drives,\n 'sata_controllers': sata_controllers,\n 'advanced_configs': advanced_configs},\n current_config)\n if not diffs:\n result.update({\n 'result': True,\n 'changes': {},\n 'comment': 'Virtual machine {0} is already up to date'.format(vm_name)})\n return result\n\n if __opts__['test']:\n comment = 'State vm_updated will update virtual machine \\'{0}\\' ' \\\n 'in datacenter \\'{1}\\':\\n{2}'.format(vm_name,\n datacenter,\n '\\n'.join([':\\n'.join([key, difference.changes_str])\n for key, difference in six.iteritems(diffs)]))\n result.update({'result': None,\n 'comment': comment})\n __salt__['vsphere.disconnect'](service_instance)\n return result\n\n try:\n changes = __salt__['vsphere.update_vm'](vm_name, cpu, memory, image,\n version, interfaces, disks,\n scsi_devices, serial_ports,\n datacenter, datastore,\n cd_dvd_drives=cd_dvd_drives,\n sata_controllers=sata_controllers,\n advanced_configs=advanced_configs,\n service_instance=service_instance)\n except salt.exceptions.CommandExecutionError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n\n if power_on:\n try:\n __salt__['vsphere.power_on_vm'](vm_name, datacenter)\n except salt.exceptions.VMwarePowerOnError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n changes.update({'power_on': True})\n\n __salt__['vsphere.disconnect'](service_instance)\n\n result = {'name': name,\n 'result': True,\n 'changes': changes,\n 'comment': 'Virtual machine '\n '{0} was updated successfully'.format(vm_name)}\n\n return result\n\n\n\ndef vm_registered(vm_name, datacenter, placement, vm_file, power_on=False):\n '''\n Registers a virtual machine if the machine files are available on\n the main datastore.\n '''\n result = {'name': vm_name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n vmx_path = '{0}{1}'.format(vm_file.folderPath, vm_file.file[0].path)\n log.trace('Registering virtual machine with vmx file: %s', vmx_path)\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n try:\n __salt__['vsphere.register_vm'](vm_name, datacenter,\n placement, vmx_path,\n service_instance=service_instance)\n except salt.exceptions.VMwareMultipleObjectsError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({'result': False,\n 'comment': six.text_type(exc)})\n return result\n except salt.exceptions.VMwareVmRegisterError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({'result': False,\n 'comment': six.text_type(exc)})\n return result\n\n if power_on:\n try:\n __salt__['vsphere.power_on_vm'](vm_name, datacenter,\n service_instance=service_instance)\n except salt.exceptions.VMwarePowerOnError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n __salt__['vsphere.disconnect'](service_instance)\n result.update({'result': True,\n 'changes': {'name': vm_name, 'power_on': power_on},\n 'comment': 'Virtual machine '\n '{0} registered successfully'.format(vm_name)})\n\n return result\n"}}},{"rowIdx":376,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/esxvm.py"},"func_name":{"kind":"string","value":"vm_registered"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def vm_registered(vm_name, datacenter, placement, vm_file, power_on=False):\n '''\n Registers a virtual machine if the machine files are available on\n the main datastore.\n '''\n result = {'name': vm_name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n vmx_path = '{0}{1}'.format(vm_file.folderPath, vm_file.file[0].path)\n log.trace('Registering virtual machine with vmx file: %s', vmx_path)\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n try:\n __salt__['vsphere.register_vm'](vm_name, datacenter,\n placement, vmx_path,\n service_instance=service_instance)\n except salt.exceptions.VMwareMultipleObjectsError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({'result': False,\n 'comment': six.text_type(exc)})\n return result\n except salt.exceptions.VMwareVmRegisterError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({'result': False,\n 'comment': six.text_type(exc)})\n return result\n\n if power_on:\n try:\n __salt__['vsphere.power_on_vm'](vm_name, datacenter,\n service_instance=service_instance)\n except salt.exceptions.VMwarePowerOnError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n __salt__['vsphere.disconnect'](service_instance)\n result.update({'result': True,\n 'changes': {'name': vm_name, 'power_on': power_on},\n 'comment': 'Virtual machine '\n '{0} registered successfully'.format(vm_name)})\n\n return result"},"func_documentation_string":{"kind":"string","value":"Registers a virtual machine if the machine files are available on\n the main datastore."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/esxvm.py#L487-L537"},"called_functions":{"kind":"null"},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nSalt state to create, update VMware ESXi Virtual Machines.\n\nDependencies\n============\n\n- pyVmomi\n- jsonschema\n\nStates\n======\n\nvm_configured\n-------------\n\nEnforces correct virtual machine configuration. Creates, updates and registers\na virtual machine.\n\nThis state identifies the action which should be taken for the virtual machine\nand applies that action via the create, update, register state functions.\n\nSupported proxies: esxvm\n\n\nExample:\n\n1. Get the virtual machine ``my_vm`` status with an ``esxvm`` proxy:\n\nProxy minion configuration for ``esxvm`` proxy:\n\n.. code-block:: yaml\n\n proxy:\n proxytype: esxvm\n datacenter: my_dc\n vcenter: vcenter.fake.com\n mechanism: sspi\n domain: fake.com\n principal: host\n\nState configuration:\n\n.. code-block:: yaml\n\n myvm_state:\n esxvm.vm_configured:\n - vm_name: my_vm\n - cpu: {{ {'count': 4, 'cores_per_socket': 2} }}\n - memory: {{ {'size': 16384, 'unit': 'MB'} }}\n - image: rhel7_64Guest\n - version: vmx-12\n - interfaces: {{ [{\n 'adapter': 'Network adapter 1',\n 'name': 'my_pg1',\n 'switch_type': 'distributed',\n 'adapter_type': 'vmxnet3',\n 'mac': '00:50:56:00:01:02,\n 'connectable': { 'start_connected': true,\n 'allow_guest_control': true,\n 'connected': true}},\n {\n 'adapter': 'Network adapter 2',\n 'name': 'my_pg2',\n 'switch_type': 'distributed',\n 'adapter_type': 'vmxnet3',\n 'mac': '00:50:56:00:01:03',\n 'connectable': { 'start_connected': true,\n 'allow_guest_control': true,\n 'connected': true}}\n ] }}\n - disks: {{ [{\n 'adapter': 'Hard disk 1',\n 'unit': 'MB',\n 'size': 51200,\n 'filename': 'my_vm/sda.vmdk',\n 'datastore': 'my_datastore',\n 'address': '0:0',\n 'thin_provision': true,\n 'eagerly_scrub': false,\n 'controller': 'SCSI controller 0'},\n {\n 'adapter': 'Hard disk 2',\n 'unit': 'MB',\n 'size': 10240,\n 'filename': 'my_vm/sdb.vmdk',\n 'datastore': 'my_datastore',\n 'address': '0:1',\n 'thin_provision': true,\n 'eagerly_scrub': false,\n 'controller': 'SCSI controller 0'}\n ] }}\n - scsi_devices: {{ [{\n 'adapter': 'SCSI controller 0',\n 'type': 'paravirtual',\n 'bus_sharing': 'no_sharing',\n 'bus_number': 0}\n ] }}\n - serial_ports: {{ [{\n 'adapter': 'Serial port 1',\n 'type': 'network',\n 'yield': false,\n 'backing': {\n 'uri': 'my_uri',\n 'direction': 'server',\n 'filename': 'my_file'},\n 'connectable': {\n 'start_connected': true,\n 'allow_guest_control': true,\n 'connected': true}}\n ] }}\n - datacenter: {{ 'my_dc' }}\n - datastore: 'my_datastore'\n - placement: {{ {'cluster': 'my_cluster'} }}\n - cd_dvd_drives: {{ [] }}\n - advanced_configs: {{ {'my_param': '1'} }}\n - template: false\n - tools: false\n - power_on: false\n - deploy: false\n\n\nvm_updated\n----------\n\nUpdates a virtual machine to a given configuration.\n\nvm_created\n----------\n\nCreates a virtual machine with a given configuration.\n\nvm_registered\n-------------\n\nRegisters a virtual machine with it's configuration file path.\n\nDependencies\n============\n\npyVmomi\n-------\n\nPyVmomi can be installed via pip:\n\n.. code-block:: bash\n\n pip install pyVmomi\n\n.. note::\n\n Version 6.0 of pyVmomi has some problems with SSL error handling on\n certain versions of Python. If using version 6.0 of pyVmomi, Python 2.6,\n Python 2.7.9, or newer must be present. This is due to an upstream\n dependency in pyVmomi 6.0 that is not supported in Python versions\n 2.7 to 2.7.8. If the version of Python is not in the supported range,\n you will need to install an earlier version of pyVmomi.\n See `Issue #29537`_ for more information.\n\n.. _Issue #29537: https://github.com/saltstack/salt/issues/29537\n\nBased on the note above, to install an earlier version of pyVmomi than the\nversion currently listed in PyPi, run the following:\n\n.. code-block:: bash\n\n pip install pyVmomi==6.0.0.2016.4\n\nThe 5.5.0.2014.1.1 is a known stable version that this original ESXi State\nModule was developed against. To be able to connect through SSPI you must\nuse pyvmomi 6.0.0.2016.4 or above. The ESXVM State Module was tested with\nthis version.\n\nAbout\n-----\n\nThis state module was written to be used in conjunction with Salt's\n:mod:`ESXi Proxy Minion <salt.proxy.esxi>` For a tutorial on how to use Salt's\nESXi Proxy Minion, please refer to the\n:ref:`ESXi Proxy Minion Tutorial <tutorial-esxi-proxy>` for\nconfiguration examples, dependency installation instructions, how to run remote\nexecution functions against ESXi hosts via a Salt Proxy Minion, and a larger state\nexample.\n'''\n\n# Import Python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport sys\nimport logging\n\n# Import Salt libs\nimport salt.exceptions\nimport salt.ext.six as six\nfrom salt.config.schemas.esxvm import ESXVirtualMachineConfigSchema\n\n# External libraries\ntry:\n import jsonschema\n HAS_JSONSCHEMA = True\nexcept ImportError:\n HAS_JSONSCHEMA = False\n\ntry:\n from pyVmomi import VmomiSupport\n HAS_PYVMOMI = True\nexcept ImportError:\n HAS_PYVMOMI = False\n\nlog = logging.getLogger(__name__)\n\n\ndef __virtual__():\n if not HAS_JSONSCHEMA:\n return False, 'State module did not load: jsonschema not found'\n if not HAS_PYVMOMI:\n return False, 'State module did not load: pyVmomi not found'\n\n # We check the supported vim versions to infer the pyVmomi version\n if 'vim25/6.0' in VmomiSupport.versionMap and \\\n sys.version_info > (2, 7) and sys.version_info < (2, 7, 9):\n\n return False, ('State module did not load: Incompatible versions '\n 'of Python and pyVmomi present. See Issue #29537.')\n return True\n\n\ndef vm_configured(name, vm_name, cpu, memory, image, version, interfaces,\n disks, scsi_devices, serial_ports, datacenter, datastore,\n placement, cd_dvd_drives=None, sata_controllers=None,\n advanced_configs=None, template=None, tools=True,\n power_on=False, deploy=False):\n '''\n Selects the correct operation to be executed on a virtual machine, non\n existing machines will be created, existing ones will be updated if the\n config differs.\n '''\n result = {'name': name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n log.trace('Validating virtual machine configuration')\n schema = ESXVirtualMachineConfigSchema.serialize()\n log.trace('schema = %s', schema)\n try:\n jsonschema.validate({'vm_name': vm_name,\n 'cpu': cpu,\n 'memory': memory,\n 'image': image,\n 'version': version,\n 'interfaces': interfaces,\n 'disks': disks,\n 'scsi_devices': scsi_devices,\n 'serial_ports': serial_ports,\n 'cd_dvd_drives': cd_dvd_drives,\n 'sata_controllers': sata_controllers,\n 'datacenter': datacenter,\n 'datastore': datastore,\n 'placement': placement,\n 'template': template,\n 'tools': tools,\n 'power_on': power_on,\n 'deploy': deploy}, schema)\n except jsonschema.exceptions.ValidationError as exc:\n raise salt.exceptions.InvalidConfigError(exc)\n\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n try:\n __salt__['vsphere.get_vm'](vm_name, vm_properties=['name'],\n service_instance=service_instance)\n except salt.exceptions.VMwareObjectRetrievalError:\n vm_file = __salt__['vsphere.get_vm_config_file'](\n vm_name, datacenter,\n placement, datastore,\n service_instance=service_instance)\n if vm_file:\n if __opts__['test']:\n result.update({'comment': 'The virtual machine {0}'\n ' will be registered.'.format(vm_name)})\n __salt__['vsphere.disconnect'](service_instance)\n return result\n result = vm_registered(vm_name, datacenter, placement,\n vm_file, power_on=power_on)\n return result\n else:\n if __opts__['test']:\n result.update({'comment': 'The virtual machine {0}'\n ' will be created.'.format(vm_name)})\n __salt__['vsphere.disconnect'](service_instance)\n return result\n if template:\n result = vm_cloned(name)\n else:\n result = vm_created(name, vm_name, cpu, memory, image, version,\n interfaces, disks, scsi_devices,\n serial_ports, datacenter, datastore,\n placement, cd_dvd_drives=cd_dvd_drives,\n advanced_configs=advanced_configs,\n power_on=power_on)\n return result\n\n result = vm_updated(name, vm_name, cpu, memory, image, version,\n interfaces, disks, scsi_devices,\n serial_ports, datacenter, datastore,\n cd_dvd_drives=cd_dvd_drives,\n sata_controllers=sata_controllers,\n advanced_configs=advanced_configs,\n power_on=power_on)\n __salt__['vsphere.disconnect'](service_instance)\n\n log.trace(result)\n return result\n\n\ndef vm_cloned(name):\n '''\n Clones a virtual machine from a template virtual machine if it doesn't\n exist and a template is defined.\n '''\n result = {'name': name,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n return result\n\n\ndef vm_updated(name, vm_name, cpu, memory, image, version, interfaces,\n disks, scsi_devices, serial_ports, datacenter, datastore,\n cd_dvd_drives=None, sata_controllers=None,\n advanced_configs=None, power_on=False):\n '''\n Updates a virtual machine configuration if there is a difference between\n the given and deployed configuration.\n '''\n result = {'name': name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n current_config = __salt__['vsphere.get_vm_config'](\n vm_name,\n datacenter=datacenter,\n objects=False,\n service_instance=service_instance)\n\n diffs = __salt__['vsphere.compare_vm_configs'](\n {'name': vm_name,\n 'cpu': cpu,\n 'memory': memory,\n 'image': image,\n 'version': version,\n 'interfaces': interfaces,\n 'disks': disks,\n 'scsi_devices': scsi_devices,\n 'serial_ports': serial_ports,\n 'datacenter': datacenter,\n 'datastore': datastore,\n 'cd_drives': cd_dvd_drives,\n 'sata_controllers': sata_controllers,\n 'advanced_configs': advanced_configs},\n current_config)\n if not diffs:\n result.update({\n 'result': True,\n 'changes': {},\n 'comment': 'Virtual machine {0} is already up to date'.format(vm_name)})\n return result\n\n if __opts__['test']:\n comment = 'State vm_updated will update virtual machine \\'{0}\\' ' \\\n 'in datacenter \\'{1}\\':\\n{2}'.format(vm_name,\n datacenter,\n '\\n'.join([':\\n'.join([key, difference.changes_str])\n for key, difference in six.iteritems(diffs)]))\n result.update({'result': None,\n 'comment': comment})\n __salt__['vsphere.disconnect'](service_instance)\n return result\n\n try:\n changes = __salt__['vsphere.update_vm'](vm_name, cpu, memory, image,\n version, interfaces, disks,\n scsi_devices, serial_ports,\n datacenter, datastore,\n cd_dvd_drives=cd_dvd_drives,\n sata_controllers=sata_controllers,\n advanced_configs=advanced_configs,\n service_instance=service_instance)\n except salt.exceptions.CommandExecutionError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n\n if power_on:\n try:\n __salt__['vsphere.power_on_vm'](vm_name, datacenter)\n except salt.exceptions.VMwarePowerOnError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n changes.update({'power_on': True})\n\n __salt__['vsphere.disconnect'](service_instance)\n\n result = {'name': name,\n 'result': True,\n 'changes': changes,\n 'comment': 'Virtual machine '\n '{0} was updated successfully'.format(vm_name)}\n\n return result\n\n\ndef vm_created(name, vm_name, cpu, memory, image, version, interfaces,\n disks, scsi_devices, serial_ports, datacenter, datastore,\n placement, ide_controllers=None, sata_controllers=None,\n cd_dvd_drives=None, advanced_configs=None, power_on=False):\n '''\n Creates a virtual machine with the given properties if it doesn't exist.\n '''\n result = {'name': name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\n if __opts__['test']:\n result['comment'] = 'Virtual machine {0} will be created'.format(\n vm_name)\n return result\n\n service_instance = __salt__['vsphere.get_service_instance_via_proxy']()\n try:\n info = __salt__['vsphere.create_vm'](vm_name, cpu, memory, image,\n version, datacenter, datastore,\n placement, interfaces, disks,\n scsi_devices,\n serial_ports=serial_ports,\n ide_controllers=ide_controllers,\n sata_controllers=sata_controllers,\n cd_drives=cd_dvd_drives,\n advanced_configs=advanced_configs,\n service_instance=service_instance)\n except salt.exceptions.CommandExecutionError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n\n if power_on:\n try:\n __salt__['vsphere.power_on_vm'](vm_name, datacenter,\n service_instance=service_instance)\n except salt.exceptions.VMwarePowerOnError as exc:\n log.error('Error: %s', exc)\n if service_instance:\n __salt__['vsphere.disconnect'](service_instance)\n result.update({\n 'result': False,\n 'comment': six.text_type(exc)})\n return result\n info['power_on'] = power_on\n\n changes = {'name': vm_name, 'info': info}\n __salt__['vsphere.disconnect'](service_instance)\n result = {'name': name,\n 'result': True,\n 'changes': changes,\n 'comment': 'Virtual machine '\n '{0} created successfully'.format(vm_name)}\n\n return result\n\n"}}},{"rowIdx":377,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/npm.py"},"func_name":{"kind":"string","value":"installed"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def installed(name,\n pkgs=None,\n dir=None,\n user=None,\n force_reinstall=False,\n registry=None,\n env=None):\n '''\n Verify that the given package is installed and is at the correct version\n (if specified).\n\n .. code-block:: yaml\n\n coffee-script:\n npm.installed:\n - user: someuser\n\n coffee-script@1.0.1:\n npm.installed: []\n\n name\n The package to install\n\n .. versionchanged:: 2014.7.2\n This parameter is no longer lowercased by salt so that\n case-sensitive NPM package names will work.\n\n pkgs\n A list of packages to install with a single npm invocation; specifying\n this argument will ignore the ``name`` argument\n\n .. versionadded:: 2014.7.0\n\n dir\n The target directory in which to install the package, or None for\n global installation\n\n user\n The user to run NPM with\n\n .. versionadded:: 0.17.0\n\n registry\n The NPM registry from which to install the package\n\n .. versionadded:: 2014.7.0\n\n env\n A list of environment variables to be set prior to execution. The\n format is the same as the :py:func:`cmd.run <salt.states.cmd.run>`.\n state function.\n\n .. versionadded:: 2014.7.0\n\n force_reinstall\n Install the package even if it is already installed\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n\n pkg_list = pkgs if pkgs else [name]\n\n try:\n installed_pkgs = __salt__['npm.list'](dir=dir, runas=user, env=env, depth=0)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error looking up \\'{0}\\': {1}'.format(name, err)\n return ret\n else:\n installed_pkgs = dict((p, info)\n for p, info in six.iteritems(installed_pkgs))\n\n pkgs_satisfied = []\n pkgs_to_install = []\n\n def _pkg_is_installed(pkg, installed_pkgs):\n '''\n Helper function to determine if a package is installed\n\n This performs more complex comparison than just checking\n keys, such as examining source repos to see if the package\n was installed by a different name from the same repo\n\n :pkg str: The package to compare\n :installed_pkgs: A dictionary produced by npm list --json\n '''\n if (pkg_name in installed_pkgs and\n 'version' in installed_pkgs[pkg_name]):\n return True\n # Check to see if we are trying to install from a URI\n elif '://' in pkg_name: # TODO Better way?\n for pkg_details in installed_pkgs.values():\n try:\n pkg_from = pkg_details.get('from', '').split('://')[1]\n # Catch condition where we may have specified package as\n # git://github.com/foo/bar but packager describes it as\n # git://github.com/foo/bar.git in the package\n if not pkg_from.endswith('.git') and pkg_name.startswith('git://'):\n pkg_from += '.git'\n if pkg_name.split('://')[1] == pkg_from:\n return True\n except IndexError:\n pass\n return False\n for pkg in pkg_list:\n # Valid:\n #\n # @google-cloud/bigquery@^0.9.6\n # @foobar\n # buffer-equal-constant-time@1.0.1\n # coffee-script\n matches = re.search(r'^(@?[^@\\s]+)(?:@(\\S+))?', pkg)\n pkg_name, pkg_ver = matches.group(1), matches.group(2) or None\n\n if force_reinstall is True:\n pkgs_to_install.append(pkg)\n continue\n if not _pkg_is_installed(pkg, installed_pkgs):\n pkgs_to_install.append(pkg)\n continue\n\n installed_name_ver = '{0}@{1}'.format(pkg_name,\n installed_pkgs[pkg_name]['version'])\n\n # If given an explicit version check the installed version matches.\n if pkg_ver:\n if installed_pkgs[pkg_name].get('version') != pkg_ver:\n pkgs_to_install.append(pkg)\n else:\n pkgs_satisfied.append(installed_name_ver)\n\n continue\n else:\n pkgs_satisfied.append(installed_name_ver)\n continue\n\n if __opts__['test']:\n ret['result'] = None\n\n comment_msg = []\n if pkgs_to_install:\n comment_msg.append('NPM package(s) \\'{0}\\' are set to be installed'\n .format(', '.join(pkgs_to_install)))\n\n ret['changes'] = {'old': [], 'new': pkgs_to_install}\n\n if pkgs_satisfied:\n comment_msg.append('Package(s) \\'{0}\\' satisfied by {1}'\n .format(', '.join(pkg_list), ', '.join(pkgs_satisfied)))\n ret['result'] = True\n\n ret['comment'] = '. '.join(comment_msg)\n return ret\n\n if not pkgs_to_install:\n ret['result'] = True\n ret['comment'] = ('Package(s) \\'{0}\\' satisfied by {1}'\n .format(', '.join(pkg_list), ', '.join(pkgs_satisfied)))\n return ret\n\n try:\n cmd_args = {\n 'dir': dir,\n 'runas': user,\n 'registry': registry,\n 'env': env,\n 'pkgs': pkg_list,\n }\n\n call = __salt__['npm.install'](**cmd_args)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error installing \\'{0}\\': {1}'.format(\n ', '.join(pkg_list), err)\n return ret\n\n if call and (isinstance(call, list) or isinstance(call, dict)):\n ret['result'] = True\n ret['changes'] = {'old': [], 'new': pkgs_to_install}\n ret['comment'] = 'Package(s) \\'{0}\\' successfully installed'.format(\n ', '.join(pkgs_to_install))\n else:\n ret['result'] = False\n ret['comment'] = 'Could not install package(s) \\'{0}\\''.format(\n ', '.join(pkg_list))\n\n return ret"},"func_documentation_string":{"kind":"string","value":"Verify that the given package is installed and is at the correct version\n (if specified).\n\n .. code-block:: yaml\n\n coffee-script:\n npm.installed:\n - user: someuser\n\n coffee-script@1.0.1:\n npm.installed: []\n\n name\n The package to install\n\n .. versionchanged:: 2014.7.2\n This parameter is no longer lowercased by salt so that\n case-sensitive NPM package names will work.\n\n pkgs\n A list of packages to install with a single npm invocation; specifying\n this argument will ignore the ``name`` argument\n\n .. versionadded:: 2014.7.0\n\n dir\n The target directory in which to install the package, or None for\n global installation\n\n user\n The user to run NPM with\n\n .. versionadded:: 0.17.0\n\n registry\n The NPM registry from which to install the package\n\n .. versionadded:: 2014.7.0\n\n env\n A list of environment variables to be set prior to execution. The\n format is the same as the :py:func:`cmd.run <salt.states.cmd.run>`.\n state function.\n\n .. versionadded:: 2014.7.0\n\n force_reinstall\n Install the package even if it is already installed"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/npm.py#L38-L223"},"called_functions":{"kind":"list like","value":["def iteritems(d, **kw):\n return d.iteritems(**kw)\n","def _pkg_is_installed(pkg, installed_pkgs):\n '''\n Helper function to determine if a package is installed\n\n This performs more complex comparison than just checking\n keys, such as examining source repos to see if the package\n was installed by a different name from the same repo\n\n :pkg str: The package to compare\n :installed_pkgs: A dictionary produced by npm list --json\n '''\n if (pkg_name in installed_pkgs and\n 'version' in installed_pkgs[pkg_name]):\n return True\n # Check to see if we are trying to install from a URI\n elif '://' in pkg_name: # TODO Better way?\n for pkg_details in installed_pkgs.values():\n try:\n pkg_from = pkg_details.get('from', '').split('://')[1]\n # Catch condition where we may have specified package as\n # git://github.com/foo/bar but packager describes it as\n # git://github.com/foo/bar.git in the package\n if not pkg_from.endswith('.git') and pkg_name.startswith('git://'):\n pkg_from += '.git'\n if pkg_name.split('://')[1] == pkg_from:\n return True\n except IndexError:\n pass\n return False\n"],"string":"[\n \"def iteritems(d, **kw):\\n return d.iteritems(**kw)\\n\",\n \"def _pkg_is_installed(pkg, installed_pkgs):\\n '''\\n Helper function to determine if a package is installed\\n\\n This performs more complex comparison than just checking\\n keys, such as examining source repos to see if the package\\n was installed by a different name from the same repo\\n\\n :pkg str: The package to compare\\n :installed_pkgs: A dictionary produced by npm list --json\\n '''\\n if (pkg_name in installed_pkgs and\\n 'version' in installed_pkgs[pkg_name]):\\n return True\\n # Check to see if we are trying to install from a URI\\n elif '://' in pkg_name: # TODO Better way?\\n for pkg_details in installed_pkgs.values():\\n try:\\n pkg_from = pkg_details.get('from', '').split('://')[1]\\n # Catch condition where we may have specified package as\\n # git://github.com/foo/bar but packager describes it as\\n # git://github.com/foo/bar.git in the package\\n if not pkg_from.endswith('.git') and pkg_name.startswith('git://'):\\n pkg_from += '.git'\\n if pkg_name.split('://')[1] == pkg_from:\\n return True\\n except IndexError:\\n pass\\n return False\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nInstallation of NPM Packages\n============================\n\nThese states manage the installed packages for node.js using the Node Package\nManager (npm). Note that npm must be installed for these states to be\navailable, so npm states should include a requisite to a pkg.installed state\nfor the package which provides npm (simply ``npm`` in most cases). Example:\n\n.. code-block:: yaml\n\n npm:\n pkg.installed\n\n yaml:\n npm.installed:\n - require:\n - pkg: npm\n'''\n\n# Import salt libs\nfrom __future__ import absolute_import, unicode_literals, print_function\nfrom salt.exceptions import CommandExecutionError, CommandNotFoundError\n\n# Import 3rd-party libs\nimport re\nfrom salt.ext import six\n\n\ndef __virtual__():\n '''\n Only load if the npm module is available in __salt__\n '''\n return 'npm' if 'npm.list' in __salt__ else False, '\\'npm\\' binary not found on system'\n\n\n\ndef removed(name, dir=None, user=None):\n '''\n Verify that the given package is not installed.\n\n dir\n The target directory in which to install the package, or None for\n global installation\n\n user\n The user to run NPM with\n\n .. versionadded:: 0.17.0\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n\n try:\n installed_pkgs = __salt__['npm.list'](dir=dir, depth=0)\n except (CommandExecutionError, CommandNotFoundError) as err:\n ret['result'] = False\n ret['comment'] = 'Error uninstalling \\'{0}\\': {1}'.format(name, err)\n return ret\n\n if name not in installed_pkgs:\n ret['result'] = True\n ret['comment'] = 'Package \\'{0}\\' is not installed'.format(name)\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n ret['comment'] = 'Package \\'{0}\\' is set to be removed'.format(name)\n return ret\n\n if __salt__['npm.uninstall'](pkg=name, dir=dir, runas=user):\n ret['result'] = True\n ret['changes'][name] = 'Removed'\n ret['comment'] = 'Package \\'{0}\\' was successfully removed'.format(name)\n else:\n ret['result'] = False\n ret['comment'] = 'Error removing package \\'{0}\\''.format(name)\n\n return ret\n\n\ndef bootstrap(name, user=None, silent=True):\n '''\n Bootstraps a node.js application.\n\n Will execute 'npm install --json' on the specified directory.\n\n user\n The user to run NPM with\n\n .. versionadded:: 0.17.0\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n\n if __opts__['test']:\n try:\n call = __salt__['npm.install'](dir=name, runas=user, pkg=None, silent=silent, dry_run=True)\n if call:\n ret['result'] = None\n ret['changes'] = {'old': [], 'new': call}\n ret['comment'] = '{0} is set to be bootstrapped'.format(name)\n else:\n ret['result'] = True\n ret['comment'] = '{0} is already bootstrapped'.format(name)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error Bootstrapping \\'{0}\\': {1}'.format(name, err)\n return ret\n\n try:\n call = __salt__['npm.install'](dir=name, runas=user, pkg=None, silent=silent)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error Bootstrapping \\'{0}\\': {1}'.format(name, err)\n return ret\n\n if not call:\n ret['result'] = True\n ret['comment'] = 'Directory is already bootstrapped'\n return ret\n\n # npm.install will return a string if it can't parse a JSON result\n if isinstance(call, six.string_types):\n ret['result'] = False\n ret['changes'] = call\n ret['comment'] = 'Could not bootstrap directory'\n else:\n ret['result'] = True\n ret['changes'] = {name: 'Bootstrapped'}\n ret['comment'] = 'Directory was successfully bootstrapped'\n\n return ret\n\n\ndef cache_cleaned(name=None,\n user=None,\n force=False):\n '''\n Ensure that the given package is not cached.\n\n If no package is specified, this ensures the entire cache is cleared.\n\n name\n The name of the package to remove from the cache, or None for all packages\n\n user\n The user to run NPM with\n\n force\n Force cleaning of cache. Required for npm@5 and greater\n\n .. versionadded:: 2016.11.6\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n specific_pkg = None\n\n try:\n cached_pkgs = __salt__['npm.cache_list'](path=name, runas=user)\n except (CommandExecutionError, CommandNotFoundError) as err:\n ret['result'] = False\n ret['comment'] = 'Error looking up cached {0}: {1}'.format(\n name or 'packages', err)\n return ret\n\n if name:\n all_cached_pkgs = __salt__['npm.cache_list'](path=None, runas=user)\n # The first package is always the cache path\n cache_root_path = all_cached_pkgs[0]\n specific_pkg = '{0}/{1}/'.format(cache_root_path, name)\n\n if specific_pkg not in cached_pkgs:\n ret['result'] = True\n ret['comment'] = 'Package {0} is not in the cache'.format(name)\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n ret['comment'] = 'Cached {0} set to be removed'.format(name or 'packages')\n return ret\n\n if __salt__['npm.cache_clean'](path=name, runas=user):\n ret['result'] = True\n ret['changes'][name or 'cache'] = 'Removed'\n ret['comment'] = 'Cached {0} successfully removed'.format(\n name or 'packages'\n )\n else:\n ret['result'] = False\n ret['comment'] = 'Error cleaning cached {0}'.format(name or 'packages')\n\n return ret\n"}}},{"rowIdx":378,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/npm.py"},"func_name":{"kind":"string","value":"removed"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def removed(name, dir=None, user=None):\n '''\n Verify that the given package is not installed.\n\n dir\n The target directory in which to install the package, or None for\n global installation\n\n user\n The user to run NPM with\n\n .. versionadded:: 0.17.0\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n\n try:\n installed_pkgs = __salt__['npm.list'](dir=dir, depth=0)\n except (CommandExecutionError, CommandNotFoundError) as err:\n ret['result'] = False\n ret['comment'] = 'Error uninstalling \\'{0}\\': {1}'.format(name, err)\n return ret\n\n if name not in installed_pkgs:\n ret['result'] = True\n ret['comment'] = 'Package \\'{0}\\' is not installed'.format(name)\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n ret['comment'] = 'Package \\'{0}\\' is set to be removed'.format(name)\n return ret\n\n if __salt__['npm.uninstall'](pkg=name, dir=dir, runas=user):\n ret['result'] = True\n ret['changes'][name] = 'Removed'\n ret['comment'] = 'Package \\'{0}\\' was successfully removed'.format(name)\n else:\n ret['result'] = False\n ret['comment'] = 'Error removing package \\'{0}\\''.format(name)\n\n return ret"},"func_documentation_string":{"kind":"string","value":"Verify that the given package is not installed.\n\n dir\n The target directory in which to install the package, or None for\n global installation\n\n user\n The user to run NPM with\n\n .. versionadded:: 0.17.0"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/npm.py#L226-L266"},"called_functions":{"kind":"null"},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nInstallation of NPM Packages\n============================\n\nThese states manage the installed packages for node.js using the Node Package\nManager (npm). Note that npm must be installed for these states to be\navailable, so npm states should include a requisite to a pkg.installed state\nfor the package which provides npm (simply ``npm`` in most cases). Example:\n\n.. code-block:: yaml\n\n npm:\n pkg.installed\n\n yaml:\n npm.installed:\n - require:\n - pkg: npm\n'''\n\n# Import salt libs\nfrom __future__ import absolute_import, unicode_literals, print_function\nfrom salt.exceptions import CommandExecutionError, CommandNotFoundError\n\n# Import 3rd-party libs\nimport re\nfrom salt.ext import six\n\n\ndef __virtual__():\n '''\n Only load if the npm module is available in __salt__\n '''\n return 'npm' if 'npm.list' in __salt__ else False, '\\'npm\\' binary not found on system'\n\n\ndef installed(name,\n pkgs=None,\n dir=None,\n user=None,\n force_reinstall=False,\n registry=None,\n env=None):\n '''\n Verify that the given package is installed and is at the correct version\n (if specified).\n\n .. code-block:: yaml\n\n coffee-script:\n npm.installed:\n - user: someuser\n\n coffee-script@1.0.1:\n npm.installed: []\n\n name\n The package to install\n\n .. versionchanged:: 2014.7.2\n This parameter is no longer lowercased by salt so that\n case-sensitive NPM package names will work.\n\n pkgs\n A list of packages to install with a single npm invocation; specifying\n this argument will ignore the ``name`` argument\n\n .. versionadded:: 2014.7.0\n\n dir\n The target directory in which to install the package, or None for\n global installation\n\n user\n The user to run NPM with\n\n .. versionadded:: 0.17.0\n\n registry\n The NPM registry from which to install the package\n\n .. versionadded:: 2014.7.0\n\n env\n A list of environment variables to be set prior to execution. The\n format is the same as the :py:func:`cmd.run <salt.states.cmd.run>`.\n state function.\n\n .. versionadded:: 2014.7.0\n\n force_reinstall\n Install the package even if it is already installed\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n\n pkg_list = pkgs if pkgs else [name]\n\n try:\n installed_pkgs = __salt__['npm.list'](dir=dir, runas=user, env=env, depth=0)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error looking up \\'{0}\\': {1}'.format(name, err)\n return ret\n else:\n installed_pkgs = dict((p, info)\n for p, info in six.iteritems(installed_pkgs))\n\n pkgs_satisfied = []\n pkgs_to_install = []\n\n def _pkg_is_installed(pkg, installed_pkgs):\n '''\n Helper function to determine if a package is installed\n\n This performs more complex comparison than just checking\n keys, such as examining source repos to see if the package\n was installed by a different name from the same repo\n\n :pkg str: The package to compare\n :installed_pkgs: A dictionary produced by npm list --json\n '''\n if (pkg_name in installed_pkgs and\n 'version' in installed_pkgs[pkg_name]):\n return True\n # Check to see if we are trying to install from a URI\n elif '://' in pkg_name: # TODO Better way?\n for pkg_details in installed_pkgs.values():\n try:\n pkg_from = pkg_details.get('from', '').split('://')[1]\n # Catch condition where we may have specified package as\n # git://github.com/foo/bar but packager describes it as\n # git://github.com/foo/bar.git in the package\n if not pkg_from.endswith('.git') and pkg_name.startswith('git://'):\n pkg_from += '.git'\n if pkg_name.split('://')[1] == pkg_from:\n return True\n except IndexError:\n pass\n return False\n for pkg in pkg_list:\n # Valid:\n #\n # @google-cloud/bigquery@^0.9.6\n # @foobar\n # buffer-equal-constant-time@1.0.1\n # coffee-script\n matches = re.search(r'^(@?[^@\\s]+)(?:@(\\S+))?', pkg)\n pkg_name, pkg_ver = matches.group(1), matches.group(2) or None\n\n if force_reinstall is True:\n pkgs_to_install.append(pkg)\n continue\n if not _pkg_is_installed(pkg, installed_pkgs):\n pkgs_to_install.append(pkg)\n continue\n\n installed_name_ver = '{0}@{1}'.format(pkg_name,\n installed_pkgs[pkg_name]['version'])\n\n # If given an explicit version check the installed version matches.\n if pkg_ver:\n if installed_pkgs[pkg_name].get('version') != pkg_ver:\n pkgs_to_install.append(pkg)\n else:\n pkgs_satisfied.append(installed_name_ver)\n\n continue\n else:\n pkgs_satisfied.append(installed_name_ver)\n continue\n\n if __opts__['test']:\n ret['result'] = None\n\n comment_msg = []\n if pkgs_to_install:\n comment_msg.append('NPM package(s) \\'{0}\\' are set to be installed'\n .format(', '.join(pkgs_to_install)))\n\n ret['changes'] = {'old': [], 'new': pkgs_to_install}\n\n if pkgs_satisfied:\n comment_msg.append('Package(s) \\'{0}\\' satisfied by {1}'\n .format(', '.join(pkg_list), ', '.join(pkgs_satisfied)))\n ret['result'] = True\n\n ret['comment'] = '. '.join(comment_msg)\n return ret\n\n if not pkgs_to_install:\n ret['result'] = True\n ret['comment'] = ('Package(s) \\'{0}\\' satisfied by {1}'\n .format(', '.join(pkg_list), ', '.join(pkgs_satisfied)))\n return ret\n\n try:\n cmd_args = {\n 'dir': dir,\n 'runas': user,\n 'registry': registry,\n 'env': env,\n 'pkgs': pkg_list,\n }\n\n call = __salt__['npm.install'](**cmd_args)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error installing \\'{0}\\': {1}'.format(\n ', '.join(pkg_list), err)\n return ret\n\n if call and (isinstance(call, list) or isinstance(call, dict)):\n ret['result'] = True\n ret['changes'] = {'old': [], 'new': pkgs_to_install}\n ret['comment'] = 'Package(s) \\'{0}\\' successfully installed'.format(\n ', '.join(pkgs_to_install))\n else:\n ret['result'] = False\n ret['comment'] = 'Could not install package(s) \\'{0}\\''.format(\n ', '.join(pkg_list))\n\n return ret\n\n\n\ndef bootstrap(name, user=None, silent=True):\n '''\n Bootstraps a node.js application.\n\n Will execute 'npm install --json' on the specified directory.\n\n user\n The user to run NPM with\n\n .. versionadded:: 0.17.0\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n\n if __opts__['test']:\n try:\n call = __salt__['npm.install'](dir=name, runas=user, pkg=None, silent=silent, dry_run=True)\n if call:\n ret['result'] = None\n ret['changes'] = {'old': [], 'new': call}\n ret['comment'] = '{0} is set to be bootstrapped'.format(name)\n else:\n ret['result'] = True\n ret['comment'] = '{0} is already bootstrapped'.format(name)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error Bootstrapping \\'{0}\\': {1}'.format(name, err)\n return ret\n\n try:\n call = __salt__['npm.install'](dir=name, runas=user, pkg=None, silent=silent)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error Bootstrapping \\'{0}\\': {1}'.format(name, err)\n return ret\n\n if not call:\n ret['result'] = True\n ret['comment'] = 'Directory is already bootstrapped'\n return ret\n\n # npm.install will return a string if it can't parse a JSON result\n if isinstance(call, six.string_types):\n ret['result'] = False\n ret['changes'] = call\n ret['comment'] = 'Could not bootstrap directory'\n else:\n ret['result'] = True\n ret['changes'] = {name: 'Bootstrapped'}\n ret['comment'] = 'Directory was successfully bootstrapped'\n\n return ret\n\n\ndef cache_cleaned(name=None,\n user=None,\n force=False):\n '''\n Ensure that the given package is not cached.\n\n If no package is specified, this ensures the entire cache is cleared.\n\n name\n The name of the package to remove from the cache, or None for all packages\n\n user\n The user to run NPM with\n\n force\n Force cleaning of cache. Required for npm@5 and greater\n\n .. versionadded:: 2016.11.6\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n specific_pkg = None\n\n try:\n cached_pkgs = __salt__['npm.cache_list'](path=name, runas=user)\n except (CommandExecutionError, CommandNotFoundError) as err:\n ret['result'] = False\n ret['comment'] = 'Error looking up cached {0}: {1}'.format(\n name or 'packages', err)\n return ret\n\n if name:\n all_cached_pkgs = __salt__['npm.cache_list'](path=None, runas=user)\n # The first package is always the cache path\n cache_root_path = all_cached_pkgs[0]\n specific_pkg = '{0}/{1}/'.format(cache_root_path, name)\n\n if specific_pkg not in cached_pkgs:\n ret['result'] = True\n ret['comment'] = 'Package {0} is not in the cache'.format(name)\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n ret['comment'] = 'Cached {0} set to be removed'.format(name or 'packages')\n return ret\n\n if __salt__['npm.cache_clean'](path=name, runas=user):\n ret['result'] = True\n ret['changes'][name or 'cache'] = 'Removed'\n ret['comment'] = 'Cached {0} successfully removed'.format(\n name or 'packages'\n )\n else:\n ret['result'] = False\n ret['comment'] = 'Error cleaning cached {0}'.format(name or 'packages')\n\n return ret\n"}}},{"rowIdx":379,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/npm.py"},"func_name":{"kind":"string","value":"bootstrap"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def bootstrap(name, user=None, silent=True):\n '''\n Bootstraps a node.js application.\n\n Will execute 'npm install --json' on the specified directory.\n\n user\n The user to run NPM with\n\n .. versionadded:: 0.17.0\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n\n if __opts__['test']:\n try:\n call = __salt__['npm.install'](dir=name, runas=user, pkg=None, silent=silent, dry_run=True)\n if call:\n ret['result'] = None\n ret['changes'] = {'old': [], 'new': call}\n ret['comment'] = '{0} is set to be bootstrapped'.format(name)\n else:\n ret['result'] = True\n ret['comment'] = '{0} is already bootstrapped'.format(name)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error Bootstrapping \\'{0}\\': {1}'.format(name, err)\n return ret\n\n try:\n call = __salt__['npm.install'](dir=name, runas=user, pkg=None, silent=silent)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error Bootstrapping \\'{0}\\': {1}'.format(name, err)\n return ret\n\n if not call:\n ret['result'] = True\n ret['comment'] = 'Directory is already bootstrapped'\n return ret\n\n # npm.install will return a string if it can't parse a JSON result\n if isinstance(call, six.string_types):\n ret['result'] = False\n ret['changes'] = call\n ret['comment'] = 'Could not bootstrap directory'\n else:\n ret['result'] = True\n ret['changes'] = {name: 'Bootstrapped'}\n ret['comment'] = 'Directory was successfully bootstrapped'\n\n return ret"},"func_documentation_string":{"kind":"string","value":"Bootstraps a node.js application.\n\n Will execute 'npm install --json' on the specified directory.\n\n user\n The user to run NPM with\n\n .. versionadded:: 0.17.0"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/npm.py#L269-L319"},"called_functions":{"kind":"null"},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nInstallation of NPM Packages\n============================\n\nThese states manage the installed packages for node.js using the Node Package\nManager (npm). Note that npm must be installed for these states to be\navailable, so npm states should include a requisite to a pkg.installed state\nfor the package which provides npm (simply ``npm`` in most cases). Example:\n\n.. code-block:: yaml\n\n npm:\n pkg.installed\n\n yaml:\n npm.installed:\n - require:\n - pkg: npm\n'''\n\n# Import salt libs\nfrom __future__ import absolute_import, unicode_literals, print_function\nfrom salt.exceptions import CommandExecutionError, CommandNotFoundError\n\n# Import 3rd-party libs\nimport re\nfrom salt.ext import six\n\n\ndef __virtual__():\n '''\n Only load if the npm module is available in __salt__\n '''\n return 'npm' if 'npm.list' in __salt__ else False, '\\'npm\\' binary not found on system'\n\n\ndef installed(name,\n pkgs=None,\n dir=None,\n user=None,\n force_reinstall=False,\n registry=None,\n env=None):\n '''\n Verify that the given package is installed and is at the correct version\n (if specified).\n\n .. code-block:: yaml\n\n coffee-script:\n npm.installed:\n - user: someuser\n\n coffee-script@1.0.1:\n npm.installed: []\n\n name\n The package to install\n\n .. versionchanged:: 2014.7.2\n This parameter is no longer lowercased by salt so that\n case-sensitive NPM package names will work.\n\n pkgs\n A list of packages to install with a single npm invocation; specifying\n this argument will ignore the ``name`` argument\n\n .. versionadded:: 2014.7.0\n\n dir\n The target directory in which to install the package, or None for\n global installation\n\n user\n The user to run NPM with\n\n .. versionadded:: 0.17.0\n\n registry\n The NPM registry from which to install the package\n\n .. versionadded:: 2014.7.0\n\n env\n A list of environment variables to be set prior to execution. The\n format is the same as the :py:func:`cmd.run <salt.states.cmd.run>`.\n state function.\n\n .. versionadded:: 2014.7.0\n\n force_reinstall\n Install the package even if it is already installed\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n\n pkg_list = pkgs if pkgs else [name]\n\n try:\n installed_pkgs = __salt__['npm.list'](dir=dir, runas=user, env=env, depth=0)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error looking up \\'{0}\\': {1}'.format(name, err)\n return ret\n else:\n installed_pkgs = dict((p, info)\n for p, info in six.iteritems(installed_pkgs))\n\n pkgs_satisfied = []\n pkgs_to_install = []\n\n def _pkg_is_installed(pkg, installed_pkgs):\n '''\n Helper function to determine if a package is installed\n\n This performs more complex comparison than just checking\n keys, such as examining source repos to see if the package\n was installed by a different name from the same repo\n\n :pkg str: The package to compare\n :installed_pkgs: A dictionary produced by npm list --json\n '''\n if (pkg_name in installed_pkgs and\n 'version' in installed_pkgs[pkg_name]):\n return True\n # Check to see if we are trying to install from a URI\n elif '://' in pkg_name: # TODO Better way?\n for pkg_details in installed_pkgs.values():\n try:\n pkg_from = pkg_details.get('from', '').split('://')[1]\n # Catch condition where we may have specified package as\n # git://github.com/foo/bar but packager describes it as\n # git://github.com/foo/bar.git in the package\n if not pkg_from.endswith('.git') and pkg_name.startswith('git://'):\n pkg_from += '.git'\n if pkg_name.split('://')[1] == pkg_from:\n return True\n except IndexError:\n pass\n return False\n for pkg in pkg_list:\n # Valid:\n #\n # @google-cloud/bigquery@^0.9.6\n # @foobar\n # buffer-equal-constant-time@1.0.1\n # coffee-script\n matches = re.search(r'^(@?[^@\\s]+)(?:@(\\S+))?', pkg)\n pkg_name, pkg_ver = matches.group(1), matches.group(2) or None\n\n if force_reinstall is True:\n pkgs_to_install.append(pkg)\n continue\n if not _pkg_is_installed(pkg, installed_pkgs):\n pkgs_to_install.append(pkg)\n continue\n\n installed_name_ver = '{0}@{1}'.format(pkg_name,\n installed_pkgs[pkg_name]['version'])\n\n # If given an explicit version check the installed version matches.\n if pkg_ver:\n if installed_pkgs[pkg_name].get('version') != pkg_ver:\n pkgs_to_install.append(pkg)\n else:\n pkgs_satisfied.append(installed_name_ver)\n\n continue\n else:\n pkgs_satisfied.append(installed_name_ver)\n continue\n\n if __opts__['test']:\n ret['result'] = None\n\n comment_msg = []\n if pkgs_to_install:\n comment_msg.append('NPM package(s) \\'{0}\\' are set to be installed'\n .format(', '.join(pkgs_to_install)))\n\n ret['changes'] = {'old': [], 'new': pkgs_to_install}\n\n if pkgs_satisfied:\n comment_msg.append('Package(s) \\'{0}\\' satisfied by {1}'\n .format(', '.join(pkg_list), ', '.join(pkgs_satisfied)))\n ret['result'] = True\n\n ret['comment'] = '. '.join(comment_msg)\n return ret\n\n if not pkgs_to_install:\n ret['result'] = True\n ret['comment'] = ('Package(s) \\'{0}\\' satisfied by {1}'\n .format(', '.join(pkg_list), ', '.join(pkgs_satisfied)))\n return ret\n\n try:\n cmd_args = {\n 'dir': dir,\n 'runas': user,\n 'registry': registry,\n 'env': env,\n 'pkgs': pkg_list,\n }\n\n call = __salt__['npm.install'](**cmd_args)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error installing \\'{0}\\': {1}'.format(\n ', '.join(pkg_list), err)\n return ret\n\n if call and (isinstance(call, list) or isinstance(call, dict)):\n ret['result'] = True\n ret['changes'] = {'old': [], 'new': pkgs_to_install}\n ret['comment'] = 'Package(s) \\'{0}\\' successfully installed'.format(\n ', '.join(pkgs_to_install))\n else:\n ret['result'] = False\n ret['comment'] = 'Could not install package(s) \\'{0}\\''.format(\n ', '.join(pkg_list))\n\n return ret\n\n\ndef removed(name, dir=None, user=None):\n '''\n Verify that the given package is not installed.\n\n dir\n The target directory in which to install the package, or None for\n global installation\n\n user\n The user to run NPM with\n\n .. versionadded:: 0.17.0\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n\n try:\n installed_pkgs = __salt__['npm.list'](dir=dir, depth=0)\n except (CommandExecutionError, CommandNotFoundError) as err:\n ret['result'] = False\n ret['comment'] = 'Error uninstalling \\'{0}\\': {1}'.format(name, err)\n return ret\n\n if name not in installed_pkgs:\n ret['result'] = True\n ret['comment'] = 'Package \\'{0}\\' is not installed'.format(name)\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n ret['comment'] = 'Package \\'{0}\\' is set to be removed'.format(name)\n return ret\n\n if __salt__['npm.uninstall'](pkg=name, dir=dir, runas=user):\n ret['result'] = True\n ret['changes'][name] = 'Removed'\n ret['comment'] = 'Package \\'{0}\\' was successfully removed'.format(name)\n else:\n ret['result'] = False\n ret['comment'] = 'Error removing package \\'{0}\\''.format(name)\n\n return ret\n\n\n\ndef cache_cleaned(name=None,\n user=None,\n force=False):\n '''\n Ensure that the given package is not cached.\n\n If no package is specified, this ensures the entire cache is cleared.\n\n name\n The name of the package to remove from the cache, or None for all packages\n\n user\n The user to run NPM with\n\n force\n Force cleaning of cache. Required for npm@5 and greater\n\n .. versionadded:: 2016.11.6\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n specific_pkg = None\n\n try:\n cached_pkgs = __salt__['npm.cache_list'](path=name, runas=user)\n except (CommandExecutionError, CommandNotFoundError) as err:\n ret['result'] = False\n ret['comment'] = 'Error looking up cached {0}: {1}'.format(\n name or 'packages', err)\n return ret\n\n if name:\n all_cached_pkgs = __salt__['npm.cache_list'](path=None, runas=user)\n # The first package is always the cache path\n cache_root_path = all_cached_pkgs[0]\n specific_pkg = '{0}/{1}/'.format(cache_root_path, name)\n\n if specific_pkg not in cached_pkgs:\n ret['result'] = True\n ret['comment'] = 'Package {0} is not in the cache'.format(name)\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n ret['comment'] = 'Cached {0} set to be removed'.format(name or 'packages')\n return ret\n\n if __salt__['npm.cache_clean'](path=name, runas=user):\n ret['result'] = True\n ret['changes'][name or 'cache'] = 'Removed'\n ret['comment'] = 'Cached {0} successfully removed'.format(\n name or 'packages'\n )\n else:\n ret['result'] = False\n ret['comment'] = 'Error cleaning cached {0}'.format(name or 'packages')\n\n return ret\n"}}},{"rowIdx":380,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/npm.py"},"func_name":{"kind":"string","value":"cache_cleaned"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def cache_cleaned(name=None,\n user=None,\n force=False):\n '''\n Ensure that the given package is not cached.\n\n If no package is specified, this ensures the entire cache is cleared.\n\n name\n The name of the package to remove from the cache, or None for all packages\n\n user\n The user to run NPM with\n\n force\n Force cleaning of cache. Required for npm@5 and greater\n\n .. versionadded:: 2016.11.6\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n specific_pkg = None\n\n try:\n cached_pkgs = __salt__['npm.cache_list'](path=name, runas=user)\n except (CommandExecutionError, CommandNotFoundError) as err:\n ret['result'] = False\n ret['comment'] = 'Error looking up cached {0}: {1}'.format(\n name or 'packages', err)\n return ret\n\n if name:\n all_cached_pkgs = __salt__['npm.cache_list'](path=None, runas=user)\n # The first package is always the cache path\n cache_root_path = all_cached_pkgs[0]\n specific_pkg = '{0}/{1}/'.format(cache_root_path, name)\n\n if specific_pkg not in cached_pkgs:\n ret['result'] = True\n ret['comment'] = 'Package {0} is not in the cache'.format(name)\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n ret['comment'] = 'Cached {0} set to be removed'.format(name or 'packages')\n return ret\n\n if __salt__['npm.cache_clean'](path=name, runas=user):\n ret['result'] = True\n ret['changes'][name or 'cache'] = 'Removed'\n ret['comment'] = 'Cached {0} successfully removed'.format(\n name or 'packages'\n )\n else:\n ret['result'] = False\n ret['comment'] = 'Error cleaning cached {0}'.format(name or 'packages')\n\n return ret"},"func_documentation_string":{"kind":"string","value":"Ensure that the given package is not cached.\n\n If no package is specified, this ensures the entire cache is cleared.\n\n name\n The name of the package to remove from the cache, or None for all packages\n\n user\n The user to run NPM with\n\n force\n Force cleaning of cache. Required for npm@5 and greater\n\n .. versionadded:: 2016.11.6"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/npm.py#L322-L378"},"called_functions":{"kind":"null"},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nInstallation of NPM Packages\n============================\n\nThese states manage the installed packages for node.js using the Node Package\nManager (npm). Note that npm must be installed for these states to be\navailable, so npm states should include a requisite to a pkg.installed state\nfor the package which provides npm (simply ``npm`` in most cases). Example:\n\n.. code-block:: yaml\n\n npm:\n pkg.installed\n\n yaml:\n npm.installed:\n - require:\n - pkg: npm\n'''\n\n# Import salt libs\nfrom __future__ import absolute_import, unicode_literals, print_function\nfrom salt.exceptions import CommandExecutionError, CommandNotFoundError\n\n# Import 3rd-party libs\nimport re\nfrom salt.ext import six\n\n\ndef __virtual__():\n '''\n Only load if the npm module is available in __salt__\n '''\n return 'npm' if 'npm.list' in __salt__ else False, '\\'npm\\' binary not found on system'\n\n\ndef installed(name,\n pkgs=None,\n dir=None,\n user=None,\n force_reinstall=False,\n registry=None,\n env=None):\n '''\n Verify that the given package is installed and is at the correct version\n (if specified).\n\n .. code-block:: yaml\n\n coffee-script:\n npm.installed:\n - user: someuser\n\n coffee-script@1.0.1:\n npm.installed: []\n\n name\n The package to install\n\n .. versionchanged:: 2014.7.2\n This parameter is no longer lowercased by salt so that\n case-sensitive NPM package names will work.\n\n pkgs\n A list of packages to install with a single npm invocation; specifying\n this argument will ignore the ``name`` argument\n\n .. versionadded:: 2014.7.0\n\n dir\n The target directory in which to install the package, or None for\n global installation\n\n user\n The user to run NPM with\n\n .. versionadded:: 0.17.0\n\n registry\n The NPM registry from which to install the package\n\n .. versionadded:: 2014.7.0\n\n env\n A list of environment variables to be set prior to execution. The\n format is the same as the :py:func:`cmd.run <salt.states.cmd.run>`.\n state function.\n\n .. versionadded:: 2014.7.0\n\n force_reinstall\n Install the package even if it is already installed\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n\n pkg_list = pkgs if pkgs else [name]\n\n try:\n installed_pkgs = __salt__['npm.list'](dir=dir, runas=user, env=env, depth=0)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error looking up \\'{0}\\': {1}'.format(name, err)\n return ret\n else:\n installed_pkgs = dict((p, info)\n for p, info in six.iteritems(installed_pkgs))\n\n pkgs_satisfied = []\n pkgs_to_install = []\n\n def _pkg_is_installed(pkg, installed_pkgs):\n '''\n Helper function to determine if a package is installed\n\n This performs more complex comparison than just checking\n keys, such as examining source repos to see if the package\n was installed by a different name from the same repo\n\n :pkg str: The package to compare\n :installed_pkgs: A dictionary produced by npm list --json\n '''\n if (pkg_name in installed_pkgs and\n 'version' in installed_pkgs[pkg_name]):\n return True\n # Check to see if we are trying to install from a URI\n elif '://' in pkg_name: # TODO Better way?\n for pkg_details in installed_pkgs.values():\n try:\n pkg_from = pkg_details.get('from', '').split('://')[1]\n # Catch condition where we may have specified package as\n # git://github.com/foo/bar but packager describes it as\n # git://github.com/foo/bar.git in the package\n if not pkg_from.endswith('.git') and pkg_name.startswith('git://'):\n pkg_from += '.git'\n if pkg_name.split('://')[1] == pkg_from:\n return True\n except IndexError:\n pass\n return False\n for pkg in pkg_list:\n # Valid:\n #\n # @google-cloud/bigquery@^0.9.6\n # @foobar\n # buffer-equal-constant-time@1.0.1\n # coffee-script\n matches = re.search(r'^(@?[^@\\s]+)(?:@(\\S+))?', pkg)\n pkg_name, pkg_ver = matches.group(1), matches.group(2) or None\n\n if force_reinstall is True:\n pkgs_to_install.append(pkg)\n continue\n if not _pkg_is_installed(pkg, installed_pkgs):\n pkgs_to_install.append(pkg)\n continue\n\n installed_name_ver = '{0}@{1}'.format(pkg_name,\n installed_pkgs[pkg_name]['version'])\n\n # If given an explicit version check the installed version matches.\n if pkg_ver:\n if installed_pkgs[pkg_name].get('version') != pkg_ver:\n pkgs_to_install.append(pkg)\n else:\n pkgs_satisfied.append(installed_name_ver)\n\n continue\n else:\n pkgs_satisfied.append(installed_name_ver)\n continue\n\n if __opts__['test']:\n ret['result'] = None\n\n comment_msg = []\n if pkgs_to_install:\n comment_msg.append('NPM package(s) \\'{0}\\' are set to be installed'\n .format(', '.join(pkgs_to_install)))\n\n ret['changes'] = {'old': [], 'new': pkgs_to_install}\n\n if pkgs_satisfied:\n comment_msg.append('Package(s) \\'{0}\\' satisfied by {1}'\n .format(', '.join(pkg_list), ', '.join(pkgs_satisfied)))\n ret['result'] = True\n\n ret['comment'] = '. '.join(comment_msg)\n return ret\n\n if not pkgs_to_install:\n ret['result'] = True\n ret['comment'] = ('Package(s) \\'{0}\\' satisfied by {1}'\n .format(', '.join(pkg_list), ', '.join(pkgs_satisfied)))\n return ret\n\n try:\n cmd_args = {\n 'dir': dir,\n 'runas': user,\n 'registry': registry,\n 'env': env,\n 'pkgs': pkg_list,\n }\n\n call = __salt__['npm.install'](**cmd_args)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error installing \\'{0}\\': {1}'.format(\n ', '.join(pkg_list), err)\n return ret\n\n if call and (isinstance(call, list) or isinstance(call, dict)):\n ret['result'] = True\n ret['changes'] = {'old': [], 'new': pkgs_to_install}\n ret['comment'] = 'Package(s) \\'{0}\\' successfully installed'.format(\n ', '.join(pkgs_to_install))\n else:\n ret['result'] = False\n ret['comment'] = 'Could not install package(s) \\'{0}\\''.format(\n ', '.join(pkg_list))\n\n return ret\n\n\ndef removed(name, dir=None, user=None):\n '''\n Verify that the given package is not installed.\n\n dir\n The target directory in which to install the package, or None for\n global installation\n\n user\n The user to run NPM with\n\n .. versionadded:: 0.17.0\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n\n try:\n installed_pkgs = __salt__['npm.list'](dir=dir, depth=0)\n except (CommandExecutionError, CommandNotFoundError) as err:\n ret['result'] = False\n ret['comment'] = 'Error uninstalling \\'{0}\\': {1}'.format(name, err)\n return ret\n\n if name not in installed_pkgs:\n ret['result'] = True\n ret['comment'] = 'Package \\'{0}\\' is not installed'.format(name)\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n ret['comment'] = 'Package \\'{0}\\' is set to be removed'.format(name)\n return ret\n\n if __salt__['npm.uninstall'](pkg=name, dir=dir, runas=user):\n ret['result'] = True\n ret['changes'][name] = 'Removed'\n ret['comment'] = 'Package \\'{0}\\' was successfully removed'.format(name)\n else:\n ret['result'] = False\n ret['comment'] = 'Error removing package \\'{0}\\''.format(name)\n\n return ret\n\n\ndef bootstrap(name, user=None, silent=True):\n '''\n Bootstraps a node.js application.\n\n Will execute 'npm install --json' on the specified directory.\n\n user\n The user to run NPM with\n\n .. versionadded:: 0.17.0\n '''\n ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}\n\n if __opts__['test']:\n try:\n call = __salt__['npm.install'](dir=name, runas=user, pkg=None, silent=silent, dry_run=True)\n if call:\n ret['result'] = None\n ret['changes'] = {'old': [], 'new': call}\n ret['comment'] = '{0} is set to be bootstrapped'.format(name)\n else:\n ret['result'] = True\n ret['comment'] = '{0} is already bootstrapped'.format(name)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error Bootstrapping \\'{0}\\': {1}'.format(name, err)\n return ret\n\n try:\n call = __salt__['npm.install'](dir=name, runas=user, pkg=None, silent=silent)\n except (CommandNotFoundError, CommandExecutionError) as err:\n ret['result'] = False\n ret['comment'] = 'Error Bootstrapping \\'{0}\\': {1}'.format(name, err)\n return ret\n\n if not call:\n ret['result'] = True\n ret['comment'] = 'Directory is already bootstrapped'\n return ret\n\n # npm.install will return a string if it can't parse a JSON result\n if isinstance(call, six.string_types):\n ret['result'] = False\n ret['changes'] = call\n ret['comment'] = 'Could not bootstrap directory'\n else:\n ret['result'] = True\n ret['changes'] = {name: 'Bootstrapped'}\n ret['comment'] = 'Directory was successfully bootstrapped'\n\n return ret\n\n"}}},{"rowIdx":381,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/splunk_search.py"},"func_name":{"kind":"string","value":"present"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def present(name, profile=\"splunk\", **kwargs):\n '''\n Ensure a search is present\n\n .. code-block:: yaml\n\n API Error Search:\n splunk_search.present:\n search: index=main sourcetype=blah\n template: alert_5min\n\n The following parameters are required:\n\n name\n This is the name of the search in splunk\n '''\n ret = {\n 'name': name,\n 'changes': {},\n 'result': None,\n 'comment': ''\n }\n\n target = __salt__['splunk_search.get'](name, profile=profile)\n if target:\n if __opts__['test']:\n ret['comment'] = \"Would update {0}\".format(name)\n return ret\n # found a search... updating\n result = __salt__['splunk_search.update'](\n name, profile=profile, **kwargs\n )\n if not result:\n # no update\n ret['result'] = True\n ret['comment'] = \"No changes\"\n else:\n (newvalues, diffs) = result\n old_content = dict(target.content)\n old_changes = {}\n for x in newvalues:\n old_changes[x] = old_content.get(x, None)\n ret['result'] = True\n ret['changes']['diff'] = diffs\n ret['changes']['old'] = old_changes\n ret['changes']['new'] = newvalues\n else:\n if __opts__['test']:\n ret['comment'] = \"Would create {0}\".format(name)\n return ret\n # creating a new search\n result = __salt__['splunk_search.create'](\n name, profile=profile, **kwargs\n )\n if result:\n ret['result'] = True\n ret['changes']['old'] = False\n ret['changes']['new'] = kwargs\n else:\n ret['result'] = False\n ret['comment'] = 'Failed to create {0}'.format(name)\n return ret"},"func_documentation_string":{"kind":"string","value":"Ensure a search is present\n\n .. code-block:: yaml\n\n API Error Search:\n splunk_search.present:\n search: index=main sourcetype=blah\n template: alert_5min\n\n The following parameters are required:\n\n name\n This is the name of the search in splunk"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/splunk_search.py#L26-L87"},"called_functions":{"kind":"null"},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nSplunk Search State Module\n\n.. versionadded:: 2015.5.0\n\nThis state is used to ensure presence of splunk searches.\n\n.. code-block:: yaml\n\n server-warning-message:\n splunk_search.present:\n - name: This is the splunk search name\n - search: index=main sourcetype=\n'''\nfrom __future__ import absolute_import, unicode_literals, print_function\n\n\ndef __virtual__():\n '''\n Only load if the splunk_search module is available in __salt__\n '''\n return 'splunk_search' if 'splunk_search.get' in __salt__ else False\n\n\n\ndef absent(name, profile=\"splunk\"):\n '''\n Ensure a search is absent\n\n .. code-block:: yaml\n\n API Error Search:\n splunk_search.absent\n\n The following parameters are required:\n\n name\n This is the name of the search in splunk\n '''\n ret = {\n 'name': name,\n 'changes': {},\n 'result': True,\n 'comment': '{0} is absent.'.format(name)\n }\n\n target = __salt__['splunk_search.get'](name, profile=profile)\n if target:\n if __opts__['test']:\n ret = {}\n ret[\"name\"] = name\n ret['comment'] = \"Would delete {0}\".format(name)\n ret['result'] = None\n return ret\n\n result = __salt__['splunk_search.delete'](name, profile=profile)\n if result:\n ret['comment'] = '{0} was deleted'.format(name)\n else:\n ret['comment'] = 'Failed to delete {0}'.format(name)\n ret['result'] = False\n return ret\n"}}},{"rowIdx":382,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/splunk_search.py"},"func_name":{"kind":"string","value":"absent"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def absent(name, profile=\"splunk\"):\n '''\n Ensure a search is absent\n\n .. code-block:: yaml\n\n API Error Search:\n splunk_search.absent\n\n The following parameters are required:\n\n name\n This is the name of the search in splunk\n '''\n ret = {\n 'name': name,\n 'changes': {},\n 'result': True,\n 'comment': '{0} is absent.'.format(name)\n }\n\n target = __salt__['splunk_search.get'](name, profile=profile)\n if target:\n if __opts__['test']:\n ret = {}\n ret[\"name\"] = name\n ret['comment'] = \"Would delete {0}\".format(name)\n ret['result'] = None\n return ret\n\n result = __salt__['splunk_search.delete'](name, profile=profile)\n if result:\n ret['comment'] = '{0} was deleted'.format(name)\n else:\n ret['comment'] = 'Failed to delete {0}'.format(name)\n ret['result'] = False\n return ret"},"func_documentation_string":{"kind":"string","value":"Ensure a search is absent\n\n .. code-block:: yaml\n\n API Error Search:\n splunk_search.absent\n\n The following parameters are required:\n\n name\n This is the name of the search in splunk"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/splunk_search.py#L90-L126"},"called_functions":{"kind":"null"},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nSplunk Search State Module\n\n.. versionadded:: 2015.5.0\n\nThis state is used to ensure presence of splunk searches.\n\n.. code-block:: yaml\n\n server-warning-message:\n splunk_search.present:\n - name: This is the splunk search name\n - search: index=main sourcetype=\n'''\nfrom __future__ import absolute_import, unicode_literals, print_function\n\n\ndef __virtual__():\n '''\n Only load if the splunk_search module is available in __salt__\n '''\n return 'splunk_search' if 'splunk_search.get' in __salt__ else False\n\n\ndef present(name, profile=\"splunk\", **kwargs):\n '''\n Ensure a search is present\n\n .. code-block:: yaml\n\n API Error Search:\n splunk_search.present:\n search: index=main sourcetype=blah\n template: alert_5min\n\n The following parameters are required:\n\n name\n This is the name of the search in splunk\n '''\n ret = {\n 'name': name,\n 'changes': {},\n 'result': None,\n 'comment': ''\n }\n\n target = __salt__['splunk_search.get'](name, profile=profile)\n if target:\n if __opts__['test']:\n ret['comment'] = \"Would update {0}\".format(name)\n return ret\n # found a search... updating\n result = __salt__['splunk_search.update'](\n name, profile=profile, **kwargs\n )\n if not result:\n # no update\n ret['result'] = True\n ret['comment'] = \"No changes\"\n else:\n (newvalues, diffs) = result\n old_content = dict(target.content)\n old_changes = {}\n for x in newvalues:\n old_changes[x] = old_content.get(x, None)\n ret['result'] = True\n ret['changes']['diff'] = diffs\n ret['changes']['old'] = old_changes\n ret['changes']['new'] = newvalues\n else:\n if __opts__['test']:\n ret['comment'] = \"Would create {0}\".format(name)\n return ret\n # creating a new search\n result = __salt__['splunk_search.create'](\n name, profile=profile, **kwargs\n )\n if result:\n ret['result'] = True\n ret['changes']['old'] = False\n ret['changes']['new'] = kwargs\n else:\n ret['result'] = False\n ret['comment'] = 'Failed to create {0}'.format(name)\n return ret\n\n"}}},{"rowIdx":383,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/modjk.py"},"func_name":{"kind":"string","value":"_bulk_state"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def _bulk_state(saltfunc, lbn, workers, profile):\n '''\n Generic function for bulk worker operation\n '''\n ret = {'name': lbn,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n if not isinstance(workers, list):\n ret['result'] = False\n ret['comment'] = 'workers should be a list not a {0}'.format(\n type(workers)\n )\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n return ret\n\n log.info('executing %s to modjk workers %s', saltfunc, workers)\n try:\n cmdret = __salt__[saltfunc](workers, lbn, profile=profile)\n except KeyError:\n ret['result'] = False\n ret['comment'] = 'unsupported function {0}'.format(\n saltfunc\n )\n return ret\n\n errors = []\n for worker, ok in six.iteritems(cmdret):\n if not ok:\n errors.append(worker)\n\n ret['changes'] = {'status': cmdret}\n if errors:\n ret['result'] = False\n ret['comment'] = '{0} failed on some workers'.format(saltfunc)\n\n return ret"},"func_documentation_string":{"kind":"string","value":"Generic function for bulk worker operation"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/modjk.py#L24-L64"},"called_functions":{"kind":"list like","value":["def iteritems(d, **kw):\n return d.iteritems(**kw)\n"],"string":"[\n \"def iteritems(d, **kw):\\n return d.iteritems(**kw)\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nState to control Apache modjk\n'''\n\n# Python Libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import 3rd-party libs\nfrom salt.ext import six\n\nlog = logging.getLogger(__name__)\n\n\ndef __virtual__():\n '''\n Load this state if modjk is loaded\n '''\n\n return 'modjk.workers' in __salt__\n\n\n\ndef worker_stopped(name, workers=None, profile='default'):\n '''\n Stop all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_stopped:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_stop', name, workers, profile\n )\n\n\ndef worker_activated(name, workers=None, profile='default'):\n '''\n Activate all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_activated:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_activate', name, workers, profile\n )\n\n\ndef worker_disabled(name, workers=None, profile='default'):\n '''\n Disable all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_disabled:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_disable', name, workers, profile\n )\n\n\ndef worker_recover(name, workers=None, profile='default'):\n '''\n Recover all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_recover:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_recover', name, workers, profile\n )\n"}}},{"rowIdx":384,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/modjk.py"},"func_name":{"kind":"string","value":"worker_stopped"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def worker_stopped(name, workers=None, profile='default'):\n '''\n Stop all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_stopped:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_stop', name, workers, profile\n )"},"func_documentation_string":{"kind":"string","value":"Stop all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_stopped:\n - workers:\n - app1\n - app2"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/modjk.py#L67-L85"},"called_functions":{"kind":"list like","value":["def _bulk_state(saltfunc, lbn, workers, profile):\n '''\n Generic function for bulk worker operation\n '''\n ret = {'name': lbn,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n if not isinstance(workers, list):\n ret['result'] = False\n ret['comment'] = 'workers should be a list not a {0}'.format(\n type(workers)\n )\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n return ret\n\n log.info('executing %s to modjk workers %s', saltfunc, workers)\n try:\n cmdret = __salt__[saltfunc](workers, lbn, profile=profile)\n except KeyError:\n ret['result'] = False\n ret['comment'] = 'unsupported function {0}'.format(\n saltfunc\n )\n return ret\n\n errors = []\n for worker, ok in six.iteritems(cmdret):\n if not ok:\n errors.append(worker)\n\n ret['changes'] = {'status': cmdret}\n if errors:\n ret['result'] = False\n ret['comment'] = '{0} failed on some workers'.format(saltfunc)\n\n return ret\n"],"string":"[\n \"def _bulk_state(saltfunc, lbn, workers, profile):\\n '''\\n Generic function for bulk worker operation\\n '''\\n ret = {'name': lbn,\\n 'result': True,\\n 'changes': {},\\n 'comment': ''}\\n\\n if not isinstance(workers, list):\\n ret['result'] = False\\n ret['comment'] = 'workers should be a list not a {0}'.format(\\n type(workers)\\n )\\n return ret\\n\\n if __opts__['test']:\\n ret['result'] = None\\n return ret\\n\\n log.info('executing %s to modjk workers %s', saltfunc, workers)\\n try:\\n cmdret = __salt__[saltfunc](workers, lbn, profile=profile)\\n except KeyError:\\n ret['result'] = False\\n ret['comment'] = 'unsupported function {0}'.format(\\n saltfunc\\n )\\n return ret\\n\\n errors = []\\n for worker, ok in six.iteritems(cmdret):\\n if not ok:\\n errors.append(worker)\\n\\n ret['changes'] = {'status': cmdret}\\n if errors:\\n ret['result'] = False\\n ret['comment'] = '{0} failed on some workers'.format(saltfunc)\\n\\n return ret\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nState to control Apache modjk\n'''\n\n# Python Libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import 3rd-party libs\nfrom salt.ext import six\n\nlog = logging.getLogger(__name__)\n\n\ndef __virtual__():\n '''\n Load this state if modjk is loaded\n '''\n\n return 'modjk.workers' in __salt__\n\n\ndef _bulk_state(saltfunc, lbn, workers, profile):\n '''\n Generic function for bulk worker operation\n '''\n ret = {'name': lbn,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n if not isinstance(workers, list):\n ret['result'] = False\n ret['comment'] = 'workers should be a list not a {0}'.format(\n type(workers)\n )\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n return ret\n\n log.info('executing %s to modjk workers %s', saltfunc, workers)\n try:\n cmdret = __salt__[saltfunc](workers, lbn, profile=profile)\n except KeyError:\n ret['result'] = False\n ret['comment'] = 'unsupported function {0}'.format(\n saltfunc\n )\n return ret\n\n errors = []\n for worker, ok in six.iteritems(cmdret):\n if not ok:\n errors.append(worker)\n\n ret['changes'] = {'status': cmdret}\n if errors:\n ret['result'] = False\n ret['comment'] = '{0} failed on some workers'.format(saltfunc)\n\n return ret\n\n\n\ndef worker_activated(name, workers=None, profile='default'):\n '''\n Activate all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_activated:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_activate', name, workers, profile\n )\n\n\ndef worker_disabled(name, workers=None, profile='default'):\n '''\n Disable all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_disabled:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_disable', name, workers, profile\n )\n\n\ndef worker_recover(name, workers=None, profile='default'):\n '''\n Recover all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_recover:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_recover', name, workers, profile\n )\n"}}},{"rowIdx":385,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/modjk.py"},"func_name":{"kind":"string","value":"worker_activated"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def worker_activated(name, workers=None, profile='default'):\n '''\n Activate all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_activated:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_activate', name, workers, profile\n )"},"func_documentation_string":{"kind":"string","value":"Activate all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_activated:\n - workers:\n - app1\n - app2"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/modjk.py#L88-L106"},"called_functions":{"kind":"list like","value":["def _bulk_state(saltfunc, lbn, workers, profile):\n '''\n Generic function for bulk worker operation\n '''\n ret = {'name': lbn,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n if not isinstance(workers, list):\n ret['result'] = False\n ret['comment'] = 'workers should be a list not a {0}'.format(\n type(workers)\n )\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n return ret\n\n log.info('executing %s to modjk workers %s', saltfunc, workers)\n try:\n cmdret = __salt__[saltfunc](workers, lbn, profile=profile)\n except KeyError:\n ret['result'] = False\n ret['comment'] = 'unsupported function {0}'.format(\n saltfunc\n )\n return ret\n\n errors = []\n for worker, ok in six.iteritems(cmdret):\n if not ok:\n errors.append(worker)\n\n ret['changes'] = {'status': cmdret}\n if errors:\n ret['result'] = False\n ret['comment'] = '{0} failed on some workers'.format(saltfunc)\n\n return ret\n"],"string":"[\n \"def _bulk_state(saltfunc, lbn, workers, profile):\\n '''\\n Generic function for bulk worker operation\\n '''\\n ret = {'name': lbn,\\n 'result': True,\\n 'changes': {},\\n 'comment': ''}\\n\\n if not isinstance(workers, list):\\n ret['result'] = False\\n ret['comment'] = 'workers should be a list not a {0}'.format(\\n type(workers)\\n )\\n return ret\\n\\n if __opts__['test']:\\n ret['result'] = None\\n return ret\\n\\n log.info('executing %s to modjk workers %s', saltfunc, workers)\\n try:\\n cmdret = __salt__[saltfunc](workers, lbn, profile=profile)\\n except KeyError:\\n ret['result'] = False\\n ret['comment'] = 'unsupported function {0}'.format(\\n saltfunc\\n )\\n return ret\\n\\n errors = []\\n for worker, ok in six.iteritems(cmdret):\\n if not ok:\\n errors.append(worker)\\n\\n ret['changes'] = {'status': cmdret}\\n if errors:\\n ret['result'] = False\\n ret['comment'] = '{0} failed on some workers'.format(saltfunc)\\n\\n return ret\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nState to control Apache modjk\n'''\n\n# Python Libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import 3rd-party libs\nfrom salt.ext import six\n\nlog = logging.getLogger(__name__)\n\n\ndef __virtual__():\n '''\n Load this state if modjk is loaded\n '''\n\n return 'modjk.workers' in __salt__\n\n\ndef _bulk_state(saltfunc, lbn, workers, profile):\n '''\n Generic function for bulk worker operation\n '''\n ret = {'name': lbn,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n if not isinstance(workers, list):\n ret['result'] = False\n ret['comment'] = 'workers should be a list not a {0}'.format(\n type(workers)\n )\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n return ret\n\n log.info('executing %s to modjk workers %s', saltfunc, workers)\n try:\n cmdret = __salt__[saltfunc](workers, lbn, profile=profile)\n except KeyError:\n ret['result'] = False\n ret['comment'] = 'unsupported function {0}'.format(\n saltfunc\n )\n return ret\n\n errors = []\n for worker, ok in six.iteritems(cmdret):\n if not ok:\n errors.append(worker)\n\n ret['changes'] = {'status': cmdret}\n if errors:\n ret['result'] = False\n ret['comment'] = '{0} failed on some workers'.format(saltfunc)\n\n return ret\n\n\ndef worker_stopped(name, workers=None, profile='default'):\n '''\n Stop all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_stopped:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_stop', name, workers, profile\n )\n\n\n\ndef worker_disabled(name, workers=None, profile='default'):\n '''\n Disable all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_disabled:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_disable', name, workers, profile\n )\n\n\ndef worker_recover(name, workers=None, profile='default'):\n '''\n Recover all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_recover:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_recover', name, workers, profile\n )\n"}}},{"rowIdx":386,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/modjk.py"},"func_name":{"kind":"string","value":"worker_disabled"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def worker_disabled(name, workers=None, profile='default'):\n '''\n Disable all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_disabled:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_disable', name, workers, profile\n )"},"func_documentation_string":{"kind":"string","value":"Disable all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_disabled:\n - workers:\n - app1\n - app2"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/modjk.py#L109-L127"},"called_functions":{"kind":"list like","value":["def _bulk_state(saltfunc, lbn, workers, profile):\n '''\n Generic function for bulk worker operation\n '''\n ret = {'name': lbn,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n if not isinstance(workers, list):\n ret['result'] = False\n ret['comment'] = 'workers should be a list not a {0}'.format(\n type(workers)\n )\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n return ret\n\n log.info('executing %s to modjk workers %s', saltfunc, workers)\n try:\n cmdret = __salt__[saltfunc](workers, lbn, profile=profile)\n except KeyError:\n ret['result'] = False\n ret['comment'] = 'unsupported function {0}'.format(\n saltfunc\n )\n return ret\n\n errors = []\n for worker, ok in six.iteritems(cmdret):\n if not ok:\n errors.append(worker)\n\n ret['changes'] = {'status': cmdret}\n if errors:\n ret['result'] = False\n ret['comment'] = '{0} failed on some workers'.format(saltfunc)\n\n return ret\n"],"string":"[\n \"def _bulk_state(saltfunc, lbn, workers, profile):\\n '''\\n Generic function for bulk worker operation\\n '''\\n ret = {'name': lbn,\\n 'result': True,\\n 'changes': {},\\n 'comment': ''}\\n\\n if not isinstance(workers, list):\\n ret['result'] = False\\n ret['comment'] = 'workers should be a list not a {0}'.format(\\n type(workers)\\n )\\n return ret\\n\\n if __opts__['test']:\\n ret['result'] = None\\n return ret\\n\\n log.info('executing %s to modjk workers %s', saltfunc, workers)\\n try:\\n cmdret = __salt__[saltfunc](workers, lbn, profile=profile)\\n except KeyError:\\n ret['result'] = False\\n ret['comment'] = 'unsupported function {0}'.format(\\n saltfunc\\n )\\n return ret\\n\\n errors = []\\n for worker, ok in six.iteritems(cmdret):\\n if not ok:\\n errors.append(worker)\\n\\n ret['changes'] = {'status': cmdret}\\n if errors:\\n ret['result'] = False\\n ret['comment'] = '{0} failed on some workers'.format(saltfunc)\\n\\n return ret\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nState to control Apache modjk\n'''\n\n# Python Libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import 3rd-party libs\nfrom salt.ext import six\n\nlog = logging.getLogger(__name__)\n\n\ndef __virtual__():\n '''\n Load this state if modjk is loaded\n '''\n\n return 'modjk.workers' in __salt__\n\n\ndef _bulk_state(saltfunc, lbn, workers, profile):\n '''\n Generic function for bulk worker operation\n '''\n ret = {'name': lbn,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n if not isinstance(workers, list):\n ret['result'] = False\n ret['comment'] = 'workers should be a list not a {0}'.format(\n type(workers)\n )\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n return ret\n\n log.info('executing %s to modjk workers %s', saltfunc, workers)\n try:\n cmdret = __salt__[saltfunc](workers, lbn, profile=profile)\n except KeyError:\n ret['result'] = False\n ret['comment'] = 'unsupported function {0}'.format(\n saltfunc\n )\n return ret\n\n errors = []\n for worker, ok in six.iteritems(cmdret):\n if not ok:\n errors.append(worker)\n\n ret['changes'] = {'status': cmdret}\n if errors:\n ret['result'] = False\n ret['comment'] = '{0} failed on some workers'.format(saltfunc)\n\n return ret\n\n\ndef worker_stopped(name, workers=None, profile='default'):\n '''\n Stop all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_stopped:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_stop', name, workers, profile\n )\n\n\ndef worker_activated(name, workers=None, profile='default'):\n '''\n Activate all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_activated:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_activate', name, workers, profile\n )\n\n\n\ndef worker_recover(name, workers=None, profile='default'):\n '''\n Recover all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_recover:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_recover', name, workers, profile\n )\n"}}},{"rowIdx":387,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/modjk.py"},"func_name":{"kind":"string","value":"worker_recover"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def worker_recover(name, workers=None, profile='default'):\n '''\n Recover all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_recover:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_recover', name, workers, profile\n )"},"func_documentation_string":{"kind":"string","value":"Recover all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_recover:\n - workers:\n - app1\n - app2"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/modjk.py#L130-L148"},"called_functions":{"kind":"list like","value":["def _bulk_state(saltfunc, lbn, workers, profile):\n '''\n Generic function for bulk worker operation\n '''\n ret = {'name': lbn,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n if not isinstance(workers, list):\n ret['result'] = False\n ret['comment'] = 'workers should be a list not a {0}'.format(\n type(workers)\n )\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n return ret\n\n log.info('executing %s to modjk workers %s', saltfunc, workers)\n try:\n cmdret = __salt__[saltfunc](workers, lbn, profile=profile)\n except KeyError:\n ret['result'] = False\n ret['comment'] = 'unsupported function {0}'.format(\n saltfunc\n )\n return ret\n\n errors = []\n for worker, ok in six.iteritems(cmdret):\n if not ok:\n errors.append(worker)\n\n ret['changes'] = {'status': cmdret}\n if errors:\n ret['result'] = False\n ret['comment'] = '{0} failed on some workers'.format(saltfunc)\n\n return ret\n"],"string":"[\n \"def _bulk_state(saltfunc, lbn, workers, profile):\\n '''\\n Generic function for bulk worker operation\\n '''\\n ret = {'name': lbn,\\n 'result': True,\\n 'changes': {},\\n 'comment': ''}\\n\\n if not isinstance(workers, list):\\n ret['result'] = False\\n ret['comment'] = 'workers should be a list not a {0}'.format(\\n type(workers)\\n )\\n return ret\\n\\n if __opts__['test']:\\n ret['result'] = None\\n return ret\\n\\n log.info('executing %s to modjk workers %s', saltfunc, workers)\\n try:\\n cmdret = __salt__[saltfunc](workers, lbn, profile=profile)\\n except KeyError:\\n ret['result'] = False\\n ret['comment'] = 'unsupported function {0}'.format(\\n saltfunc\\n )\\n return ret\\n\\n errors = []\\n for worker, ok in six.iteritems(cmdret):\\n if not ok:\\n errors.append(worker)\\n\\n ret['changes'] = {'status': cmdret}\\n if errors:\\n ret['result'] = False\\n ret['comment'] = '{0} failed on some workers'.format(saltfunc)\\n\\n return ret\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nState to control Apache modjk\n'''\n\n# Python Libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import 3rd-party libs\nfrom salt.ext import six\n\nlog = logging.getLogger(__name__)\n\n\ndef __virtual__():\n '''\n Load this state if modjk is loaded\n '''\n\n return 'modjk.workers' in __salt__\n\n\ndef _bulk_state(saltfunc, lbn, workers, profile):\n '''\n Generic function for bulk worker operation\n '''\n ret = {'name': lbn,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n if not isinstance(workers, list):\n ret['result'] = False\n ret['comment'] = 'workers should be a list not a {0}'.format(\n type(workers)\n )\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n return ret\n\n log.info('executing %s to modjk workers %s', saltfunc, workers)\n try:\n cmdret = __salt__[saltfunc](workers, lbn, profile=profile)\n except KeyError:\n ret['result'] = False\n ret['comment'] = 'unsupported function {0}'.format(\n saltfunc\n )\n return ret\n\n errors = []\n for worker, ok in six.iteritems(cmdret):\n if not ok:\n errors.append(worker)\n\n ret['changes'] = {'status': cmdret}\n if errors:\n ret['result'] = False\n ret['comment'] = '{0} failed on some workers'.format(saltfunc)\n\n return ret\n\n\ndef worker_stopped(name, workers=None, profile='default'):\n '''\n Stop all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_stopped:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_stop', name, workers, profile\n )\n\n\ndef worker_activated(name, workers=None, profile='default'):\n '''\n Activate all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_activated:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_activate', name, workers, profile\n )\n\n\ndef worker_disabled(name, workers=None, profile='default'):\n '''\n Disable all the workers in the modjk load balancer\n\n Example:\n\n .. code-block:: yaml\n\n loadbalancer:\n modjk.worker_disabled:\n - workers:\n - app1\n - app2\n '''\n if workers is None:\n workers = []\n return _bulk_state(\n 'modjk.bulk_disable', name, workers, profile\n )\n\n"}}},{"rowIdx":388,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/firewalld.py"},"func_name":{"kind":"string","value":"_parse_forward"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def _parse_forward(mapping):\n '''\n Parses a port forwarding statement in the form used by this state:\n\n from_port:to_port:protocol[:destination]\n\n and returns a ForwardingMapping object\n '''\n if len(mapping.split(':')) > 3:\n (srcport, destport, protocol, destaddr) = mapping.split(':')\n else:\n (srcport, destport, protocol) = mapping.split(':')\n destaddr = ''\n return ForwardingMapping(srcport, destport, protocol, destaddr)"},"func_documentation_string":{"kind":"string","value":"Parses a port forwarding statement in the form used by this state:\n\n from_port:to_port:protocol[:destination]\n\n and returns a ForwardingMapping object"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/firewalld.py#L129-L142"},"called_functions":{"kind":"null"},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nManagement of firewalld\n\n.. versionadded:: 2015.8.0\n\nThe following example applies changes to the public zone, blocks echo-reply\nand echo-request packets, does not set the zone to be the default, enables\nmasquerading, and allows ports 22/tcp and 25/tcp.\nIt will be applied permanently and directly before restart/reload.\n\n.. code-block:: yaml\n\n public:\n firewalld.present:\n - name: public\n - block_icmp:\n - echo-reply\n - echo-request\n - default: False\n - masquerade: True\n - ports:\n - 22/tcp\n - 25/tcp\n\nThe following example applies changes to the public zone, enables\nmasquerading and configures port forwarding TCP traffic from port 22\nto 2222, and forwards TCP traffic from port 80 to 443 at 192.168.0.1.\n\n.. code-block:: yaml\n\n my_zone:\n firewalld.present:\n - name: public\n - masquerade: True\n - port_fwd:\n - 22:2222:tcp\n - 80:443:tcp:192.168.0.1\n\nThe following example binds the public zone to interface eth0 and to all\npackets coming from the 192.168.1.0/24 subnet. It also removes the zone\nfrom all other interfaces or sources.\n\n.. code-block:: yaml\n\n public:\n firewalld.present:\n - name: public\n - interfaces:\n - eth0\n - sources:\n - 192.168.1.0/24\n\nHere, we define a new service that encompasses TCP ports 4505 4506:\n\n.. code-block:: yaml\n\n saltmaster:\n firewalld.service:\n - name: saltmaster\n - ports:\n - 4505/tcp\n - 4506/tcp\n\nTo make this new service available in a zone, the following can be used, which\nwould allow access to the salt master from the 10.0.0.0/8 subnet:\n\n.. code-block:: yaml\n\n saltzone:\n firewalld.present:\n - name: saltzone\n - services:\n - saltmaster\n - sources:\n - 10.0.0.0/8\n'''\n\n# Import Python Libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import Salt Libs\nfrom salt.exceptions import CommandExecutionError\nfrom salt.output import nested\nimport salt.utils.path\n\nlog = logging.getLogger(__name__)\n\n\nclass ForwardingMapping(object):\n '''\n Represents a port forwarding statement mapping a local port to a remote\n port for a specific protocol (TCP or UDP)\n '''\n def __init__(self, srcport, destport, protocol, destaddr):\n self.srcport = srcport\n self.destport = destport\n self.protocol = protocol\n self.destaddr = destaddr\n\n def __eq__(self, other):\n return (self.srcport == other.srcport and\n self.destport == other.destport and\n self.protocol == other.protocol and\n self.destaddr == other.destaddr)\n\n def __ne__(self, other):\n return not self.__eq__(other)\n\n # hash is needed for set operations\n def __hash__(self):\n return (hash(self.srcport) ^\n hash(self.destport) ^\n hash(self.protocol) ^\n hash(self.destaddr))\n\n def todict(self):\n '''\n Returns a pretty dictionary meant for command line output.\n '''\n return {\n 'Source port': self.srcport,\n 'Destination port': self.destport,\n 'Protocol': self.protocol,\n 'Destination address': self.destaddr}\n\n\n\ndef __virtual__():\n '''\n Ensure the firewall-cmd is available\n '''\n if salt.utils.path.which('firewall-cmd'):\n return True\n\n return (False, 'firewall-cmd is not available, firewalld is probably not installed.')\n\n\ndef present(name,\n block_icmp=None,\n prune_block_icmp=False,\n default=None,\n masquerade=False,\n ports=None,\n prune_ports=False,\n port_fwd=None,\n prune_port_fwd=False,\n services=None,\n prune_services=False,\n interfaces=None,\n prune_interfaces=False,\n sources=None,\n prune_sources=False,\n rich_rules=None,\n prune_rich_rules=False):\n\n '''\n Ensure a zone has specific attributes.\n\n name\n The zone to modify.\n\n default : None\n Set this zone as the default zone if ``True``.\n\n masquerade : False\n Enable or disable masquerade for a zone.\n\n block_icmp : None\n List of ICMP types to block in the zone.\n\n prune_block_icmp : False\n If ``True``, remove all but the specified block_icmp from the zone.\n\n ports : None\n List of ports to add to the zone.\n\n prune_ports : False\n If ``True``, remove all but the specified ports from the zone.\n\n port_fwd : None\n List of port forwards to add to the zone.\n\n prune_port_fwd : False\n If ``True``, remove all but the specified port_fwd from the zone.\n\n services : None\n List of services to add to the zone.\n\n prune_services : False\n If ``True``, remove all but the specified services from the zone.\n .. note:: Currently defaults to True for compatibility, but will be changed to False in a future release.\n\n interfaces : None\n List of interfaces to add to the zone.\n\n prune_interfaces : False\n If ``True``, remove all but the specified interfaces from the zone.\n\n sources : None\n List of sources to add to the zone.\n\n prune_sources : False\n If ``True``, remove all but the specified sources from the zone.\n\n rich_rules : None\n List of rich rules to add to the zone.\n\n prune_rich_rules : False\n If ``True``, remove all but the specified rich rules from the zone.\n '''\n ret = _present(name, block_icmp, prune_block_icmp, default, masquerade, ports, prune_ports,\n port_fwd, prune_port_fwd, services, prune_services, interfaces, prune_interfaces,\n sources, prune_sources, rich_rules, prune_rich_rules)\n\n # Reload firewalld service on changes\n if ret['changes'] != {}:\n __salt__['firewalld.reload_rules']()\n\n return ret\n\n\ndef service(name,\n ports=None,\n protocols=None):\n '''\n Ensure the service exists and encompasses the specified ports and\n protocols.\n\n .. versionadded:: 2016.11.0\n '''\n ret = {'name': name,\n 'result': False,\n 'changes': {},\n 'comment': ''}\n\n if name not in __salt__['firewalld.get_services']():\n __salt__['firewalld.new_service'](name, restart=False)\n\n ports = ports or []\n\n try:\n _current_ports = __salt__['firewalld.get_service_ports'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_ports = set(ports) - set(_current_ports)\n old_ports = set(_current_ports) - set(ports)\n\n for port in new_ports:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_service_port'](name, port)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n for port in old_ports:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_service_port'](name, port)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_ports or old_ports:\n ret['changes'].update({'ports':\n {'old': _current_ports,\n 'new': ports}})\n\n protocols = protocols or []\n\n try:\n _current_protocols = __salt__['firewalld.get_service_protocols'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_protocols = set(protocols) - set(_current_protocols)\n old_protocols = set(_current_protocols) - set(protocols)\n\n for protocol in new_protocols:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_service_protocol'](name, protocol)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n for protocol in old_protocols:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_service_protocol'](name, protocol)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_protocols or old_protocols:\n ret['changes'].update({'protocols':\n {'old': _current_protocols,\n 'new': protocols}})\n\n if ret['changes'] != {}:\n __salt__['firewalld.reload_rules']()\n\n ret['result'] = True\n if ret['changes'] == {}:\n ret['comment'] = '\\'{0}\\' is already in the desired state.'.format(\n name)\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n ret['comment'] = 'Configuration for \\'{0}\\' will change.'.format(name)\n return ret\n\n ret['comment'] = '\\'{0}\\' was configured.'.format(name)\n return ret\n\n\ndef _present(name,\n block_icmp=None,\n prune_block_icmp=False,\n default=None,\n masquerade=False,\n ports=None,\n prune_ports=False,\n port_fwd=None,\n prune_port_fwd=False,\n services=None,\n # TODO: prune_services=False in future release\n # prune_services=False,\n prune_services=None,\n interfaces=None,\n prune_interfaces=False,\n sources=None,\n prune_sources=False,\n rich_rules=None,\n prune_rich_rules=False):\n '''\n Ensure a zone has specific attributes.\n '''\n ret = {'name': name,\n 'result': False,\n 'changes': {},\n 'comment': ''}\n\n try:\n zones = __salt__['firewalld.get_zones'](permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if name not in zones:\n if not __opts__['test']:\n try:\n __salt__['firewalld.new_zone'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n ret['changes'].update({name:\n {'old': zones,\n 'new': name}})\n\n if block_icmp or prune_block_icmp:\n block_icmp = block_icmp or []\n new_icmp_types = []\n old_icmp_types = []\n\n try:\n _current_icmp_blocks = __salt__['firewalld.list_icmp_block'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if block_icmp:\n try:\n _valid_icmp_types = __salt__['firewalld.get_icmp_types'](\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n # log errors for invalid ICMP types in block_icmp input\n for icmp_type in set(block_icmp) - set(_valid_icmp_types):\n log.error('%s is an invalid ICMP type', icmp_type)\n block_icmp.remove(icmp_type)\n\n new_icmp_types = set(block_icmp) - set(_current_icmp_blocks)\n for icmp_type in new_icmp_types:\n if not __opts__['test']:\n try:\n __salt__['firewalld.block_icmp'](name, icmp_type,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_block_icmp:\n old_icmp_types = set(_current_icmp_blocks) - set(block_icmp)\n for icmp_type in old_icmp_types:\n # no need to check against _valid_icmp_types here, because all\n # elements in old_icmp_types are guaranteed to be in\n # _current_icmp_blocks, whose elements are inherently valid\n if not __opts__['test']:\n try:\n __salt__['firewalld.allow_icmp'](name, icmp_type,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_icmp_types or old_icmp_types:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_block_icmp:\n block_icmp = list(new_icmp_types | set(_current_icmp_blocks))\n ret['changes'].update({'icmp_types':\n {'old': _current_icmp_blocks,\n 'new': block_icmp}})\n\n # that's the only parameter that can't be permanent or runtime, it's\n # directly both\n if default:\n try:\n default_zone = __salt__['firewalld.default_zone']()\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n if name != default_zone:\n if not __opts__['test']:\n try:\n __salt__['firewalld.set_default_zone'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n ret['changes'].update({'default':\n {'old': default_zone,\n 'new': name}})\n\n try:\n masquerade_ret = __salt__['firewalld.get_masquerade'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if masquerade and not masquerade_ret:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_masquerade'](name, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n ret['changes'].update({'masquerade':\n {'old': '',\n 'new': 'Masquerading successfully set.'}})\n elif not masquerade and masquerade_ret:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_masquerade'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n ret['changes'].update({'masquerade':\n {'old': '',\n 'new': 'Masquerading successfully '\n 'disabled.'}})\n\n if ports or prune_ports:\n ports = ports or []\n try:\n _current_ports = __salt__['firewalld.list_ports'](name, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_ports = set(ports) - set(_current_ports)\n old_ports = []\n\n for port in new_ports:\n if not __opts__['test']:\n try:\n # TODO: force_masquerade to be removed in future release\n __salt__['firewalld.add_port'](name, port, permanent=True, force_masquerade=False)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_ports:\n old_ports = set(_current_ports) - set(ports)\n for port in old_ports:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_port'](name, port, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_ports or old_ports:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_ports:\n ports = list(new_ports | set(_current_ports))\n ret['changes'].update({'ports':\n {'old': _current_ports,\n 'new': ports}})\n\n if port_fwd or prune_port_fwd:\n port_fwd = port_fwd or []\n try:\n _current_port_fwd = __salt__['firewalld.list_port_fwd'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n port_fwd = [_parse_forward(fwd) for fwd in port_fwd]\n _current_port_fwd = [\n ForwardingMapping(\n srcport=fwd['Source port'],\n destport=fwd['Destination port'],\n protocol=fwd['Protocol'],\n destaddr=fwd['Destination address']\n ) for fwd in _current_port_fwd]\n\n new_port_fwd = set(port_fwd) - set(_current_port_fwd)\n old_port_fwd = []\n\n for fwd in new_port_fwd:\n if not __opts__['test']:\n try:\n # TODO: force_masquerade to be removed in future release\n __salt__['firewalld.add_port_fwd'](name, fwd.srcport,\n fwd.destport, fwd.protocol, fwd.destaddr, permanent=True,\n force_masquerade=False)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_port_fwd:\n old_port_fwd = set(_current_port_fwd) - set(port_fwd)\n for fwd in old_port_fwd:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_port_fwd'](name, fwd.srcport,\n fwd.destport, fwd.protocol, fwd.destaddr, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_port_fwd or old_port_fwd:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_port_fwd:\n port_fwd = list(new_port_fwd | set(_current_port_fwd))\n ret['changes'].update({'port_fwd':\n {'old': [fwd.todict() for fwd in\n _current_port_fwd],\n 'new': [fwd.todict() for fwd in port_fwd]}})\n\n if services or prune_services:\n services = services or []\n try:\n _current_services = __salt__['firewalld.list_services'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_services = set(services) - set(_current_services)\n old_services = []\n\n for new_service in new_services:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_service'](new_service, name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_services:\n old_services = set(_current_services) - set(services)\n for old_service in old_services:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_service'](old_service, name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_services or old_services:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_services:\n services = list(new_services | set(_current_services))\n ret['changes'].update({'services':\n {'old': _current_services,\n 'new': services}})\n\n if interfaces or prune_interfaces:\n interfaces = interfaces or []\n try:\n _current_interfaces = __salt__['firewalld.get_interfaces'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_interfaces = set(interfaces) - set(_current_interfaces)\n old_interfaces = []\n\n for interface in new_interfaces:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_interface'](name, interface,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_interfaces:\n old_interfaces = set(_current_interfaces) - set(interfaces)\n for interface in old_interfaces:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_interface'](name, interface,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_interfaces or old_interfaces:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_interfaces:\n interfaces = list(new_interfaces | set(_current_interfaces))\n ret['changes'].update({'interfaces':\n {'old': _current_interfaces,\n 'new': interfaces}})\n\n if sources or prune_sources:\n sources = sources or []\n try:\n _current_sources = __salt__['firewalld.get_sources'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_sources = set(sources) - set(_current_sources)\n old_sources = []\n\n for source in new_sources:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_source'](name, source, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_sources:\n old_sources = set(_current_sources) - set(sources)\n for source in old_sources:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_source'](name, source,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_sources or old_sources:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_sources:\n sources = list(new_sources | set(_current_sources))\n ret['changes'].update({'sources':\n {'old': _current_sources,\n 'new': sources}})\n\n if rich_rules or prune_rich_rules:\n rich_rules = rich_rules or []\n try:\n _current_rich_rules = __salt__['firewalld.get_rich_rules'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_rich_rules = set(rich_rules) - set(_current_rich_rules)\n old_rich_rules = []\n\n for rich_rule in new_rich_rules:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_rich_rule'](name, rich_rule,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_rich_rules:\n old_rich_rules = set(_current_rich_rules) - set(rich_rules)\n for rich_rule in old_rich_rules:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_rich_rule'](name, rich_rule,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_rich_rules or old_rich_rules:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_rich_rules:\n rich_rules = list(new_rich_rules | set(_current_rich_rules))\n ret['changes'].update({'rich_rules':\n {'old': _current_rich_rules,\n 'new': rich_rules}})\n\n # No changes\n if ret['changes'] == {}:\n ret['result'] = True\n ret['comment'] = '\\'{0}\\' is already in the desired state.'.format(name)\n return ret\n\n # test=True and changes predicted\n if __opts__['test']:\n ret['result'] = None\n # build comment string\n nested.__opts__ = __opts__\n comment = []\n comment.append('Configuration for \\'{0}\\' will change:'.format(name))\n comment.append(nested.output(ret['changes']).rstrip())\n ret['comment'] = '\\n'.join(comment)\n ret['changes'] = {}\n return ret\n\n # Changes were made successfully\n ret['result'] = True\n ret['comment'] = '\\'{0}\\' was configured.'.format(name)\n return ret\n"}}},{"rowIdx":389,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/firewalld.py"},"func_name":{"kind":"string","value":"present"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def present(name,\n block_icmp=None,\n prune_block_icmp=False,\n default=None,\n masquerade=False,\n ports=None,\n prune_ports=False,\n port_fwd=None,\n prune_port_fwd=False,\n services=None,\n prune_services=False,\n interfaces=None,\n prune_interfaces=False,\n sources=None,\n prune_sources=False,\n rich_rules=None,\n prune_rich_rules=False):\n\n '''\n Ensure a zone has specific attributes.\n\n name\n The zone to modify.\n\n default : None\n Set this zone as the default zone if ``True``.\n\n masquerade : False\n Enable or disable masquerade for a zone.\n\n block_icmp : None\n List of ICMP types to block in the zone.\n\n prune_block_icmp : False\n If ``True``, remove all but the specified block_icmp from the zone.\n\n ports : None\n List of ports to add to the zone.\n\n prune_ports : False\n If ``True``, remove all but the specified ports from the zone.\n\n port_fwd : None\n List of port forwards to add to the zone.\n\n prune_port_fwd : False\n If ``True``, remove all but the specified port_fwd from the zone.\n\n services : None\n List of services to add to the zone.\n\n prune_services : False\n If ``True``, remove all but the specified services from the zone.\n .. note:: Currently defaults to True for compatibility, but will be changed to False in a future release.\n\n interfaces : None\n List of interfaces to add to the zone.\n\n prune_interfaces : False\n If ``True``, remove all but the specified interfaces from the zone.\n\n sources : None\n List of sources to add to the zone.\n\n prune_sources : False\n If ``True``, remove all but the specified sources from the zone.\n\n rich_rules : None\n List of rich rules to add to the zone.\n\n prune_rich_rules : False\n If ``True``, remove all but the specified rich rules from the zone.\n '''\n ret = _present(name, block_icmp, prune_block_icmp, default, masquerade, ports, prune_ports,\n port_fwd, prune_port_fwd, services, prune_services, interfaces, prune_interfaces,\n sources, prune_sources, rich_rules, prune_rich_rules)\n\n # Reload firewalld service on changes\n if ret['changes'] != {}:\n __salt__['firewalld.reload_rules']()\n\n return ret"},"func_documentation_string":{"kind":"string","value":"Ensure a zone has specific attributes.\n\n name\n The zone to modify.\n\n default : None\n Set this zone as the default zone if ``True``.\n\n masquerade : False\n Enable or disable masquerade for a zone.\n\n block_icmp : None\n List of ICMP types to block in the zone.\n\n prune_block_icmp : False\n If ``True``, remove all but the specified block_icmp from the zone.\n\n ports : None\n List of ports to add to the zone.\n\n prune_ports : False\n If ``True``, remove all but the specified ports from the zone.\n\n port_fwd : None\n List of port forwards to add to the zone.\n\n prune_port_fwd : False\n If ``True``, remove all but the specified port_fwd from the zone.\n\n services : None\n List of services to add to the zone.\n\n prune_services : False\n If ``True``, remove all but the specified services from the zone.\n .. note:: Currently defaults to True for compatibility, but will be changed to False in a future release.\n\n interfaces : None\n List of interfaces to add to the zone.\n\n prune_interfaces : False\n If ``True``, remove all but the specified interfaces from the zone.\n\n sources : None\n List of sources to add to the zone.\n\n prune_sources : False\n If ``True``, remove all but the specified sources from the zone.\n\n rich_rules : None\n List of rich rules to add to the zone.\n\n prune_rich_rules : False\n If ``True``, remove all but the specified rich rules from the zone."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/firewalld.py#L155-L236"},"called_functions":{"kind":"list like","value":["def _present(name,\n block_icmp=None,\n prune_block_icmp=False,\n default=None,\n masquerade=False,\n ports=None,\n prune_ports=False,\n port_fwd=None,\n prune_port_fwd=False,\n services=None,\n # TODO: prune_services=False in future release\n # prune_services=False,\n prune_services=None,\n interfaces=None,\n prune_interfaces=False,\n sources=None,\n prune_sources=False,\n rich_rules=None,\n prune_rich_rules=False):\n '''\n Ensure a zone has specific attributes.\n '''\n ret = {'name': name,\n 'result': False,\n 'changes': {},\n 'comment': ''}\n\n try:\n zones = __salt__['firewalld.get_zones'](permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if name not in zones:\n if not __opts__['test']:\n try:\n __salt__['firewalld.new_zone'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n ret['changes'].update({name:\n {'old': zones,\n 'new': name}})\n\n if block_icmp or prune_block_icmp:\n block_icmp = block_icmp or []\n new_icmp_types = []\n old_icmp_types = []\n\n try:\n _current_icmp_blocks = __salt__['firewalld.list_icmp_block'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if block_icmp:\n try:\n _valid_icmp_types = __salt__['firewalld.get_icmp_types'](\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n # log errors for invalid ICMP types in block_icmp input\n for icmp_type in set(block_icmp) - set(_valid_icmp_types):\n log.error('%s is an invalid ICMP type', icmp_type)\n block_icmp.remove(icmp_type)\n\n new_icmp_types = set(block_icmp) - set(_current_icmp_blocks)\n for icmp_type in new_icmp_types:\n if not __opts__['test']:\n try:\n __salt__['firewalld.block_icmp'](name, icmp_type,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_block_icmp:\n old_icmp_types = set(_current_icmp_blocks) - set(block_icmp)\n for icmp_type in old_icmp_types:\n # no need to check against _valid_icmp_types here, because all\n # elements in old_icmp_types are guaranteed to be in\n # _current_icmp_blocks, whose elements are inherently valid\n if not __opts__['test']:\n try:\n __salt__['firewalld.allow_icmp'](name, icmp_type,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_icmp_types or old_icmp_types:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_block_icmp:\n block_icmp = list(new_icmp_types | set(_current_icmp_blocks))\n ret['changes'].update({'icmp_types':\n {'old': _current_icmp_blocks,\n 'new': block_icmp}})\n\n # that's the only parameter that can't be permanent or runtime, it's\n # directly both\n if default:\n try:\n default_zone = __salt__['firewalld.default_zone']()\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n if name != default_zone:\n if not __opts__['test']:\n try:\n __salt__['firewalld.set_default_zone'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n ret['changes'].update({'default':\n {'old': default_zone,\n 'new': name}})\n\n try:\n masquerade_ret = __salt__['firewalld.get_masquerade'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if masquerade and not masquerade_ret:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_masquerade'](name, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n ret['changes'].update({'masquerade':\n {'old': '',\n 'new': 'Masquerading successfully set.'}})\n elif not masquerade and masquerade_ret:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_masquerade'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n ret['changes'].update({'masquerade':\n {'old': '',\n 'new': 'Masquerading successfully '\n 'disabled.'}})\n\n if ports or prune_ports:\n ports = ports or []\n try:\n _current_ports = __salt__['firewalld.list_ports'](name, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_ports = set(ports) - set(_current_ports)\n old_ports = []\n\n for port in new_ports:\n if not __opts__['test']:\n try:\n # TODO: force_masquerade to be removed in future release\n __salt__['firewalld.add_port'](name, port, permanent=True, force_masquerade=False)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_ports:\n old_ports = set(_current_ports) - set(ports)\n for port in old_ports:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_port'](name, port, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_ports or old_ports:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_ports:\n ports = list(new_ports | set(_current_ports))\n ret['changes'].update({'ports':\n {'old': _current_ports,\n 'new': ports}})\n\n if port_fwd or prune_port_fwd:\n port_fwd = port_fwd or []\n try:\n _current_port_fwd = __salt__['firewalld.list_port_fwd'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n port_fwd = [_parse_forward(fwd) for fwd in port_fwd]\n _current_port_fwd = [\n ForwardingMapping(\n srcport=fwd['Source port'],\n destport=fwd['Destination port'],\n protocol=fwd['Protocol'],\n destaddr=fwd['Destination address']\n ) for fwd in _current_port_fwd]\n\n new_port_fwd = set(port_fwd) - set(_current_port_fwd)\n old_port_fwd = []\n\n for fwd in new_port_fwd:\n if not __opts__['test']:\n try:\n # TODO: force_masquerade to be removed in future release\n __salt__['firewalld.add_port_fwd'](name, fwd.srcport,\n fwd.destport, fwd.protocol, fwd.destaddr, permanent=True,\n force_masquerade=False)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_port_fwd:\n old_port_fwd = set(_current_port_fwd) - set(port_fwd)\n for fwd in old_port_fwd:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_port_fwd'](name, fwd.srcport,\n fwd.destport, fwd.protocol, fwd.destaddr, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_port_fwd or old_port_fwd:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_port_fwd:\n port_fwd = list(new_port_fwd | set(_current_port_fwd))\n ret['changes'].update({'port_fwd':\n {'old': [fwd.todict() for fwd in\n _current_port_fwd],\n 'new': [fwd.todict() for fwd in port_fwd]}})\n\n if services or prune_services:\n services = services or []\n try:\n _current_services = __salt__['firewalld.list_services'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_services = set(services) - set(_current_services)\n old_services = []\n\n for new_service in new_services:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_service'](new_service, name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_services:\n old_services = set(_current_services) - set(services)\n for old_service in old_services:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_service'](old_service, name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_services or old_services:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_services:\n services = list(new_services | set(_current_services))\n ret['changes'].update({'services':\n {'old': _current_services,\n 'new': services}})\n\n if interfaces or prune_interfaces:\n interfaces = interfaces or []\n try:\n _current_interfaces = __salt__['firewalld.get_interfaces'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_interfaces = set(interfaces) - set(_current_interfaces)\n old_interfaces = []\n\n for interface in new_interfaces:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_interface'](name, interface,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_interfaces:\n old_interfaces = set(_current_interfaces) - set(interfaces)\n for interface in old_interfaces:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_interface'](name, interface,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_interfaces or old_interfaces:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_interfaces:\n interfaces = list(new_interfaces | set(_current_interfaces))\n ret['changes'].update({'interfaces':\n {'old': _current_interfaces,\n 'new': interfaces}})\n\n if sources or prune_sources:\n sources = sources or []\n try:\n _current_sources = __salt__['firewalld.get_sources'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_sources = set(sources) - set(_current_sources)\n old_sources = []\n\n for source in new_sources:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_source'](name, source, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_sources:\n old_sources = set(_current_sources) - set(sources)\n for source in old_sources:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_source'](name, source,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_sources or old_sources:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_sources:\n sources = list(new_sources | set(_current_sources))\n ret['changes'].update({'sources':\n {'old': _current_sources,\n 'new': sources}})\n\n if rich_rules or prune_rich_rules:\n rich_rules = rich_rules or []\n try:\n _current_rich_rules = __salt__['firewalld.get_rich_rules'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_rich_rules = set(rich_rules) - set(_current_rich_rules)\n old_rich_rules = []\n\n for rich_rule in new_rich_rules:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_rich_rule'](name, rich_rule,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_rich_rules:\n old_rich_rules = set(_current_rich_rules) - set(rich_rules)\n for rich_rule in old_rich_rules:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_rich_rule'](name, rich_rule,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_rich_rules or old_rich_rules:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_rich_rules:\n rich_rules = list(new_rich_rules | set(_current_rich_rules))\n ret['changes'].update({'rich_rules':\n {'old': _current_rich_rules,\n 'new': rich_rules}})\n\n # No changes\n if ret['changes'] == {}:\n ret['result'] = True\n ret['comment'] = '\\'{0}\\' is already in the desired state.'.format(name)\n return ret\n\n # test=True and changes predicted\n if __opts__['test']:\n ret['result'] = None\n # build comment string\n nested.__opts__ = __opts__\n comment = []\n comment.append('Configuration for \\'{0}\\' will change:'.format(name))\n comment.append(nested.output(ret['changes']).rstrip())\n ret['comment'] = '\\n'.join(comment)\n ret['changes'] = {}\n return ret\n\n # Changes were made successfully\n ret['result'] = True\n ret['comment'] = '\\'{0}\\' was configured.'.format(name)\n return ret\n"],"string":"[\n \"def _present(name,\\n block_icmp=None,\\n prune_block_icmp=False,\\n default=None,\\n masquerade=False,\\n ports=None,\\n prune_ports=False,\\n port_fwd=None,\\n prune_port_fwd=False,\\n services=None,\\n # TODO: prune_services=False in future release\\n # prune_services=False,\\n prune_services=None,\\n interfaces=None,\\n prune_interfaces=False,\\n sources=None,\\n prune_sources=False,\\n rich_rules=None,\\n prune_rich_rules=False):\\n '''\\n Ensure a zone has specific attributes.\\n '''\\n ret = {'name': name,\\n 'result': False,\\n 'changes': {},\\n 'comment': ''}\\n\\n try:\\n zones = __salt__['firewalld.get_zones'](permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if name not in zones:\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.new_zone'](name)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n ret['changes'].update({name:\\n {'old': zones,\\n 'new': name}})\\n\\n if block_icmp or prune_block_icmp:\\n block_icmp = block_icmp or []\\n new_icmp_types = []\\n old_icmp_types = []\\n\\n try:\\n _current_icmp_blocks = __salt__['firewalld.list_icmp_block'](name,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if block_icmp:\\n try:\\n _valid_icmp_types = __salt__['firewalld.get_icmp_types'](\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n # log errors for invalid ICMP types in block_icmp input\\n for icmp_type in set(block_icmp) - set(_valid_icmp_types):\\n log.error('%s is an invalid ICMP type', icmp_type)\\n block_icmp.remove(icmp_type)\\n\\n new_icmp_types = set(block_icmp) - set(_current_icmp_blocks)\\n for icmp_type in new_icmp_types:\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.block_icmp'](name, icmp_type,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if prune_block_icmp:\\n old_icmp_types = set(_current_icmp_blocks) - set(block_icmp)\\n for icmp_type in old_icmp_types:\\n # no need to check against _valid_icmp_types here, because all\\n # elements in old_icmp_types are guaranteed to be in\\n # _current_icmp_blocks, whose elements are inherently valid\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.allow_icmp'](name, icmp_type,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if new_icmp_types or old_icmp_types:\\n # If we're not pruning, include current items in new output so it's clear\\n # that they're still present\\n if not prune_block_icmp:\\n block_icmp = list(new_icmp_types | set(_current_icmp_blocks))\\n ret['changes'].update({'icmp_types':\\n {'old': _current_icmp_blocks,\\n 'new': block_icmp}})\\n\\n # that's the only parameter that can't be permanent or runtime, it's\\n # directly both\\n if default:\\n try:\\n default_zone = __salt__['firewalld.default_zone']()\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n if name != default_zone:\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.set_default_zone'](name)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n ret['changes'].update({'default':\\n {'old': default_zone,\\n 'new': name}})\\n\\n try:\\n masquerade_ret = __salt__['firewalld.get_masquerade'](name,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if masquerade and not masquerade_ret:\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.add_masquerade'](name, permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n ret['changes'].update({'masquerade':\\n {'old': '',\\n 'new': 'Masquerading successfully set.'}})\\n elif not masquerade and masquerade_ret:\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.remove_masquerade'](name,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n ret['changes'].update({'masquerade':\\n {'old': '',\\n 'new': 'Masquerading successfully '\\n 'disabled.'}})\\n\\n if ports or prune_ports:\\n ports = ports or []\\n try:\\n _current_ports = __salt__['firewalld.list_ports'](name, permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n new_ports = set(ports) - set(_current_ports)\\n old_ports = []\\n\\n for port in new_ports:\\n if not __opts__['test']:\\n try:\\n # TODO: force_masquerade to be removed in future release\\n __salt__['firewalld.add_port'](name, port, permanent=True, force_masquerade=False)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if prune_ports:\\n old_ports = set(_current_ports) - set(ports)\\n for port in old_ports:\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.remove_port'](name, port, permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if new_ports or old_ports:\\n # If we're not pruning, include current items in new output so it's clear\\n # that they're still present\\n if not prune_ports:\\n ports = list(new_ports | set(_current_ports))\\n ret['changes'].update({'ports':\\n {'old': _current_ports,\\n 'new': ports}})\\n\\n if port_fwd or prune_port_fwd:\\n port_fwd = port_fwd or []\\n try:\\n _current_port_fwd = __salt__['firewalld.list_port_fwd'](name,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n port_fwd = [_parse_forward(fwd) for fwd in port_fwd]\\n _current_port_fwd = [\\n ForwardingMapping(\\n srcport=fwd['Source port'],\\n destport=fwd['Destination port'],\\n protocol=fwd['Protocol'],\\n destaddr=fwd['Destination address']\\n ) for fwd in _current_port_fwd]\\n\\n new_port_fwd = set(port_fwd) - set(_current_port_fwd)\\n old_port_fwd = []\\n\\n for fwd in new_port_fwd:\\n if not __opts__['test']:\\n try:\\n # TODO: force_masquerade to be removed in future release\\n __salt__['firewalld.add_port_fwd'](name, fwd.srcport,\\n fwd.destport, fwd.protocol, fwd.destaddr, permanent=True,\\n force_masquerade=False)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if prune_port_fwd:\\n old_port_fwd = set(_current_port_fwd) - set(port_fwd)\\n for fwd in old_port_fwd:\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.remove_port_fwd'](name, fwd.srcport,\\n fwd.destport, fwd.protocol, fwd.destaddr, permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if new_port_fwd or old_port_fwd:\\n # If we're not pruning, include current items in new output so it's clear\\n # that they're still present\\n if not prune_port_fwd:\\n port_fwd = list(new_port_fwd | set(_current_port_fwd))\\n ret['changes'].update({'port_fwd':\\n {'old': [fwd.todict() for fwd in\\n _current_port_fwd],\\n 'new': [fwd.todict() for fwd in port_fwd]}})\\n\\n if services or prune_services:\\n services = services or []\\n try:\\n _current_services = __salt__['firewalld.list_services'](name,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n new_services = set(services) - set(_current_services)\\n old_services = []\\n\\n for new_service in new_services:\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.add_service'](new_service, name,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if prune_services:\\n old_services = set(_current_services) - set(services)\\n for old_service in old_services:\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.remove_service'](old_service, name,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if new_services or old_services:\\n # If we're not pruning, include current items in new output so it's clear\\n # that they're still present\\n if not prune_services:\\n services = list(new_services | set(_current_services))\\n ret['changes'].update({'services':\\n {'old': _current_services,\\n 'new': services}})\\n\\n if interfaces or prune_interfaces:\\n interfaces = interfaces or []\\n try:\\n _current_interfaces = __salt__['firewalld.get_interfaces'](name,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n new_interfaces = set(interfaces) - set(_current_interfaces)\\n old_interfaces = []\\n\\n for interface in new_interfaces:\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.add_interface'](name, interface,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if prune_interfaces:\\n old_interfaces = set(_current_interfaces) - set(interfaces)\\n for interface in old_interfaces:\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.remove_interface'](name, interface,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if new_interfaces or old_interfaces:\\n # If we're not pruning, include current items in new output so it's clear\\n # that they're still present\\n if not prune_interfaces:\\n interfaces = list(new_interfaces | set(_current_interfaces))\\n ret['changes'].update({'interfaces':\\n {'old': _current_interfaces,\\n 'new': interfaces}})\\n\\n if sources or prune_sources:\\n sources = sources or []\\n try:\\n _current_sources = __salt__['firewalld.get_sources'](name,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n new_sources = set(sources) - set(_current_sources)\\n old_sources = []\\n\\n for source in new_sources:\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.add_source'](name, source, permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if prune_sources:\\n old_sources = set(_current_sources) - set(sources)\\n for source in old_sources:\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.remove_source'](name, source,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if new_sources or old_sources:\\n # If we're not pruning, include current items in new output so it's clear\\n # that they're still present\\n if not prune_sources:\\n sources = list(new_sources | set(_current_sources))\\n ret['changes'].update({'sources':\\n {'old': _current_sources,\\n 'new': sources}})\\n\\n if rich_rules or prune_rich_rules:\\n rich_rules = rich_rules or []\\n try:\\n _current_rich_rules = __salt__['firewalld.get_rich_rules'](name,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n new_rich_rules = set(rich_rules) - set(_current_rich_rules)\\n old_rich_rules = []\\n\\n for rich_rule in new_rich_rules:\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.add_rich_rule'](name, rich_rule,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if prune_rich_rules:\\n old_rich_rules = set(_current_rich_rules) - set(rich_rules)\\n for rich_rule in old_rich_rules:\\n if not __opts__['test']:\\n try:\\n __salt__['firewalld.remove_rich_rule'](name, rich_rule,\\n permanent=True)\\n except CommandExecutionError as err:\\n ret['comment'] = 'Error: {0}'.format(err)\\n return ret\\n\\n if new_rich_rules or old_rich_rules:\\n # If we're not pruning, include current items in new output so it's clear\\n # that they're still present\\n if not prune_rich_rules:\\n rich_rules = list(new_rich_rules | set(_current_rich_rules))\\n ret['changes'].update({'rich_rules':\\n {'old': _current_rich_rules,\\n 'new': rich_rules}})\\n\\n # No changes\\n if ret['changes'] == {}:\\n ret['result'] = True\\n ret['comment'] = '\\\\'{0}\\\\' is already in the desired state.'.format(name)\\n return ret\\n\\n # test=True and changes predicted\\n if __opts__['test']:\\n ret['result'] = None\\n # build comment string\\n nested.__opts__ = __opts__\\n comment = []\\n comment.append('Configuration for \\\\'{0}\\\\' will change:'.format(name))\\n comment.append(nested.output(ret['changes']).rstrip())\\n ret['comment'] = '\\\\n'.join(comment)\\n ret['changes'] = {}\\n return ret\\n\\n # Changes were made successfully\\n ret['result'] = True\\n ret['comment'] = '\\\\'{0}\\\\' was configured.'.format(name)\\n return ret\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nManagement of firewalld\n\n.. versionadded:: 2015.8.0\n\nThe following example applies changes to the public zone, blocks echo-reply\nand echo-request packets, does not set the zone to be the default, enables\nmasquerading, and allows ports 22/tcp and 25/tcp.\nIt will be applied permanently and directly before restart/reload.\n\n.. code-block:: yaml\n\n public:\n firewalld.present:\n - name: public\n - block_icmp:\n - echo-reply\n - echo-request\n - default: False\n - masquerade: True\n - ports:\n - 22/tcp\n - 25/tcp\n\nThe following example applies changes to the public zone, enables\nmasquerading and configures port forwarding TCP traffic from port 22\nto 2222, and forwards TCP traffic from port 80 to 443 at 192.168.0.1.\n\n.. code-block:: yaml\n\n my_zone:\n firewalld.present:\n - name: public\n - masquerade: True\n - port_fwd:\n - 22:2222:tcp\n - 80:443:tcp:192.168.0.1\n\nThe following example binds the public zone to interface eth0 and to all\npackets coming from the 192.168.1.0/24 subnet. It also removes the zone\nfrom all other interfaces or sources.\n\n.. code-block:: yaml\n\n public:\n firewalld.present:\n - name: public\n - interfaces:\n - eth0\n - sources:\n - 192.168.1.0/24\n\nHere, we define a new service that encompasses TCP ports 4505 4506:\n\n.. code-block:: yaml\n\n saltmaster:\n firewalld.service:\n - name: saltmaster\n - ports:\n - 4505/tcp\n - 4506/tcp\n\nTo make this new service available in a zone, the following can be used, which\nwould allow access to the salt master from the 10.0.0.0/8 subnet:\n\n.. code-block:: yaml\n\n saltzone:\n firewalld.present:\n - name: saltzone\n - services:\n - saltmaster\n - sources:\n - 10.0.0.0/8\n'''\n\n# Import Python Libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import Salt Libs\nfrom salt.exceptions import CommandExecutionError\nfrom salt.output import nested\nimport salt.utils.path\n\nlog = logging.getLogger(__name__)\n\n\nclass ForwardingMapping(object):\n '''\n Represents a port forwarding statement mapping a local port to a remote\n port for a specific protocol (TCP or UDP)\n '''\n def __init__(self, srcport, destport, protocol, destaddr):\n self.srcport = srcport\n self.destport = destport\n self.protocol = protocol\n self.destaddr = destaddr\n\n def __eq__(self, other):\n return (self.srcport == other.srcport and\n self.destport == other.destport and\n self.protocol == other.protocol and\n self.destaddr == other.destaddr)\n\n def __ne__(self, other):\n return not self.__eq__(other)\n\n # hash is needed for set operations\n def __hash__(self):\n return (hash(self.srcport) ^\n hash(self.destport) ^\n hash(self.protocol) ^\n hash(self.destaddr))\n\n def todict(self):\n '''\n Returns a pretty dictionary meant for command line output.\n '''\n return {\n 'Source port': self.srcport,\n 'Destination port': self.destport,\n 'Protocol': self.protocol,\n 'Destination address': self.destaddr}\n\n\ndef _parse_forward(mapping):\n '''\n Parses a port forwarding statement in the form used by this state:\n\n from_port:to_port:protocol[:destination]\n\n and returns a ForwardingMapping object\n '''\n if len(mapping.split(':')) > 3:\n (srcport, destport, protocol, destaddr) = mapping.split(':')\n else:\n (srcport, destport, protocol) = mapping.split(':')\n destaddr = ''\n return ForwardingMapping(srcport, destport, protocol, destaddr)\n\n\ndef __virtual__():\n '''\n Ensure the firewall-cmd is available\n '''\n if salt.utils.path.which('firewall-cmd'):\n return True\n\n return (False, 'firewall-cmd is not available, firewalld is probably not installed.')\n\n\n\ndef service(name,\n ports=None,\n protocols=None):\n '''\n Ensure the service exists and encompasses the specified ports and\n protocols.\n\n .. versionadded:: 2016.11.0\n '''\n ret = {'name': name,\n 'result': False,\n 'changes': {},\n 'comment': ''}\n\n if name not in __salt__['firewalld.get_services']():\n __salt__['firewalld.new_service'](name, restart=False)\n\n ports = ports or []\n\n try:\n _current_ports = __salt__['firewalld.get_service_ports'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_ports = set(ports) - set(_current_ports)\n old_ports = set(_current_ports) - set(ports)\n\n for port in new_ports:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_service_port'](name, port)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n for port in old_ports:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_service_port'](name, port)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_ports or old_ports:\n ret['changes'].update({'ports':\n {'old': _current_ports,\n 'new': ports}})\n\n protocols = protocols or []\n\n try:\n _current_protocols = __salt__['firewalld.get_service_protocols'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_protocols = set(protocols) - set(_current_protocols)\n old_protocols = set(_current_protocols) - set(protocols)\n\n for protocol in new_protocols:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_service_protocol'](name, protocol)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n for protocol in old_protocols:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_service_protocol'](name, protocol)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_protocols or old_protocols:\n ret['changes'].update({'protocols':\n {'old': _current_protocols,\n 'new': protocols}})\n\n if ret['changes'] != {}:\n __salt__['firewalld.reload_rules']()\n\n ret['result'] = True\n if ret['changes'] == {}:\n ret['comment'] = '\\'{0}\\' is already in the desired state.'.format(\n name)\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n ret['comment'] = 'Configuration for \\'{0}\\' will change.'.format(name)\n return ret\n\n ret['comment'] = '\\'{0}\\' was configured.'.format(name)\n return ret\n\n\ndef _present(name,\n block_icmp=None,\n prune_block_icmp=False,\n default=None,\n masquerade=False,\n ports=None,\n prune_ports=False,\n port_fwd=None,\n prune_port_fwd=False,\n services=None,\n # TODO: prune_services=False in future release\n # prune_services=False,\n prune_services=None,\n interfaces=None,\n prune_interfaces=False,\n sources=None,\n prune_sources=False,\n rich_rules=None,\n prune_rich_rules=False):\n '''\n Ensure a zone has specific attributes.\n '''\n ret = {'name': name,\n 'result': False,\n 'changes': {},\n 'comment': ''}\n\n try:\n zones = __salt__['firewalld.get_zones'](permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if name not in zones:\n if not __opts__['test']:\n try:\n __salt__['firewalld.new_zone'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n ret['changes'].update({name:\n {'old': zones,\n 'new': name}})\n\n if block_icmp or prune_block_icmp:\n block_icmp = block_icmp or []\n new_icmp_types = []\n old_icmp_types = []\n\n try:\n _current_icmp_blocks = __salt__['firewalld.list_icmp_block'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if block_icmp:\n try:\n _valid_icmp_types = __salt__['firewalld.get_icmp_types'](\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n # log errors for invalid ICMP types in block_icmp input\n for icmp_type in set(block_icmp) - set(_valid_icmp_types):\n log.error('%s is an invalid ICMP type', icmp_type)\n block_icmp.remove(icmp_type)\n\n new_icmp_types = set(block_icmp) - set(_current_icmp_blocks)\n for icmp_type in new_icmp_types:\n if not __opts__['test']:\n try:\n __salt__['firewalld.block_icmp'](name, icmp_type,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_block_icmp:\n old_icmp_types = set(_current_icmp_blocks) - set(block_icmp)\n for icmp_type in old_icmp_types:\n # no need to check against _valid_icmp_types here, because all\n # elements in old_icmp_types are guaranteed to be in\n # _current_icmp_blocks, whose elements are inherently valid\n if not __opts__['test']:\n try:\n __salt__['firewalld.allow_icmp'](name, icmp_type,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_icmp_types or old_icmp_types:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_block_icmp:\n block_icmp = list(new_icmp_types | set(_current_icmp_blocks))\n ret['changes'].update({'icmp_types':\n {'old': _current_icmp_blocks,\n 'new': block_icmp}})\n\n # that's the only parameter that can't be permanent or runtime, it's\n # directly both\n if default:\n try:\n default_zone = __salt__['firewalld.default_zone']()\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n if name != default_zone:\n if not __opts__['test']:\n try:\n __salt__['firewalld.set_default_zone'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n ret['changes'].update({'default':\n {'old': default_zone,\n 'new': name}})\n\n try:\n masquerade_ret = __salt__['firewalld.get_masquerade'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if masquerade and not masquerade_ret:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_masquerade'](name, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n ret['changes'].update({'masquerade':\n {'old': '',\n 'new': 'Masquerading successfully set.'}})\n elif not masquerade and masquerade_ret:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_masquerade'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n ret['changes'].update({'masquerade':\n {'old': '',\n 'new': 'Masquerading successfully '\n 'disabled.'}})\n\n if ports or prune_ports:\n ports = ports or []\n try:\n _current_ports = __salt__['firewalld.list_ports'](name, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_ports = set(ports) - set(_current_ports)\n old_ports = []\n\n for port in new_ports:\n if not __opts__['test']:\n try:\n # TODO: force_masquerade to be removed in future release\n __salt__['firewalld.add_port'](name, port, permanent=True, force_masquerade=False)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_ports:\n old_ports = set(_current_ports) - set(ports)\n for port in old_ports:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_port'](name, port, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_ports or old_ports:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_ports:\n ports = list(new_ports | set(_current_ports))\n ret['changes'].update({'ports':\n {'old': _current_ports,\n 'new': ports}})\n\n if port_fwd or prune_port_fwd:\n port_fwd = port_fwd or []\n try:\n _current_port_fwd = __salt__['firewalld.list_port_fwd'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n port_fwd = [_parse_forward(fwd) for fwd in port_fwd]\n _current_port_fwd = [\n ForwardingMapping(\n srcport=fwd['Source port'],\n destport=fwd['Destination port'],\n protocol=fwd['Protocol'],\n destaddr=fwd['Destination address']\n ) for fwd in _current_port_fwd]\n\n new_port_fwd = set(port_fwd) - set(_current_port_fwd)\n old_port_fwd = []\n\n for fwd in new_port_fwd:\n if not __opts__['test']:\n try:\n # TODO: force_masquerade to be removed in future release\n __salt__['firewalld.add_port_fwd'](name, fwd.srcport,\n fwd.destport, fwd.protocol, fwd.destaddr, permanent=True,\n force_masquerade=False)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_port_fwd:\n old_port_fwd = set(_current_port_fwd) - set(port_fwd)\n for fwd in old_port_fwd:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_port_fwd'](name, fwd.srcport,\n fwd.destport, fwd.protocol, fwd.destaddr, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_port_fwd or old_port_fwd:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_port_fwd:\n port_fwd = list(new_port_fwd | set(_current_port_fwd))\n ret['changes'].update({'port_fwd':\n {'old': [fwd.todict() for fwd in\n _current_port_fwd],\n 'new': [fwd.todict() for fwd in port_fwd]}})\n\n if services or prune_services:\n services = services or []\n try:\n _current_services = __salt__['firewalld.list_services'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_services = set(services) - set(_current_services)\n old_services = []\n\n for new_service in new_services:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_service'](new_service, name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_services:\n old_services = set(_current_services) - set(services)\n for old_service in old_services:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_service'](old_service, name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_services or old_services:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_services:\n services = list(new_services | set(_current_services))\n ret['changes'].update({'services':\n {'old': _current_services,\n 'new': services}})\n\n if interfaces or prune_interfaces:\n interfaces = interfaces or []\n try:\n _current_interfaces = __salt__['firewalld.get_interfaces'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_interfaces = set(interfaces) - set(_current_interfaces)\n old_interfaces = []\n\n for interface in new_interfaces:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_interface'](name, interface,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_interfaces:\n old_interfaces = set(_current_interfaces) - set(interfaces)\n for interface in old_interfaces:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_interface'](name, interface,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_interfaces or old_interfaces:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_interfaces:\n interfaces = list(new_interfaces | set(_current_interfaces))\n ret['changes'].update({'interfaces':\n {'old': _current_interfaces,\n 'new': interfaces}})\n\n if sources or prune_sources:\n sources = sources or []\n try:\n _current_sources = __salt__['firewalld.get_sources'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_sources = set(sources) - set(_current_sources)\n old_sources = []\n\n for source in new_sources:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_source'](name, source, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_sources:\n old_sources = set(_current_sources) - set(sources)\n for source in old_sources:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_source'](name, source,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_sources or old_sources:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_sources:\n sources = list(new_sources | set(_current_sources))\n ret['changes'].update({'sources':\n {'old': _current_sources,\n 'new': sources}})\n\n if rich_rules or prune_rich_rules:\n rich_rules = rich_rules or []\n try:\n _current_rich_rules = __salt__['firewalld.get_rich_rules'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_rich_rules = set(rich_rules) - set(_current_rich_rules)\n old_rich_rules = []\n\n for rich_rule in new_rich_rules:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_rich_rule'](name, rich_rule,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_rich_rules:\n old_rich_rules = set(_current_rich_rules) - set(rich_rules)\n for rich_rule in old_rich_rules:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_rich_rule'](name, rich_rule,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_rich_rules or old_rich_rules:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_rich_rules:\n rich_rules = list(new_rich_rules | set(_current_rich_rules))\n ret['changes'].update({'rich_rules':\n {'old': _current_rich_rules,\n 'new': rich_rules}})\n\n # No changes\n if ret['changes'] == {}:\n ret['result'] = True\n ret['comment'] = '\\'{0}\\' is already in the desired state.'.format(name)\n return ret\n\n # test=True and changes predicted\n if __opts__['test']:\n ret['result'] = None\n # build comment string\n nested.__opts__ = __opts__\n comment = []\n comment.append('Configuration for \\'{0}\\' will change:'.format(name))\n comment.append(nested.output(ret['changes']).rstrip())\n ret['comment'] = '\\n'.join(comment)\n ret['changes'] = {}\n return ret\n\n # Changes were made successfully\n ret['result'] = True\n ret['comment'] = '\\'{0}\\' was configured.'.format(name)\n return ret\n"}}},{"rowIdx":390,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/firewalld.py"},"func_name":{"kind":"string","value":"service"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def service(name,\n ports=None,\n protocols=None):\n '''\n Ensure the service exists and encompasses the specified ports and\n protocols.\n\n .. versionadded:: 2016.11.0\n '''\n ret = {'name': name,\n 'result': False,\n 'changes': {},\n 'comment': ''}\n\n if name not in __salt__['firewalld.get_services']():\n __salt__['firewalld.new_service'](name, restart=False)\n\n ports = ports or []\n\n try:\n _current_ports = __salt__['firewalld.get_service_ports'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_ports = set(ports) - set(_current_ports)\n old_ports = set(_current_ports) - set(ports)\n\n for port in new_ports:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_service_port'](name, port)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n for port in old_ports:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_service_port'](name, port)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_ports or old_ports:\n ret['changes'].update({'ports':\n {'old': _current_ports,\n 'new': ports}})\n\n protocols = protocols or []\n\n try:\n _current_protocols = __salt__['firewalld.get_service_protocols'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_protocols = set(protocols) - set(_current_protocols)\n old_protocols = set(_current_protocols) - set(protocols)\n\n for protocol in new_protocols:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_service_protocol'](name, protocol)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n for protocol in old_protocols:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_service_protocol'](name, protocol)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_protocols or old_protocols:\n ret['changes'].update({'protocols':\n {'old': _current_protocols,\n 'new': protocols}})\n\n if ret['changes'] != {}:\n __salt__['firewalld.reload_rules']()\n\n ret['result'] = True\n if ret['changes'] == {}:\n ret['comment'] = '\\'{0}\\' is already in the desired state.'.format(\n name)\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n ret['comment'] = 'Configuration for \\'{0}\\' will change.'.format(name)\n return ret\n\n ret['comment'] = '\\'{0}\\' was configured.'.format(name)\n return ret"},"func_documentation_string":{"kind":"string","value":"Ensure the service exists and encompasses the specified ports and\n protocols.\n\n .. versionadded:: 2016.11.0"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/firewalld.py#L239-L335"},"called_functions":{"kind":"null"},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nManagement of firewalld\n\n.. versionadded:: 2015.8.0\n\nThe following example applies changes to the public zone, blocks echo-reply\nand echo-request packets, does not set the zone to be the default, enables\nmasquerading, and allows ports 22/tcp and 25/tcp.\nIt will be applied permanently and directly before restart/reload.\n\n.. code-block:: yaml\n\n public:\n firewalld.present:\n - name: public\n - block_icmp:\n - echo-reply\n - echo-request\n - default: False\n - masquerade: True\n - ports:\n - 22/tcp\n - 25/tcp\n\nThe following example applies changes to the public zone, enables\nmasquerading and configures port forwarding TCP traffic from port 22\nto 2222, and forwards TCP traffic from port 80 to 443 at 192.168.0.1.\n\n.. code-block:: yaml\n\n my_zone:\n firewalld.present:\n - name: public\n - masquerade: True\n - port_fwd:\n - 22:2222:tcp\n - 80:443:tcp:192.168.0.1\n\nThe following example binds the public zone to interface eth0 and to all\npackets coming from the 192.168.1.0/24 subnet. It also removes the zone\nfrom all other interfaces or sources.\n\n.. code-block:: yaml\n\n public:\n firewalld.present:\n - name: public\n - interfaces:\n - eth0\n - sources:\n - 192.168.1.0/24\n\nHere, we define a new service that encompasses TCP ports 4505 4506:\n\n.. code-block:: yaml\n\n saltmaster:\n firewalld.service:\n - name: saltmaster\n - ports:\n - 4505/tcp\n - 4506/tcp\n\nTo make this new service available in a zone, the following can be used, which\nwould allow access to the salt master from the 10.0.0.0/8 subnet:\n\n.. code-block:: yaml\n\n saltzone:\n firewalld.present:\n - name: saltzone\n - services:\n - saltmaster\n - sources:\n - 10.0.0.0/8\n'''\n\n# Import Python Libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import Salt Libs\nfrom salt.exceptions import CommandExecutionError\nfrom salt.output import nested\nimport salt.utils.path\n\nlog = logging.getLogger(__name__)\n\n\nclass ForwardingMapping(object):\n '''\n Represents a port forwarding statement mapping a local port to a remote\n port for a specific protocol (TCP or UDP)\n '''\n def __init__(self, srcport, destport, protocol, destaddr):\n self.srcport = srcport\n self.destport = destport\n self.protocol = protocol\n self.destaddr = destaddr\n\n def __eq__(self, other):\n return (self.srcport == other.srcport and\n self.destport == other.destport and\n self.protocol == other.protocol and\n self.destaddr == other.destaddr)\n\n def __ne__(self, other):\n return not self.__eq__(other)\n\n # hash is needed for set operations\n def __hash__(self):\n return (hash(self.srcport) ^\n hash(self.destport) ^\n hash(self.protocol) ^\n hash(self.destaddr))\n\n def todict(self):\n '''\n Returns a pretty dictionary meant for command line output.\n '''\n return {\n 'Source port': self.srcport,\n 'Destination port': self.destport,\n 'Protocol': self.protocol,\n 'Destination address': self.destaddr}\n\n\ndef _parse_forward(mapping):\n '''\n Parses a port forwarding statement in the form used by this state:\n\n from_port:to_port:protocol[:destination]\n\n and returns a ForwardingMapping object\n '''\n if len(mapping.split(':')) > 3:\n (srcport, destport, protocol, destaddr) = mapping.split(':')\n else:\n (srcport, destport, protocol) = mapping.split(':')\n destaddr = ''\n return ForwardingMapping(srcport, destport, protocol, destaddr)\n\n\ndef __virtual__():\n '''\n Ensure the firewall-cmd is available\n '''\n if salt.utils.path.which('firewall-cmd'):\n return True\n\n return (False, 'firewall-cmd is not available, firewalld is probably not installed.')\n\n\ndef present(name,\n block_icmp=None,\n prune_block_icmp=False,\n default=None,\n masquerade=False,\n ports=None,\n prune_ports=False,\n port_fwd=None,\n prune_port_fwd=False,\n services=None,\n prune_services=False,\n interfaces=None,\n prune_interfaces=False,\n sources=None,\n prune_sources=False,\n rich_rules=None,\n prune_rich_rules=False):\n\n '''\n Ensure a zone has specific attributes.\n\n name\n The zone to modify.\n\n default : None\n Set this zone as the default zone if ``True``.\n\n masquerade : False\n Enable or disable masquerade for a zone.\n\n block_icmp : None\n List of ICMP types to block in the zone.\n\n prune_block_icmp : False\n If ``True``, remove all but the specified block_icmp from the zone.\n\n ports : None\n List of ports to add to the zone.\n\n prune_ports : False\n If ``True``, remove all but the specified ports from the zone.\n\n port_fwd : None\n List of port forwards to add to the zone.\n\n prune_port_fwd : False\n If ``True``, remove all but the specified port_fwd from the zone.\n\n services : None\n List of services to add to the zone.\n\n prune_services : False\n If ``True``, remove all but the specified services from the zone.\n .. note:: Currently defaults to True for compatibility, but will be changed to False in a future release.\n\n interfaces : None\n List of interfaces to add to the zone.\n\n prune_interfaces : False\n If ``True``, remove all but the specified interfaces from the zone.\n\n sources : None\n List of sources to add to the zone.\n\n prune_sources : False\n If ``True``, remove all but the specified sources from the zone.\n\n rich_rules : None\n List of rich rules to add to the zone.\n\n prune_rich_rules : False\n If ``True``, remove all but the specified rich rules from the zone.\n '''\n ret = _present(name, block_icmp, prune_block_icmp, default, masquerade, ports, prune_ports,\n port_fwd, prune_port_fwd, services, prune_services, interfaces, prune_interfaces,\n sources, prune_sources, rich_rules, prune_rich_rules)\n\n # Reload firewalld service on changes\n if ret['changes'] != {}:\n __salt__['firewalld.reload_rules']()\n\n return ret\n\n\n\ndef _present(name,\n block_icmp=None,\n prune_block_icmp=False,\n default=None,\n masquerade=False,\n ports=None,\n prune_ports=False,\n port_fwd=None,\n prune_port_fwd=False,\n services=None,\n # TODO: prune_services=False in future release\n # prune_services=False,\n prune_services=None,\n interfaces=None,\n prune_interfaces=False,\n sources=None,\n prune_sources=False,\n rich_rules=None,\n prune_rich_rules=False):\n '''\n Ensure a zone has specific attributes.\n '''\n ret = {'name': name,\n 'result': False,\n 'changes': {},\n 'comment': ''}\n\n try:\n zones = __salt__['firewalld.get_zones'](permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if name not in zones:\n if not __opts__['test']:\n try:\n __salt__['firewalld.new_zone'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n ret['changes'].update({name:\n {'old': zones,\n 'new': name}})\n\n if block_icmp or prune_block_icmp:\n block_icmp = block_icmp or []\n new_icmp_types = []\n old_icmp_types = []\n\n try:\n _current_icmp_blocks = __salt__['firewalld.list_icmp_block'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if block_icmp:\n try:\n _valid_icmp_types = __salt__['firewalld.get_icmp_types'](\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n # log errors for invalid ICMP types in block_icmp input\n for icmp_type in set(block_icmp) - set(_valid_icmp_types):\n log.error('%s is an invalid ICMP type', icmp_type)\n block_icmp.remove(icmp_type)\n\n new_icmp_types = set(block_icmp) - set(_current_icmp_blocks)\n for icmp_type in new_icmp_types:\n if not __opts__['test']:\n try:\n __salt__['firewalld.block_icmp'](name, icmp_type,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_block_icmp:\n old_icmp_types = set(_current_icmp_blocks) - set(block_icmp)\n for icmp_type in old_icmp_types:\n # no need to check against _valid_icmp_types here, because all\n # elements in old_icmp_types are guaranteed to be in\n # _current_icmp_blocks, whose elements are inherently valid\n if not __opts__['test']:\n try:\n __salt__['firewalld.allow_icmp'](name, icmp_type,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_icmp_types or old_icmp_types:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_block_icmp:\n block_icmp = list(new_icmp_types | set(_current_icmp_blocks))\n ret['changes'].update({'icmp_types':\n {'old': _current_icmp_blocks,\n 'new': block_icmp}})\n\n # that's the only parameter that can't be permanent or runtime, it's\n # directly both\n if default:\n try:\n default_zone = __salt__['firewalld.default_zone']()\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n if name != default_zone:\n if not __opts__['test']:\n try:\n __salt__['firewalld.set_default_zone'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n ret['changes'].update({'default':\n {'old': default_zone,\n 'new': name}})\n\n try:\n masquerade_ret = __salt__['firewalld.get_masquerade'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if masquerade and not masquerade_ret:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_masquerade'](name, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n ret['changes'].update({'masquerade':\n {'old': '',\n 'new': 'Masquerading successfully set.'}})\n elif not masquerade and masquerade_ret:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_masquerade'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n ret['changes'].update({'masquerade':\n {'old': '',\n 'new': 'Masquerading successfully '\n 'disabled.'}})\n\n if ports or prune_ports:\n ports = ports or []\n try:\n _current_ports = __salt__['firewalld.list_ports'](name, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_ports = set(ports) - set(_current_ports)\n old_ports = []\n\n for port in new_ports:\n if not __opts__['test']:\n try:\n # TODO: force_masquerade to be removed in future release\n __salt__['firewalld.add_port'](name, port, permanent=True, force_masquerade=False)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_ports:\n old_ports = set(_current_ports) - set(ports)\n for port in old_ports:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_port'](name, port, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_ports or old_ports:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_ports:\n ports = list(new_ports | set(_current_ports))\n ret['changes'].update({'ports':\n {'old': _current_ports,\n 'new': ports}})\n\n if port_fwd or prune_port_fwd:\n port_fwd = port_fwd or []\n try:\n _current_port_fwd = __salt__['firewalld.list_port_fwd'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n port_fwd = [_parse_forward(fwd) for fwd in port_fwd]\n _current_port_fwd = [\n ForwardingMapping(\n srcport=fwd['Source port'],\n destport=fwd['Destination port'],\n protocol=fwd['Protocol'],\n destaddr=fwd['Destination address']\n ) for fwd in _current_port_fwd]\n\n new_port_fwd = set(port_fwd) - set(_current_port_fwd)\n old_port_fwd = []\n\n for fwd in new_port_fwd:\n if not __opts__['test']:\n try:\n # TODO: force_masquerade to be removed in future release\n __salt__['firewalld.add_port_fwd'](name, fwd.srcport,\n fwd.destport, fwd.protocol, fwd.destaddr, permanent=True,\n force_masquerade=False)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_port_fwd:\n old_port_fwd = set(_current_port_fwd) - set(port_fwd)\n for fwd in old_port_fwd:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_port_fwd'](name, fwd.srcport,\n fwd.destport, fwd.protocol, fwd.destaddr, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_port_fwd or old_port_fwd:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_port_fwd:\n port_fwd = list(new_port_fwd | set(_current_port_fwd))\n ret['changes'].update({'port_fwd':\n {'old': [fwd.todict() for fwd in\n _current_port_fwd],\n 'new': [fwd.todict() for fwd in port_fwd]}})\n\n if services or prune_services:\n services = services or []\n try:\n _current_services = __salt__['firewalld.list_services'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_services = set(services) - set(_current_services)\n old_services = []\n\n for new_service in new_services:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_service'](new_service, name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_services:\n old_services = set(_current_services) - set(services)\n for old_service in old_services:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_service'](old_service, name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_services or old_services:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_services:\n services = list(new_services | set(_current_services))\n ret['changes'].update({'services':\n {'old': _current_services,\n 'new': services}})\n\n if interfaces or prune_interfaces:\n interfaces = interfaces or []\n try:\n _current_interfaces = __salt__['firewalld.get_interfaces'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_interfaces = set(interfaces) - set(_current_interfaces)\n old_interfaces = []\n\n for interface in new_interfaces:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_interface'](name, interface,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_interfaces:\n old_interfaces = set(_current_interfaces) - set(interfaces)\n for interface in old_interfaces:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_interface'](name, interface,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_interfaces or old_interfaces:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_interfaces:\n interfaces = list(new_interfaces | set(_current_interfaces))\n ret['changes'].update({'interfaces':\n {'old': _current_interfaces,\n 'new': interfaces}})\n\n if sources or prune_sources:\n sources = sources or []\n try:\n _current_sources = __salt__['firewalld.get_sources'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_sources = set(sources) - set(_current_sources)\n old_sources = []\n\n for source in new_sources:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_source'](name, source, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_sources:\n old_sources = set(_current_sources) - set(sources)\n for source in old_sources:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_source'](name, source,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_sources or old_sources:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_sources:\n sources = list(new_sources | set(_current_sources))\n ret['changes'].update({'sources':\n {'old': _current_sources,\n 'new': sources}})\n\n if rich_rules or prune_rich_rules:\n rich_rules = rich_rules or []\n try:\n _current_rich_rules = __salt__['firewalld.get_rich_rules'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_rich_rules = set(rich_rules) - set(_current_rich_rules)\n old_rich_rules = []\n\n for rich_rule in new_rich_rules:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_rich_rule'](name, rich_rule,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_rich_rules:\n old_rich_rules = set(_current_rich_rules) - set(rich_rules)\n for rich_rule in old_rich_rules:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_rich_rule'](name, rich_rule,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_rich_rules or old_rich_rules:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_rich_rules:\n rich_rules = list(new_rich_rules | set(_current_rich_rules))\n ret['changes'].update({'rich_rules':\n {'old': _current_rich_rules,\n 'new': rich_rules}})\n\n # No changes\n if ret['changes'] == {}:\n ret['result'] = True\n ret['comment'] = '\\'{0}\\' is already in the desired state.'.format(name)\n return ret\n\n # test=True and changes predicted\n if __opts__['test']:\n ret['result'] = None\n # build comment string\n nested.__opts__ = __opts__\n comment = []\n comment.append('Configuration for \\'{0}\\' will change:'.format(name))\n comment.append(nested.output(ret['changes']).rstrip())\n ret['comment'] = '\\n'.join(comment)\n ret['changes'] = {}\n return ret\n\n # Changes were made successfully\n ret['result'] = True\n ret['comment'] = '\\'{0}\\' was configured.'.format(name)\n return ret\n"}}},{"rowIdx":391,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/firewalld.py"},"func_name":{"kind":"string","value":"_present"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def _present(name,\n block_icmp=None,\n prune_block_icmp=False,\n default=None,\n masquerade=False,\n ports=None,\n prune_ports=False,\n port_fwd=None,\n prune_port_fwd=False,\n services=None,\n # TODO: prune_services=False in future release\n # prune_services=False,\n prune_services=None,\n interfaces=None,\n prune_interfaces=False,\n sources=None,\n prune_sources=False,\n rich_rules=None,\n prune_rich_rules=False):\n '''\n Ensure a zone has specific attributes.\n '''\n ret = {'name': name,\n 'result': False,\n 'changes': {},\n 'comment': ''}\n\n try:\n zones = __salt__['firewalld.get_zones'](permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if name not in zones:\n if not __opts__['test']:\n try:\n __salt__['firewalld.new_zone'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n ret['changes'].update({name:\n {'old': zones,\n 'new': name}})\n\n if block_icmp or prune_block_icmp:\n block_icmp = block_icmp or []\n new_icmp_types = []\n old_icmp_types = []\n\n try:\n _current_icmp_blocks = __salt__['firewalld.list_icmp_block'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if block_icmp:\n try:\n _valid_icmp_types = __salt__['firewalld.get_icmp_types'](\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n # log errors for invalid ICMP types in block_icmp input\n for icmp_type in set(block_icmp) - set(_valid_icmp_types):\n log.error('%s is an invalid ICMP type', icmp_type)\n block_icmp.remove(icmp_type)\n\n new_icmp_types = set(block_icmp) - set(_current_icmp_blocks)\n for icmp_type in new_icmp_types:\n if not __opts__['test']:\n try:\n __salt__['firewalld.block_icmp'](name, icmp_type,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_block_icmp:\n old_icmp_types = set(_current_icmp_blocks) - set(block_icmp)\n for icmp_type in old_icmp_types:\n # no need to check against _valid_icmp_types here, because all\n # elements in old_icmp_types are guaranteed to be in\n # _current_icmp_blocks, whose elements are inherently valid\n if not __opts__['test']:\n try:\n __salt__['firewalld.allow_icmp'](name, icmp_type,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_icmp_types or old_icmp_types:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_block_icmp:\n block_icmp = list(new_icmp_types | set(_current_icmp_blocks))\n ret['changes'].update({'icmp_types':\n {'old': _current_icmp_blocks,\n 'new': block_icmp}})\n\n # that's the only parameter that can't be permanent or runtime, it's\n # directly both\n if default:\n try:\n default_zone = __salt__['firewalld.default_zone']()\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n if name != default_zone:\n if not __opts__['test']:\n try:\n __salt__['firewalld.set_default_zone'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n ret['changes'].update({'default':\n {'old': default_zone,\n 'new': name}})\n\n try:\n masquerade_ret = __salt__['firewalld.get_masquerade'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if masquerade and not masquerade_ret:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_masquerade'](name, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n ret['changes'].update({'masquerade':\n {'old': '',\n 'new': 'Masquerading successfully set.'}})\n elif not masquerade and masquerade_ret:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_masquerade'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n ret['changes'].update({'masquerade':\n {'old': '',\n 'new': 'Masquerading successfully '\n 'disabled.'}})\n\n if ports or prune_ports:\n ports = ports or []\n try:\n _current_ports = __salt__['firewalld.list_ports'](name, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_ports = set(ports) - set(_current_ports)\n old_ports = []\n\n for port in new_ports:\n if not __opts__['test']:\n try:\n # TODO: force_masquerade to be removed in future release\n __salt__['firewalld.add_port'](name, port, permanent=True, force_masquerade=False)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_ports:\n old_ports = set(_current_ports) - set(ports)\n for port in old_ports:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_port'](name, port, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_ports or old_ports:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_ports:\n ports = list(new_ports | set(_current_ports))\n ret['changes'].update({'ports':\n {'old': _current_ports,\n 'new': ports}})\n\n if port_fwd or prune_port_fwd:\n port_fwd = port_fwd or []\n try:\n _current_port_fwd = __salt__['firewalld.list_port_fwd'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n port_fwd = [_parse_forward(fwd) for fwd in port_fwd]\n _current_port_fwd = [\n ForwardingMapping(\n srcport=fwd['Source port'],\n destport=fwd['Destination port'],\n protocol=fwd['Protocol'],\n destaddr=fwd['Destination address']\n ) for fwd in _current_port_fwd]\n\n new_port_fwd = set(port_fwd) - set(_current_port_fwd)\n old_port_fwd = []\n\n for fwd in new_port_fwd:\n if not __opts__['test']:\n try:\n # TODO: force_masquerade to be removed in future release\n __salt__['firewalld.add_port_fwd'](name, fwd.srcport,\n fwd.destport, fwd.protocol, fwd.destaddr, permanent=True,\n force_masquerade=False)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_port_fwd:\n old_port_fwd = set(_current_port_fwd) - set(port_fwd)\n for fwd in old_port_fwd:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_port_fwd'](name, fwd.srcport,\n fwd.destport, fwd.protocol, fwd.destaddr, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_port_fwd or old_port_fwd:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_port_fwd:\n port_fwd = list(new_port_fwd | set(_current_port_fwd))\n ret['changes'].update({'port_fwd':\n {'old': [fwd.todict() for fwd in\n _current_port_fwd],\n 'new': [fwd.todict() for fwd in port_fwd]}})\n\n if services or prune_services:\n services = services or []\n try:\n _current_services = __salt__['firewalld.list_services'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_services = set(services) - set(_current_services)\n old_services = []\n\n for new_service in new_services:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_service'](new_service, name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_services:\n old_services = set(_current_services) - set(services)\n for old_service in old_services:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_service'](old_service, name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_services or old_services:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_services:\n services = list(new_services | set(_current_services))\n ret['changes'].update({'services':\n {'old': _current_services,\n 'new': services}})\n\n if interfaces or prune_interfaces:\n interfaces = interfaces or []\n try:\n _current_interfaces = __salt__['firewalld.get_interfaces'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_interfaces = set(interfaces) - set(_current_interfaces)\n old_interfaces = []\n\n for interface in new_interfaces:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_interface'](name, interface,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_interfaces:\n old_interfaces = set(_current_interfaces) - set(interfaces)\n for interface in old_interfaces:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_interface'](name, interface,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_interfaces or old_interfaces:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_interfaces:\n interfaces = list(new_interfaces | set(_current_interfaces))\n ret['changes'].update({'interfaces':\n {'old': _current_interfaces,\n 'new': interfaces}})\n\n if sources or prune_sources:\n sources = sources or []\n try:\n _current_sources = __salt__['firewalld.get_sources'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_sources = set(sources) - set(_current_sources)\n old_sources = []\n\n for source in new_sources:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_source'](name, source, permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_sources:\n old_sources = set(_current_sources) - set(sources)\n for source in old_sources:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_source'](name, source,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_sources or old_sources:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_sources:\n sources = list(new_sources | set(_current_sources))\n ret['changes'].update({'sources':\n {'old': _current_sources,\n 'new': sources}})\n\n if rich_rules or prune_rich_rules:\n rich_rules = rich_rules or []\n try:\n _current_rich_rules = __salt__['firewalld.get_rich_rules'](name,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_rich_rules = set(rich_rules) - set(_current_rich_rules)\n old_rich_rules = []\n\n for rich_rule in new_rich_rules:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_rich_rule'](name, rich_rule,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if prune_rich_rules:\n old_rich_rules = set(_current_rich_rules) - set(rich_rules)\n for rich_rule in old_rich_rules:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_rich_rule'](name, rich_rule,\n permanent=True)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_rich_rules or old_rich_rules:\n # If we're not pruning, include current items in new output so it's clear\n # that they're still present\n if not prune_rich_rules:\n rich_rules = list(new_rich_rules | set(_current_rich_rules))\n ret['changes'].update({'rich_rules':\n {'old': _current_rich_rules,\n 'new': rich_rules}})\n\n # No changes\n if ret['changes'] == {}:\n ret['result'] = True\n ret['comment'] = '\\'{0}\\' is already in the desired state.'.format(name)\n return ret\n\n # test=True and changes predicted\n if __opts__['test']:\n ret['result'] = None\n # build comment string\n nested.__opts__ = __opts__\n comment = []\n comment.append('Configuration for \\'{0}\\' will change:'.format(name))\n comment.append(nested.output(ret['changes']).rstrip())\n ret['comment'] = '\\n'.join(comment)\n ret['changes'] = {}\n return ret\n\n # Changes were made successfully\n ret['result'] = True\n ret['comment'] = '\\'{0}\\' was configured.'.format(name)\n return ret"},"func_documentation_string":{"kind":"string","value":"Ensure a zone has specific attributes."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/firewalld.py#L338-L766"},"called_functions":{"kind":"list like","value":["def output(ret, **kwargs):\n '''\n Display ret data\n '''\n # Prefer kwargs before opts\n retcode = kwargs.get('_retcode', 0)\n base_indent = kwargs.get('nested_indent', 0) \\\n or __opts__.get('nested_indent', 0)\n nest = NestDisplay(retcode=retcode)\n lines = nest.display(ret, base_indent, '', [])\n try:\n return '\\n'.join(lines)\n except UnicodeDecodeError:\n # output contains binary data that can't be decoded\n return str('\\n').join( # future lint: disable=blacklisted-function\n [salt.utils.stringutils.to_str(x) for x in lines]\n )\n"],"string":"[\n \"def output(ret, **kwargs):\\n '''\\n Display ret data\\n '''\\n # Prefer kwargs before opts\\n retcode = kwargs.get('_retcode', 0)\\n base_indent = kwargs.get('nested_indent', 0) \\\\\\n or __opts__.get('nested_indent', 0)\\n nest = NestDisplay(retcode=retcode)\\n lines = nest.display(ret, base_indent, '', [])\\n try:\\n return '\\\\n'.join(lines)\\n except UnicodeDecodeError:\\n # output contains binary data that can't be decoded\\n return str('\\\\n').join( # future lint: disable=blacklisted-function\\n [salt.utils.stringutils.to_str(x) for x in lines]\\n )\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nManagement of firewalld\n\n.. versionadded:: 2015.8.0\n\nThe following example applies changes to the public zone, blocks echo-reply\nand echo-request packets, does not set the zone to be the default, enables\nmasquerading, and allows ports 22/tcp and 25/tcp.\nIt will be applied permanently and directly before restart/reload.\n\n.. code-block:: yaml\n\n public:\n firewalld.present:\n - name: public\n - block_icmp:\n - echo-reply\n - echo-request\n - default: False\n - masquerade: True\n - ports:\n - 22/tcp\n - 25/tcp\n\nThe following example applies changes to the public zone, enables\nmasquerading and configures port forwarding TCP traffic from port 22\nto 2222, and forwards TCP traffic from port 80 to 443 at 192.168.0.1.\n\n.. code-block:: yaml\n\n my_zone:\n firewalld.present:\n - name: public\n - masquerade: True\n - port_fwd:\n - 22:2222:tcp\n - 80:443:tcp:192.168.0.1\n\nThe following example binds the public zone to interface eth0 and to all\npackets coming from the 192.168.1.0/24 subnet. It also removes the zone\nfrom all other interfaces or sources.\n\n.. code-block:: yaml\n\n public:\n firewalld.present:\n - name: public\n - interfaces:\n - eth0\n - sources:\n - 192.168.1.0/24\n\nHere, we define a new service that encompasses TCP ports 4505 4506:\n\n.. code-block:: yaml\n\n saltmaster:\n firewalld.service:\n - name: saltmaster\n - ports:\n - 4505/tcp\n - 4506/tcp\n\nTo make this new service available in a zone, the following can be used, which\nwould allow access to the salt master from the 10.0.0.0/8 subnet:\n\n.. code-block:: yaml\n\n saltzone:\n firewalld.present:\n - name: saltzone\n - services:\n - saltmaster\n - sources:\n - 10.0.0.0/8\n'''\n\n# Import Python Libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import Salt Libs\nfrom salt.exceptions import CommandExecutionError\nfrom salt.output import nested\nimport salt.utils.path\n\nlog = logging.getLogger(__name__)\n\n\nclass ForwardingMapping(object):\n '''\n Represents a port forwarding statement mapping a local port to a remote\n port for a specific protocol (TCP or UDP)\n '''\n def __init__(self, srcport, destport, protocol, destaddr):\n self.srcport = srcport\n self.destport = destport\n self.protocol = protocol\n self.destaddr = destaddr\n\n def __eq__(self, other):\n return (self.srcport == other.srcport and\n self.destport == other.destport and\n self.protocol == other.protocol and\n self.destaddr == other.destaddr)\n\n def __ne__(self, other):\n return not self.__eq__(other)\n\n # hash is needed for set operations\n def __hash__(self):\n return (hash(self.srcport) ^\n hash(self.destport) ^\n hash(self.protocol) ^\n hash(self.destaddr))\n\n def todict(self):\n '''\n Returns a pretty dictionary meant for command line output.\n '''\n return {\n 'Source port': self.srcport,\n 'Destination port': self.destport,\n 'Protocol': self.protocol,\n 'Destination address': self.destaddr}\n\n\ndef _parse_forward(mapping):\n '''\n Parses a port forwarding statement in the form used by this state:\n\n from_port:to_port:protocol[:destination]\n\n and returns a ForwardingMapping object\n '''\n if len(mapping.split(':')) > 3:\n (srcport, destport, protocol, destaddr) = mapping.split(':')\n else:\n (srcport, destport, protocol) = mapping.split(':')\n destaddr = ''\n return ForwardingMapping(srcport, destport, protocol, destaddr)\n\n\ndef __virtual__():\n '''\n Ensure the firewall-cmd is available\n '''\n if salt.utils.path.which('firewall-cmd'):\n return True\n\n return (False, 'firewall-cmd is not available, firewalld is probably not installed.')\n\n\ndef present(name,\n block_icmp=None,\n prune_block_icmp=False,\n default=None,\n masquerade=False,\n ports=None,\n prune_ports=False,\n port_fwd=None,\n prune_port_fwd=False,\n services=None,\n prune_services=False,\n interfaces=None,\n prune_interfaces=False,\n sources=None,\n prune_sources=False,\n rich_rules=None,\n prune_rich_rules=False):\n\n '''\n Ensure a zone has specific attributes.\n\n name\n The zone to modify.\n\n default : None\n Set this zone as the default zone if ``True``.\n\n masquerade : False\n Enable or disable masquerade for a zone.\n\n block_icmp : None\n List of ICMP types to block in the zone.\n\n prune_block_icmp : False\n If ``True``, remove all but the specified block_icmp from the zone.\n\n ports : None\n List of ports to add to the zone.\n\n prune_ports : False\n If ``True``, remove all but the specified ports from the zone.\n\n port_fwd : None\n List of port forwards to add to the zone.\n\n prune_port_fwd : False\n If ``True``, remove all but the specified port_fwd from the zone.\n\n services : None\n List of services to add to the zone.\n\n prune_services : False\n If ``True``, remove all but the specified services from the zone.\n .. note:: Currently defaults to True for compatibility, but will be changed to False in a future release.\n\n interfaces : None\n List of interfaces to add to the zone.\n\n prune_interfaces : False\n If ``True``, remove all but the specified interfaces from the zone.\n\n sources : None\n List of sources to add to the zone.\n\n prune_sources : False\n If ``True``, remove all but the specified sources from the zone.\n\n rich_rules : None\n List of rich rules to add to the zone.\n\n prune_rich_rules : False\n If ``True``, remove all but the specified rich rules from the zone.\n '''\n ret = _present(name, block_icmp, prune_block_icmp, default, masquerade, ports, prune_ports,\n port_fwd, prune_port_fwd, services, prune_services, interfaces, prune_interfaces,\n sources, prune_sources, rich_rules, prune_rich_rules)\n\n # Reload firewalld service on changes\n if ret['changes'] != {}:\n __salt__['firewalld.reload_rules']()\n\n return ret\n\n\ndef service(name,\n ports=None,\n protocols=None):\n '''\n Ensure the service exists and encompasses the specified ports and\n protocols.\n\n .. versionadded:: 2016.11.0\n '''\n ret = {'name': name,\n 'result': False,\n 'changes': {},\n 'comment': ''}\n\n if name not in __salt__['firewalld.get_services']():\n __salt__['firewalld.new_service'](name, restart=False)\n\n ports = ports or []\n\n try:\n _current_ports = __salt__['firewalld.get_service_ports'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_ports = set(ports) - set(_current_ports)\n old_ports = set(_current_ports) - set(ports)\n\n for port in new_ports:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_service_port'](name, port)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n for port in old_ports:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_service_port'](name, port)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_ports or old_ports:\n ret['changes'].update({'ports':\n {'old': _current_ports,\n 'new': ports}})\n\n protocols = protocols or []\n\n try:\n _current_protocols = __salt__['firewalld.get_service_protocols'](name)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n new_protocols = set(protocols) - set(_current_protocols)\n old_protocols = set(_current_protocols) - set(protocols)\n\n for protocol in new_protocols:\n if not __opts__['test']:\n try:\n __salt__['firewalld.add_service_protocol'](name, protocol)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n for protocol in old_protocols:\n if not __opts__['test']:\n try:\n __salt__['firewalld.remove_service_protocol'](name, protocol)\n except CommandExecutionError as err:\n ret['comment'] = 'Error: {0}'.format(err)\n return ret\n\n if new_protocols or old_protocols:\n ret['changes'].update({'protocols':\n {'old': _current_protocols,\n 'new': protocols}})\n\n if ret['changes'] != {}:\n __salt__['firewalld.reload_rules']()\n\n ret['result'] = True\n if ret['changes'] == {}:\n ret['comment'] = '\\'{0}\\' is already in the desired state.'.format(\n name)\n return ret\n\n if __opts__['test']:\n ret['result'] = None\n ret['comment'] = 'Configuration for \\'{0}\\' will change.'.format(name)\n return ret\n\n ret['comment'] = '\\'{0}\\' was configured.'.format(name)\n return ret\n\n"}}},{"rowIdx":392,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/states/firewalld.py"},"func_name":{"kind":"string","value":"ForwardingMapping.todict"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def todict(self):\n '''\n Returns a pretty dictionary meant for command line output.\n '''\n return {\n 'Source port': self.srcport,\n 'Destination port': self.destport,\n 'Protocol': self.protocol,\n 'Destination address': self.destaddr}"},"func_documentation_string":{"kind":"string","value":"Returns a pretty dictionary meant for command line output."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/firewalld.py#L118-L126"},"called_functions":{"kind":"null"},"enclosing_scope":{"kind":"string","value":"class ForwardingMapping(object):\n '''\n Represents a port forwarding statement mapping a local port to a remote\n port for a specific protocol (TCP or UDP)\n '''\n def __init__(self, srcport, destport, protocol, destaddr):\n self.srcport = srcport\n self.destport = destport\n self.protocol = protocol\n self.destaddr = destaddr\n\n def __eq__(self, other):\n return (self.srcport == other.srcport and\n self.destport == other.destport and\n self.protocol == other.protocol and\n self.destaddr == other.destaddr)\n\n def __ne__(self, other):\n return not self.__eq__(other)\n\n # hash is needed for set operations\n def __hash__(self):\n return (hash(self.srcport) ^\n hash(self.destport) ^\n hash(self.protocol) ^\n hash(self.destaddr))\n\n"}}},{"rowIdx":393,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/jenkinsmod.py"},"func_name":{"kind":"string","value":"_connect"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\n __salt__['config.get']('jenkins:user') or \\\n __salt__['pillar.get']('jenkins.user')\n\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\n __salt__['config.get']('jenkins:password') or \\\n __salt__['pillar.get']('jenkins.password')\n\n if not jenkins_url:\n raise SaltInvocationError('No Jenkins URL found.')\n\n return jenkins.Jenkins(jenkins_url,\n username=jenkins_user,\n password=jenkins_password)"},"func_documentation_string":{"kind":"string","value":"Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/jenkinsmod.py#L69-L92"},"called_functions":{"kind":"null"},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nModule for controlling Jenkins\n\n:depends: python-jenkins\n\n.. versionadded:: 2016.3.0\n\n:depends: python-jenkins_ Python module (not to be confused with jenkins_)\n\n.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins\n.. _jenkins: https://pypi.python.org/pypi/jenkins\n\n:configuration: This module can be used by either passing an api key and version\n directly or by specifying both in a configuration profile in the salt\n master/minion config.\n\n For example:\n\n .. code-block:: yaml\n\n jenkins:\n api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15\n'''\n\n# Import Python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import Salt libs\nimport salt.utils.stringutils\n\ntry:\n import jenkins\n HAS_JENKINS = True\nexcept ImportError:\n HAS_JENKINS = False\n\nimport salt.utils.files\n\n# Import 3rd-party libs\n# pylint: disable=import-error,no-name-in-module,redefined-builtin\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\n# pylint: enable=import-error,no-name-in-module\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'jenkins'\n\n\ndef __virtual__():\n '''\n Return virtual name of the module.\n\n :return: The virtual name of the module.\n '''\n if HAS_JENKINS:\n if hasattr(jenkins, 'Jenkins'):\n return __virtualname__\n else:\n return (False,\n 'The wrong Python module appears to be installed. Please '\n 'make sure that \\'python-jenkins\\' is installed, not '\n '\\'jenkins\\'.')\n return (False, 'The jenkins execution module cannot be loaded: '\n 'python-jenkins is not installed.')\n\n\n\ndef _retrieve_config_xml(config_xml, saltenv):\n '''\n Helper to cache the config XML and raise a CommandExecutionError if we fail\n to do so. If we successfully cache the file, return the cached path.\n '''\n ret = __salt__['cp.cache_file'](config_xml, saltenv)\n\n if not ret:\n raise CommandExecutionError('Failed to retrieve {0}'.format(config_xml))\n\n return ret\n\n\ndef run(script):\n '''\n .. versionadded:: 2017.7.0\n\n Execute a script on the jenkins master\n\n :param script: The script\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.run 'Jenkins.instance.doSafeRestart()'\n\n '''\n\n server = _connect()\n return server.run_script(script)\n\n\ndef get_version():\n '''\n Return version of Jenkins\n\n :return: The version of Jenkins\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_version\n '''\n\n server = _connect()\n\n version = server.get_version()\n if version:\n return version\n return False\n\n\ndef get_jobs():\n '''\n Return the currently configured jobs.\n\n :return: The currently configured jobs.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_jobs\n '''\n\n server = _connect()\n\n jobs = server.get_jobs()\n if jobs:\n return jobs\n return {}\n\n\ndef job_exists(name=None):\n '''\n Check whether the job exists in configured Jenkins jobs.\n\n :param name: The name of the job is check if it exists.\n :return: True if job exists, False if job does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_exists jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n if server.job_exists(name):\n return True\n else:\n return False\n\n\ndef get_job_info(name=None):\n '''\n Return information about the Jenkins job.\n\n :param name: The name of the job is check if it exists.\n :return: Information about the Jenkins job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_job_info jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n job_info = server.get_job_info(name)\n if job_info:\n return job_info\n return False\n\n\ndef build_job(name=None, parameters=None):\n '''\n Initiate a build for the provided job.\n\n :param name: The name of the job is check if it exists.\n :param parameters: Parameters to send to the job.\n :return: True is successful, otherwise raise an exception.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.build_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist.'.format(name))\n\n try:\n server.build_job(name, parameters)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error building job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef create_job(name=None,\n config_xml=None,\n saltenv='base'):\n '''\n Return the configuration file.\n\n :param name: The name of the job is check if it exists.\n :param config_xml: The configuration file to use to create the job.\n :param saltenv: The environment to look for the file in.\n :return: The configuration file used for the job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.create_job jobname\n\n salt '*' jenkins.create_job jobname config_xml='salt://jenkins/config.xml'\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n if job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' already exists'.format(name))\n\n if not config_xml:\n config_xml = jenkins.EMPTY_CONFIG_XML\n else:\n config_xml_file = _retrieve_config_xml(config_xml, saltenv)\n\n with salt.utils.files.fopen(config_xml_file) as _fp:\n config_xml = salt.utils.stringutils.to_unicode(_fp.read())\n\n server = _connect()\n try:\n server.create_job(name, config_xml)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error creating job \\'{0}\\': {1}'.format(name, err)\n )\n return config_xml\n\n\ndef update_job(name=None,\n config_xml=None,\n saltenv='base'):\n '''\n Return the updated configuration file.\n\n :param name: The name of the job is check if it exists.\n :param config_xml: The configuration file to use to create the job.\n :param saltenv: The environment to look for the file in.\n :return: The configuration file used for the job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.update_job jobname\n\n salt '*' jenkins.update_job jobname config_xml='salt://jenkins/config.xml'\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n if not config_xml:\n config_xml = jenkins.EMPTY_CONFIG_XML\n else:\n config_xml_file = _retrieve_config_xml(config_xml, saltenv)\n\n with salt.utils.files.fopen(config_xml_file) as _fp:\n config_xml = salt.utils.stringutils.to_unicode(_fp.read())\n\n server = _connect()\n try:\n server.reconfig_job(name, config_xml)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error updating job \\'{0}\\': {1}'.format(name, err)\n )\n return config_xml\n\n\ndef delete_job(name=None):\n '''\n Return true is job is deleted successfully.\n\n :param name: The name of the job to delete.\n :return: Return true if job is deleted successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.delete_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.delete_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error deleting job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef enable_job(name=None):\n '''\n Return true is job is enabled successfully.\n\n :param name: The name of the job to enable.\n :return: Return true if job is enabled successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.enable_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.enable_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error enabling job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef disable_job(name=None):\n '''\n Return true is job is disabled successfully.\n\n :param name: The name of the job to disable.\n :return: Return true if job is disabled successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.disable_job jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.disable_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error disabling job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef job_status(name=None):\n '''\n Return the current status, enabled or disabled, of the job.\n\n :param name: The name of the job to return status for\n :return: Return true if enabled or false if disabled.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_status jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n return server.get_job_info('empty')['buildable']\n\n\ndef get_job_config(name=None):\n '''\n Return the current job configuration for the provided job.\n\n :param name: The name of the job to return the configuration for.\n :return: The configuration for the job specified.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_job_config jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n job_info = server.get_job_config(name)\n return job_info\n\n\ndef plugin_installed(name):\n '''\n .. versionadded:: 2016.11.0\n\n Return if the plugin is installed for the provided plugin name.\n\n :param name: The name of the parameter to confirm installation.\n :return: True if plugin exists, False if plugin does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.plugin_installed pluginName\n\n '''\n\n server = _connect()\n plugins = server.get_plugins()\n\n exists = [plugin for plugin in plugins.keys() if name in plugin]\n\n if exists:\n return True\n else:\n return False\n"}}},{"rowIdx":394,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/jenkinsmod.py"},"func_name":{"kind":"string","value":"_retrieve_config_xml"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def _retrieve_config_xml(config_xml, saltenv):\n '''\n Helper to cache the config XML and raise a CommandExecutionError if we fail\n to do so. If we successfully cache the file, return the cached path.\n '''\n ret = __salt__['cp.cache_file'](config_xml, saltenv)\n\n if not ret:\n raise CommandExecutionError('Failed to retrieve {0}'.format(config_xml))\n\n return ret"},"func_documentation_string":{"kind":"string","value":"Helper to cache the config XML and raise a CommandExecutionError if we fail\n to do so. If we successfully cache the file, return the cached path."},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/jenkinsmod.py#L95-L105"},"called_functions":{"kind":"null"},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nModule for controlling Jenkins\n\n:depends: python-jenkins\n\n.. versionadded:: 2016.3.0\n\n:depends: python-jenkins_ Python module (not to be confused with jenkins_)\n\n.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins\n.. _jenkins: https://pypi.python.org/pypi/jenkins\n\n:configuration: This module can be used by either passing an api key and version\n directly or by specifying both in a configuration profile in the salt\n master/minion config.\n\n For example:\n\n .. code-block:: yaml\n\n jenkins:\n api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15\n'''\n\n# Import Python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import Salt libs\nimport salt.utils.stringutils\n\ntry:\n import jenkins\n HAS_JENKINS = True\nexcept ImportError:\n HAS_JENKINS = False\n\nimport salt.utils.files\n\n# Import 3rd-party libs\n# pylint: disable=import-error,no-name-in-module,redefined-builtin\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\n# pylint: enable=import-error,no-name-in-module\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'jenkins'\n\n\ndef __virtual__():\n '''\n Return virtual name of the module.\n\n :return: The virtual name of the module.\n '''\n if HAS_JENKINS:\n if hasattr(jenkins, 'Jenkins'):\n return __virtualname__\n else:\n return (False,\n 'The wrong Python module appears to be installed. Please '\n 'make sure that \\'python-jenkins\\' is installed, not '\n '\\'jenkins\\'.')\n return (False, 'The jenkins execution module cannot be loaded: '\n 'python-jenkins is not installed.')\n\n\ndef _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\n __salt__['config.get']('jenkins:user') or \\\n __salt__['pillar.get']('jenkins.user')\n\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\n __salt__['config.get']('jenkins:password') or \\\n __salt__['pillar.get']('jenkins.password')\n\n if not jenkins_url:\n raise SaltInvocationError('No Jenkins URL found.')\n\n return jenkins.Jenkins(jenkins_url,\n username=jenkins_user,\n password=jenkins_password)\n\n\n\ndef run(script):\n '''\n .. versionadded:: 2017.7.0\n\n Execute a script on the jenkins master\n\n :param script: The script\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.run 'Jenkins.instance.doSafeRestart()'\n\n '''\n\n server = _connect()\n return server.run_script(script)\n\n\ndef get_version():\n '''\n Return version of Jenkins\n\n :return: The version of Jenkins\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_version\n '''\n\n server = _connect()\n\n version = server.get_version()\n if version:\n return version\n return False\n\n\ndef get_jobs():\n '''\n Return the currently configured jobs.\n\n :return: The currently configured jobs.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_jobs\n '''\n\n server = _connect()\n\n jobs = server.get_jobs()\n if jobs:\n return jobs\n return {}\n\n\ndef job_exists(name=None):\n '''\n Check whether the job exists in configured Jenkins jobs.\n\n :param name: The name of the job is check if it exists.\n :return: True if job exists, False if job does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_exists jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n if server.job_exists(name):\n return True\n else:\n return False\n\n\ndef get_job_info(name=None):\n '''\n Return information about the Jenkins job.\n\n :param name: The name of the job is check if it exists.\n :return: Information about the Jenkins job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_job_info jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n job_info = server.get_job_info(name)\n if job_info:\n return job_info\n return False\n\n\ndef build_job(name=None, parameters=None):\n '''\n Initiate a build for the provided job.\n\n :param name: The name of the job is check if it exists.\n :param parameters: Parameters to send to the job.\n :return: True is successful, otherwise raise an exception.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.build_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist.'.format(name))\n\n try:\n server.build_job(name, parameters)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error building job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef create_job(name=None,\n config_xml=None,\n saltenv='base'):\n '''\n Return the configuration file.\n\n :param name: The name of the job is check if it exists.\n :param config_xml: The configuration file to use to create the job.\n :param saltenv: The environment to look for the file in.\n :return: The configuration file used for the job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.create_job jobname\n\n salt '*' jenkins.create_job jobname config_xml='salt://jenkins/config.xml'\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n if job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' already exists'.format(name))\n\n if not config_xml:\n config_xml = jenkins.EMPTY_CONFIG_XML\n else:\n config_xml_file = _retrieve_config_xml(config_xml, saltenv)\n\n with salt.utils.files.fopen(config_xml_file) as _fp:\n config_xml = salt.utils.stringutils.to_unicode(_fp.read())\n\n server = _connect()\n try:\n server.create_job(name, config_xml)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error creating job \\'{0}\\': {1}'.format(name, err)\n )\n return config_xml\n\n\ndef update_job(name=None,\n config_xml=None,\n saltenv='base'):\n '''\n Return the updated configuration file.\n\n :param name: The name of the job is check if it exists.\n :param config_xml: The configuration file to use to create the job.\n :param saltenv: The environment to look for the file in.\n :return: The configuration file used for the job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.update_job jobname\n\n salt '*' jenkins.update_job jobname config_xml='salt://jenkins/config.xml'\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n if not config_xml:\n config_xml = jenkins.EMPTY_CONFIG_XML\n else:\n config_xml_file = _retrieve_config_xml(config_xml, saltenv)\n\n with salt.utils.files.fopen(config_xml_file) as _fp:\n config_xml = salt.utils.stringutils.to_unicode(_fp.read())\n\n server = _connect()\n try:\n server.reconfig_job(name, config_xml)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error updating job \\'{0}\\': {1}'.format(name, err)\n )\n return config_xml\n\n\ndef delete_job(name=None):\n '''\n Return true is job is deleted successfully.\n\n :param name: The name of the job to delete.\n :return: Return true if job is deleted successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.delete_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.delete_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error deleting job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef enable_job(name=None):\n '''\n Return true is job is enabled successfully.\n\n :param name: The name of the job to enable.\n :return: Return true if job is enabled successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.enable_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.enable_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error enabling job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef disable_job(name=None):\n '''\n Return true is job is disabled successfully.\n\n :param name: The name of the job to disable.\n :return: Return true if job is disabled successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.disable_job jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.disable_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error disabling job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef job_status(name=None):\n '''\n Return the current status, enabled or disabled, of the job.\n\n :param name: The name of the job to return status for\n :return: Return true if enabled or false if disabled.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_status jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n return server.get_job_info('empty')['buildable']\n\n\ndef get_job_config(name=None):\n '''\n Return the current job configuration for the provided job.\n\n :param name: The name of the job to return the configuration for.\n :return: The configuration for the job specified.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_job_config jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n job_info = server.get_job_config(name)\n return job_info\n\n\ndef plugin_installed(name):\n '''\n .. versionadded:: 2016.11.0\n\n Return if the plugin is installed for the provided plugin name.\n\n :param name: The name of the parameter to confirm installation.\n :return: True if plugin exists, False if plugin does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.plugin_installed pluginName\n\n '''\n\n server = _connect()\n plugins = server.get_plugins()\n\n exists = [plugin for plugin in plugins.keys() if name in plugin]\n\n if exists:\n return True\n else:\n return False\n"}}},{"rowIdx":395,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/jenkinsmod.py"},"func_name":{"kind":"string","value":"job_exists"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def job_exists(name=None):\n '''\n Check whether the job exists in configured Jenkins jobs.\n\n :param name: The name of the job is check if it exists.\n :return: True if job exists, False if job does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_exists jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n if server.job_exists(name):\n return True\n else:\n return False"},"func_documentation_string":{"kind":"string","value":"Check whether the job exists in configured Jenkins jobs.\n\n :param name: The name of the job is check if it exists.\n :return: True if job exists, False if job does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_exists jobname"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/jenkinsmod.py#L170-L191"},"called_functions":{"kind":"list like","value":["def _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\n __salt__['config.get']('jenkins:user') or \\\n __salt__['pillar.get']('jenkins.user')\n\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\n __salt__['config.get']('jenkins:password') or \\\n __salt__['pillar.get']('jenkins.password')\n\n if not jenkins_url:\n raise SaltInvocationError('No Jenkins URL found.')\n\n return jenkins.Jenkins(jenkins_url,\n username=jenkins_user,\n password=jenkins_password)\n"],"string":"[\n \"def _connect():\\n '''\\n Return server object used to interact with Jenkins.\\n\\n :return: server object used to interact with Jenkins\\n '''\\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\\\\n __salt__['config.get']('jenkins:url') or \\\\\\n __salt__['pillar.get']('jenkins.url')\\n\\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\\\\n __salt__['config.get']('jenkins:user') or \\\\\\n __salt__['pillar.get']('jenkins.user')\\n\\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\\\\n __salt__['config.get']('jenkins:password') or \\\\\\n __salt__['pillar.get']('jenkins.password')\\n\\n if not jenkins_url:\\n raise SaltInvocationError('No Jenkins URL found.')\\n\\n return jenkins.Jenkins(jenkins_url,\\n username=jenkins_user,\\n password=jenkins_password)\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nModule for controlling Jenkins\n\n:depends: python-jenkins\n\n.. versionadded:: 2016.3.0\n\n:depends: python-jenkins_ Python module (not to be confused with jenkins_)\n\n.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins\n.. _jenkins: https://pypi.python.org/pypi/jenkins\n\n:configuration: This module can be used by either passing an api key and version\n directly or by specifying both in a configuration profile in the salt\n master/minion config.\n\n For example:\n\n .. code-block:: yaml\n\n jenkins:\n api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15\n'''\n\n# Import Python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import Salt libs\nimport salt.utils.stringutils\n\ntry:\n import jenkins\n HAS_JENKINS = True\nexcept ImportError:\n HAS_JENKINS = False\n\nimport salt.utils.files\n\n# Import 3rd-party libs\n# pylint: disable=import-error,no-name-in-module,redefined-builtin\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\n# pylint: enable=import-error,no-name-in-module\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'jenkins'\n\n\ndef __virtual__():\n '''\n Return virtual name of the module.\n\n :return: The virtual name of the module.\n '''\n if HAS_JENKINS:\n if hasattr(jenkins, 'Jenkins'):\n return __virtualname__\n else:\n return (False,\n 'The wrong Python module appears to be installed. Please '\n 'make sure that \\'python-jenkins\\' is installed, not '\n '\\'jenkins\\'.')\n return (False, 'The jenkins execution module cannot be loaded: '\n 'python-jenkins is not installed.')\n\n\ndef _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\n __salt__['config.get']('jenkins:user') or \\\n __salt__['pillar.get']('jenkins.user')\n\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\n __salt__['config.get']('jenkins:password') or \\\n __salt__['pillar.get']('jenkins.password')\n\n if not jenkins_url:\n raise SaltInvocationError('No Jenkins URL found.')\n\n return jenkins.Jenkins(jenkins_url,\n username=jenkins_user,\n password=jenkins_password)\n\n\ndef _retrieve_config_xml(config_xml, saltenv):\n '''\n Helper to cache the config XML and raise a CommandExecutionError if we fail\n to do so. If we successfully cache the file, return the cached path.\n '''\n ret = __salt__['cp.cache_file'](config_xml, saltenv)\n\n if not ret:\n raise CommandExecutionError('Failed to retrieve {0}'.format(config_xml))\n\n return ret\n\n\ndef run(script):\n '''\n .. versionadded:: 2017.7.0\n\n Execute a script on the jenkins master\n\n :param script: The script\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.run 'Jenkins.instance.doSafeRestart()'\n\n '''\n\n server = _connect()\n return server.run_script(script)\n\n\ndef get_version():\n '''\n Return version of Jenkins\n\n :return: The version of Jenkins\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_version\n '''\n\n server = _connect()\n\n version = server.get_version()\n if version:\n return version\n return False\n\n\ndef get_jobs():\n '''\n Return the currently configured jobs.\n\n :return: The currently configured jobs.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_jobs\n '''\n\n server = _connect()\n\n jobs = server.get_jobs()\n if jobs:\n return jobs\n return {}\n\n\n\ndef get_job_info(name=None):\n '''\n Return information about the Jenkins job.\n\n :param name: The name of the job is check if it exists.\n :return: Information about the Jenkins job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_job_info jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n job_info = server.get_job_info(name)\n if job_info:\n return job_info\n return False\n\n\ndef build_job(name=None, parameters=None):\n '''\n Initiate a build for the provided job.\n\n :param name: The name of the job is check if it exists.\n :param parameters: Parameters to send to the job.\n :return: True is successful, otherwise raise an exception.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.build_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist.'.format(name))\n\n try:\n server.build_job(name, parameters)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error building job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef create_job(name=None,\n config_xml=None,\n saltenv='base'):\n '''\n Return the configuration file.\n\n :param name: The name of the job is check if it exists.\n :param config_xml: The configuration file to use to create the job.\n :param saltenv: The environment to look for the file in.\n :return: The configuration file used for the job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.create_job jobname\n\n salt '*' jenkins.create_job jobname config_xml='salt://jenkins/config.xml'\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n if job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' already exists'.format(name))\n\n if not config_xml:\n config_xml = jenkins.EMPTY_CONFIG_XML\n else:\n config_xml_file = _retrieve_config_xml(config_xml, saltenv)\n\n with salt.utils.files.fopen(config_xml_file) as _fp:\n config_xml = salt.utils.stringutils.to_unicode(_fp.read())\n\n server = _connect()\n try:\n server.create_job(name, config_xml)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error creating job \\'{0}\\': {1}'.format(name, err)\n )\n return config_xml\n\n\ndef update_job(name=None,\n config_xml=None,\n saltenv='base'):\n '''\n Return the updated configuration file.\n\n :param name: The name of the job is check if it exists.\n :param config_xml: The configuration file to use to create the job.\n :param saltenv: The environment to look for the file in.\n :return: The configuration file used for the job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.update_job jobname\n\n salt '*' jenkins.update_job jobname config_xml='salt://jenkins/config.xml'\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n if not config_xml:\n config_xml = jenkins.EMPTY_CONFIG_XML\n else:\n config_xml_file = _retrieve_config_xml(config_xml, saltenv)\n\n with salt.utils.files.fopen(config_xml_file) as _fp:\n config_xml = salt.utils.stringutils.to_unicode(_fp.read())\n\n server = _connect()\n try:\n server.reconfig_job(name, config_xml)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error updating job \\'{0}\\': {1}'.format(name, err)\n )\n return config_xml\n\n\ndef delete_job(name=None):\n '''\n Return true is job is deleted successfully.\n\n :param name: The name of the job to delete.\n :return: Return true if job is deleted successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.delete_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.delete_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error deleting job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef enable_job(name=None):\n '''\n Return true is job is enabled successfully.\n\n :param name: The name of the job to enable.\n :return: Return true if job is enabled successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.enable_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.enable_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error enabling job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef disable_job(name=None):\n '''\n Return true is job is disabled successfully.\n\n :param name: The name of the job to disable.\n :return: Return true if job is disabled successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.disable_job jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.disable_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error disabling job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef job_status(name=None):\n '''\n Return the current status, enabled or disabled, of the job.\n\n :param name: The name of the job to return status for\n :return: Return true if enabled or false if disabled.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_status jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n return server.get_job_info('empty')['buildable']\n\n\ndef get_job_config(name=None):\n '''\n Return the current job configuration for the provided job.\n\n :param name: The name of the job to return the configuration for.\n :return: The configuration for the job specified.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_job_config jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n job_info = server.get_job_config(name)\n return job_info\n\n\ndef plugin_installed(name):\n '''\n .. versionadded:: 2016.11.0\n\n Return if the plugin is installed for the provided plugin name.\n\n :param name: The name of the parameter to confirm installation.\n :return: True if plugin exists, False if plugin does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.plugin_installed pluginName\n\n '''\n\n server = _connect()\n plugins = server.get_plugins()\n\n exists = [plugin for plugin in plugins.keys() if name in plugin]\n\n if exists:\n return True\n else:\n return False\n"}}},{"rowIdx":396,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/jenkinsmod.py"},"func_name":{"kind":"string","value":"get_job_info"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def get_job_info(name=None):\n '''\n Return information about the Jenkins job.\n\n :param name: The name of the job is check if it exists.\n :return: Information about the Jenkins job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_job_info jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n job_info = server.get_job_info(name)\n if job_info:\n return job_info\n return False"},"func_documentation_string":{"kind":"string","value":"Return information about the Jenkins job.\n\n :param name: The name of the job is check if it exists.\n :return: Information about the Jenkins job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_job_info jobname"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/jenkinsmod.py#L194-L219"},"called_functions":{"kind":"list like","value":["def _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\n __salt__['config.get']('jenkins:user') or \\\n __salt__['pillar.get']('jenkins.user')\n\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\n __salt__['config.get']('jenkins:password') or \\\n __salt__['pillar.get']('jenkins.password')\n\n if not jenkins_url:\n raise SaltInvocationError('No Jenkins URL found.')\n\n return jenkins.Jenkins(jenkins_url,\n username=jenkins_user,\n password=jenkins_password)\n","def job_exists(name=None):\n '''\n Check whether the job exists in configured Jenkins jobs.\n\n :param name: The name of the job is check if it exists.\n :return: True if job exists, False if job does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_exists jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n if server.job_exists(name):\n return True\n else:\n return False\n"],"string":"[\n \"def _connect():\\n '''\\n Return server object used to interact with Jenkins.\\n\\n :return: server object used to interact with Jenkins\\n '''\\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\\\\n __salt__['config.get']('jenkins:url') or \\\\\\n __salt__['pillar.get']('jenkins.url')\\n\\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\\\\n __salt__['config.get']('jenkins:user') or \\\\\\n __salt__['pillar.get']('jenkins.user')\\n\\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\\\\n __salt__['config.get']('jenkins:password') or \\\\\\n __salt__['pillar.get']('jenkins.password')\\n\\n if not jenkins_url:\\n raise SaltInvocationError('No Jenkins URL found.')\\n\\n return jenkins.Jenkins(jenkins_url,\\n username=jenkins_user,\\n password=jenkins_password)\\n\",\n \"def job_exists(name=None):\\n '''\\n Check whether the job exists in configured Jenkins jobs.\\n\\n :param name: The name of the job is check if it exists.\\n :return: True if job exists, False if job does not exist.\\n\\n CLI Example:\\n\\n .. code-block:: bash\\n\\n salt '*' jenkins.job_exists jobname\\n\\n '''\\n if not name:\\n raise SaltInvocationError('Required parameter \\\\'name\\\\' is missing')\\n\\n server = _connect()\\n if server.job_exists(name):\\n return True\\n else:\\n return False\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nModule for controlling Jenkins\n\n:depends: python-jenkins\n\n.. versionadded:: 2016.3.0\n\n:depends: python-jenkins_ Python module (not to be confused with jenkins_)\n\n.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins\n.. _jenkins: https://pypi.python.org/pypi/jenkins\n\n:configuration: This module can be used by either passing an api key and version\n directly or by specifying both in a configuration profile in the salt\n master/minion config.\n\n For example:\n\n .. code-block:: yaml\n\n jenkins:\n api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15\n'''\n\n# Import Python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import Salt libs\nimport salt.utils.stringutils\n\ntry:\n import jenkins\n HAS_JENKINS = True\nexcept ImportError:\n HAS_JENKINS = False\n\nimport salt.utils.files\n\n# Import 3rd-party libs\n# pylint: disable=import-error,no-name-in-module,redefined-builtin\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\n# pylint: enable=import-error,no-name-in-module\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'jenkins'\n\n\ndef __virtual__():\n '''\n Return virtual name of the module.\n\n :return: The virtual name of the module.\n '''\n if HAS_JENKINS:\n if hasattr(jenkins, 'Jenkins'):\n return __virtualname__\n else:\n return (False,\n 'The wrong Python module appears to be installed. Please '\n 'make sure that \\'python-jenkins\\' is installed, not '\n '\\'jenkins\\'.')\n return (False, 'The jenkins execution module cannot be loaded: '\n 'python-jenkins is not installed.')\n\n\ndef _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\n __salt__['config.get']('jenkins:user') or \\\n __salt__['pillar.get']('jenkins.user')\n\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\n __salt__['config.get']('jenkins:password') or \\\n __salt__['pillar.get']('jenkins.password')\n\n if not jenkins_url:\n raise SaltInvocationError('No Jenkins URL found.')\n\n return jenkins.Jenkins(jenkins_url,\n username=jenkins_user,\n password=jenkins_password)\n\n\ndef _retrieve_config_xml(config_xml, saltenv):\n '''\n Helper to cache the config XML and raise a CommandExecutionError if we fail\n to do so. If we successfully cache the file, return the cached path.\n '''\n ret = __salt__['cp.cache_file'](config_xml, saltenv)\n\n if not ret:\n raise CommandExecutionError('Failed to retrieve {0}'.format(config_xml))\n\n return ret\n\n\ndef run(script):\n '''\n .. versionadded:: 2017.7.0\n\n Execute a script on the jenkins master\n\n :param script: The script\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.run 'Jenkins.instance.doSafeRestart()'\n\n '''\n\n server = _connect()\n return server.run_script(script)\n\n\ndef get_version():\n '''\n Return version of Jenkins\n\n :return: The version of Jenkins\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_version\n '''\n\n server = _connect()\n\n version = server.get_version()\n if version:\n return version\n return False\n\n\ndef get_jobs():\n '''\n Return the currently configured jobs.\n\n :return: The currently configured jobs.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_jobs\n '''\n\n server = _connect()\n\n jobs = server.get_jobs()\n if jobs:\n return jobs\n return {}\n\n\ndef job_exists(name=None):\n '''\n Check whether the job exists in configured Jenkins jobs.\n\n :param name: The name of the job is check if it exists.\n :return: True if job exists, False if job does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_exists jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n if server.job_exists(name):\n return True\n else:\n return False\n\n\n\ndef build_job(name=None, parameters=None):\n '''\n Initiate a build for the provided job.\n\n :param name: The name of the job is check if it exists.\n :param parameters: Parameters to send to the job.\n :return: True is successful, otherwise raise an exception.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.build_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist.'.format(name))\n\n try:\n server.build_job(name, parameters)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error building job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef create_job(name=None,\n config_xml=None,\n saltenv='base'):\n '''\n Return the configuration file.\n\n :param name: The name of the job is check if it exists.\n :param config_xml: The configuration file to use to create the job.\n :param saltenv: The environment to look for the file in.\n :return: The configuration file used for the job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.create_job jobname\n\n salt '*' jenkins.create_job jobname config_xml='salt://jenkins/config.xml'\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n if job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' already exists'.format(name))\n\n if not config_xml:\n config_xml = jenkins.EMPTY_CONFIG_XML\n else:\n config_xml_file = _retrieve_config_xml(config_xml, saltenv)\n\n with salt.utils.files.fopen(config_xml_file) as _fp:\n config_xml = salt.utils.stringutils.to_unicode(_fp.read())\n\n server = _connect()\n try:\n server.create_job(name, config_xml)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error creating job \\'{0}\\': {1}'.format(name, err)\n )\n return config_xml\n\n\ndef update_job(name=None,\n config_xml=None,\n saltenv='base'):\n '''\n Return the updated configuration file.\n\n :param name: The name of the job is check if it exists.\n :param config_xml: The configuration file to use to create the job.\n :param saltenv: The environment to look for the file in.\n :return: The configuration file used for the job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.update_job jobname\n\n salt '*' jenkins.update_job jobname config_xml='salt://jenkins/config.xml'\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n if not config_xml:\n config_xml = jenkins.EMPTY_CONFIG_XML\n else:\n config_xml_file = _retrieve_config_xml(config_xml, saltenv)\n\n with salt.utils.files.fopen(config_xml_file) as _fp:\n config_xml = salt.utils.stringutils.to_unicode(_fp.read())\n\n server = _connect()\n try:\n server.reconfig_job(name, config_xml)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error updating job \\'{0}\\': {1}'.format(name, err)\n )\n return config_xml\n\n\ndef delete_job(name=None):\n '''\n Return true is job is deleted successfully.\n\n :param name: The name of the job to delete.\n :return: Return true if job is deleted successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.delete_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.delete_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error deleting job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef enable_job(name=None):\n '''\n Return true is job is enabled successfully.\n\n :param name: The name of the job to enable.\n :return: Return true if job is enabled successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.enable_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.enable_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error enabling job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef disable_job(name=None):\n '''\n Return true is job is disabled successfully.\n\n :param name: The name of the job to disable.\n :return: Return true if job is disabled successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.disable_job jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.disable_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error disabling job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef job_status(name=None):\n '''\n Return the current status, enabled or disabled, of the job.\n\n :param name: The name of the job to return status for\n :return: Return true if enabled or false if disabled.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_status jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n return server.get_job_info('empty')['buildable']\n\n\ndef get_job_config(name=None):\n '''\n Return the current job configuration for the provided job.\n\n :param name: The name of the job to return the configuration for.\n :return: The configuration for the job specified.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_job_config jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n job_info = server.get_job_config(name)\n return job_info\n\n\ndef plugin_installed(name):\n '''\n .. versionadded:: 2016.11.0\n\n Return if the plugin is installed for the provided plugin name.\n\n :param name: The name of the parameter to confirm installation.\n :return: True if plugin exists, False if plugin does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.plugin_installed pluginName\n\n '''\n\n server = _connect()\n plugins = server.get_plugins()\n\n exists = [plugin for plugin in plugins.keys() if name in plugin]\n\n if exists:\n return True\n else:\n return False\n"}}},{"rowIdx":397,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/jenkinsmod.py"},"func_name":{"kind":"string","value":"build_job"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def build_job(name=None, parameters=None):\n '''\n Initiate a build for the provided job.\n\n :param name: The name of the job is check if it exists.\n :param parameters: Parameters to send to the job.\n :return: True is successful, otherwise raise an exception.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.build_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist.'.format(name))\n\n try:\n server.build_job(name, parameters)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error building job \\'{0}\\': {1}'.format(name, err)\n )\n return True"},"func_documentation_string":{"kind":"string","value":"Initiate a build for the provided job.\n\n :param name: The name of the job is check if it exists.\n :param parameters: Parameters to send to the job.\n :return: True is successful, otherwise raise an exception.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.build_job jobname"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/jenkinsmod.py#L222-L251"},"called_functions":{"kind":"list like","value":["def _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\n __salt__['config.get']('jenkins:user') or \\\n __salt__['pillar.get']('jenkins.user')\n\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\n __salt__['config.get']('jenkins:password') or \\\n __salt__['pillar.get']('jenkins.password')\n\n if not jenkins_url:\n raise SaltInvocationError('No Jenkins URL found.')\n\n return jenkins.Jenkins(jenkins_url,\n username=jenkins_user,\n password=jenkins_password)\n","def job_exists(name=None):\n '''\n Check whether the job exists in configured Jenkins jobs.\n\n :param name: The name of the job is check if it exists.\n :return: True if job exists, False if job does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_exists jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n if server.job_exists(name):\n return True\n else:\n return False\n"],"string":"[\n \"def _connect():\\n '''\\n Return server object used to interact with Jenkins.\\n\\n :return: server object used to interact with Jenkins\\n '''\\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\\\\n __salt__['config.get']('jenkins:url') or \\\\\\n __salt__['pillar.get']('jenkins.url')\\n\\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\\\\n __salt__['config.get']('jenkins:user') or \\\\\\n __salt__['pillar.get']('jenkins.user')\\n\\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\\\\n __salt__['config.get']('jenkins:password') or \\\\\\n __salt__['pillar.get']('jenkins.password')\\n\\n if not jenkins_url:\\n raise SaltInvocationError('No Jenkins URL found.')\\n\\n return jenkins.Jenkins(jenkins_url,\\n username=jenkins_user,\\n password=jenkins_password)\\n\",\n \"def job_exists(name=None):\\n '''\\n Check whether the job exists in configured Jenkins jobs.\\n\\n :param name: The name of the job is check if it exists.\\n :return: True if job exists, False if job does not exist.\\n\\n CLI Example:\\n\\n .. code-block:: bash\\n\\n salt '*' jenkins.job_exists jobname\\n\\n '''\\n if not name:\\n raise SaltInvocationError('Required parameter \\\\'name\\\\' is missing')\\n\\n server = _connect()\\n if server.job_exists(name):\\n return True\\n else:\\n return False\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nModule for controlling Jenkins\n\n:depends: python-jenkins\n\n.. versionadded:: 2016.3.0\n\n:depends: python-jenkins_ Python module (not to be confused with jenkins_)\n\n.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins\n.. _jenkins: https://pypi.python.org/pypi/jenkins\n\n:configuration: This module can be used by either passing an api key and version\n directly or by specifying both in a configuration profile in the salt\n master/minion config.\n\n For example:\n\n .. code-block:: yaml\n\n jenkins:\n api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15\n'''\n\n# Import Python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import Salt libs\nimport salt.utils.stringutils\n\ntry:\n import jenkins\n HAS_JENKINS = True\nexcept ImportError:\n HAS_JENKINS = False\n\nimport salt.utils.files\n\n# Import 3rd-party libs\n# pylint: disable=import-error,no-name-in-module,redefined-builtin\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\n# pylint: enable=import-error,no-name-in-module\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'jenkins'\n\n\ndef __virtual__():\n '''\n Return virtual name of the module.\n\n :return: The virtual name of the module.\n '''\n if HAS_JENKINS:\n if hasattr(jenkins, 'Jenkins'):\n return __virtualname__\n else:\n return (False,\n 'The wrong Python module appears to be installed. Please '\n 'make sure that \\'python-jenkins\\' is installed, not '\n '\\'jenkins\\'.')\n return (False, 'The jenkins execution module cannot be loaded: '\n 'python-jenkins is not installed.')\n\n\ndef _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\n __salt__['config.get']('jenkins:user') or \\\n __salt__['pillar.get']('jenkins.user')\n\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\n __salt__['config.get']('jenkins:password') or \\\n __salt__['pillar.get']('jenkins.password')\n\n if not jenkins_url:\n raise SaltInvocationError('No Jenkins URL found.')\n\n return jenkins.Jenkins(jenkins_url,\n username=jenkins_user,\n password=jenkins_password)\n\n\ndef _retrieve_config_xml(config_xml, saltenv):\n '''\n Helper to cache the config XML and raise a CommandExecutionError if we fail\n to do so. If we successfully cache the file, return the cached path.\n '''\n ret = __salt__['cp.cache_file'](config_xml, saltenv)\n\n if not ret:\n raise CommandExecutionError('Failed to retrieve {0}'.format(config_xml))\n\n return ret\n\n\ndef run(script):\n '''\n .. versionadded:: 2017.7.0\n\n Execute a script on the jenkins master\n\n :param script: The script\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.run 'Jenkins.instance.doSafeRestart()'\n\n '''\n\n server = _connect()\n return server.run_script(script)\n\n\ndef get_version():\n '''\n Return version of Jenkins\n\n :return: The version of Jenkins\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_version\n '''\n\n server = _connect()\n\n version = server.get_version()\n if version:\n return version\n return False\n\n\ndef get_jobs():\n '''\n Return the currently configured jobs.\n\n :return: The currently configured jobs.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_jobs\n '''\n\n server = _connect()\n\n jobs = server.get_jobs()\n if jobs:\n return jobs\n return {}\n\n\ndef job_exists(name=None):\n '''\n Check whether the job exists in configured Jenkins jobs.\n\n :param name: The name of the job is check if it exists.\n :return: True if job exists, False if job does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_exists jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n if server.job_exists(name):\n return True\n else:\n return False\n\n\ndef get_job_info(name=None):\n '''\n Return information about the Jenkins job.\n\n :param name: The name of the job is check if it exists.\n :return: Information about the Jenkins job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_job_info jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n job_info = server.get_job_info(name)\n if job_info:\n return job_info\n return False\n\n\n\ndef create_job(name=None,\n config_xml=None,\n saltenv='base'):\n '''\n Return the configuration file.\n\n :param name: The name of the job is check if it exists.\n :param config_xml: The configuration file to use to create the job.\n :param saltenv: The environment to look for the file in.\n :return: The configuration file used for the job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.create_job jobname\n\n salt '*' jenkins.create_job jobname config_xml='salt://jenkins/config.xml'\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n if job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' already exists'.format(name))\n\n if not config_xml:\n config_xml = jenkins.EMPTY_CONFIG_XML\n else:\n config_xml_file = _retrieve_config_xml(config_xml, saltenv)\n\n with salt.utils.files.fopen(config_xml_file) as _fp:\n config_xml = salt.utils.stringutils.to_unicode(_fp.read())\n\n server = _connect()\n try:\n server.create_job(name, config_xml)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error creating job \\'{0}\\': {1}'.format(name, err)\n )\n return config_xml\n\n\ndef update_job(name=None,\n config_xml=None,\n saltenv='base'):\n '''\n Return the updated configuration file.\n\n :param name: The name of the job is check if it exists.\n :param config_xml: The configuration file to use to create the job.\n :param saltenv: The environment to look for the file in.\n :return: The configuration file used for the job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.update_job jobname\n\n salt '*' jenkins.update_job jobname config_xml='salt://jenkins/config.xml'\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n if not config_xml:\n config_xml = jenkins.EMPTY_CONFIG_XML\n else:\n config_xml_file = _retrieve_config_xml(config_xml, saltenv)\n\n with salt.utils.files.fopen(config_xml_file) as _fp:\n config_xml = salt.utils.stringutils.to_unicode(_fp.read())\n\n server = _connect()\n try:\n server.reconfig_job(name, config_xml)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error updating job \\'{0}\\': {1}'.format(name, err)\n )\n return config_xml\n\n\ndef delete_job(name=None):\n '''\n Return true is job is deleted successfully.\n\n :param name: The name of the job to delete.\n :return: Return true if job is deleted successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.delete_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.delete_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error deleting job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef enable_job(name=None):\n '''\n Return true is job is enabled successfully.\n\n :param name: The name of the job to enable.\n :return: Return true if job is enabled successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.enable_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.enable_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error enabling job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef disable_job(name=None):\n '''\n Return true is job is disabled successfully.\n\n :param name: The name of the job to disable.\n :return: Return true if job is disabled successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.disable_job jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.disable_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error disabling job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef job_status(name=None):\n '''\n Return the current status, enabled or disabled, of the job.\n\n :param name: The name of the job to return status for\n :return: Return true if enabled or false if disabled.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_status jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n return server.get_job_info('empty')['buildable']\n\n\ndef get_job_config(name=None):\n '''\n Return the current job configuration for the provided job.\n\n :param name: The name of the job to return the configuration for.\n :return: The configuration for the job specified.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_job_config jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n job_info = server.get_job_config(name)\n return job_info\n\n\ndef plugin_installed(name):\n '''\n .. versionadded:: 2016.11.0\n\n Return if the plugin is installed for the provided plugin name.\n\n :param name: The name of the parameter to confirm installation.\n :return: True if plugin exists, False if plugin does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.plugin_installed pluginName\n\n '''\n\n server = _connect()\n plugins = server.get_plugins()\n\n exists = [plugin for plugin in plugins.keys() if name in plugin]\n\n if exists:\n return True\n else:\n return False\n"}}},{"rowIdx":398,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/jenkinsmod.py"},"func_name":{"kind":"string","value":"create_job"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def create_job(name=None,\n config_xml=None,\n saltenv='base'):\n '''\n Return the configuration file.\n\n :param name: The name of the job is check if it exists.\n :param config_xml: The configuration file to use to create the job.\n :param saltenv: The environment to look for the file in.\n :return: The configuration file used for the job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.create_job jobname\n\n salt '*' jenkins.create_job jobname config_xml='salt://jenkins/config.xml'\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n if job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' already exists'.format(name))\n\n if not config_xml:\n config_xml = jenkins.EMPTY_CONFIG_XML\n else:\n config_xml_file = _retrieve_config_xml(config_xml, saltenv)\n\n with salt.utils.files.fopen(config_xml_file) as _fp:\n config_xml = salt.utils.stringutils.to_unicode(_fp.read())\n\n server = _connect()\n try:\n server.create_job(name, config_xml)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error creating job \\'{0}\\': {1}'.format(name, err)\n )\n return config_xml"},"func_documentation_string":{"kind":"string","value":"Return the configuration file.\n\n :param name: The name of the job is check if it exists.\n :param config_xml: The configuration file to use to create the job.\n :param saltenv: The environment to look for the file in.\n :return: The configuration file used for the job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.create_job jobname\n\n salt '*' jenkins.create_job jobname config_xml='salt://jenkins/config.xml'"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/jenkinsmod.py#L254-L295"},"called_functions":{"kind":"list like","value":["def fopen(*args, **kwargs):\n '''\n Wrapper around open() built-in to set CLOEXEC on the fd.\n\n This flag specifies that the file descriptor should be closed when an exec\n function is invoked;\n\n When a file descriptor is allocated (as with open or dup), this bit is\n initially cleared on the new file descriptor, meaning that descriptor will\n survive into the new program after exec.\n\n NB! We still have small race condition between open and fcntl.\n '''\n if six.PY3:\n try:\n # Don't permit stdin/stdout/stderr to be opened. The boolean False\n # and True are treated by Python 3's open() as file descriptors 0\n # and 1, respectively.\n if args[0] in (0, 1, 2):\n raise TypeError(\n '{0} is not a permitted file descriptor'.format(args[0])\n )\n except IndexError:\n pass\n binary = None\n # ensure 'binary' mode is always used on Windows in Python 2\n if ((six.PY2 and salt.utils.platform.is_windows() and 'binary' not in kwargs) or\n kwargs.pop('binary', False)):\n if len(args) > 1:\n args = list(args)\n if 'b' not in args[1]:\n args[1] = args[1].replace('t', 'b')\n if 'b' not in args[1]:\n args[1] += 'b'\n elif kwargs.get('mode'):\n if 'b' not in kwargs['mode']:\n kwargs['mode'] = kwargs['mode'].replace('t', 'b')\n if 'b' not in kwargs['mode']:\n kwargs['mode'] += 'b'\n else:\n # the default is to read\n kwargs['mode'] = 'rb'\n elif six.PY3 and 'encoding' not in kwargs:\n # In Python 3, if text mode is used and the encoding\n # is not specified, set the encoding to 'utf-8'.\n binary = False\n if len(args) > 1:\n args = list(args)\n if 'b' in args[1]:\n binary = True\n if kwargs.get('mode', None):\n if 'b' in kwargs['mode']:\n binary = True\n if not binary:\n kwargs['encoding'] = __salt_system_encoding__\n\n if six.PY3 and not binary and not kwargs.get('newline', None):\n kwargs['newline'] = ''\n\n f_handle = open(*args, **kwargs) # pylint: disable=resource-leakage\n\n if is_fcntl_available():\n # modify the file descriptor on systems with fcntl\n # unix and unix-like systems only\n try:\n FD_CLOEXEC = fcntl.FD_CLOEXEC # pylint: disable=C0103\n except AttributeError:\n FD_CLOEXEC = 1 # pylint: disable=C0103\n old_flags = fcntl.fcntl(f_handle.fileno(), fcntl.F_GETFD)\n fcntl.fcntl(f_handle.fileno(), fcntl.F_SETFD, old_flags | FD_CLOEXEC)\n\n return f_handle\n","def to_unicode(s, encoding=None, errors='strict', normalize=False):\n '''\n Given str or unicode, return unicode (str for python 3)\n '''\n def _normalize(s):\n return unicodedata.normalize('NFC', s) if normalize else s\n\n if encoding is None:\n # Try utf-8 first, and fall back to detected encoding\n encoding = ('utf-8', __salt_system_encoding__)\n if not isinstance(encoding, (tuple, list)):\n encoding = (encoding,)\n\n if not encoding:\n raise ValueError('encoding cannot be empty')\n\n exc = None\n if six.PY3:\n if isinstance(s, str):\n return _normalize(s)\n elif isinstance(s, (bytes, bytearray)):\n return _normalize(to_str(s, encoding, errors))\n raise TypeError('expected str, bytes, or bytearray')\n else:\n # This needs to be str and not six.string_types, since if the string is\n # already a unicode type, it does not need to be decoded (and doing so\n # will raise an exception).\n if isinstance(s, unicode): # pylint: disable=incompatible-py3-code,undefined-variable\n return _normalize(s)\n elif isinstance(s, (str, bytearray)):\n for enc in encoding:\n try:\n return _normalize(s.decode(enc, errors))\n except UnicodeDecodeError as err:\n exc = err\n continue\n # The only way we get this far is if a UnicodeDecodeError was\n # raised, otherwise we would have already returned (or raised some\n # other exception).\n raise exc # pylint: disable=raising-bad-type\n raise TypeError('expected str or bytearray')\n","def _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\n __salt__['config.get']('jenkins:user') or \\\n __salt__['pillar.get']('jenkins.user')\n\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\n __salt__['config.get']('jenkins:password') or \\\n __salt__['pillar.get']('jenkins.password')\n\n if not jenkins_url:\n raise SaltInvocationError('No Jenkins URL found.')\n\n return jenkins.Jenkins(jenkins_url,\n username=jenkins_user,\n password=jenkins_password)\n","def _retrieve_config_xml(config_xml, saltenv):\n '''\n Helper to cache the config XML and raise a CommandExecutionError if we fail\n to do so. If we successfully cache the file, return the cached path.\n '''\n ret = __salt__['cp.cache_file'](config_xml, saltenv)\n\n if not ret:\n raise CommandExecutionError('Failed to retrieve {0}'.format(config_xml))\n\n return ret\n","def job_exists(name=None):\n '''\n Check whether the job exists in configured Jenkins jobs.\n\n :param name: The name of the job is check if it exists.\n :return: True if job exists, False if job does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_exists jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n if server.job_exists(name):\n return True\n else:\n return False\n"],"string":"[\n \"def fopen(*args, **kwargs):\\n '''\\n Wrapper around open() built-in to set CLOEXEC on the fd.\\n\\n This flag specifies that the file descriptor should be closed when an exec\\n function is invoked;\\n\\n When a file descriptor is allocated (as with open or dup), this bit is\\n initially cleared on the new file descriptor, meaning that descriptor will\\n survive into the new program after exec.\\n\\n NB! We still have small race condition between open and fcntl.\\n '''\\n if six.PY3:\\n try:\\n # Don't permit stdin/stdout/stderr to be opened. The boolean False\\n # and True are treated by Python 3's open() as file descriptors 0\\n # and 1, respectively.\\n if args[0] in (0, 1, 2):\\n raise TypeError(\\n '{0} is not a permitted file descriptor'.format(args[0])\\n )\\n except IndexError:\\n pass\\n binary = None\\n # ensure 'binary' mode is always used on Windows in Python 2\\n if ((six.PY2 and salt.utils.platform.is_windows() and 'binary' not in kwargs) or\\n kwargs.pop('binary', False)):\\n if len(args) > 1:\\n args = list(args)\\n if 'b' not in args[1]:\\n args[1] = args[1].replace('t', 'b')\\n if 'b' not in args[1]:\\n args[1] += 'b'\\n elif kwargs.get('mode'):\\n if 'b' not in kwargs['mode']:\\n kwargs['mode'] = kwargs['mode'].replace('t', 'b')\\n if 'b' not in kwargs['mode']:\\n kwargs['mode'] += 'b'\\n else:\\n # the default is to read\\n kwargs['mode'] = 'rb'\\n elif six.PY3 and 'encoding' not in kwargs:\\n # In Python 3, if text mode is used and the encoding\\n # is not specified, set the encoding to 'utf-8'.\\n binary = False\\n if len(args) > 1:\\n args = list(args)\\n if 'b' in args[1]:\\n binary = True\\n if kwargs.get('mode', None):\\n if 'b' in kwargs['mode']:\\n binary = True\\n if not binary:\\n kwargs['encoding'] = __salt_system_encoding__\\n\\n if six.PY3 and not binary and not kwargs.get('newline', None):\\n kwargs['newline'] = ''\\n\\n f_handle = open(*args, **kwargs) # pylint: disable=resource-leakage\\n\\n if is_fcntl_available():\\n # modify the file descriptor on systems with fcntl\\n # unix and unix-like systems only\\n try:\\n FD_CLOEXEC = fcntl.FD_CLOEXEC # pylint: disable=C0103\\n except AttributeError:\\n FD_CLOEXEC = 1 # pylint: disable=C0103\\n old_flags = fcntl.fcntl(f_handle.fileno(), fcntl.F_GETFD)\\n fcntl.fcntl(f_handle.fileno(), fcntl.F_SETFD, old_flags | FD_CLOEXEC)\\n\\n return f_handle\\n\",\n \"def to_unicode(s, encoding=None, errors='strict', normalize=False):\\n '''\\n Given str or unicode, return unicode (str for python 3)\\n '''\\n def _normalize(s):\\n return unicodedata.normalize('NFC', s) if normalize else s\\n\\n if encoding is None:\\n # Try utf-8 first, and fall back to detected encoding\\n encoding = ('utf-8', __salt_system_encoding__)\\n if not isinstance(encoding, (tuple, list)):\\n encoding = (encoding,)\\n\\n if not encoding:\\n raise ValueError('encoding cannot be empty')\\n\\n exc = None\\n if six.PY3:\\n if isinstance(s, str):\\n return _normalize(s)\\n elif isinstance(s, (bytes, bytearray)):\\n return _normalize(to_str(s, encoding, errors))\\n raise TypeError('expected str, bytes, or bytearray')\\n else:\\n # This needs to be str and not six.string_types, since if the string is\\n # already a unicode type, it does not need to be decoded (and doing so\\n # will raise an exception).\\n if isinstance(s, unicode): # pylint: disable=incompatible-py3-code,undefined-variable\\n return _normalize(s)\\n elif isinstance(s, (str, bytearray)):\\n for enc in encoding:\\n try:\\n return _normalize(s.decode(enc, errors))\\n except UnicodeDecodeError as err:\\n exc = err\\n continue\\n # The only way we get this far is if a UnicodeDecodeError was\\n # raised, otherwise we would have already returned (or raised some\\n # other exception).\\n raise exc # pylint: disable=raising-bad-type\\n raise TypeError('expected str or bytearray')\\n\",\n \"def _connect():\\n '''\\n Return server object used to interact with Jenkins.\\n\\n :return: server object used to interact with Jenkins\\n '''\\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\\\\n __salt__['config.get']('jenkins:url') or \\\\\\n __salt__['pillar.get']('jenkins.url')\\n\\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\\\\n __salt__['config.get']('jenkins:user') or \\\\\\n __salt__['pillar.get']('jenkins.user')\\n\\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\\\\n __salt__['config.get']('jenkins:password') or \\\\\\n __salt__['pillar.get']('jenkins.password')\\n\\n if not jenkins_url:\\n raise SaltInvocationError('No Jenkins URL found.')\\n\\n return jenkins.Jenkins(jenkins_url,\\n username=jenkins_user,\\n password=jenkins_password)\\n\",\n \"def _retrieve_config_xml(config_xml, saltenv):\\n '''\\n Helper to cache the config XML and raise a CommandExecutionError if we fail\\n to do so. If we successfully cache the file, return the cached path.\\n '''\\n ret = __salt__['cp.cache_file'](config_xml, saltenv)\\n\\n if not ret:\\n raise CommandExecutionError('Failed to retrieve {0}'.format(config_xml))\\n\\n return ret\\n\",\n \"def job_exists(name=None):\\n '''\\n Check whether the job exists in configured Jenkins jobs.\\n\\n :param name: The name of the job is check if it exists.\\n :return: True if job exists, False if job does not exist.\\n\\n CLI Example:\\n\\n .. code-block:: bash\\n\\n salt '*' jenkins.job_exists jobname\\n\\n '''\\n if not name:\\n raise SaltInvocationError('Required parameter \\\\'name\\\\' is missing')\\n\\n server = _connect()\\n if server.job_exists(name):\\n return True\\n else:\\n return False\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nModule for controlling Jenkins\n\n:depends: python-jenkins\n\n.. versionadded:: 2016.3.0\n\n:depends: python-jenkins_ Python module (not to be confused with jenkins_)\n\n.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins\n.. _jenkins: https://pypi.python.org/pypi/jenkins\n\n:configuration: This module can be used by either passing an api key and version\n directly or by specifying both in a configuration profile in the salt\n master/minion config.\n\n For example:\n\n .. code-block:: yaml\n\n jenkins:\n api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15\n'''\n\n# Import Python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import Salt libs\nimport salt.utils.stringutils\n\ntry:\n import jenkins\n HAS_JENKINS = True\nexcept ImportError:\n HAS_JENKINS = False\n\nimport salt.utils.files\n\n# Import 3rd-party libs\n# pylint: disable=import-error,no-name-in-module,redefined-builtin\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\n# pylint: enable=import-error,no-name-in-module\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'jenkins'\n\n\ndef __virtual__():\n '''\n Return virtual name of the module.\n\n :return: The virtual name of the module.\n '''\n if HAS_JENKINS:\n if hasattr(jenkins, 'Jenkins'):\n return __virtualname__\n else:\n return (False,\n 'The wrong Python module appears to be installed. Please '\n 'make sure that \\'python-jenkins\\' is installed, not '\n '\\'jenkins\\'.')\n return (False, 'The jenkins execution module cannot be loaded: '\n 'python-jenkins is not installed.')\n\n\ndef _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\n __salt__['config.get']('jenkins:user') or \\\n __salt__['pillar.get']('jenkins.user')\n\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\n __salt__['config.get']('jenkins:password') or \\\n __salt__['pillar.get']('jenkins.password')\n\n if not jenkins_url:\n raise SaltInvocationError('No Jenkins URL found.')\n\n return jenkins.Jenkins(jenkins_url,\n username=jenkins_user,\n password=jenkins_password)\n\n\ndef _retrieve_config_xml(config_xml, saltenv):\n '''\n Helper to cache the config XML and raise a CommandExecutionError if we fail\n to do so. If we successfully cache the file, return the cached path.\n '''\n ret = __salt__['cp.cache_file'](config_xml, saltenv)\n\n if not ret:\n raise CommandExecutionError('Failed to retrieve {0}'.format(config_xml))\n\n return ret\n\n\ndef run(script):\n '''\n .. versionadded:: 2017.7.0\n\n Execute a script on the jenkins master\n\n :param script: The script\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.run 'Jenkins.instance.doSafeRestart()'\n\n '''\n\n server = _connect()\n return server.run_script(script)\n\n\ndef get_version():\n '''\n Return version of Jenkins\n\n :return: The version of Jenkins\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_version\n '''\n\n server = _connect()\n\n version = server.get_version()\n if version:\n return version\n return False\n\n\ndef get_jobs():\n '''\n Return the currently configured jobs.\n\n :return: The currently configured jobs.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_jobs\n '''\n\n server = _connect()\n\n jobs = server.get_jobs()\n if jobs:\n return jobs\n return {}\n\n\ndef job_exists(name=None):\n '''\n Check whether the job exists in configured Jenkins jobs.\n\n :param name: The name of the job is check if it exists.\n :return: True if job exists, False if job does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_exists jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n if server.job_exists(name):\n return True\n else:\n return False\n\n\ndef get_job_info(name=None):\n '''\n Return information about the Jenkins job.\n\n :param name: The name of the job is check if it exists.\n :return: Information about the Jenkins job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_job_info jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n job_info = server.get_job_info(name)\n if job_info:\n return job_info\n return False\n\n\ndef build_job(name=None, parameters=None):\n '''\n Initiate a build for the provided job.\n\n :param name: The name of the job is check if it exists.\n :param parameters: Parameters to send to the job.\n :return: True is successful, otherwise raise an exception.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.build_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist.'.format(name))\n\n try:\n server.build_job(name, parameters)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error building job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\n\ndef update_job(name=None,\n config_xml=None,\n saltenv='base'):\n '''\n Return the updated configuration file.\n\n :param name: The name of the job is check if it exists.\n :param config_xml: The configuration file to use to create the job.\n :param saltenv: The environment to look for the file in.\n :return: The configuration file used for the job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.update_job jobname\n\n salt '*' jenkins.update_job jobname config_xml='salt://jenkins/config.xml'\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n if not config_xml:\n config_xml = jenkins.EMPTY_CONFIG_XML\n else:\n config_xml_file = _retrieve_config_xml(config_xml, saltenv)\n\n with salt.utils.files.fopen(config_xml_file) as _fp:\n config_xml = salt.utils.stringutils.to_unicode(_fp.read())\n\n server = _connect()\n try:\n server.reconfig_job(name, config_xml)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error updating job \\'{0}\\': {1}'.format(name, err)\n )\n return config_xml\n\n\ndef delete_job(name=None):\n '''\n Return true is job is deleted successfully.\n\n :param name: The name of the job to delete.\n :return: Return true if job is deleted successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.delete_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.delete_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error deleting job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef enable_job(name=None):\n '''\n Return true is job is enabled successfully.\n\n :param name: The name of the job to enable.\n :return: Return true if job is enabled successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.enable_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.enable_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error enabling job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef disable_job(name=None):\n '''\n Return true is job is disabled successfully.\n\n :param name: The name of the job to disable.\n :return: Return true if job is disabled successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.disable_job jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.disable_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error disabling job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef job_status(name=None):\n '''\n Return the current status, enabled or disabled, of the job.\n\n :param name: The name of the job to return status for\n :return: Return true if enabled or false if disabled.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_status jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n return server.get_job_info('empty')['buildable']\n\n\ndef get_job_config(name=None):\n '''\n Return the current job configuration for the provided job.\n\n :param name: The name of the job to return the configuration for.\n :return: The configuration for the job specified.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_job_config jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n job_info = server.get_job_config(name)\n return job_info\n\n\ndef plugin_installed(name):\n '''\n .. versionadded:: 2016.11.0\n\n Return if the plugin is installed for the provided plugin name.\n\n :param name: The name of the parameter to confirm installation.\n :return: True if plugin exists, False if plugin does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.plugin_installed pluginName\n\n '''\n\n server = _connect()\n plugins = server.get_plugins()\n\n exists = [plugin for plugin in plugins.keys() if name in plugin]\n\n if exists:\n return True\n else:\n return False\n"}}},{"rowIdx":399,"cells":{"repository_name":{"kind":"string","value":"saltstack/salt"},"func_path_in_repository":{"kind":"string","value":"salt/modules/jenkinsmod.py"},"func_name":{"kind":"string","value":"delete_job"},"language":{"kind":"string","value":"python"},"func_code_string":{"kind":"string","value":"def delete_job(name=None):\n '''\n Return true is job is deleted successfully.\n\n :param name: The name of the job to delete.\n :return: Return true if job is deleted successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.delete_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.delete_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error deleting job \\'{0}\\': {1}'.format(name, err)\n )\n return True"},"func_documentation_string":{"kind":"string","value":"Return true is job is deleted successfully.\n\n :param name: The name of the job to delete.\n :return: Return true if job is deleted successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.delete_job jobname"},"split_name":{"kind":"string","value":"train"},"func_code_url":{"kind":"string","value":"https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/jenkinsmod.py#L339-L367"},"called_functions":{"kind":"list like","value":["def _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\n __salt__['config.get']('jenkins:user') or \\\n __salt__['pillar.get']('jenkins.user')\n\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\n __salt__['config.get']('jenkins:password') or \\\n __salt__['pillar.get']('jenkins.password')\n\n if not jenkins_url:\n raise SaltInvocationError('No Jenkins URL found.')\n\n return jenkins.Jenkins(jenkins_url,\n username=jenkins_user,\n password=jenkins_password)\n","def job_exists(name=None):\n '''\n Check whether the job exists in configured Jenkins jobs.\n\n :param name: The name of the job is check if it exists.\n :return: True if job exists, False if job does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_exists jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n if server.job_exists(name):\n return True\n else:\n return False\n"],"string":"[\n \"def _connect():\\n '''\\n Return server object used to interact with Jenkins.\\n\\n :return: server object used to interact with Jenkins\\n '''\\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\\\\n __salt__['config.get']('jenkins:url') or \\\\\\n __salt__['pillar.get']('jenkins.url')\\n\\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\\\\n __salt__['config.get']('jenkins:user') or \\\\\\n __salt__['pillar.get']('jenkins.user')\\n\\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\\\\n __salt__['config.get']('jenkins:password') or \\\\\\n __salt__['pillar.get']('jenkins.password')\\n\\n if not jenkins_url:\\n raise SaltInvocationError('No Jenkins URL found.')\\n\\n return jenkins.Jenkins(jenkins_url,\\n username=jenkins_user,\\n password=jenkins_password)\\n\",\n \"def job_exists(name=None):\\n '''\\n Check whether the job exists in configured Jenkins jobs.\\n\\n :param name: The name of the job is check if it exists.\\n :return: True if job exists, False if job does not exist.\\n\\n CLI Example:\\n\\n .. code-block:: bash\\n\\n salt '*' jenkins.job_exists jobname\\n\\n '''\\n if not name:\\n raise SaltInvocationError('Required parameter \\\\'name\\\\' is missing')\\n\\n server = _connect()\\n if server.job_exists(name):\\n return True\\n else:\\n return False\\n\"\n]","isConversational":false},"enclosing_scope":{"kind":"string","value":"# -*- coding: utf-8 -*-\n'''\nModule for controlling Jenkins\n\n:depends: python-jenkins\n\n.. versionadded:: 2016.3.0\n\n:depends: python-jenkins_ Python module (not to be confused with jenkins_)\n\n.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins\n.. _jenkins: https://pypi.python.org/pypi/jenkins\n\n:configuration: This module can be used by either passing an api key and version\n directly or by specifying both in a configuration profile in the salt\n master/minion config.\n\n For example:\n\n .. code-block:: yaml\n\n jenkins:\n api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15\n'''\n\n# Import Python libs\nfrom __future__ import absolute_import, print_function, unicode_literals\nimport logging\n\n# Import Salt libs\nimport salt.utils.stringutils\n\ntry:\n import jenkins\n HAS_JENKINS = True\nexcept ImportError:\n HAS_JENKINS = False\n\nimport salt.utils.files\n\n# Import 3rd-party libs\n# pylint: disable=import-error,no-name-in-module,redefined-builtin\nfrom salt.exceptions import CommandExecutionError, SaltInvocationError\n# pylint: enable=import-error,no-name-in-module\n\nlog = logging.getLogger(__name__)\n\n__virtualname__ = 'jenkins'\n\n\ndef __virtual__():\n '''\n Return virtual name of the module.\n\n :return: The virtual name of the module.\n '''\n if HAS_JENKINS:\n if hasattr(jenkins, 'Jenkins'):\n return __virtualname__\n else:\n return (False,\n 'The wrong Python module appears to be installed. Please '\n 'make sure that \\'python-jenkins\\' is installed, not '\n '\\'jenkins\\'.')\n return (False, 'The jenkins execution module cannot be loaded: '\n 'python-jenkins is not installed.')\n\n\ndef _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n\n jenkins_user = __salt__['config.get']('jenkins.user') or \\\n __salt__['config.get']('jenkins:user') or \\\n __salt__['pillar.get']('jenkins.user')\n\n jenkins_password = __salt__['config.get']('jenkins.password') or \\\n __salt__['config.get']('jenkins:password') or \\\n __salt__['pillar.get']('jenkins.password')\n\n if not jenkins_url:\n raise SaltInvocationError('No Jenkins URL found.')\n\n return jenkins.Jenkins(jenkins_url,\n username=jenkins_user,\n password=jenkins_password)\n\n\ndef _retrieve_config_xml(config_xml, saltenv):\n '''\n Helper to cache the config XML and raise a CommandExecutionError if we fail\n to do so. If we successfully cache the file, return the cached path.\n '''\n ret = __salt__['cp.cache_file'](config_xml, saltenv)\n\n if not ret:\n raise CommandExecutionError('Failed to retrieve {0}'.format(config_xml))\n\n return ret\n\n\ndef run(script):\n '''\n .. versionadded:: 2017.7.0\n\n Execute a script on the jenkins master\n\n :param script: The script\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.run 'Jenkins.instance.doSafeRestart()'\n\n '''\n\n server = _connect()\n return server.run_script(script)\n\n\ndef get_version():\n '''\n Return version of Jenkins\n\n :return: The version of Jenkins\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_version\n '''\n\n server = _connect()\n\n version = server.get_version()\n if version:\n return version\n return False\n\n\ndef get_jobs():\n '''\n Return the currently configured jobs.\n\n :return: The currently configured jobs.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_jobs\n '''\n\n server = _connect()\n\n jobs = server.get_jobs()\n if jobs:\n return jobs\n return {}\n\n\ndef job_exists(name=None):\n '''\n Check whether the job exists in configured Jenkins jobs.\n\n :param name: The name of the job is check if it exists.\n :return: True if job exists, False if job does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_exists jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n if server.job_exists(name):\n return True\n else:\n return False\n\n\ndef get_job_info(name=None):\n '''\n Return information about the Jenkins job.\n\n :param name: The name of the job is check if it exists.\n :return: Information about the Jenkins job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_job_info jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n job_info = server.get_job_info(name)\n if job_info:\n return job_info\n return False\n\n\ndef build_job(name=None, parameters=None):\n '''\n Initiate a build for the provided job.\n\n :param name: The name of the job is check if it exists.\n :param parameters: Parameters to send to the job.\n :return: True is successful, otherwise raise an exception.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.build_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist.'.format(name))\n\n try:\n server.build_job(name, parameters)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error building job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef create_job(name=None,\n config_xml=None,\n saltenv='base'):\n '''\n Return the configuration file.\n\n :param name: The name of the job is check if it exists.\n :param config_xml: The configuration file to use to create the job.\n :param saltenv: The environment to look for the file in.\n :return: The configuration file used for the job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.create_job jobname\n\n salt '*' jenkins.create_job jobname config_xml='salt://jenkins/config.xml'\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n if job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' already exists'.format(name))\n\n if not config_xml:\n config_xml = jenkins.EMPTY_CONFIG_XML\n else:\n config_xml_file = _retrieve_config_xml(config_xml, saltenv)\n\n with salt.utils.files.fopen(config_xml_file) as _fp:\n config_xml = salt.utils.stringutils.to_unicode(_fp.read())\n\n server = _connect()\n try:\n server.create_job(name, config_xml)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error creating job \\'{0}\\': {1}'.format(name, err)\n )\n return config_xml\n\n\ndef update_job(name=None,\n config_xml=None,\n saltenv='base'):\n '''\n Return the updated configuration file.\n\n :param name: The name of the job is check if it exists.\n :param config_xml: The configuration file to use to create the job.\n :param saltenv: The environment to look for the file in.\n :return: The configuration file used for the job.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.update_job jobname\n\n salt '*' jenkins.update_job jobname config_xml='salt://jenkins/config.xml'\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n if not config_xml:\n config_xml = jenkins.EMPTY_CONFIG_XML\n else:\n config_xml_file = _retrieve_config_xml(config_xml, saltenv)\n\n with salt.utils.files.fopen(config_xml_file) as _fp:\n config_xml = salt.utils.stringutils.to_unicode(_fp.read())\n\n server = _connect()\n try:\n server.reconfig_job(name, config_xml)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error updating job \\'{0}\\': {1}'.format(name, err)\n )\n return config_xml\n\n\n\ndef enable_job(name=None):\n '''\n Return true is job is enabled successfully.\n\n :param name: The name of the job to enable.\n :return: Return true if job is enabled successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.enable_job jobname\n\n '''\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.enable_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error enabling job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef disable_job(name=None):\n '''\n Return true is job is disabled successfully.\n\n :param name: The name of the job to disable.\n :return: Return true if job is disabled successfully.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.disable_job jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n try:\n server.disable_job(name)\n except jenkins.JenkinsException as err:\n raise CommandExecutionError(\n 'Encountered error disabling job \\'{0}\\': {1}'.format(name, err)\n )\n return True\n\n\ndef job_status(name=None):\n '''\n Return the current status, enabled or disabled, of the job.\n\n :param name: The name of the job to return status for\n :return: Return true if enabled or false if disabled.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.job_status jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n return server.get_job_info('empty')['buildable']\n\n\ndef get_job_config(name=None):\n '''\n Return the current job configuration for the provided job.\n\n :param name: The name of the job to return the configuration for.\n :return: The configuration for the job specified.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.get_job_config jobname\n\n '''\n\n if not name:\n raise SaltInvocationError('Required parameter \\'name\\' is missing')\n\n server = _connect()\n\n if not job_exists(name):\n raise CommandExecutionError('Job \\'{0}\\' does not exist'.format(name))\n\n job_info = server.get_job_config(name)\n return job_info\n\n\ndef plugin_installed(name):\n '''\n .. versionadded:: 2016.11.0\n\n Return if the plugin is installed for the provided plugin name.\n\n :param name: The name of the parameter to confirm installation.\n :return: True if plugin exists, False if plugin does not exist.\n\n CLI Example:\n\n .. code-block:: bash\n\n salt '*' jenkins.plugin_installed pluginName\n\n '''\n\n server = _connect()\n plugins = server.get_plugins()\n\n exists = [plugin for plugin in plugins.keys() if name in plugin]\n\n if exists:\n return True\n else:\n return False\n"}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":3,"numItemsPerPage":100,"numTotalItems":353342,"offset":300,"length":100}},"jwt":"eyJhbGciOiJFZERTQSJ9.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sImlhdCI6MTc4MDU3Mjc0OCwic3ViIjoiL2RhdGFzZXRzL0lteHhuL2NvZGVjb250ZXh0IiwiZXhwIjoxNzgwNTc2MzQ4LCJpc3MiOiJodHRwczovL2h1Z2dpbmdmYWNlLmNvIn0._zh1UDT5Bc8kJRLo1qZiyh4BvsFVi2R1UvTdUZyyC9XdC6oK7S2BFvR_fGSaXuS1Qp7V-wMRO7PLDKxjgnD8CA","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":353342,"numBytesParquet":2171279882},{"config":"default","split":"valid","numRows":19721,"numBytesParquet":130546905},{"config":"default","split":"test","numRows":16681,"numBytesParquet":90685945}]},"discussionsStats":{"closed":0,"open":1,"total":1},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
repository_name stringclasses 316
values | func_path_in_repository stringlengths 6 223 | func_name stringlengths 1 134 | language stringclasses 1
value | func_code_string stringlengths 57 65.5k | func_documentation_string stringlengths 1 46.3k | split_name stringclasses 1
value | func_code_url stringlengths 91 315 | called_functions listlengths 1 156 ⌀ | enclosing_scope stringlengths 2 1.48M |
|---|---|---|---|---|---|---|---|---|---|
saltstack/salt | salt/cloud/clouds/ec2.py | avail_images | python | def avail_images(kwargs=None, call=None):
'''
Return a dict of all available VM images on the cloud provider.
'''
if call == 'action':
raise SaltCloudSystemExit(
'The avail_images function must be called with '
'-f or --function, or with the --list-images option'
... | Return a dict of all available VM images on the cloud provider. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L942-L975 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | ssh_interface | python | def ssh_interface(vm_):
'''
Return the ssh_interface type to connect to. Either 'public_ips' (default)
or 'private_ips'.
'''
ret = config.get_cloud_config_value(
'ssh_interface', vm_, __opts__, default='public_ips',
search_global=False
)
if ret not in ('public_ips', 'private_... | Return the ssh_interface type to connect to. Either 'public_ips' (default)
or 'private_ips'. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1034-L1050 | [
"def get_cloud_config_value(name, vm_, opts, default=None, search_global=True):\n '''\n Search and return a setting in a known order:\n\n 1. In the virtual machine's configuration\n 2. In the virtual machine's profile configuration\n 3. In the virtual machine's provider configuration\n ... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | get_ssh_gateway_config | python | def get_ssh_gateway_config(vm_):
'''
Return the ssh_gateway configuration.
'''
ssh_gateway = config.get_cloud_config_value(
'ssh_gateway', vm_, __opts__, default=None,
search_global=False
)
# Check to see if a SSH Gateway will be used.
if not isinstance(ssh_gateway, six.stri... | Return the ssh_gateway configuration. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1053-L1117 | [
"def get_cloud_config_value(name, vm_, opts, default=None, search_global=True):\n '''\n Search and return a setting in a known order:\n\n 1. In the virtual machine's configuration\n 2. In the virtual machine's profile configuration\n 3. In the virtual machine's provider configuration\n ... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | avail_locations | python | def avail_locations(call=None):
'''
List all available locations
'''
if call == 'action':
raise SaltCloudSystemExit(
'The avail_locations function must be called with '
'-f or --function, or with the --list-locations option'
)
ret = {}
params = {'Action'... | List all available locations | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1139-L1164 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | get_availability_zone | python | def get_availability_zone(vm_):
'''
Return the availability zone to use
'''
avz = config.get_cloud_config_value(
'availability_zone', vm_, __opts__, search_global=False
)
if avz is None:
return None
zones = _list_availability_zones(vm_)
# Validate user-specified AZ
... | Return the availability zone to use | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1167-L1198 | [
"def get_cloud_config_value(name, vm_, opts, default=None, search_global=True):\n '''\n Search and return a setting in a known order:\n\n 1. In the virtual machine's configuration\n 2. In the virtual machine's profile configuration\n 3. In the virtual machine's provider configuration\n ... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | get_imageid | python | def get_imageid(vm_):
'''
Returns the ImageId to use
'''
image = config.get_cloud_config_value(
'image', vm_, __opts__, search_global=False
)
if image.startswith('ami-'):
return image
# a poor man's cache
if not hasattr(get_imageid, 'images'):
get_imageid.images =... | Returns the ImageId to use | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1212-L1236 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | _get_subnetname_id | python | def _get_subnetname_id(subnetname):
'''
Returns the SubnetId of a SubnetName to use
'''
params = {'Action': 'DescribeSubnets'}
for subnet in aws.query(params, location=get_location(),
provider=get_provider(), opts=__opts__, sigver='4'):
tags = subnet.get('tagSet', {}).get('ite... | Returns the SubnetId of a SubnetName to use | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1239-L1256 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | get_subnetid | python | def get_subnetid(vm_):
'''
Returns the SubnetId to use
'''
subnetid = config.get_cloud_config_value(
'subnetid', vm_, __opts__, search_global=False
)
if subnetid:
return subnetid
subnetname = config.get_cloud_config_value(
'subnetname', vm_, __opts__, search_global=F... | Returns the SubnetId to use | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1259-L1274 | [
"def get_cloud_config_value(name, vm_, opts, default=None, search_global=True):\n '''\n Search and return a setting in a known order:\n\n 1. In the virtual machine's configuration\n 2. In the virtual machine's profile configuration\n 3. In the virtual machine's provider configuration\n ... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | _get_securitygroupname_id | python | def _get_securitygroupname_id(securitygroupname_list):
'''
Returns the SecurityGroupId of a SecurityGroupName to use
'''
securitygroupid_set = set()
if not isinstance(securitygroupname_list, list):
securitygroupname_list = [securitygroupname_list]
params = {'Action': 'DescribeSecurityGro... | Returns the SecurityGroupId of a SecurityGroupName to use | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1277-L1293 | null | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | securitygroupid | python | def securitygroupid(vm_):
'''
Returns the SecurityGroupId
'''
securitygroupid_set = set()
securitygroupid_list = config.get_cloud_config_value(
'securitygroupid',
vm_,
__opts__,
search_global=False
)
# If the list is None, then the set will remain empty
# ... | Returns the SecurityGroupId | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1296-L1329 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | get_provider | python | def get_provider(vm_=None):
'''
Extract the provider name from vm
'''
if vm_ is None:
provider = __active_provider_name__ or 'ec2'
else:
provider = vm_.get('provider', 'ec2')
if ':' in provider:
prov_comps = provider.split(':')
provider = prov_comps[0]
return... | Extract the provider name from vm | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1350-L1362 | null | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | _list_availability_zones | python | def _list_availability_zones(vm_=None):
'''
List all availability zones in the current region
'''
ret = {}
params = {'Action': 'DescribeAvailabilityZones',
'Filter.0.Name': 'region-name',
'Filter.0.Value.0': get_location(vm_)}
result = aws.query(params,
... | List all availability zones in the current region | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1365-L1383 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | _request_eip | python | def _request_eip(interface, vm_):
'''
Request and return Elastic IP
'''
params = {'Action': 'AllocateAddress'}
params['Domain'] = interface.setdefault('domain', 'vpc')
eips = aws.query(params,
return_root=True,
location=get_location(vm_),
... | Request and return Elastic IP | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1400-L1415 | null | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | _create_eni_if_necessary | python | def _create_eni_if_necessary(interface, vm_):
'''
Create an Elastic Interface if necessary and return a Network Interface Specification
'''
if 'NetworkInterfaceId' in interface and interface['NetworkInterfaceId'] is not None:
return {'DeviceIndex': interface['DeviceIndex'],
'Netw... | Create an Elastic Interface if necessary and return a Network Interface Specification | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1418-L1515 | null | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | _list_interface_private_addrs | python | def _list_interface_private_addrs(eni_desc):
'''
Returns a list of all of the private IP addresses attached to a
network interface. The 'primary' address will be listed first.
'''
primary = eni_desc.get('privateIpAddress')
if not primary:
return None
addresses = [primary]
lst =... | Returns a list of all of the private IP addresses attached to a
network interface. The 'primary' address will be listed first. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1543-L1564 | null | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | _modify_eni_properties | python | def _modify_eni_properties(eni_id, properties=None, vm_=None):
'''
Change properties of the interface
with id eni_id to the values in properties dict
'''
if not isinstance(properties, dict):
raise SaltCloudException(
'ENI properties must be a dictionary'
)
params = {... | Change properties of the interface
with id eni_id to the values in properties dict | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1567-L1596 | null | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | _associate_eip_with_interface | python | def _associate_eip_with_interface(eni_id, eip_id, private_ip=None, vm_=None):
'''
Accept the id of a network interface, and the id of an elastic ip
address, and associate the two of them, such that traffic sent to the
elastic ip address will be forwarded (NATted) to this network interface.
Optional... | Accept the id of a network interface, and the id of an elastic ip
address, and associate the two of them, such that traffic sent to the
elastic ip address will be forwarded (NATted) to this network interface.
Optionally specify the private (10.x.x.x) IP address that traffic should
be NATted to - useful... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1599-L1636 | null | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | _param_from_config | python | def _param_from_config(key, data):
'''
Return EC2 API parameters based on the given config data.
Examples:
1. List of dictionaries
>>> data = [
... {'DeviceIndex': 0, 'SubnetId': 'subid0',
... 'AssociatePublicIpAddress': True},
... {'DeviceIndex': 1,
... 'SubnetId'... | Return EC2 API parameters based on the given config data.
Examples:
1. List of dictionaries
>>> data = [
... {'DeviceIndex': 0, 'SubnetId': 'subid0',
... 'AssociatePublicIpAddress': True},
... {'DeviceIndex': 1,
... 'SubnetId': 'subid1',
... 'PrivateIpAddress': '1... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1675-L1744 | [
"def iteritems(d, **kw):\n return d.iteritems(**kw)\n",
"def _param_from_config(key, data):\n '''\n Return EC2 API parameters based on the given config data.\n\n Examples:\n 1. List of dictionaries\n >>> data = [\n ... {'DeviceIndex': 0, 'SubnetId': 'subid0',\n ... 'AssociatePubli... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | request_instance | python | def request_instance(vm_=None, call=None):
'''
Put together all of the information necessary to request an instance on EC2,
and then fire off the request the instance.
Returns data about the instance
'''
if call == 'function':
# Technically this function may be called other ways too, bu... | Put together all of the information necessary to request an instance on EC2,
and then fire off the request the instance.
Returns data about the instance | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L1747-L2175 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | query_instance | python | def query_instance(vm_=None, call=None):
'''
Query an instance upon creation from the EC2 API
'''
if call == 'function':
# Technically this function may be called other ways too, but it
# definitely cannot be called with --function.
raise SaltCloudSystemExit(
'The que... | Query an instance upon creation from the EC2 API | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L2178-L2304 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | wait_for_instance | python | def wait_for_instance(
vm_=None,
data=None,
ip_address=None,
display_ssh_output=True,
call=None,
):
'''
Wait for an instance upon creation from the EC2 API, to become available
'''
if call == 'function':
# Technically this function may be called other ... | Wait for an instance upon creation from the EC2 API, to become available | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L2307-L2527 | [
"def get_cloud_config_value(name, vm_, opts, default=None, search_global=True):\n '''\n Search and return a setting in a known order:\n\n 1. In the virtual machine's configuration\n 2. In the virtual machine's profile configuration\n 3. In the virtual machine's provider configuration\n ... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | create | python | def create(vm_=None, call=None):
'''
Create a single VM from a data dict
'''
if call:
raise SaltCloudSystemExit(
'You cannot create an instance with -a or -f.'
)
try:
# Check for required profile parameters before sending any API calls.
if vm_['profile'] ... | Create a single VM from a data dict | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L2555-L2931 | [
"def iteritems(d, **kw):\n return d.iteritems(**kw)\n",
"def itervalues(d, **kw):\n return d.itervalues(**kw)\n",
"def get_cloud_config_value(name, vm_, opts, default=None, search_global=True):\n '''\n Search and return a setting in a known order:\n\n 1. In the virtual machine's configuration... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | queue_instances | python | def queue_instances(instances):
'''
Queue a set of instances to be provisioned later. Expects a list.
Currently this only queries node data, and then places it in the cloud
cache (if configured). If the salt-cloud-reactor is being used, these
instances will be automatically provisioned using that.
... | Queue a set of instances to be provisioned later. Expects a list.
Currently this only queries node data, and then places it in the cloud
cache (if configured). If the salt-cloud-reactor is being used, these
instances will be automatically provisioned using that.
For more information about the salt-clo... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L2934-L2948 | [
"def _get_node(name=None, instance_id=None, location=None):\n if location is None:\n location = get_location()\n\n params = {'Action': 'DescribeInstances'}\n\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if instance_id:\n ... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | create_attach_volumes | python | def create_attach_volumes(name, kwargs, call=None, wait_to_finish=True):
'''
Create and attach volumes to created node
'''
if call != 'action':
raise SaltCloudSystemExit(
'The create_attach_volumes action must be called with '
'-a or --action.'
)
if 'instance... | Create and attach volumes to created node | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L2951-L3034 | [
"def safe_load(stream, Loader=SaltYamlSafeLoader):\n '''\n .. versionadded:: 2018.3.0\n\n Helper function which automagically uses our custom loader.\n '''\n return yaml.load(stream, Loader=Loader)\n",
"def _get_node(name=None, instance_id=None, location=None):\n if location is None:\n lo... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | stop | python | def stop(name, call=None):
'''
Stop a node
'''
if call != 'action':
raise SaltCloudSystemExit(
'The stop action must be called with -a or --action.'
)
log.info('Stopping node %s', name)
instance_id = _get_node(name)['instanceId']
__utils__['cloud.fire_event'](
... | Stop a node | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3037-L3067 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | set_tags | python | def set_tags(name=None,
tags=None,
call=None,
location=None,
instance_id=None,
resource_id=None,
kwargs=None): # pylint: disable=W0613
'''
Set tags for a resource. Normally a VM name or instance_id is passed in,
but a resource_id... | Set tags for a resource. Normally a VM name or instance_id is passed in,
but a resource_id may be passed instead. If both are passed in, the
instance_id will be used.
CLI Examples:
.. code-block:: bash
salt-cloud -a set_tags mymachine tag1=somestuff tag2='Other stuff'
salt-cloud -a se... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3103-L3206 | [
"def iteritems(d, **kw):\n return d.iteritems(**kw)\n",
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n ... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | get_tags | python | def get_tags(name=None,
instance_id=None,
call=None,
location=None,
kwargs=None,
resource_id=None): # pylint: disable=W0613
'''
Retrieve tags for a resource. Normally a VM name or instance_id is passed
in, but a resource_id may be passed inst... | Retrieve tags for a resource. Normally a VM name or instance_id is passed
in, but a resource_id may be passed instead. If both are passed in, the
instance_id will be used.
CLI Examples:
.. code-block:: bash
salt-cloud -a get_tags mymachine
salt-cloud -a get_tags resource_id=vol-3267ab... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3209-L3250 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | del_tags | python | def del_tags(name=None,
kwargs=None,
call=None,
instance_id=None,
resource_id=None): # pylint: disable=W0613
'''
Delete tags for a resource. Normally a VM name or instance_id is passed in,
but a resource_id may be passed instead. If both are passed in, th... | Delete tags for a resource. Normally a VM name or instance_id is passed in,
but a resource_id may be passed instead. If both are passed in, the
instance_id will be used.
CLI Examples:
.. code-block:: bash
salt-cloud -a del_tags mymachine tags=mytag,
salt-cloud -a del_tags mymachine ta... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3253-L3302 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | rename | python | def rename(name, kwargs, call=None):
'''
Properly rename a node. Pass in the new name as "new name".
CLI Example:
.. code-block:: bash
salt-cloud -a rename mymachine newname=yourmachine
'''
if call != 'action':
raise SaltCloudSystemExit(
'The rename action must be ... | Properly rename a node. Pass in the new name as "new name".
CLI Example:
.. code-block:: bash
salt-cloud -a rename mymachine newname=yourmachine | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3305-L3326 | [
"def set_tags(name=None,\n tags=None,\n call=None,\n location=None,\n instance_id=None,\n resource_id=None,\n kwargs=None): # pylint: disable=W0613\n '''\n Set tags for a resource. Normally a VM name or instance_id is passed in,\n but... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | destroy | python | def destroy(name, call=None):
'''
Destroy a node. Will check termination protection and warn if enabled.
CLI Example:
.. code-block:: bash
salt-cloud --destroy mymachine
'''
if call == 'function':
raise SaltCloudSystemExit(
'The destroy action must be called with -... | Destroy a node. Will check termination protection and warn if enabled.
CLI Example:
.. code-block:: bash
salt-cloud --destroy mymachine | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3329-L3430 | [
"def rename(name, kwargs, call=None):\n '''\n Properly rename a node. Pass in the new name as \"new name\".\n\n CLI Example:\n\n .. code-block:: bash\n\n salt-cloud -a rename mymachine newname=yourmachine\n '''\n if call != 'action':\n raise SaltCloudSystemExit(\n 'The ren... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | reboot | python | def reboot(name, call=None):
'''
Reboot a node.
CLI Example:
.. code-block:: bash
salt-cloud -a reboot mymachine
'''
instance_id = _get_node(name)['instanceId']
params = {'Action': 'RebootInstances',
'InstanceId.1': instance_id}
result = aws.query(params,
... | Reboot a node.
CLI Example:
.. code-block:: bash
salt-cloud -a reboot mymachine | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3433-L3457 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | show_image | python | def show_image(kwargs, call=None):
'''
Show the details from EC2 concerning an AMI
'''
if call != 'function':
raise SaltCloudSystemExit(
'The show_image action must be called with -f or --function.'
)
params = {'ImageId.1': kwargs['image'],
'Action': 'Descr... | Show the details from EC2 concerning an AMI | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3460-L3479 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | show_instance | python | def show_instance(name=None, instance_id=None, call=None, kwargs=None):
'''
Show the details from EC2 concerning an AMI.
Can be called as an action (which requires a name):
.. code-block:: bash
salt-cloud -a show_instance myinstance
...or as a function (which requires either a name or in... | Show the details from EC2 concerning an AMI.
Can be called as an action (which requires a name):
.. code-block:: bash
salt-cloud -a show_instance myinstance
...or as a function (which requires either a name or instance_id):
.. code-block:: bash
salt-cloud -f show_instance my-ec2 na... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3482-L3516 | [
"def _get_node(name=None, instance_id=None, location=None):\n if location is None:\n location = get_location()\n\n params = {'Action': 'DescribeInstances'}\n\n if six.text_type(name).startswith('i-') and (len(name) == 10 or len(name) == 19):\n instance_id = name\n\n if instance_id:\n ... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | _extract_instance_info | python | def _extract_instance_info(instances):
'''
Given an instance query, return a dict of all instance data
'''
ret = {}
for instance in instances:
# items could be type dict or list (for stopped EC2 instances)
if isinstance(instance['instancesSet']['item'], list):
for item in... | Given an instance query, return a dict of all instance data | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3583-L3621 | null | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | _list_nodes_full | python | def _list_nodes_full(location=None):
'''
Return a list of the VMs that in this location
'''
provider = __active_provider_name__ or 'ec2'
if ':' in provider:
comps = provider.split(':')
provider = comps[0]
params = {'Action': 'DescribeInstances'}
instances = aws.query(params,... | Return a list of the VMs that in this location | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3624-L3649 | [
"def query(params=None, setname=None, requesturl=None, location=None,\n return_url=False, return_root=False, opts=None, provider=None,\n endpoint=None, product='ec2', sigver='2'):\n '''\n Perform a query against AWS services using Signature Version 2 Signing\n Process. This is documented ... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | list_nodes_min | python | def list_nodes_min(location=None, call=None):
'''
Return a list of the VMs that are on the provider. Only a list of VM names,
and their state, is returned. This is the minimum amount of information
needed to check for existing VMs.
'''
if call == 'action':
raise SaltCloudSystemExit(
... | Return a list of the VMs that are on the provider. Only a list of VM names,
and their state, is returned. This is the minimum amount of information
needed to check for existing VMs. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3652-L3688 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | list_nodes_select | python | def list_nodes_select(call=None):
'''
Return a list of the VMs that are on the provider, with select fields
'''
return salt.utils.cloud.list_nodes_select(
list_nodes_full(get_location()), __opts__['query.selection'], call,
) | Return a list of the VMs that are on the provider, with select fields | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3721-L3727 | [
"def list_nodes_full(location=None, call=None):\n '''\n Return a list of the VMs that are on the provider\n '''\n if call == 'action':\n raise SaltCloudSystemExit(\n 'The list_nodes_full function must be called with -f '\n 'or --function.'\n )\n\n return _list_node... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | show_term_protect | python | def show_term_protect(name=None, instance_id=None, call=None, quiet=False):
'''
Show the details from EC2 concerning an instance's termination protection state
'''
if call != 'action':
raise SaltCloudSystemExit(
'The show_term_protect action must be called with -a or --action.'
... | Show the details from EC2 concerning an instance's termination protection state | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3730-L3764 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | show_detailed_monitoring | python | def show_detailed_monitoring(name=None, instance_id=None, call=None, quiet=False):
'''
Show the details from EC2 regarding cloudwatch detailed monitoring.
'''
if call != 'action':
raise SaltCloudSystemExit(
'The show_detailed_monitoring action must be called with -a or --action.'
... | Show the details from EC2 regarding cloudwatch detailed monitoring. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3767-L3789 | [
"def get_location(vm_=None):\n '''\n Return the EC2 region to use, in this order:\n - CLI parameter\n - VM parameter\n - Cloud profile setting\n '''\n return __opts__.get(\n 'location',\n config.get_cloud_config_value(\n 'location',\n vm_ or get_c... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | _toggle_term_protect | python | def _toggle_term_protect(name, value):
'''
Enable or Disable termination protection on a node
'''
instance_id = _get_node(name)['instanceId']
params = {'Action': 'ModifyInstanceAttribute',
'InstanceId': instance_id,
'DisableApiTermination.Value': value}
result = aws... | Enable or Disable termination protection on a node | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3792-L3809 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | disable_detailed_monitoring | python | def disable_detailed_monitoring(name, call=None):
'''
Enable/disable detailed monitoring on a node
CLI Example:
'''
if call != 'action':
raise SaltCloudSystemExit(
'The enable_term_protect action must be called with '
'-a or --action.'
)
instance_id = _g... | Enable/disable detailed monitoring on a node
CLI Example: | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3850-L3873 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | show_delvol_on_destroy | python | def show_delvol_on_destroy(name, kwargs=None, call=None):
'''
Do not delete all/specified EBS volumes upon instance termination
CLI Example:
.. code-block:: bash
salt-cloud -a show_delvol_on_destroy mymachine
'''
if call != 'action':
raise SaltCloudSystemExit(
'Th... | Do not delete all/specified EBS volumes upon instance termination
CLI Example:
.. code-block:: bash
salt-cloud -a show_delvol_on_destroy mymachine | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3903-L3963 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | keepvol_on_destroy | python | def keepvol_on_destroy(name, kwargs=None, call=None):
'''
Do not delete all/specified EBS volumes upon instance termination
CLI Example:
.. code-block:: bash
salt-cloud -a keepvol_on_destroy mymachine
'''
if call != 'action':
raise SaltCloudSystemExit(
'The keepvol... | Do not delete all/specified EBS volumes upon instance termination
CLI Example:
.. code-block:: bash
salt-cloud -a keepvol_on_destroy mymachine | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L3966-L3988 | [
"def _toggle_delvol(name=None, instance_id=None, device=None, volume_id=None,\n value=None, requesturl=None):\n\n if not instance_id:\n instance_id = _get_node(name)['instanceId']\n\n if requesturl:\n data = aws.query(requesturl=requesturl,\n location=ge... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | register_image | python | def register_image(kwargs=None, call=None):
'''
Create an ami from a snapshot
CLI Example:
.. code-block:: bash
salt-cloud -f register_image my-ec2-config ami_name=my_ami description="my description"
root_device_name=/dev/xvda snapshot_id=snap-xxxxxxxx
'''
if call != ... | Create an ami from a snapshot
CLI Example:
.. code-block:: bash
salt-cloud -f register_image my-ec2-config ami_name=my_ami description="my description"
root_device_name=/dev/xvda snapshot_id=snap-xxxxxxxx | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4070-L4143 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | create_volume | python | def create_volume(kwargs=None, call=None, wait_to_finish=False):
'''
Create a volume.
zone
The availability zone used to create the volume. Required. String.
size
The size of the volume, in GiBs. Defaults to ``10``. Integer.
snapshot
The snapshot-id from which to create th... | Create a volume.
zone
The availability zone used to create the volume. Required. String.
size
The size of the volume, in GiBs. Defaults to ``10``. Integer.
snapshot
The snapshot-id from which to create the volume. Integer.
type
The volume type. This can be gp2 for Gen... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4154-L4282 | [
"def iteritems(d, **kw):\n return d.iteritems(**kw)\n",
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n ... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | attach_volume | python | def attach_volume(name=None, kwargs=None, instance_id=None, call=None):
'''
Attach a volume to an instance
'''
if call != 'action':
raise SaltCloudSystemExit(
'The attach_volume action must be called with -a or --action.'
)
if not kwargs:
kwargs = {}
if 'ins... | Attach a volume to an instance | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4302-L4352 | [
"def get_cloud_config_value(name, vm_, opts, default=None, search_global=True):\n '''\n Search and return a setting in a known order:\n\n 1. In the virtual machine's configuration\n 2. In the virtual machine's profile configuration\n 3. In the virtual machine's provider configuration\n ... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | describe_volumes | python | def describe_volumes(kwargs=None, call=None):
'''
Describe a volume (or volumes)
volume_id
One or more volume IDs. Multiple IDs must be separated by ",".
TODO: Add all of the filters.
'''
if call != 'function':
log.error(
'The describe_volumes function must be calle... | Describe a volume (or volumes)
volume_id
One or more volume IDs. Multiple IDs must be separated by ",".
TODO: Add all of the filters. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4426-L4460 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | create_keypair | python | def create_keypair(kwargs=None, call=None):
'''
Create an SSH keypair
'''
if call != 'function':
log.error(
'The create_keypair function must be called with -f or --function.'
)
return False
if not kwargs:
kwargs = {}
if 'keyname' not in kwargs:
... | Create an SSH keypair | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4463-L4492 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | import_keypair | python | def import_keypair(kwargs=None, call=None):
'''
Import an SSH public key.
.. versionadded:: 2015.8.3
'''
if call != 'function':
log.error(
'The import_keypair function must be called with -f or --function.'
)
return False
if not kwargs:
kwargs = {}
... | Import an SSH public key.
.. versionadded:: 2015.8.3 | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4495-L4536 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | delete_keypair | python | def delete_keypair(kwargs=None, call=None):
'''
Delete an SSH keypair
'''
if call != 'function':
log.error(
'The delete_keypair function must be called with -f or --function.'
)
return False
if not kwargs:
kwargs = {}
if 'keyname' not in kwargs:
... | Delete an SSH keypair | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4568-L4594 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | create_snapshot | python | def create_snapshot(kwargs=None, call=None, wait_to_finish=False):
'''
Create a snapshot.
volume_id
The ID of the Volume from which to create a snapshot.
description
The optional description of the snapshot.
CLI Exampe:
.. code-block:: bash
salt-cloud -f create_snaps... | Create a snapshot.
volume_id
The ID of the Volume from which to create a snapshot.
description
The optional description of the snapshot.
CLI Exampe:
.. code-block:: bash
salt-cloud -f create_snapshot my-ec2-config volume_id=vol-351d8826
salt-cloud -f create_snapshot ... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4597-L4662 | [
"def iteritems(d, **kw):\n return d.iteritems(**kw)\n",
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n ... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | copy_snapshot | python | def copy_snapshot(kwargs=None, call=None):
'''
Copy a snapshot
'''
if call != 'function':
log.error(
'The copy_snapshot function must be called with -f or --function.'
)
return False
if 'source_region' not in kwargs:
log.error('A source_region must be spe... | Copy a snapshot | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4696-L4736 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | describe_snapshots | python | def describe_snapshots(kwargs=None, call=None):
'''
Describe a snapshot (or snapshots)
snapshot_id
One or more snapshot IDs. Multiple IDs must be separated by ",".
owner
Return the snapshots owned by the specified owner. Valid values
include: self, amazon, <AWS Account ID>. Mul... | Describe a snapshot (or snapshots)
snapshot_id
One or more snapshot IDs. Multiple IDs must be separated by ",".
owner
Return the snapshots owned by the specified owner. Valid values
include: self, amazon, <AWS Account ID>. Multiple values must be
separated by ",".
restorab... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4739-L4795 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | get_console_output | python | def get_console_output(
name=None,
location=None,
instance_id=None,
call=None,
kwargs=None,
):
'''
Show the console output from the instance.
By default, returns decoded data, not the Base64-encoded data that is
actually returned from the EC2 API.
'''
... | Show the console output from the instance.
By default, returns decoded data, not the Base64-encoded data that is
actually returned from the EC2 API. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4798-L4848 | [
"def iterkeys(d, **kw):\n return d.iterkeys(**kw)\n",
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n pr... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | get_password_data | python | def get_password_data(
name=None,
kwargs=None,
instance_id=None,
call=None,
):
'''
Return password data for a Windows instance.
By default only the encrypted password data will be returned. However, if a
key_file is passed in, then a decrypted password will also be r... | Return password data for a Windows instance.
By default only the encrypted password data will be returned. However, if a
key_file is passed in, then a decrypted password will also be returned.
Note that the key_file references the private key that was used to generate
the keypair associated with this ... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4851-L4932 | [
"def iterkeys(d, **kw):\n return d.iterkeys(**kw)\n",
"def itervalues(d, **kw):\n return d.itervalues(**kw)\n",
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | update_pricing | python | def update_pricing(kwargs=None, call=None):
'''
Download most recent pricing information from AWS and convert to a local
JSON file.
CLI Examples:
.. code-block:: bash
salt-cloud -f update_pricing my-ec2-config
salt-cloud -f update_pricing my-ec2-config type=linux
.. versionad... | Download most recent pricing information from AWS and convert to a local
JSON file.
CLI Examples:
.. code-block:: bash
salt-cloud -f update_pricing my-ec2-config
salt-cloud -f update_pricing my-ec2-config type=linux
.. versionadded:: 2015.8.0 | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4935-L4965 | [
"def _parse_pricing(url, name):\n '''\n Download and parse an individual pricing file from AWS\n\n .. versionadded:: 2015.8.0\n '''\n price_js = http.query(url, text=True)\n\n items = []\n current_item = ''\n\n price_js = re.sub(JS_COMMENT_RE, '', price_js['text'])\n price_js = price_js.s... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | _parse_pricing | python | def _parse_pricing(url, name):
'''
Download and parse an individual pricing file from AWS
.. versionadded:: 2015.8.0
'''
price_js = http.query(url, text=True)
items = []
current_item = ''
price_js = re.sub(JS_COMMENT_RE, '', price_js['text'])
price_js = price_js.strip().rstrip(');... | Download and parse an individual pricing file from AWS
.. versionadded:: 2015.8.0 | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L4968-L5021 | [
"def pack(o, stream, **kwargs):\n '''\n .. versionadded:: 2018.3.4\n\n Wraps msgpack.pack and ensures that the passed object is unwrapped if it is\n a proxy.\n\n By default, this function uses the msgpack module and falls back to\n msgpack_pure, if the msgpack is not available. You can pass an alt... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | show_pricing | python | def show_pricing(kwargs=None, call=None):
'''
Show pricing for a particular profile. This is only an estimate, based on
unofficial pricing sources.
CLI Examples:
.. code-block:: bash
salt-cloud -f show_pricing my-ec2-config profile=my-profile
If pricing sources have not been cached, ... | Show pricing for a particular profile. This is only an estimate, based on
unofficial pricing sources.
CLI Examples:
.. code-block:: bash
salt-cloud -f show_pricing my-ec2-config profile=my-profile
If pricing sources have not been cached, they will be downloaded. Once they
have been cache... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L5024-L5115 | [
"def unpack(stream, **kwargs):\n '''\n .. versionadded:: 2018.3.4\n\n Wraps msgpack.unpack.\n\n By default, this function uses the msgpack module and falls back to\n msgpack_pure, if the msgpack is not available. You can pass an alternate\n msgpack module using the _msgpack_module argument.\n '... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/cloud/clouds/ec2.py | ssm_create_association | python | def ssm_create_association(name=None, kwargs=None, instance_id=None, call=None):
'''
Associates the specified SSM document with the specified instance
http://docs.aws.amazon.com/ssm/latest/APIReference/API_CreateAssociation.html
CLI Examples:
.. code-block:: bash
salt-cloud -a ssm_create... | Associates the specified SSM document with the specified instance
http://docs.aws.amazon.com/ssm/latest/APIReference/API_CreateAssociation.html
CLI Examples:
.. code-block:: bash
salt-cloud -a ssm_create_association ec2-instance-name ssm_document=ssm-document-name | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cloud/clouds/ec2.py#L5118-L5166 | [
"def get_provider(vm_=None):\n '''\n Extract the provider name from vm\n '''\n if vm_ is None:\n provider = __active_provider_name__ or 'ec2'\n else:\n provider = vm_.get('provider', 'ec2')\n\n if ':' in provider:\n prov_comps = provider.split(':')\n provider = prov_com... | # -*- coding: utf-8 -*-
'''
The EC2 Cloud Module
====================
The EC2 cloud module is used to interact with the Amazon Elastic Compute Cloud.
To use the EC2 cloud module, set up the cloud configuration at
``/etc/salt/cloud.providers`` or ``/etc/salt/cloud.providers.d/ec2.conf``:
.. code-block:: yaml
my... |
saltstack/salt | salt/modules/vagrant.py | _build_machine_uri | python | def _build_machine_uri(machine, cwd):
'''
returns string used to fetch id names from the sdb store.
the cwd and machine name are concatenated with '?' which should
never collide with a Salt node id -- which is important since we
will be storing both in the same table.
'''
key = '{}?{}'.form... | returns string used to fetch id names from the sdb store.
the cwd and machine name are concatenated with '?' which should
never collide with a Salt node id -- which is important since we
will be storing both in the same table. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L70-L79 | [
"def _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n"
] | # -*- coding: utf-8 -*-
'''
Work with virtual machines managed by Vagrant.
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sd... |
saltstack/salt | salt/modules/vagrant.py | _update_vm_info | python | def _update_vm_info(name, vm_):
''' store the vm_ information keyed by name '''
__utils__['sdb.sdb_set'](_build_sdb_uri(name), vm_, __opts__)
# store machine-to-name mapping, too
if vm_['machine']:
__utils__['sdb.sdb_set'](
_build_machine_uri(vm_['machine'], vm_.get('cwd', '.')),
... | store the vm_ information keyed by name | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L82-L91 | null | # -*- coding: utf-8 -*-
'''
Work with virtual machines managed by Vagrant.
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sd... |
saltstack/salt | salt/modules/vagrant.py | get_vm_info | python | def get_vm_info(name):
'''
get the information for a VM.
:param name: salt_id name
:return: dictionary of {'machine': x, 'cwd': y, ...}.
'''
try:
vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)
except KeyError:
raise SaltInvocationError(
'Probable ... | get the information for a VM.
:param name: salt_id name
:return: dictionary of {'machine': x, 'cwd': y, ...}. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L94-L109 | [
"def _build_sdb_uri(key):\n '''\n returns string used to fetch data for \"key\" from the sdb store.\n\n Salt node id's are used as the key for vm_ dicts.\n\n '''\n return '{}{}'.format(VAGRANT_SDB_URL, key)\n"
] | # -*- coding: utf-8 -*-
'''
Work with virtual machines managed by Vagrant.
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sd... |
saltstack/salt | salt/modules/vagrant.py | get_machine_id | python | def get_machine_id(machine, cwd):
'''
returns the salt_id name of the Vagrant VM
:param machine: the Vagrant machine name
:param cwd: the path to Vagrantfile
:return: salt_id name
'''
name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)
return name | returns the salt_id name of the Vagrant VM
:param machine: the Vagrant machine name
:param cwd: the path to Vagrantfile
:return: salt_id name | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L112-L121 | [
"def _build_machine_uri(machine, cwd):\n '''\n returns string used to fetch id names from the sdb store.\n\n the cwd and machine name are concatenated with '?' which should\n never collide with a Salt node id -- which is important since we\n will be storing both in the same table.\n '''\n key =... | # -*- coding: utf-8 -*-
'''
Work with virtual machines managed by Vagrant.
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sd... |
saltstack/salt | salt/modules/vagrant.py | _erase_vm_info | python | def _erase_vm_info(name):
'''
erase the information for a VM the we are destroying.
some sdb drivers (such as the SQLite driver we expect to use)
do not have a `delete` method, so if the delete fails, we have
to replace the with a blank entry.
'''
try:
# delete the machine record
... | erase the information for a VM the we are destroying.
some sdb drivers (such as the SQLite driver we expect to use)
do not have a `delete` method, so if the delete fails, we have
to replace the with a blank entry. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L124-L153 | [
"def get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n ... | # -*- coding: utf-8 -*-
'''
Work with virtual machines managed by Vagrant.
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sd... |
saltstack/salt | salt/modules/vagrant.py | _vagrant_ssh_config | python | def _vagrant_ssh_config(vm_):
'''
get the information for ssh communication from the new VM
:param vm_: the VM's info as we have it now
:return: dictionary of ssh stuff
'''
machine = vm_['machine']
log.info('requesting vagrant ssh-config for VM %s', machine or '(default)')
cmd = 'vagran... | get the information for ssh communication from the new VM
:param vm_: the VM's info as we have it now
:return: dictionary of ssh stuff | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L156-L176 | null | # -*- coding: utf-8 -*-
'''
Work with virtual machines managed by Vagrant.
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sd... |
saltstack/salt | salt/modules/vagrant.py | list_domains | python | def list_domains():
'''
Return a list of the salt_id names of all available Vagrant VMs on
this host without regard to the path where they are defined.
CLI Example:
.. code-block:: bash
salt '*' vagrant.list_domains --log-level=info
The log shows information about all known Vagrant e... | Return a list of the salt_id names of all available Vagrant VMs on
this host without regard to the path where they are defined.
CLI Example:
.. code-block:: bash
salt '*' vagrant.list_domains --log-level=info
The log shows information about all known Vagrant environments
on this machine.... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L193-L223 | [
"def get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n... | # -*- coding: utf-8 -*-
'''
Work with virtual machines managed by Vagrant.
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sd... |
saltstack/salt | salt/modules/vagrant.py | list_active_vms | python | def list_active_vms(cwd=None):
'''
Return a list of machine names for active virtual machine on the host,
which are defined in the Vagrantfile at the indicated path.
CLI Example:
.. code-block:: bash
salt '*' vagrant.list_active_vms cwd=/projects/project_1
'''
vms = []
cmd = ... | Return a list of machine names for active virtual machine on the host,
which are defined in the Vagrantfile at the indicated path.
CLI Example:
.. code-block:: bash
salt '*' vagrant.list_active_vms cwd=/projects/project_1 | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L226-L246 | null | # -*- coding: utf-8 -*-
'''
Work with virtual machines managed by Vagrant.
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sd... |
saltstack/salt | salt/modules/vagrant.py | vm_state | python | def vm_state(name='', cwd=None):
'''
Return list of information for all the vms indicating their state.
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs defined by
the Vagrantfile in the `cwd` directory.
CLI Example:
... | Return list of information for all the vms indicating their state.
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs defined by
the Vagrantfile in the `cwd` directory.
CLI Example:
.. code-block:: bash
salt '*' vagran... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L273-L330 | [
"def get_machine_id(machine, cwd):\n '''\n returns the salt_id name of the Vagrant VM\n\n :param machine: the Vagrant machine name\n :param cwd: the path to Vagrantfile\n :return: salt_id name\n '''\n name = __utils__['sdb.sdb_get'](_build_machine_uri(machine, cwd), __opts__)\n return name\n... | # -*- coding: utf-8 -*-
'''
Work with virtual machines managed by Vagrant.
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sd... |
saltstack/salt | salt/modules/vagrant.py | init | python | def init(name, # Salt_id for created VM
cwd=None, # path to find Vagrantfile
machine='', # name of machine in Vagrantfile
runas=None, # username who owns Vagrant box
start=False, # start the machine when initialized
vagrant_provider='', # vagrant provider (default=virt... | Initialize a new Vagrant VM.
This inputs all the information needed to start a Vagrant VM. These settings are stored in
a Salt sdb database on the Vagrant host minion and used to start, control, and query the
guest VMs. The salt_id assigned here is the key field for that database and must be unique.
... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L333-L380 | [
"def _start(name, vm_): # internal call name, because \"start\" is a keyword argument to vagrant.init\n\n try:\n machine = vm_['machine']\n except KeyError:\n raise SaltInvocationError('No Vagrant machine defined for Salt_id {}'.format(name))\n\n vagrant_provider = vm_.get('vagrant_provider'... | # -*- coding: utf-8 -*-
'''
Work with virtual machines managed by Vagrant.
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sd... |
saltstack/salt | salt/modules/vagrant.py | stop | python | def stop(name):
'''
Hard shutdown the virtual machine. (vagrant halt)
CLI Example:
.. code-block:: bash
salt <host> vagrant.stop <salt_id>
'''
vm_ = get_vm_info(name)
machine = vm_['machine']
cmd = 'vagrant halt {}'.format(machine)
ret = __salt__['cmd.retcode'](cmd,
... | Hard shutdown the virtual machine. (vagrant halt)
CLI Example:
.. code-block:: bash
salt <host> vagrant.stop <salt_id> | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L440-L457 | [
"def get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n ... | # -*- coding: utf-8 -*-
'''
Work with virtual machines managed by Vagrant.
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sd... |
saltstack/salt | salt/modules/vagrant.py | reboot | python | def reboot(name, provision=False):
'''
Reboot a VM. (vagrant reload)
CLI Example:
.. code-block:: bash
salt <host> vagrant.reboot <salt_id> provision=True
:param name: The salt_id name you will use to control this VM
:param provision: (False) also re-run the Vagrant provisioning scri... | Reboot a VM. (vagrant reload)
CLI Example:
.. code-block:: bash
salt <host> vagrant.reboot <salt_id> provision=True
:param name: The salt_id name you will use to control this VM
:param provision: (False) also re-run the Vagrant provisioning scripts. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L480-L501 | [
"def get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n ... | # -*- coding: utf-8 -*-
'''
Work with virtual machines managed by Vagrant.
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sd... |
saltstack/salt | salt/modules/vagrant.py | destroy | python | def destroy(name):
'''
Destroy and delete a virtual machine. (vagrant destroy -f)
This also removes the salt_id name defined by vagrant.init.
CLI Example:
.. code-block:: bash
salt <host> vagrant.destroy <salt_id>
'''
vm_ = get_vm_info(name)
machine = vm_['machine']
cmd ... | Destroy and delete a virtual machine. (vagrant destroy -f)
This also removes the salt_id name defined by vagrant.init.
CLI Example:
.. code-block:: bash
salt <host> vagrant.destroy <salt_id> | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L504-L528 | [
"def get_vm_info(name):\n '''\n get the information for a VM.\n\n :param name: salt_id name\n :return: dictionary of {'machine': x, 'cwd': y, ...}.\n '''\n try:\n vm_ = __utils__['sdb.sdb_get'](_build_sdb_uri(name), __opts__)\n except KeyError:\n raise SaltInvocationError(\n ... | # -*- coding: utf-8 -*-
'''
Work with virtual machines managed by Vagrant.
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sd... |
saltstack/salt | salt/modules/vagrant.py | get_ssh_config | python | def get_ssh_config(name, network_mask='', get_private_key=False):
r'''
Retrieve hints of how you might connect to a Vagrant VM.
:param name: the salt_id of the machine
:param network_mask: a CIDR mask to search for the VM's address
:param get_private_key: (default: False) return the key used for ss... | r'''
Retrieve hints of how you might connect to a Vagrant VM.
:param name: the salt_id of the machine
:param network_mask: a CIDR mask to search for the VM's address
:param get_private_key: (default: False) return the key used for ssh login
:return: a dict of ssh login information for the VM
C... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/vagrant.py#L531-L632 | [
"def fopen(*args, **kwargs):\n '''\n Wrapper around open() built-in to set CLOEXEC on the fd.\n\n This flag specifies that the file descriptor should be closed when an exec\n function is invoked;\n\n When a file descriptor is allocated (as with open or dup), this bit is\n initially cleared on the ... | # -*- coding: utf-8 -*-
'''
Work with virtual machines managed by Vagrant.
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sd... |
saltstack/salt | salt/states/esxvm.py | vm_configured | python | def vm_configured(name, vm_name, cpu, memory, image, version, interfaces,
disks, scsi_devices, serial_ports, datacenter, datastore,
placement, cd_dvd_drives=None, sata_controllers=None,
advanced_configs=None, template=None, tools=True,
power_on=Fal... | Selects the correct operation to be executed on a virtual machine, non
existing machines will be created, existing ones will be updated if the
config differs. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/esxvm.py#L227-L312 | [
"def vm_registered(vm_name, datacenter, placement, vm_file, power_on=False):\n '''\n Registers a virtual machine if the machine files are available on\n the main datastore.\n '''\n result = {'name': vm_name,\n 'result': None,\n 'changes': {},\n 'comment': ''}\n\... | # -*- coding: utf-8 -*-
'''
Salt state to create, update VMware ESXi Virtual Machines.
Dependencies
============
- pyVmomi
- jsonschema
States
======
vm_configured
-------------
Enforces correct virtual machine configuration. Creates, updates and registers
a virtual machine.
This state identifies the action which... |
saltstack/salt | salt/states/esxvm.py | vm_updated | python | def vm_updated(name, vm_name, cpu, memory, image, version, interfaces,
disks, scsi_devices, serial_ports, datacenter, datastore,
cd_dvd_drives=None, sata_controllers=None,
advanced_configs=None, power_on=False):
'''
Updates a virtual machine configuration if there is... | Updates a virtual machine configuration if there is a difference between
the given and deployed configuration. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/esxvm.py#L328-L421 | [
"def iteritems(d, **kw):\n return d.iteritems(**kw)\n"
] | # -*- coding: utf-8 -*-
'''
Salt state to create, update VMware ESXi Virtual Machines.
Dependencies
============
- pyVmomi
- jsonschema
States
======
vm_configured
-------------
Enforces correct virtual machine configuration. Creates, updates and registers
a virtual machine.
This state identifies the action which... |
saltstack/salt | salt/states/esxvm.py | vm_created | python | def vm_created(name, vm_name, cpu, memory, image, version, interfaces,
disks, scsi_devices, serial_ports, datacenter, datastore,
placement, ide_controllers=None, sata_controllers=None,
cd_dvd_drives=None, advanced_configs=None, power_on=False):
'''
Creates a virtual ... | Creates a virtual machine with the given properties if it doesn't exist. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/esxvm.py#L424-L484 | null | # -*- coding: utf-8 -*-
'''
Salt state to create, update VMware ESXi Virtual Machines.
Dependencies
============
- pyVmomi
- jsonschema
States
======
vm_configured
-------------
Enforces correct virtual machine configuration. Creates, updates and registers
a virtual machine.
This state identifies the action which... |
saltstack/salt | salt/states/esxvm.py | vm_registered | python | def vm_registered(vm_name, datacenter, placement, vm_file, power_on=False):
'''
Registers a virtual machine if the machine files are available on
the main datastore.
'''
result = {'name': vm_name,
'result': None,
'changes': {},
'comment': ''}
vmx_path =... | Registers a virtual machine if the machine files are available on
the main datastore. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/esxvm.py#L487-L537 | null | # -*- coding: utf-8 -*-
'''
Salt state to create, update VMware ESXi Virtual Machines.
Dependencies
============
- pyVmomi
- jsonschema
States
======
vm_configured
-------------
Enforces correct virtual machine configuration. Creates, updates and registers
a virtual machine.
This state identifies the action which... |
saltstack/salt | salt/states/npm.py | installed | python | def installed(name,
pkgs=None,
dir=None,
user=None,
force_reinstall=False,
registry=None,
env=None):
'''
Verify that the given package is installed and is at the correct version
(if specified).
.. code-block:: yaml
... | Verify that the given package is installed and is at the correct version
(if specified).
.. code-block:: yaml
coffee-script:
npm.installed:
- user: someuser
coffee-script@1.0.1:
npm.installed: []
name
The package to install
.. versionchang... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/npm.py#L38-L223 | [
"def iteritems(d, **kw):\n return d.iteritems(**kw)\n",
"def _pkg_is_installed(pkg, installed_pkgs):\n '''\n Helper function to determine if a package is installed\n\n This performs more complex comparison than just checking\n keys, such as examining source repos to see if the package\n was inst... | # -*- coding: utf-8 -*-
'''
Installation of NPM Packages
============================
These states manage the installed packages for node.js using the Node Package
Manager (npm). Note that npm must be installed for these states to be
available, so npm states should include a requisite to a pkg.installed state
for the ... |
saltstack/salt | salt/states/npm.py | removed | python | def removed(name, dir=None, user=None):
'''
Verify that the given package is not installed.
dir
The target directory in which to install the package, or None for
global installation
user
The user to run NPM with
.. versionadded:: 0.17.0
'''
ret = {'name': name,... | Verify that the given package is not installed.
dir
The target directory in which to install the package, or None for
global installation
user
The user to run NPM with
.. versionadded:: 0.17.0 | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/npm.py#L226-L266 | null | # -*- coding: utf-8 -*-
'''
Installation of NPM Packages
============================
These states manage the installed packages for node.js using the Node Package
Manager (npm). Note that npm must be installed for these states to be
available, so npm states should include a requisite to a pkg.installed state
for the ... |
saltstack/salt | salt/states/npm.py | bootstrap | python | def bootstrap(name, user=None, silent=True):
'''
Bootstraps a node.js application.
Will execute 'npm install --json' on the specified directory.
user
The user to run NPM with
.. versionadded:: 0.17.0
'''
ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}
i... | Bootstraps a node.js application.
Will execute 'npm install --json' on the specified directory.
user
The user to run NPM with
.. versionadded:: 0.17.0 | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/npm.py#L269-L319 | null | # -*- coding: utf-8 -*-
'''
Installation of NPM Packages
============================
These states manage the installed packages for node.js using the Node Package
Manager (npm). Note that npm must be installed for these states to be
available, so npm states should include a requisite to a pkg.installed state
for the ... |
saltstack/salt | salt/states/npm.py | cache_cleaned | python | def cache_cleaned(name=None,
user=None,
force=False):
'''
Ensure that the given package is not cached.
If no package is specified, this ensures the entire cache is cleared.
name
The name of the package to remove from the cache, or None for all packages
... | Ensure that the given package is not cached.
If no package is specified, this ensures the entire cache is cleared.
name
The name of the package to remove from the cache, or None for all packages
user
The user to run NPM with
force
Force cleaning of cache. Required for npm@5 ... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/npm.py#L322-L378 | null | # -*- coding: utf-8 -*-
'''
Installation of NPM Packages
============================
These states manage the installed packages for node.js using the Node Package
Manager (npm). Note that npm must be installed for these states to be
available, so npm states should include a requisite to a pkg.installed state
for the ... |
saltstack/salt | salt/states/splunk_search.py | present | python | def present(name, profile="splunk", **kwargs):
'''
Ensure a search is present
.. code-block:: yaml
API Error Search:
splunk_search.present:
search: index=main sourcetype=blah
template: alert_5min
The following parameters are required:
name
This i... | Ensure a search is present
.. code-block:: yaml
API Error Search:
splunk_search.present:
search: index=main sourcetype=blah
template: alert_5min
The following parameters are required:
name
This is the name of the search in splunk | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/splunk_search.py#L26-L87 | null | # -*- coding: utf-8 -*-
'''
Splunk Search State Module
.. versionadded:: 2015.5.0
This state is used to ensure presence of splunk searches.
.. code-block:: yaml
server-warning-message:
splunk_search.present:
- name: This is the splunk search name
- search: index=main sourcetype=
'''
from _... |
saltstack/salt | salt/states/splunk_search.py | absent | python | def absent(name, profile="splunk"):
'''
Ensure a search is absent
.. code-block:: yaml
API Error Search:
splunk_search.absent
The following parameters are required:
name
This is the name of the search in splunk
'''
ret = {
'name': name,
'changes'... | Ensure a search is absent
.. code-block:: yaml
API Error Search:
splunk_search.absent
The following parameters are required:
name
This is the name of the search in splunk | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/splunk_search.py#L90-L126 | null | # -*- coding: utf-8 -*-
'''
Splunk Search State Module
.. versionadded:: 2015.5.0
This state is used to ensure presence of splunk searches.
.. code-block:: yaml
server-warning-message:
splunk_search.present:
- name: This is the splunk search name
- search: index=main sourcetype=
'''
from _... |
saltstack/salt | salt/states/modjk.py | _bulk_state | python | def _bulk_state(saltfunc, lbn, workers, profile):
'''
Generic function for bulk worker operation
'''
ret = {'name': lbn,
'result': True,
'changes': {},
'comment': ''}
if not isinstance(workers, list):
ret['result'] = False
ret['comment'] = 'workers s... | Generic function for bulk worker operation | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/modjk.py#L24-L64 | [
"def iteritems(d, **kw):\n return d.iteritems(**kw)\n"
] | # -*- coding: utf-8 -*-
'''
State to control Apache modjk
'''
# Python Libs
from __future__ import absolute_import, print_function, unicode_literals
import logging
# Import 3rd-party libs
from salt.ext import six
log = logging.getLogger(__name__)
def __virtual__():
'''
Load this state if modjk is loaded
... |
saltstack/salt | salt/states/modjk.py | worker_stopped | python | def worker_stopped(name, workers=None, profile='default'):
'''
Stop all the workers in the modjk load balancer
Example:
.. code-block:: yaml
loadbalancer:
modjk.worker_stopped:
- workers:
- app1
- app2
'''
if workers is None:
w... | Stop all the workers in the modjk load balancer
Example:
.. code-block:: yaml
loadbalancer:
modjk.worker_stopped:
- workers:
- app1
- app2 | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/modjk.py#L67-L85 | [
"def _bulk_state(saltfunc, lbn, workers, profile):\n '''\n Generic function for bulk worker operation\n '''\n ret = {'name': lbn,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n if not isinstance(workers, list):\n ret['result'] = False\n ret['commen... | # -*- coding: utf-8 -*-
'''
State to control Apache modjk
'''
# Python Libs
from __future__ import absolute_import, print_function, unicode_literals
import logging
# Import 3rd-party libs
from salt.ext import six
log = logging.getLogger(__name__)
def __virtual__():
'''
Load this state if modjk is loaded
... |
saltstack/salt | salt/states/modjk.py | worker_activated | python | def worker_activated(name, workers=None, profile='default'):
'''
Activate all the workers in the modjk load balancer
Example:
.. code-block:: yaml
loadbalancer:
modjk.worker_activated:
- workers:
- app1
- app2
'''
if workers is None:
... | Activate all the workers in the modjk load balancer
Example:
.. code-block:: yaml
loadbalancer:
modjk.worker_activated:
- workers:
- app1
- app2 | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/modjk.py#L88-L106 | [
"def _bulk_state(saltfunc, lbn, workers, profile):\n '''\n Generic function for bulk worker operation\n '''\n ret = {'name': lbn,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n if not isinstance(workers, list):\n ret['result'] = False\n ret['commen... | # -*- coding: utf-8 -*-
'''
State to control Apache modjk
'''
# Python Libs
from __future__ import absolute_import, print_function, unicode_literals
import logging
# Import 3rd-party libs
from salt.ext import six
log = logging.getLogger(__name__)
def __virtual__():
'''
Load this state if modjk is loaded
... |
saltstack/salt | salt/states/modjk.py | worker_disabled | python | def worker_disabled(name, workers=None, profile='default'):
'''
Disable all the workers in the modjk load balancer
Example:
.. code-block:: yaml
loadbalancer:
modjk.worker_disabled:
- workers:
- app1
- app2
'''
if workers is None:
... | Disable all the workers in the modjk load balancer
Example:
.. code-block:: yaml
loadbalancer:
modjk.worker_disabled:
- workers:
- app1
- app2 | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/modjk.py#L109-L127 | [
"def _bulk_state(saltfunc, lbn, workers, profile):\n '''\n Generic function for bulk worker operation\n '''\n ret = {'name': lbn,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n if not isinstance(workers, list):\n ret['result'] = False\n ret['commen... | # -*- coding: utf-8 -*-
'''
State to control Apache modjk
'''
# Python Libs
from __future__ import absolute_import, print_function, unicode_literals
import logging
# Import 3rd-party libs
from salt.ext import six
log = logging.getLogger(__name__)
def __virtual__():
'''
Load this state if modjk is loaded
... |
saltstack/salt | salt/states/modjk.py | worker_recover | python | def worker_recover(name, workers=None, profile='default'):
'''
Recover all the workers in the modjk load balancer
Example:
.. code-block:: yaml
loadbalancer:
modjk.worker_recover:
- workers:
- app1
- app2
'''
if workers is None:
... | Recover all the workers in the modjk load balancer
Example:
.. code-block:: yaml
loadbalancer:
modjk.worker_recover:
- workers:
- app1
- app2 | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/modjk.py#L130-L148 | [
"def _bulk_state(saltfunc, lbn, workers, profile):\n '''\n Generic function for bulk worker operation\n '''\n ret = {'name': lbn,\n 'result': True,\n 'changes': {},\n 'comment': ''}\n\n if not isinstance(workers, list):\n ret['result'] = False\n ret['commen... | # -*- coding: utf-8 -*-
'''
State to control Apache modjk
'''
# Python Libs
from __future__ import absolute_import, print_function, unicode_literals
import logging
# Import 3rd-party libs
from salt.ext import six
log = logging.getLogger(__name__)
def __virtual__():
'''
Load this state if modjk is loaded
... |
saltstack/salt | salt/states/firewalld.py | _parse_forward | python | def _parse_forward(mapping):
'''
Parses a port forwarding statement in the form used by this state:
from_port:to_port:protocol[:destination]
and returns a ForwardingMapping object
'''
if len(mapping.split(':')) > 3:
(srcport, destport, protocol, destaddr) = mapping.split(':')
else:... | Parses a port forwarding statement in the form used by this state:
from_port:to_port:protocol[:destination]
and returns a ForwardingMapping object | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/firewalld.py#L129-L142 | null | # -*- coding: utf-8 -*-
'''
Management of firewalld
.. versionadded:: 2015.8.0
The following example applies changes to the public zone, blocks echo-reply
and echo-request packets, does not set the zone to be the default, enables
masquerading, and allows ports 22/tcp and 25/tcp.
It will be applied permanently and dir... |
saltstack/salt | salt/states/firewalld.py | present | python | def present(name,
block_icmp=None,
prune_block_icmp=False,
default=None,
masquerade=False,
ports=None,
prune_ports=False,
port_fwd=None,
prune_port_fwd=False,
services=None,
prune_services=False,
... | Ensure a zone has specific attributes.
name
The zone to modify.
default : None
Set this zone as the default zone if ``True``.
masquerade : False
Enable or disable masquerade for a zone.
block_icmp : None
List of ICMP types to block in the zone.
prune_block_icmp :... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/firewalld.py#L155-L236 | [
"def _present(name,\n block_icmp=None,\n prune_block_icmp=False,\n default=None,\n masquerade=False,\n ports=None,\n prune_ports=False,\n port_fwd=None,\n prune_port_fwd=False,\n services=None,\n # TODO: pr... | # -*- coding: utf-8 -*-
'''
Management of firewalld
.. versionadded:: 2015.8.0
The following example applies changes to the public zone, blocks echo-reply
and echo-request packets, does not set the zone to be the default, enables
masquerading, and allows ports 22/tcp and 25/tcp.
It will be applied permanently and dir... |
saltstack/salt | salt/states/firewalld.py | service | python | def service(name,
ports=None,
protocols=None):
'''
Ensure the service exists and encompasses the specified ports and
protocols.
.. versionadded:: 2016.11.0
'''
ret = {'name': name,
'result': False,
'changes': {},
'comment': ''}
if na... | Ensure the service exists and encompasses the specified ports and
protocols.
.. versionadded:: 2016.11.0 | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/firewalld.py#L239-L335 | null | # -*- coding: utf-8 -*-
'''
Management of firewalld
.. versionadded:: 2015.8.0
The following example applies changes to the public zone, blocks echo-reply
and echo-request packets, does not set the zone to be the default, enables
masquerading, and allows ports 22/tcp and 25/tcp.
It will be applied permanently and dir... |
saltstack/salt | salt/states/firewalld.py | _present | python | def _present(name,
block_icmp=None,
prune_block_icmp=False,
default=None,
masquerade=False,
ports=None,
prune_ports=False,
port_fwd=None,
prune_port_fwd=False,
services=None,
# TODO: prune_services=Fa... | Ensure a zone has specific attributes. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/firewalld.py#L338-L766 | [
"def output(ret, **kwargs):\n '''\n Display ret data\n '''\n # Prefer kwargs before opts\n retcode = kwargs.get('_retcode', 0)\n base_indent = kwargs.get('nested_indent', 0) \\\n or __opts__.get('nested_indent', 0)\n nest = NestDisplay(retcode=retcode)\n lines = nest.display(ret, base... | # -*- coding: utf-8 -*-
'''
Management of firewalld
.. versionadded:: 2015.8.0
The following example applies changes to the public zone, blocks echo-reply
and echo-request packets, does not set the zone to be the default, enables
masquerading, and allows ports 22/tcp and 25/tcp.
It will be applied permanently and dir... |
saltstack/salt | salt/states/firewalld.py | ForwardingMapping.todict | python | def todict(self):
'''
Returns a pretty dictionary meant for command line output.
'''
return {
'Source port': self.srcport,
'Destination port': self.destport,
'Protocol': self.protocol,
'Destination address': self.destaddr} | Returns a pretty dictionary meant for command line output. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/firewalld.py#L118-L126 | null | class ForwardingMapping(object):
'''
Represents a port forwarding statement mapping a local port to a remote
port for a specific protocol (TCP or UDP)
'''
def __init__(self, srcport, destport, protocol, destaddr):
self.srcport = srcport
self.destport = destport
self.protocol ... |
saltstack/salt | salt/modules/jenkinsmod.py | _connect | python | def _connect():
'''
Return server object used to interact with Jenkins.
:return: server object used to interact with Jenkins
'''
jenkins_url = __salt__['config.get']('jenkins.url') or \
__salt__['config.get']('jenkins:url') or \
__salt__['pillar.get']('jenkins.url')
jenkins_use... | Return server object used to interact with Jenkins.
:return: server object used to interact with Jenkins | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/jenkinsmod.py#L69-L92 | null | # -*- coding: utf-8 -*-
'''
Module for controlling Jenkins
:depends: python-jenkins
.. versionadded:: 2016.3.0
:depends: python-jenkins_ Python module (not to be confused with jenkins_)
.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins
.. _jenkins: https://pypi.python.org/pypi/jenkins
:configuration:... |
saltstack/salt | salt/modules/jenkinsmod.py | _retrieve_config_xml | python | def _retrieve_config_xml(config_xml, saltenv):
'''
Helper to cache the config XML and raise a CommandExecutionError if we fail
to do so. If we successfully cache the file, return the cached path.
'''
ret = __salt__['cp.cache_file'](config_xml, saltenv)
if not ret:
raise CommandExecution... | Helper to cache the config XML and raise a CommandExecutionError if we fail
to do so. If we successfully cache the file, return the cached path. | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/jenkinsmod.py#L95-L105 | null | # -*- coding: utf-8 -*-
'''
Module for controlling Jenkins
:depends: python-jenkins
.. versionadded:: 2016.3.0
:depends: python-jenkins_ Python module (not to be confused with jenkins_)
.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins
.. _jenkins: https://pypi.python.org/pypi/jenkins
:configuration:... |
saltstack/salt | salt/modules/jenkinsmod.py | job_exists | python | def job_exists(name=None):
'''
Check whether the job exists in configured Jenkins jobs.
:param name: The name of the job is check if it exists.
:return: True if job exists, False if job does not exist.
CLI Example:
.. code-block:: bash
salt '*' jenkins.job_exists jobname
'''
... | Check whether the job exists in configured Jenkins jobs.
:param name: The name of the job is check if it exists.
:return: True if job exists, False if job does not exist.
CLI Example:
.. code-block:: bash
salt '*' jenkins.job_exists jobname | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/jenkinsmod.py#L170-L191 | [
"def _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n... | # -*- coding: utf-8 -*-
'''
Module for controlling Jenkins
:depends: python-jenkins
.. versionadded:: 2016.3.0
:depends: python-jenkins_ Python module (not to be confused with jenkins_)
.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins
.. _jenkins: https://pypi.python.org/pypi/jenkins
:configuration:... |
saltstack/salt | salt/modules/jenkinsmod.py | get_job_info | python | def get_job_info(name=None):
'''
Return information about the Jenkins job.
:param name: The name of the job is check if it exists.
:return: Information about the Jenkins job.
CLI Example:
.. code-block:: bash
salt '*' jenkins.get_job_info jobname
'''
if not name:
rai... | Return information about the Jenkins job.
:param name: The name of the job is check if it exists.
:return: Information about the Jenkins job.
CLI Example:
.. code-block:: bash
salt '*' jenkins.get_job_info jobname | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/jenkinsmod.py#L194-L219 | [
"def _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n... | # -*- coding: utf-8 -*-
'''
Module for controlling Jenkins
:depends: python-jenkins
.. versionadded:: 2016.3.0
:depends: python-jenkins_ Python module (not to be confused with jenkins_)
.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins
.. _jenkins: https://pypi.python.org/pypi/jenkins
:configuration:... |
saltstack/salt | salt/modules/jenkinsmod.py | build_job | python | def build_job(name=None, parameters=None):
'''
Initiate a build for the provided job.
:param name: The name of the job is check if it exists.
:param parameters: Parameters to send to the job.
:return: True is successful, otherwise raise an exception.
CLI Example:
.. code-block:: bash
... | Initiate a build for the provided job.
:param name: The name of the job is check if it exists.
:param parameters: Parameters to send to the job.
:return: True is successful, otherwise raise an exception.
CLI Example:
.. code-block:: bash
salt '*' jenkins.build_job jobname | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/jenkinsmod.py#L222-L251 | [
"def _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n... | # -*- coding: utf-8 -*-
'''
Module for controlling Jenkins
:depends: python-jenkins
.. versionadded:: 2016.3.0
:depends: python-jenkins_ Python module (not to be confused with jenkins_)
.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins
.. _jenkins: https://pypi.python.org/pypi/jenkins
:configuration:... |
saltstack/salt | salt/modules/jenkinsmod.py | create_job | python | def create_job(name=None,
config_xml=None,
saltenv='base'):
'''
Return the configuration file.
:param name: The name of the job is check if it exists.
:param config_xml: The configuration file to use to create the job.
:param saltenv: The environment to look for the fi... | Return the configuration file.
:param name: The name of the job is check if it exists.
:param config_xml: The configuration file to use to create the job.
:param saltenv: The environment to look for the file in.
:return: The configuration file used for the job.
CLI Example:
.. code-block:: ba... | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/jenkinsmod.py#L254-L295 | [
"def fopen(*args, **kwargs):\n '''\n Wrapper around open() built-in to set CLOEXEC on the fd.\n\n This flag specifies that the file descriptor should be closed when an exec\n function is invoked;\n\n When a file descriptor is allocated (as with open or dup), this bit is\n initially cleared on the ... | # -*- coding: utf-8 -*-
'''
Module for controlling Jenkins
:depends: python-jenkins
.. versionadded:: 2016.3.0
:depends: python-jenkins_ Python module (not to be confused with jenkins_)
.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins
.. _jenkins: https://pypi.python.org/pypi/jenkins
:configuration:... |
saltstack/salt | salt/modules/jenkinsmod.py | delete_job | python | def delete_job(name=None):
'''
Return true is job is deleted successfully.
:param name: The name of the job to delete.
:return: Return true if job is deleted successfully.
CLI Example:
.. code-block:: bash
salt '*' jenkins.delete_job jobname
'''
if not name:
raise Sa... | Return true is job is deleted successfully.
:param name: The name of the job to delete.
:return: Return true if job is deleted successfully.
CLI Example:
.. code-block:: bash
salt '*' jenkins.delete_job jobname | train | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/jenkinsmod.py#L339-L367 | [
"def _connect():\n '''\n Return server object used to interact with Jenkins.\n\n :return: server object used to interact with Jenkins\n '''\n jenkins_url = __salt__['config.get']('jenkins.url') or \\\n __salt__['config.get']('jenkins:url') or \\\n __salt__['pillar.get']('jenkins.url')\n... | # -*- coding: utf-8 -*-
'''
Module for controlling Jenkins
:depends: python-jenkins
.. versionadded:: 2016.3.0
:depends: python-jenkins_ Python module (not to be confused with jenkins_)
.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins
.. _jenkins: https://pypi.python.org/pypi/jenkins
:configuration:... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.