Try SpotterCreate, modify or delete a fabric on OpenManage Enterprise Modular
| "added in version" 2.1.0 of dellemc.openmanage"
Authors: Sajna Shetty(@Sajna-Shetty)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module allows to create a fabric, and modify or delete an existing fabric on OpenManage Enterprise Modular.
---
- name: Create a fabric
dellemc.openmanage.ome_smart_fabric:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
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"
ca_path: "/path/to/ca_cert.pem"
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"
ca_path: "/path/to/ca_cert.pem"
state: "absent"
name: "fabric1"
name:
description: Provide the I(name) of the fabric to be created, deleted or modified.
required: true
type: str
port:
default: 443
description: OpenManage Enterprise Modular HTTPS port.
type: int
state:
choices:
- present
- absent
default: present
description:
- C(present) creates a new fabric or modifies an existing fabric.
- C(absent) deletes an existing fabric.
- '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.'
type: str
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
new_name:
description: Provide the I(name) of the fabric to be modified.
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
description:
description: Provide a short description of the fabric to be created or modified.
type: str
fabric_design:
choices:
- 2xMX5108n_Ethernet_Switches_in_same_chassis
- 2xMX9116n_Fabric_Switching_Engines_in_same_chassis
- 2xMX9116n_Fabric_Switching_Engines_in_different_chassis
description:
- Specify the fabric topology.See the use API U(https://www.dell.com/support/manuals/en-in/poweredge-mx7000/omem_1_20_10_ug/smartfabric-network-topologies)
to know why its topology.
- I(fabric_design) is mandatory for fabric creation.
type: str
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
primary_switch_service_tag:
description:
- Service tag of the first switch.
- I(primary_switch_service_tag) is mandatory for fabric creation.
- I(primary_switch_service_tag) must belong to the model selected in I(fabric_design).
type: str
override_LLDP_configuration:
choices:
- Enabled
- Disabled
description:
- 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.'
type: str
secondary_switch_service_tag:
description:
- Service tag of the second switch.
- I(secondary_switch_service_tag) is mandatory for fabric creation.
- I(secondary_switch_service_tag) must belong to the model selected in I(fabric_design).
type: str
additional_info:
description: Additional details of the fabric operation.
returned: when I(state=present) and additional information present in response.
sample:
error:
'@Message.ExtendedInfo':
- Message: Fabric update is successful. The OverrideLLDPConfiguration attribute
is not provided in the payload, so it preserves the previous value.
MessageArgs: []
RelatedProperties: []
Resolution: Please update the Fabric with the OverrideLLDPConfiguration as
Disabled or Enabled if necessary.
Severity: Informational
code: Base.1.0.GeneralError
message: A general error has occurred. See ExtendedInfo for more information.
type: dict
error_info:
description: Details of the HTTP Error.
returned: on 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.
type: dict
fabric_id:
description: Returns the ID when an fabric is created, modified or deleted.
returned: success
sample: 1312cceb-c3dd-4348-95c1-d8541a17d776
type: str
msg:
description: Overall status of the fabric operation.
returned: always
sample: Fabric creation operation is initiated.
type: str