ansible / ansible.builtin / v2.9.0 / module / _iam_server_certificate_facts Retrieve the information of a server certificate | "added in version" 2.2 of ansible.builtin" Authors: Allen Sanabria (@linuxdynasty) preview | supported by communityansible.builtin._iam_server_certificate_facts (v2.9.0) — module
pip
Install with pip install ansible==2.9.0
Retrieve the attributes of a server certificate
This module was called C(iam_server_certificate_facts) before Ansible 2.9. The usage did not change.
# 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 }}"
name: description: - The name of the server certificate you are retrieving attributes for. required: true region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_session_token - session_token - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
arn: description: The Amazon resource name of the server certificate returned: success sample: arn:aws:iam::911277865346:server-certificate/server-cert-name type: str certificate_body: description: The asn1der encoded PEM string returned: success sample: '-----BEGIN CERTIFICATE----- bunch of random data -----END CERTIFICATE-----' type: str expiration: description: The date and time this server certificate will expire, in ISO 8601 format. returned: success sample: '2017-06-15T12:00:00+00:00' type: str path: description: The path of the server certificate returned: success sample: / type: str server_certificate_id: description: The 21 character certificate id returned: success sample: ADWAJXWTZAXIPIMQHMJPO type: str server_certificate_name: description: The name of the server certificate returned: success sample: server-cert-name type: str upload_date: description: The date and time this server certificate was uploaded, in ISO 8601 format. returned: success sample: '2015-04-25T00:36:40+00:00' type: str