dellemc.openmanage.ome_application_network_webserver – Updates the Web server configuration on OpenManage Enterprise

Note

This plugin is part of the dellemc.openmanage collection (version 3.6.0).

To install it use: ansible-galaxy collection install dellemc.openmanage.

To use it in a playbook, specify: dellemc.openmanage.ome_application_network_webserver.

New in version 2.1.0: of dellemc.openmanage

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 >= 2.7.5

Parameters

Parameter Choices/Defaults Comments
hostname
string / required
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname.
password
string / required
OpenManage Enterprise or OpenManage Enterprise Modular password.
port
integer
Default:
443
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
username
string / required
OpenManage Enterprise or OpenManage Enterprise Modular username.
webserver_port
integer
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.
webserver_timeout
integer
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.

Notes

Note

  • Run this module from a system that has direct access to DellEMC 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"
    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"
    webserver_timeout: 30

- name: Update web server port
  dellemc.openmanage.ome_application_network_webserver:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    webserver_port: 8443

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
error_info
dictionary
on HTTP error
Details of the HTTP error.

Sample:
{'error': {'@Message.ExtendedInfo': [{'Message': 'Unable to complete the request because the input value for PortNumber is missing or an invalid value is entered.', 'MessageArgs': ['PortNumber'], 'MessageId': 'CGEN6002', 'RelatedProperties': [], 'Resolution': 'Enter a valid value and retry the operation.', 'Severity': 'Critical'}], 'code': 'Base.1.0.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.'}}
msg
string
always
Overall status of the network web server configuration change.

Sample:
Successfully updated network web server configuration.
webserver_configuration
dictionary
success
Updated application network web server configuration.

Sample:
{'EnableWebServer': True, 'PortNumber': 443, 'TimeOut': 20}


Authors

  • Jagadeesh N V(@jagadeeshnv)