From 463d58802ebc1d8d40703baa96fa1c8b42ac13f8 Mon Sep 17 00:00:00 2001 From: Alina Buzachis Date: Thu, 1 Jun 2023 23:44:17 +0200 Subject: [PATCH] Update aws_ec2 documentation for the use_ssm_inventory option (#1586) Update aws_ec2 documentation for the use_ssm_inventory option SUMMARY Update aws_ec2 documentation for the use_ssm_inventory option Might fix #1461 ISSUE TYPE Docs Pull Request COMPONENT NAME aws_ec2 Reviewed-by: Mark Chappell Reviewed-by: Jill R --- .../20230531-aws_ec2-use_ssm_inventory_documentation.yml | 2 ++ docs/docsite/rst/aws_ec2_guide.rst | 4 +++- plugins/inventory/aws_ec2.py | 5 ++++- 3 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 changelogs/fragments/20230531-aws_ec2-use_ssm_inventory_documentation.yml diff --git a/changelogs/fragments/20230531-aws_ec2-use_ssm_inventory_documentation.yml b/changelogs/fragments/20230531-aws_ec2-use_ssm_inventory_documentation.yml new file mode 100644 index 00000000000..3b769cd3f07 --- /dev/null +++ b/changelogs/fragments/20230531-aws_ec2-use_ssm_inventory_documentation.yml @@ -0,0 +1,2 @@ +trivial: + - "Update the ``aws_ec2`` inventory plugins documentation for the ``use_ssm_inventory`` option." diff --git a/docs/docsite/rst/aws_ec2_guide.rst b/docs/docsite/rst/aws_ec2_guide.rst index 6d8b9f2123d..514d8ada439 100644 --- a/docs/docsite/rst/aws_ec2_guide.rst +++ b/docs/docsite/rst/aws_ec2_guide.rst @@ -484,7 +484,9 @@ Now the output of ``ansible-inventory -i demo.aws_ec2.yml --list``: ``use_ssm_inventory`` --------------------- -``use_ssm_inventory: True`` will include SSM inventory variables into hostvars for ssm-configured instances. +``use_ssm_inventory: True`` enables fetching additional EC2 instance information from the AWS Systems Manager (SSM) inventory service into hostvars. By leveraging the SSM inventory data, the ``use_ssm_inventory`` option provides additional details and attributes about the EC2 instances in your inventory. +These details can include operating system information, installed software, network configurations, and custom inventory attributes defined in SSM. + ``cache`` --------- diff --git a/plugins/inventory/aws_ec2.py b/plugins/inventory/aws_ec2.py index 260ad03d51f..ac6df2e84b0 100644 --- a/plugins/inventory/aws_ec2.py +++ b/plugins/inventory/aws_ec2.py @@ -137,7 +137,10 @@ version_added: 3.1.0 use_ssm_inventory: description: - - Add SSM inventory information into hostvars. + - Enables fetching additional EC2 instance information from the AWS Systems Manager (SSM) inventory service into hostvars. + - By leveraging the SSM inventory data, the I(use_ssm_inventory) option provides additional details and attributes + about the EC2 instances in your inventory. These details can include operating system information, installed software, + network configurations, and custom inventory attributes defined in SSM. type: bool default: False version_added: 6.0.0