1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
.. _ome_application_certificate_module:
ome_application_certificate -- This module allows to generate a CSR and upload the certificate
==============================================================================================
.. contents::
:local:
:depth: 1
Synopsis
--------
This module allows the generation a new certificate signing request (CSR) and to upload the certificate on OpenManage Enterprise.
Requirements
------------
The below requirements are needed on the host that executes this module.
- python \>= 3.9.6
Parameters
----------
command (optional, str, generate_csr)
\ :literal:`generate\_csr`\ allows the generation of a CSR and \ :literal:`upload`\ uploads the certificate.
distinguished_name (optional, str, None)
Name of the certificate issuer. This option is applicable for \ :literal:`generate\_csr`\ .
department_name (optional, str, None)
Name of the department that issued the certificate. This option is applicable for \ :literal:`generate\_csr`\ .
business_name (optional, str, None)
Name of the business that issued the certificate. This option is applicable for \ :literal:`generate\_csr`\ .
locality (optional, str, None)
Local address of the issuer of the certificate. This option is applicable for \ :literal:`generate\_csr`\ .
country_state (optional, str, None)
State in which the issuer resides. This option is applicable for \ :literal:`generate\_csr`\ .
country (optional, str, None)
Country in which the issuer resides. This option is applicable for \ :literal:`generate\_csr`\ .
email (optional, str, None)
Email associated with the issuer. This option is applicable for \ :literal:`generate\_csr`\ .
subject_alternative_names (optional, str, None)
Subject alternative name required for the certificate signing request generation.
Supports up to 4 comma separated values starting from primary, secondary, Tertiary and Quaternary values.
upload_file (optional, str, None)
Local path of the certificate file to be uploaded. This option is applicable for \ :literal:`upload`\ . Once the certificate is uploaded, OpenManage Enterprise cannot be accessed for a few seconds.
hostname (True, str, None)
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname.
username (False, str, None)
OpenManage Enterprise or OpenManage Enterprise Modular username.
If the username is not provided, then the environment variable \ :envvar:`OME\_USERNAME`\ is used.
Example: export OME\_USERNAME=username
password (False, str, None)
OpenManage Enterprise or OpenManage Enterprise Modular password.
If the password is not provided, then the environment variable \ :envvar:`OME\_PASSWORD`\ is used.
Example: export OME\_PASSWORD=password
x_auth_token (False, str, None)
Authentication token.
If the x\_auth\_token is not provided, then the environment variable \ :envvar:`OME\_X\_AUTH\_TOKEN`\ is used.
Example: export OME\_X\_AUTH\_TOKEN=x\_auth\_token
port (optional, int, 443)
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
validate_certs (optional, bool, True)
If \ :literal:`false`\ , the SSL certificates will not be validated.
Configure \ :literal:`false`\ only on personally controlled sites where self-signed certificates are used.
Prior to collection version \ :literal:`5.0.0`\ , the \ :emphasis:`validate\_certs`\ is \ :literal:`false`\ by default.
ca_path (optional, path, None)
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
timeout (optional, int, 30)
The socket level timeout in seconds.
Notes
-----
.. note::
- If a certificate is uploaded, which is identical to an already existing certificate, it is accepted by the module.
- This module does not support \ :literal:`check\_mode`\ .
Examples
--------
.. code-block:: yaml+jinja
---
- name: Generate a certificate signing request
dellemc.openmanage.ome_application_certificate:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
command: "generate_csr"
distinguished_name: "hostname.com"
department_name: "Remote Access Group"
business_name: "Dell Inc."
locality: "Round Rock"
country_state: "Texas"
country: "US"
email: "support@dell.com"
- name: Generate a certificate signing request with subject alternative names
dellemc.openmanage.ome_application_certificate:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
command: "generate_csr"
distinguished_name: "hostname.com"
subject_alternative_names: "hostname1.chassis.com,hostname2.chassis.com"
department_name: "Remote Access Group"
business_name: "Dell Inc."
locality: "Round Rock"
country_state: "Texas"
country: "US"
email: "support@dell.com"
- name: Upload the certificate
dellemc.openmanage.ome_application_certificate:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
command: "upload"
upload_file: "/path/certificate.cer"
Return Values
-------------
msg (always, str, Successfully generated certificate signing request.)
Overall status of the certificate signing request.
csr_status (on success, dict, {'CertificateData': '-----BEGIN CERTIFICATE REQUEST-----GHFSUEKLELE af3u4h2rkdkfjasczjfefhkrr/frjrfrjfrxnvzklf/nbcvxmzvndlskmcvbmzkdk kafhaksksvklhfdjtrhhffgeth/tashdrfstkm@kdjFGD/sdlefrujjfvvsfeikdf yeufghdkatbavfdomehtdnske/tahndfavdtdfgeikjlagmdfbandfvfcrfgdtwxc qwgfrteyupojmnsbajdkdbfs/ujdfgthedsygtamnsuhakmanfuarweyuiwruefjr etwuwurefefgfgurkjkdmbvfmvfvfk==-----END CERTIFICATE REQUEST-----'})
Details of the generated certificate.
error_info (on HTTP error, dict, {'error': {'code': 'Base.1.0.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.', '@Message.ExtendedInfo': [{'MessageId': 'CSEC9002', 'RelatedProperties': [], 'Message': 'Unable to upload the certificate because the certificate file provided is invalid.', 'MessageArgs': [], 'Severity': 'Critical', 'Resolution': 'Make sure the CA certificate and private key are correct and retry the operation.'}]}})
Details of the HTTP error.
Status
------
Authors
~~~~~~~
- Felix Stephen (@felixs88)
- Kritika Bhateja (@Kritika-Bhateja-03)
- Jennifer John (@Jennifer-John)
|
