dellemc.openmanage.ome_application_network_proxy – Updates the proxy configuration on OpenManage Enterprise
Note
This plugin is part of the dellemc.openmanage collection (version 3.6.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
.
To use it in a playbook, specify: dellemc.openmanage.ome_application_network_proxy
.
New in version 2.1.0: of dellemc.openmanage
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7.5
Parameters
Parameter |
Comments |
---|---|
Enable or disable proxy authentication. If enable_authentication is true, proxy_username and proxy_password must be provided. If enable_authentication is false, the proxy username and password are set to its default values. Choices:
|
|
Enables or disables the HTTP proxy configuration. If enable proxy is false, then the HTTP proxy configuration is set to its default value. Choices:
|
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
Proxy server address. This option is mandatory when enable_proxy is true. |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: 443 |
|
Proxy server password. This option is mandatory when enable_authentication is true. |
|
Proxy server’s port number. This option is mandatory when enable_proxy is true. |
|
Proxy server username. This option is mandatory when enable_authentication is true. |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. |
Notes
Note
Run this module from a system that has direct access to DellEMC OpenManage Enterprise.
This module does not support
check_mode
.
Examples
---
- name: Update proxy configuration and enable authentication
dellemc.openmanage.ome_application_network_proxy:
hostname: "192.168.0.1"
username: "username"
password: "password"
enable_proxy: true
ip_address: "192.168.0.2"
proxy_port: 444
enable_authentication: true
proxy_username: "proxy_username"
proxy_password: "proxy_password"
- name: Reset proxy authentication
dellemc.openmanage.ome_application_network_proxy:
hostname: "192.168.0.1"
username: "username"
password: "password"
enable_proxy: true
ip_address: "192.168.0.2"
proxy_port: 444
enable_authentication: false
- name: Reset proxy configuration
dellemc.openmanage.ome_application_network_proxy:
hostname: "192.168.0.1"
username: "username"
password: "password"
enable_proxy: false
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: {“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.”}} |
|
Overall status of the network proxy configuration change. Returned: always Sample: “Successfully updated network proxy configuration.” |
|
Updated application network proxy configuration. Returned: success Sample: {“EnableAuthentication”: true, “EnableProxy”: true, “IpAddress”: “192.168.0.2”, “Password”: null, “PortNumber”: 444, “Username”: “root”} |
Authors
Sajna Shetty(@Sajna-Shetty)