dellemc.openmanage.ome_smart_fabric_uplink_info module – Retrieve details of fabric uplink on OpenManage Enterprise Modular.
Note
This module is part of the dellemc.openmanage collection (version 9.8.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_smart_fabric_uplink_info
.
New in dellemc.openmanage 7.1.0
Synopsis
This module retrieve details of fabric uplink 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 Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
Unique id of the fabric. fabric_id is mutually exclusive with fabric_name. |
|
Unique name of the fabric. fabric_name is mutually exclusive with fabric_id. |
|
OpenManage Enterprise Modular IP address or hostname. |
|
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 socket level timeout in seconds. Default: |
|
Unique id of the uplink. uplink_id is mutually exclusive with uplink_name. fabric_id or fabric_name is required along with uplink_id. |
|
Unique name of the uplink. uplink_name is mutually exclusive with uplink_id. fabric_id or fabric_name is required along with uplink_name. |
|
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: Retrieve all fabric uplink information using fabric_id.
dellemc.openmanage.ome_smart_fabric_uplink_info:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
fabric_id: "61c20a59-9ed5-4ae5-b850-5e5acf42d2f2"
- name: Retrieve all fabric uplink information using fabric_name.
dellemc.openmanage.ome_smart_fabric_uplink_info:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
fabric_name: "f1"
- name: Retrieve specific fabric information using uplink_id.
dellemc.openmanage.ome_smart_fabric_uplink_info:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
fabric_id: "61c20a59-9ed5-4ae5-b850-5e5acf42d2f2"
uplink_id: "1ad54420-b145-49a1-9779-21a579ef6f2d"
- name: Retrieve specific fabric information using uplink_name.
dellemc.openmanage.ome_smart_fabric_uplink_info:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
fabric_id: "61c20a59-9ed5-4ae5-b850-5e5acf42d2f2"
uplink_name: "u1"
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: |
|
Status of fabric uplink information retrieval. Returned: always Sample: |
|
Information about the fabric uplink. Returned: on success Sample: |