dellemc.openmanage.ome_device_local_access_configuration module – Configure local access settings on OpenManage Enterprise Modular.
Note
This module is part of the dellemc.openmanage collection (version 6.3.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_device_local_access_configuration.
New in dellemc.openmanage 4.4.0
Synopsis
This module allows to configure the local access settings of the power button, quick sync, KVM, LCD, and chassis direct access on OpenManage Enterprise Modular.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.8.6
Parameters
Parameter |
Comments |
|---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
The settings for the chassis power button. |
|
The six digit LCD override pin to change the power state of the chassis. This is required when enable_lcd_override_pin is The module will always report change when disabled_button_lcd_override_pin is |
|
Enables or disables the chassis power button. If Choices:
|
|
Enables or disables the LCD override pin. This is required when enable_chassis_power_button is Choices:
|
|
The ID of the chassis for which the local access configuration to be updated. If the device ID is not specified, this module updates the local access settings for the hostname. device_id is mutually exclusive with device_service_tag. |
|
The service tag of the chassis for which the local access settings needs to be updated. If the device service tag is not specified, this module updates the local access settings for the hostname. device_service_tag is mutually exclusive with device_id. |
|
Enables or disables the access to management consoles such as iDRAC and the management module of the device on the chassis. Choices:
|
|
Enables or disables the keyboard, video, and mouse (KVM) interfaces. Choices:
|
|
OpenManage Enterprise Modular IP address or hostname. |
|
The settings for LCD. The lcd options are ignored if the LCD hardware is not present in the chassis. |
|
Option to configure the quick sync settings using LCD.
Choices:
|
|
The language code in which the text on the LCD must be displayed. en to set English language. fr to set French language. de to set German language. es to set Spanish language. ja to set Japanese language. zh to set Chinese language. |
|
The text to display on the LCD Home screen. The LCD Home screen is displayed when the system is reset to factory default settings. The user-defined text can have a maximum of 62 characters. |
|
OpenManage Enterprise Modular password. |
|
OpenManage Enterprise Modular HTTPS port. Default: |
|
The settings for quick sync. The quick_sync options are ignored if the quick sync hardware is not present. |
|
Enables or disables the inactivity timeout. Choices:
|
|
Enables or disables the Wi-Fi communication path to the chassis. Choices:
|
|
Enables or disables the option to log in using your user credentials and to read the inventory in a secure data center. Choices:
|
|
Users with administrator privileges can set the following types of quick_sync_access.
Choices:
|
|
Inactivity timeout in seconds or minutes. The range is 120 to 3600 in seconds, or 2 to 60 in minutes. This option is required when enable_inactivity_timeout is |
|
Inactivity timeout limit unit.
This option is required when enable_inactivity_timeout is Choices:
|
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise Modular username. |
|
If Configure Prior to collection version Choices:
|
Notes
Note
Run this module from a system that has direct access to OpenManage Enterprise Modular.
This module supports
check_mode.The module will always report change when enable_chassis_power_button is
True.
Examples
---
- name: Configure KVM, direct access and power button settings of the chassis using device ID.
dellemc.openmanage.ome_device_local_access_configuration:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_id: 25011
enable_kvm_access: true
enable_chassis_direct_access: false
chassis_power_button:
enable_chassis_power_button: false
enable_lcd_override_pin: true
disabled_button_lcd_override_pin: 123456
- name: Configure Quick sync and LCD settings of the chassis using device service tag.
dellemc.openmanage.ome_device_local_access_configuration:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
device_service_tag: GHRT2RL
quick_sync:
quick_sync_access: READ_ONLY
enable_read_authentication: true
enable_quick_sync_wifi: true
enable_inactivity_timeout: true
timeout_limit: 10
timeout_limit_unit: MINUTES
lcd:
lcd_access: VIEW_ONLY
lcd_language: en
user_defined: "LCD Text"
- name: Configure all local access settings of the host chassis.
dellemc.openmanage.ome_device_local_access_configuration:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
enable_kvm_access: true
enable_chassis_direct_access: false
chassis_power_button:
enable_chassis_power_button: false
enable_lcd_override_pin: true
disabled_button_lcd_override_pin: 123456
quick_sync:
quick_sync_access: READ_WRITE
enable_read_authentication: true
enable_quick_sync_wifi: true
enable_inactivity_timeout: true
timeout_limit: 120
timeout_limit_unit: SECONDS
lcd:
lcd_access: VIEW_MODIFY
lcd_language: en
user_defined: "LCD Text"
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: |
|
returned when local access settings are updated successfully. Returned: success Sample: |
|
Overall status of the device local access settings. Returned: always Sample: |