dellemc.openmanage.ome_smart_fabric – Create, modify or delete a fabric on OpenManage Enterprise Modular
dellemc.openmanage.ome_smart_fabric – Create, modify or delete a fabric on OpenManage Enterprise Modular
Note
This plugin is part of the dellemc.openmanage collection (version 3.0.0).
To install it use: ansible-galaxy collection install dellemc.openmanage
.
To use it in a playbook, specify: dellemc.openmanage.ome_smart_fabric
.
New in version 2.1.0: of dellemc.openmanage
Synopsis
- This module allows to create a fabric, and modify or delete an existing fabric 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 |
---|---|---|
description string |
Provide a short description of the fabric to be created or modified. | |
fabric_design string |
|
Specify the fabric topology.See the use API https://www.dell.com/support/manuals/en-in/poweredge-mx7000/omem_1_20_10_ug/smartfabric-network-topologies to know why its topology. fabric_design is mandatory for fabric creation. |
hostname string / required |
Target IP address or hostname. | |
name string / required |
Provide the name of the fabric to be created, deleted or modified. | |
new_name string |
Provide the name of the fabric to be modified. | |
override_LLDP_configuration string |
|
Enable this configuration to allow Fabric Management Address to be included in LLDP messages. Notes: OpenManage Enterprise Modular 1.0 does not support this option. Some software networking solutions require a single management address to be transmitted by all Ethernet switches to represent the entire fabric. Enable this feature only when connecting to such a solution. |
password string / required |
Target user password. | |
port integer |
Default: 443 |
Target HTTPS port. |
primary_switch_service_tag string |
Service tag of the first switch. primary_switch_service_tag is mandatory for fabric creation. primary_switch_service_tag must belong to the model selected in fabric_design. | |
secondary_switch_service_tag string |
Service tag of the second switch. secondary_switch_service_tag is mandatory for fabric creation. secondary_switch_service_tag must belong to the model selected in fabric_design. | |
state string |
|
Notes: The create, modify, or delete fabric operation takes around 15-20 minutes to complete. It is recommended not to start an another operation until the current operation is completed. |
username string / required |
Target username. |
Notes
Note
- Run this module from a system that has direct access to DellEMC OpenManage Enterprise Modular.
- This module supports
check_mode
.
Examples
---
- name: Create a fabric
dellemc.openmanage.ome_smart_fabric:
hostname: "192.168.0.1"
username: "username"
password: "password"
state: present
name: "fabric1"
description: "fabric desc"
fabric_design: "2xMX9116n_Fabric_Switching_Engines_in_different_chassis"
primary_switch_service_tag: "SVTG123"
secondary_switch_service_tag: "PXYT456"
override_LLDP_configuration: "Enabled"
- name: Modify a fabric
dellemc.openmanage.ome_smart_fabric:
hostname: "192.168.0.1"
username: "username"
password: "password"
state: present
name: "fabric1"
new_name: "fabric_gold1"
description: "new description"
- name: Delete a fabric
dellemc.openmanage.ome_smart_fabric:
hostname: "192.168.0.1"
username: "username"
password: "password"
state: "absent"
name: "fabric1"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
additional_info dictionary |
when state=present and additional information present in response. |
Additional details of the fabric operation.
Sample: {'error': {'@Message.ExtendedInfo': [{'Message': '\xa0"Fabric\xa0update\xa0is\xa0successful.\xa0The\xa0OverrideLLDPConfiguration\xa0attribute\xa0is\xa0not\xa0provided\xa0in\xa0the \xa0payload', 'MessageArgs': [], 'RelatedProperties': [], 'Resolution': 'Please\xa0update\xa0the\xa0Fabric\xa0with\xa0the\xa0OverrideLLDPConfiguration\xa0as\xa0Disabled\xa0or\xa0Enabled\xa0if \xa0necessary.', 'Severity': 'Informational', '\xa0so\xa0it\xa0preserves\xa0the\xa0previous\xa0value."': None}], 'code': 'Base.1.0.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.'}} |
error_info dictionary |
on HTTP error |
Details of the HTTP Error.
Sample: {'error': {'@Message.ExtendedInfo': [{'Message': 'Unable to perform operation, because the fabric manager was not reachable.', 'MessageArgs': [], 'RelatedProperties': [], 'Resolution': 'Make sure of the following and retry the operation: 1) There is at least one advanced I/O Module in power-on mode. For example, MX9116n Ethernet Switch and MX5108n Ethernet Switch. However, if an advanced I/O Module is available in the power-on mode, make sure that the network profile is not set when the fabric manager is in the switch-over mode. 2) If the issue persists, wait for few minutes and retry the operation.', 'Severity': 'Warning'}], 'code': 'Base.1.0.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.'}} |
fabric_id string |
success |
Returns the ID when an fabric is created, modified or deleted.
Sample: 1312cceb-c3dd-4348-95c1-d8541a17d776 |
msg string |
always |
Overall status of the fabric operation.
Sample: Fabric creation operation is initiated. |
Authors
- Sajna Shetty(@Sajna-Shetty)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/dellemc/openmanage/ome_smart_fabric_module.html