dellemc.openmanage.ome_application_network_proxy (9.1.0) — module

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 proxy on OpenManage Enterprise.

Requirements

• python >= 3.8.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

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

ip_address:
    description:
    - Proxy server address.
    - This option is mandatory when I(enable_proxy) is true.
    type: str

proxy_port:
    description:
    - Proxy server's port number.
    - This option is mandatory when I(enable_proxy) is true.
    type: int

enable_proxy:
    description:
    - Enables or disables the HTTP proxy configuration.
    - If I(enable proxy) is false, then the HTTP proxy configuration is set to its default
      value.
    required: true
    type: bool

proxy_password:
    description:
    - Proxy server password.
    - This option is mandatory when I(enable_authentication) is true.
    type: str

proxy_username:
    description:
    - Proxy server username.
    - This option is mandatory when I(enable_authentication) is 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

enable_authentication:
    description:
    - Enable or disable proxy authentication.
    - If I(enable_authentication) is true, I(proxy_username) and I(proxy_password) must
      be provided.
    - If I(enable_authentication) is false, the proxy username and password are set to
      its default values.
    type: bool

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 proxy configuration change.
  returned: always
  sample: Successfully updated network proxy configuration.
  type: str
proxy_configuration:
  description: Updated application network proxy configuration.
  returned: success
  sample:
    EnableAuthentication: true
    EnableProxy: true
    IpAddress: 192.168.0.2
    Password: null
    PortNumber: 444
    Username: root
  type: dict