mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Added module to describe EC2 Placement Groups. (#33228)
* Added module to describe EC2 Placement Groups. * Update to newer way of handling Boto3 connections and exceptions. * Futzing around with imports and HAS_BOTO3 * Fix up exception imports. * Fix license block * Correct task indenting in doc * Added list-filtering example to docs
This commit is contained in:
parent
65ffb92bff
commit
dd041e6f72
2 changed files with 143 additions and 5 deletions
|
@ -63,7 +63,8 @@ as the module does that check.
|
|||
|
||||
If you want to import the modules anyway (for example `from botocore.exception import
|
||||
ClientError`) Wrap import statements in a try block and fail the module later using `HAS_BOTO3` if
|
||||
the import fails.
|
||||
the import fails. See below as well (`Exception Handling for boto3 and botocore`) for more detail
|
||||
on how to safely import botocore exceptions.
|
||||
|
||||
#### boto
|
||||
|
||||
|
|
137
lib/ansible/modules/cloud/amazon/ec2_placement_group_facts.py
Normal file
137
lib/ansible/modules/cloud/amazon/ec2_placement_group_facts.py
Normal file
|
@ -0,0 +1,137 @@
|
|||
#!/usr/bin/python
|
||||
# Copyright (c) 2017 Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ec2_placement_group_facts
|
||||
short_description: List EC2 Placement Group(s) details
|
||||
description:
|
||||
- List details of EC2 Placement Group(s).
|
||||
version_added: "2.5"
|
||||
author: "Brad Macpherson (@iiibrad)"
|
||||
options:
|
||||
names:
|
||||
description:
|
||||
- A list of names to filter on. If a listed group does not exist, there
|
||||
will be no corresponding entry in the result; no error will be raised.
|
||||
required: false
|
||||
default: []
|
||||
extends_documentation_fragment:
|
||||
- aws
|
||||
- ec2
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Note: These examples do not set authentication details or the AWS region,
|
||||
# see the AWS Guide for details.
|
||||
|
||||
# List all placement groups.
|
||||
- ec2_placement_group_facts:
|
||||
register: all_ec2_placement_groups
|
||||
|
||||
# List two placement groups.
|
||||
- ec2_placement_group_facts:
|
||||
names:
|
||||
- my-cluster
|
||||
- my-other-cluster
|
||||
register: specific_ec2_placement_groups
|
||||
|
||||
- debug: msg="{{ specific_ec2_placement_groups | json_query(\"[?name=='my-cluster']\") }}"
|
||||
|
||||
'''
|
||||
|
||||
|
||||
RETURN = '''
|
||||
placement_groups:
|
||||
description: Placement group attributes
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description: PG name
|
||||
type: string
|
||||
sample: my-cluster
|
||||
state:
|
||||
description: PG state
|
||||
type: string
|
||||
sample: "available"
|
||||
strategy:
|
||||
description: PG strategy
|
||||
type: string
|
||||
sample: "cluster"
|
||||
|
||||
'''
|
||||
|
||||
from ansible.module_utils.aws.core import AnsibleAWSModule
|
||||
from ansible.module_utils.ec2 import (connect_to_aws,
|
||||
boto3_conn,
|
||||
ec2_argument_spec,
|
||||
get_aws_connection_info,
|
||||
HAS_BOTO3)
|
||||
try:
|
||||
from botocore.exceptions import (BotoCoreError, ClientError)
|
||||
except ImportError:
|
||||
pass # caught by imported HAS_BOTO3
|
||||
|
||||
|
||||
def get_placement_groups_details(connection, module):
|
||||
names = module.params.get("names")
|
||||
try:
|
||||
if len(names) > 0:
|
||||
response = connection.describe_placement_groups(
|
||||
Filters=[{
|
||||
"Name": "group-name",
|
||||
"Values": names
|
||||
}])
|
||||
else:
|
||||
response = connection.describe_placement_groups()
|
||||
except (BotoCoreError, ClientError) as e:
|
||||
module.fail_json_aws(
|
||||
e,
|
||||
msg="Couldn't find placement groups named [%s]" % names)
|
||||
|
||||
results = []
|
||||
for placement_group in response['PlacementGroups']:
|
||||
results.append({
|
||||
"name": placement_group['GroupName'],
|
||||
"state": placement_group['State'],
|
||||
"strategy": placement_group['Strategy'],
|
||||
})
|
||||
return results
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = ec2_argument_spec()
|
||||
argument_spec.update(
|
||||
dict(
|
||||
names=dict(type='list', default=[])
|
||||
)
|
||||
)
|
||||
|
||||
module = AnsibleAWSModule(
|
||||
argument_spec=argument_spec,
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
if not HAS_BOTO3:
|
||||
module.fail_json(msg='boto3 and botocore are required for this module')
|
||||
|
||||
region, ec2_url, aws_connect_params = get_aws_connection_info(
|
||||
module, boto3=True)
|
||||
|
||||
connection = boto3_conn(module,
|
||||
resource='ec2', conn_type='client',
|
||||
region=region, **aws_connect_params)
|
||||
|
||||
placement_groups = get_placement_groups_details(connection, module)
|
||||
module.exit_json(changed=False, placement_groups=placement_groups)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
Loading…
Reference in a new issue