Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update aws_ec2 documentation for the use_ssm_inventory option #1586

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
trivial:
- "Update the ``aws_ec2`` inventory plugins documentation for the ``use_ssm_inventory`` option."
4 changes: 3 additions & 1 deletion docs/docsite/rst/aws_ec2_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``
---------
Expand Down
5 changes: 4 additions & 1 deletion plugins/inventory/aws_ec2.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down