Documentation

iam_cert_facts - Retrieves iam_cert details using AWS methods.

New in version 2.4.

Synopsis

  • Gets various details related to IAM cert, ARN, expiration, Certificates.

Options

parameter required default choices comments
aws_access_key
no
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.

aliases: ec2_access_key, access_key
aws_secret_key
no
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.

aliases: ec2_secret_key, secret_key
certificate_name
no
The name of the server certificate you want to retrieve information about.
ec2_url
no
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
path_prefix
no
The path prefix for filtering the results. http://docs.aws.amazon.com/cli/latest/reference/iam/list-server-certificates.html#options
profile
(added in 1.6)
no
Uses a boto profile. Only works with boto >= 2.24.0.
security_token
(added in 1.6)
no
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

aliases: access_token
validate_certs
(added in 1.5)
no yes
  • yes
  • no
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Examples

- name: List all server certificates
  iam_cert_facts:
  register: server_certificates

- name: Retrieve specific certificate
  iam_cert_facts:
      certificate_name: cookie

- name: List all server certificates with this path
  iam_cert_facts:
      path_prefix: /company/servercerts

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
server_certificate_metadata_list Metadata list. always dict http://boto3.readthedocs.io/en/latest/reference/services/iam.html#IAM.Client.list_server_certificates
response_metadata Response metadata. always dict {'http_status_code': 200, 'request_id': '9f6d-671298e72d8b'}
is_truncated A flag that indicates whether there are more items to return. always bool False


Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.