dellemc.openmanage.ome_application_network_webserver module – Updates the Web server configuration on OpenManage Enterprise
Note
This module is part of the dellemc.openmanage collection (version 9.7.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install dellemc.openmanage
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.ome_application_network_webserver
.
New in dellemc.openmanage 2.1.0
Synopsis
This module allows to configure a network web server on OpenManage Enterprise.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. If the username is not provided, then the environment variable Example: export OME_USERNAME=username |
|
If Configure Prior to collection version Choices:
|
|
Port number used by OpenManage Enterprise to establish a secure server connection. WARNING A change in port number results in a loss of connectivity in the current session for more than a minute. |
|
The duration in minutes after which a web user interface session is automatically disconnected. If a change is made to the session timeout, it will only take effect after the next log in. |
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export OME_X_AUTH_TOKEN=x_auth_token |
Notes
Note
Run this module from a system that has direct access to Dell OpenManage Enterprise.
This module supports
check_mode
.
Examples
---
- name: Update web server port and session time out
dellemc.openmanage.ome_application_network_webserver:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
webserver_port: 9443
webserver_timeout: 20
- name: Update session time out
dellemc.openmanage.ome_application_network_webserver:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
webserver_timeout: 30
- name: Update web server port
dellemc.openmanage.ome_application_network_webserver:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
webserver_port: 8443
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details of the HTTP error. Returned: on HTTP error Sample: |
|
Overall status of the network web server configuration change. Returned: always Sample: |
|
Updated application network web server configuration. Returned: success Sample: |