Try SpotterConfigure local access settings on OpenManage Enterprise Modular.
| "added in version" 4.4.0 of dellemc.openmanage"
Authors: Felix Stephen (@felixs88), Shivam Sharma (@ShivamSh3)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module allows to configure the local access settings of the power button, quick sync, KVM, LCD, and chassis direct access on OpenManage Enterprise Modular.
---
- 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"
lcd:
description:
- The settings for LCD.
- The I(lcd) options are ignored if the LCD hardware is not present in the chassis.
suboptions:
lcd_access:
choices:
- VIEW_AND_MODIFY
- VIEW_ONLY
- DISABLED
description:
- Option to configure the quick sync settings using LCD.
- C(VIEW_AND_MODIFY) to set access level to view and modify.
- C(VIEW_ONLY) to set access level to view.
- C(DISABLED) to disable the access.
type: str
lcd_language:
description:
- 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.
type: str
user_defined:
description: 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.
type: str
type: dict
port:
default: 443
description: 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 Modular IP address or hostname.
required: true
type: str
password:
description:
- 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 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
device_id:
description:
- 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 I(hostname).
- I(device_id) is mutually exclusive with I(device_service_tag).
type: int
quick_sync:
description:
- The settings for quick sync.
- The I(quick_sync) options are ignored if the quick sync hardware is not present.
suboptions:
enable_inactivity_timeout:
description: Enables or disables the inactivity timeout.
type: bool
enable_quick_sync_wifi:
description: Enables or disables the Wi-Fi communication path to the chassis.
type: bool
enable_read_authentication:
description: Enables or disables the option to log in using your user credentials
and to read the inventory in a secure data center.
type: bool
quick_sync_access:
choices:
- READ_WRITE
- READ_ONLY
- DISABLED
description:
- Users with administrator privileges can set the following types of I(quick_sync_access).
- C(READ_WRITE) enables writing configuration using quick sync.
- C(READ_ONLY) enables read only access to Wi-Fi and Bluetooth Low Energy(BLE).
- C(DISABLED) disables reading or writing configuration through quick sync.
type: str
timeout_limit:
description:
- 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 I(enable_inactivity_timeout) is C(true).
type: int
timeout_limit_unit:
choices:
- SECONDS
- MINUTES
description:
- Inactivity timeout limit unit.
- C(SECONDS) to set I(timeout_limit) in seconds.
- C(MINUTES) to set I(timeout_limit) in minutes.
- This option is required when I(enable_inactivity_timeout) is C(true).
type: str
type: dict
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_kvm_access:
description: Enables or disables the keyboard, video, and mouse (KVM) interfaces.
type: bool
device_service_tag:
description:
- 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 I(hostname).
- I(device_service_tag) is mutually exclusive with I(device_id).
type: str
chassis_power_button:
description: The settings for the chassis power button.
suboptions:
disabled_button_lcd_override_pin:
description:
- The six digit LCD override pin to change the power state of the chassis.
- This is required when I(enable_lcd_override_pin) is C(true).
- The module will always report change when I(disabled_button_lcd_override_pin)
is C(true).
- 'The value must be specified in quotes. ex: "001100".'
type: str
enable_chassis_power_button:
description:
- Enables or disables the chassis power button.
- If C(false), the chassis cannot be turn on or turn off using the power button.
required: true
type: bool
enable_lcd_override_pin:
description:
- Enables or disables the LCD override pin.
- This is required when I(enable_chassis_power_button) is C(false).
type: bool
type: dict
enable_chassis_direct_access:
description: Enables or disables the access to management consoles such as iDRAC and
the management module of the device on the chassis.
type: bool
error_info:
description: Details of the HTTP Error.
returned: on HTTP error
sample:
error:
'@Message.ExtendedInfo':
- Message: Unable to process the request because an error occurred.
MessageArgs: []
MessageId: GEN1234
RelatedProperties: []
Resolution: Retry the operation. If the issue persists, contact your system
administrator.
Severity: Critical
code: Base.1.0.GeneralError
message: A general error has occurred. See ExtendedInfo for more information.
type: dict
location_details:
description: returned when local access settings are updated successfully.
returned: success
sample:
EnableChassisDirect: false
EnableChassisPowerButton: false
EnableKvmAccess: true
EnableLcdOverridePin: false
LcdAccess: VIEW_ONLY
LcdCustomString: LCD Text
LcdLanguage: en
LcdOverridePin: ''
LcdPinLength: 6
LcdPresence: Present
LedPresence: Absent
QuickSync:
EnableInactivityTimeout: true
EnableQuickSyncWifi: false
EnableReadAuthentication: false
QuickSyncAccess: READ_ONLY
QuickSyncHardware: Present
TimeoutLimit: 7
TimeoutLimitUnit: MINUTES
SettingType: LocalAccessConfiguration
type: dict
msg:
description: Overall status of the device local access settings.
returned: always
sample: Successfully updated the local access settings.
type: str