dellemc.openmanage.ome_application_network_proxy module – Updates the proxy configuration on OpenManage Enterprise
Note
This module is part of the dellemc.openmanage collection (version 9.8.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_proxy.
New in dellemc.openmanage 2.1.0
Synopsis
This module allows to configure a network proxy 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. |
|
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. |
|
This option will ignore the integrated certificate checks like those used for the warranty and catalog updates.
Choices:
|
|
Proxy server address. This option is mandatory when enable_proxy is true. |
|
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 list of IPv4 addresses, IPv6 addresses or the domain names of the devices that can bypass the proxy server to directly access the appliance. |
|
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. |
|
The socket level timeout in seconds. Default: |
|
This flag is used to update the proxy_password. This is applicable only when enable_authentication is
Choices:
|
|
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:
|
|
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.This module supports IPv4 and IPv6 addresses.
Examples
---
- name: Update proxy configuration and enable authentication
dellemc.openmanage.ome_application_network_proxy:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
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"
ca_path: "/path/to/ca_cert.pem"
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"
ca_path: "/path/to/ca_cert.pem"
enable_proxy: false
- name: Add IPv4, IPv6 and domain names of devices in proxy exclusion list
dellemc.openmanage.ome_application_network_proxy:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
enable_proxy: true
ip_address: "192.168.0.2"
proxy_port: 444
enable_authentication: false
proxy_exclusion_list:
- 192.168.1.0
- 191.187.2.0
- www.*.com
- 191.1.168.1/24
- name: Clear the proxy exclusion list
dellemc.openmanage.ome_application_network_proxy:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
enable_proxy: true
ip_address: "192.168.0.2"
proxy_port: 444
proxy_exclusion_list: []
- name: Ignore the certificate validation
dellemc.openmanage.ome_application_network_proxy:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
enable_proxy: true
ip_address: "192.168.0.2"
proxy_port: 444
ignore_certificate_validation: true
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 proxy configuration change. Returned: always Sample: |
|
Updated application network proxy configuration. Returned: On successful configuration of network proxy settings Sample: |