dellemc.openmanage.ome_device_location module – Configure device location settings on OpenManage Enterprise Modular
Note
This module is part of the dellemc.openmanage collection (version 9.12.3).
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_location.
New in dellemc.openmanage 4.2.0
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 >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
The aisle of the chassis. |
|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
The data center name of the chassis. |
|
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. |
|
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. |
|
OpenManage Enterprise Modular IP address or hostname. |
|
The physical location of the chassis. |
|
OpenManage Enterprise Modular password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise Modular HTTPS port. Default: |
|
The rack name of the chassis. |
|
The rack slot number of the chassis. |
|
The room of the chassis. |
|
The socket level timeout in seconds. Default: |
|
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 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"
ca_path: "/path/to/ca_cert.pem"
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"
ca_path: "/path/to/ca_cert.pem"
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"
ca_path: "/path/to/ca_cert.pem"
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 |
Description |
|---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
returned when location settings are updated successfully. Returned: success Sample: |
|
Overall status of the device location settings. Returned: always Sample: |