iam_server_certificate_facts before Ansible 2.9. The usage did not change.Aliases: iam_cert_facts,iam_server_certificate_facts
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| aws_access_key string | 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 string | 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 | |
| debug_botocore_endpoint_logs boolean added in 2.8 |
| Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. |
| ec2_url string | 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. | |
| name string / required | The name of the server certificate you are retrieving attributes for. | |
| profile string | Uses a boto profile. Only works with boto >= 2.24.0. | |
| region string | The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
aliases: aws_region, ec2_region | |
| security_token string | 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 boolean |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
Note
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
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# Retrieve server certificate
- iam_server_certificate_info:
name: production-cert
register: server_cert
# Fail if the server certificate name was not found
- iam_server_certificate_info:
name: production-cert
register: server_cert
failed_when: "{{ server_cert.results | length == 0 }}"
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| arn string | success | The Amazon resource name of the server certificate Sample: arn:aws:iam::911277865346:server-certificate/server-cert-name |
| certificate_body string | success | The asn1der encoded PEM string Sample: -----BEGIN CERTIFICATE----- bunch of random data -----END CERTIFICATE----- |
| expiration string | success | The date and time this server certificate will expire, in ISO 8601 format. Sample: 2017-06-15T12:00:00+00:00 |
| path string | success | The path of the server certificate Sample: / |
| server_certificate_id string | success | The 21 character certificate id Sample: ADWAJXWTZAXIPIMQHMJPO |
| server_certificate_name string | success | The name of the server certificate Sample: server-cert-name |
| upload_date string | success | The date and time this server certificate was uploaded, in ISO 8601 format. Sample: 2015-04-25T00:36:40+00:00 |
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/iam_server_certificate_info_module.html