W3cubDocs

/Ansible 2.11

dellemc.openmanage.ome_smart_fabric_uplink – Create, modify or delete a uplink for 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_uplink.

New in version 2.1.0: of dellemc.openmanage

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

This module allows to create, modify or delete an uplink for a fabric.

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 for the uplink to be created or modified.
fabric_name string / required		Provide the fabric_name of the fabric for which the uplink is to be configured.
hostname string / required		Target IP address or hostname.
name string / required		Provide the name of the uplink to be modified.
new_name string		Provide the name of the uplink to be modified.
password string / required		Target user password.
port integer	Default: 443	Target HTTPS port.
primary_switch_ports list / elements=string		The IOM slots to be connected to the primary switch. primary_switch_service_tag is mandatory for this option.
primary_switch_service_tag string		Service tag of the primary switch.
secondary_switch_ports list / elements=string		The IOM slots to be connected to the secondary switch. secondary_switch_service_tag is mandatory for this option.
secondary_switch_service_tag string		Service tag of the secondary switch.
state string	Choices: present ← absent	`present` - Creates a new uplink with the provided name. - Modifies an existing uplink with the provided name. `absent` – Deletes the uplink with the provided name. WARNING Delete operation can impact the network infrastructure.
tagged_networks list / elements=string		VLANs to be associated with the uplink name.
ufd_enable string	Choices: Enabled Disabled	Add or Remove the uplink to the Uplink Failure Detection (UFD) group. The UFD group identifies the loss of connectivity to the upstream switch and notifies the servers that are connected to the switch. During an uplink failure, the switch disables the corresponding downstream server ports. The downstream servers can then select alternate connectivity routes, if available. WARNING The firmware version of the I/O Module running the Fabric Manager must support this configuration feature. If not, uplink creation will be successful with an appropriate error message in response.
untagged_network string		Specify the name of the VLAN to be added as untagged to the uplink.
uplink_type string	Choices: Ethernet FCoE FC Gateway FC Direct Attach Ethernet - No Spanning Tree	Specify the uplink type. NOTE The uplink type cannot be changed for an existing uplink.
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 an Uplink
  dellemc.openmanage.ome_smart_fabric_uplink:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    state: "present"
    fabric_name: "fabric1"
    name: "uplink1"
    description: "CREATED from OMAM"
    uplink_type: "Ethernet"
    ufd_enable: "Enabled"
    primary_switch_service_tag: "ABC1234"
    primary_switch_ports:
      - ethernet1/1/13
      - ethernet1/1/14
    secondary_switch_service_tag: "XYZ1234"
    secondary_switch_ports:
      - ethernet1/1/13
      - ethernet1/1/14
    tagged_networks:
      - vlan1
      - vlan3
    untagged_network: vlan2
  tags: create_uplink

- name: Modify an existing uplink
  dellemc.openmanage.ome_smart_fabric_uplink:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    state: "present"
    fabric_name: "fabric1"
    name: "uplink1"
    new_name: "uplink2"
    description: "Modified from OMAM"
    uplink_type: "Ethernet"
    ufd_enable: "Disabled"
    primary_switch_service_tag: "DEF1234"
    primary_switch_ports:
      - ethernet1/2/13
      - ethernet1/2/14
    secondary_switch_service_tag: "TUV1234"
    secondary_switch_ports:
      - ethernet1/2/13
      - ethernet1/2/14
    tagged_networks:
      - vlan11
      - vlan33
    untagged_network: vlan22
  tags: modify_uplink

- name: Delete an Uplink
  dellemc.openmanage.ome_smart_fabric_uplink:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    state: "absent"
    fabric_name: "fabric1"
    name: "uplink1"
  tags: delete_uplink

- name: Modify an Uplink name
  dellemc.openmanage.ome_smart_fabric_uplink:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    state: "present"
    fabric_name: "fabric1"
    name: "uplink1"
    new_name: "uplink2"
  tags: modify_uplink_name

- name: Modify Uplink ports
  dellemc.openmanage.ome_smart_fabric_uplink:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    state: "present"
    fabric_name: "fabric1"
    name: "uplink1"
    description: "uplink ports modified"
    primary_switch_service_tag: "ABC1234"
    primary_switch_ports:
      - ethernet1/1/6
      - ethernet1/1/7
    secondary_switch_service_tag: "XYZ1234"
    secondary_switch_ports:
      - ethernet1/1/9
      - ethernet1/1/10
  tags: modify_ports

- name: Modify Uplink networks
  dellemc.openmanage.ome_smart_fabric_uplink:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    state: "present"
    fabric_name: "fabric1"
    name: "create1"
    description: "uplink networks modified"
    tagged_networks:
      - vlan4
  tags: modify_networks

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': 'Unable to configure the Uplink Failure Detection mode on the uplink because the firmware version of the I/O Module running the Fabric Manager does not support the configuration feature.', 'MessageArgs': [], 'MessageId': 'CDEV7151', 'RelatedProperties': [], 'Resolution': "Update the firmware version of the I/O Module running the Fabric Manager and retry the operation. For information about the recommended I/O Module firmware versions, see the OpenManage Enterprise-Modular User's Guide available on the support site.", 'Severity': 'Informational'}], '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 complete the request because the resource URI does not exist or is not implemented.', 'MessageArgs': [], 'MessageId': 'CGEN1006', 'RelatedProperties': [], 'Resolution': "Check the request resource URI. Refer to the OpenManage Enterprise-Modular User's Guide for more information about resource URI and its properties.", 'Severity': 'Critical'}], 'code': 'Base.1.0.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.'}}
msg string	always	Overall status of the uplink operation. Sample: Successfully modified the uplink.
uplink_id string	when state=present	Returns the ID when an uplink is created or modified. Sample: ddc3d260-fd71-46a1-97f9-708e12345678

Authors

Jagadeesh N V(@jagadeeshnv)

© 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_uplink_module.html