dellemc.openmanage.ome_device_location – Configure device location settings on OpenManage Enterprise Modular

Note

This plugin is part of the dellemc.openmanage collection (version 4.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.

To use it in a playbook, specify: dellemc.openmanage.ome_device_location.

New in version 4.2.0: of dellemc.openmanage

Synopsis

  • This module allows to configure the device location settings of the chassis on OpenManage Enterprise Modular.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7.17

Parameters

Parameter Choices/Defaults Comments
aisle
string
The aisle of the chassis.
data_center
string
The data center name of the chassis.
device_id
integer
The ID of the chassis for which the settings need to be updated.
If the device ID is not specified, this module updates the location settings for the hostname.
device_id is mutually exclusive with device_service_tag.
device_service_tag
string
The service tag of the chassis for which the settings need to be updated.
If the device service tag is not specified, this module updates the location settings for the hostname.
device_service_tag is mutually exclusive with device_id.
hostname
string / required
OpenManage Enterprise Modular IP address or hostname.
location
string
The physical location of the chassis.
password
string / required
OpenManage Enterprise Modular password.
port
integer
Default:
443
OpenManage Enterprise Modular HTTPS port.
rack
string
The rack name of the chassis.
rack_slot
integer
The rack slot number of the chassis.
room
string
The room of the chassis.
username
string / required
OpenManage Enterprise Modular username.

Notes

Note

  • Run this module from a system that has direct access to Dell EMC OpenManage Enterprise Modular.

  • This module supports check_mode.

Examples

---
- name: Update device location settings of a chassis using the device ID.
  dellemc.openmanage.ome_device_location:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    device_id: 25011
    data_center: data center 1
    room: room 1
    aisle: aisle 1
    rack: rack 1
    rack_slot: 2
    location: location 1

- name: Update device location settings of a chassis using the device service tag.
  dellemc.openmanage.ome_device_location:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    device_service_tag: GHRT2RL
    data_center: data center 2
    room: room 7
    aisle: aisle 4
    rack: rack 6
    rack_slot: 22
    location: location 5

- name: Update device location settings of the host chassis.
  dellemc.openmanage.ome_device_location:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    data_center: data center 3
    room: room 3
    aisle: aisle 1
    rack: rack 7
    rack_slot: 10
    location: location 9

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
error_info
dictionary
on HTTP error
Details of the 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.'}}
location_details
dictionary
success
returned when location settings are updated successfully.

Sample:
{'Aisle': 'aisle 1', 'DataCenter': 'data center 1', 'Location': 'location 1', 'RackName': 'rack 1', 'RackSlot': 2, 'Room': 'room 1', 'SettingType': 'Location'}
msg
string
always
Overall status of the device location settings.

Sample:
Successfully updated the location settings.


Authors

  • Felix Stephen (@felixs88)