mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-19 17:01:25 -07:00
[ip ... j]*.py: normalize docs (#9392)
* [ip ... j]*.py: normalize docs * Update plugins/modules/ip_netns.py Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
cea6eeef37
commit
a99f72fc36
43 changed files with 1290 additions and 1429 deletions
|
@ -8,14 +8,13 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: java_cert
|
||||
|
||||
short_description: Uses keytool to import/remove certificate to/from java keystore (cacerts)
|
||||
description:
|
||||
- This is a wrapper module around keytool, which can be used to import certificates
|
||||
and optionally private keys to a given java keystore, or remove them from it.
|
||||
- This is a wrapper module around keytool, which can be used to import certificates and optionally private keys to a given
|
||||
java keystore, or remove them from it.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
- ansible.builtin.files
|
||||
|
@ -61,9 +60,8 @@ options:
|
|||
pkcs12_path:
|
||||
description:
|
||||
- Local path to load PKCS12 keystore from.
|
||||
- Unlike O(cert_url), O(cert_path) and O(cert_content), the PKCS12 keystore embeds the private key matching
|
||||
the certificate, and is used to import both the certificate and its private key into the
|
||||
java keystore.
|
||||
- Unlike O(cert_url), O(cert_path) and O(cert_content), the PKCS12 keystore embeds the private key matching the certificate,
|
||||
and is used to import both the certificate and its private key into the java keystore.
|
||||
- Exactly one of O(cert_url), O(cert_path), O(cert_content), or O(pkcs12_path) is required to load certificate.
|
||||
type: path
|
||||
pkcs12_password:
|
||||
|
@ -100,10 +98,10 @@ options:
|
|||
state:
|
||||
description:
|
||||
- Defines action which can be either certificate import or removal.
|
||||
- When state is present, the certificate will always idempotently be inserted
|
||||
into the keystore, even if there already exists a cert alias that is different.
|
||||
- When state is present, the certificate will always idempotently be inserted into the keystore, even if there already
|
||||
exists a cert alias that is different.
|
||||
type: str
|
||||
choices: [ absent, present ]
|
||||
choices: [absent, present]
|
||||
default: present
|
||||
mode:
|
||||
version_added: 8.5.0
|
||||
|
@ -125,10 +123,10 @@ options:
|
|||
version_added: 8.5.0
|
||||
requirements: [openssl, keytool]
|
||||
author:
|
||||
- Adam Hamsik (@haad)
|
||||
'''
|
||||
- Adam Hamsik (@haad)
|
||||
"""
|
||||
|
||||
EXAMPLES = r'''
|
||||
EXAMPLES = r"""
|
||||
- name: Import SSL certificate from google.com to a given cacerts keystore
|
||||
community.general.java_cert:
|
||||
cert_url: google.com
|
||||
|
@ -196,9 +194,9 @@ EXAMPLES = r'''
|
|||
keystore_pass: changeit
|
||||
keystore_create: true
|
||||
state: present
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = r'''
|
||||
RETURN = r"""
|
||||
msg:
|
||||
description: Output from stdout of keytool command after execution of given command.
|
||||
returned: success
|
||||
|
@ -216,7 +214,7 @@ cmd:
|
|||
returned: success
|
||||
type: str
|
||||
sample: "keytool -importcert -noprompt -keystore"
|
||||
'''
|
||||
"""
|
||||
|
||||
import os
|
||||
import tempfile
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue