/ home / dellemc / dellemc.openmanage / 9.1.0 / module / ome_application_network_webserver

dellemc.openmanage.ome_application_network_webserver (9.1.0) — module

Updates the Web server configuration on OpenManage Enterprise

| "added in version" 2.1.0 of dellemc.openmanage"

Authors: Jagadeesh N V(@jagadeeshnv)

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 9.1.0

Description

This module allows to configure a network web server on OpenManage Enterprise.

Requirements

python >= 3.8.6

Usage examples

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

- 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

Inputs

    
port:
    default: 443
    description: OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
    type: int

ca_path:
    description:
    - The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
      the validation.
    type: path
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

timeout:
    default: 30
    description: The socket level timeout in seconds.
    type: int
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

hostname:
    description: OpenManage Enterprise or OpenManage Enterprise Modular IP address or
      hostname.
    required: true
    type: str

password:
    description:
    - OpenManage Enterprise or OpenManage Enterprise Modular password.
    - If the password is not provided, then the environment variable C(OME_PASSWORD) is
      used.
    - 'Example: export OME_PASSWORD=password'
    required: true
    type: str

username:
    description:
    - OpenManage Enterprise or OpenManage Enterprise Modular username.
    - If the username is not provided, then the environment variable C(OME_USERNAME) is
      used.
    - 'Example: export OME_USERNAME=username'
    required: true
    type: str

validate_certs:
    default: true
    description:
    - If C(false), the SSL certificates will not be validated.
    - Configure C(false) only on personally controlled sites where self-signed certificates
      are used.
    - Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
    type: bool
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

webserver_port:
    description:
    - Port number used by OpenManage Enterprise to establish a secure server connection.
    - I(WARNING) A change in port number results in a loss of connectivity in the current
      session for more than a minute.
    type: int

webserver_timeout:
    description:
    - 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.
    type: int

Outputs

error_info:
  description: Details of the HTTP error.
  returned: on 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.
  type: dict
msg:
  description: Overall status of the network web server configuration change.
  returned: always
  sample: Successfully updated network web server configuration.
  type: str
webserver_configuration:
  description: Updated application network web server configuration.
  returned: success
  sample:
    EnableWebServer: true
    PortNumber: 443
    TimeOut: 20
  type: dict