iam_server_certificate_facts - Retrieve the facts of a server certificate
New in version 2.2.
Synopsis
- Retrieve the attributes of a server certificate
Requirements (on host that executes module)
- boto
- boto3
- botocore
- python >= 2.6
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
|
||
| 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.
|
||
| name |
yes |
The name of the server certificate you are retrieving attributes for.
|
||
| profile
(added in 1.6)
|
no |
Uses a boto profile. Only works with boto >= 2.24.0.
|
||
| region |
no |
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
(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 |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
Examples
# Retrieve server certificate
- iam_server_certificate_facts:
name: production-cert
register: server_cert
# Fail if the server certificate name was not found
- iam_server_certificate_facts:
name: production-cert
register: server_cert
failed_when: "{{ server_cert.results | length == 0 }}"
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| arn |
The Amazon resource name of the server certificate
|
success | str | arn:aws:iam::911277865346:server-certificate/server-cert-name |
| certificate_body |
The asn1der encoded PEM string
|
success | str | -----BEGIN CERTIFICATE----- bunch of random data -----END CERTIFICATE----- |
| expiration |
The date and time this server certificate will expire, in ISO 8601 format.
|
success | str | 2017-06-15T12:00:00+00:00 |
| path |
The path of the server certificate
|
success | str | / |
| server_certificate_id |
The 21 character certificate id
|
success | str | ADWAJXWTZAXIPIMQHMJPO |
| server_certificate_name |
The name of the server certificate
|
success | str | server-cert-name |
| upload_date |
The date and time this server certificate was uploaded, in ISO 8601 format.
|
success | str | 2015-04-25T00:36:40+00:00 |
Notes
Note
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URLorEC2_URL,AWS_ACCESS_KEY_IDorAWS_ACCESS_KEYorEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEYorEC2_SECRET_KEY,AWS_SECURITY_TOKENorEC2_SECURITY_TOKEN,AWS_REGIONorEC2_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_REGIONorEC2_REGIONcan 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.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/iam_server_certificate_facts_module.html
